You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24Lines changed: 24 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -58,10 +58,34 @@ This node represents a specific local device registered in an Azure IoT Hub.
58
58
- Cloud-to-Device Messages - A list of cloud-to-device messages that this device has received from the IoT Hub.
59
59
60
60
**Child Nodes**
61
+
- D2C Rules - Holds _D2CRuleNodes_
61
62
- Methods - Holds _DirectMethodNodes_
62
63
- Desired Properties - Holds the desired properties of this device's device twin, retrieved from the IoT Hub.
63
64
- Reported Properties - Holds this device's reported properties and the action that creates them.
64
65
66
+
### D2C Rules
67
+
68
+
Holds _D2CRuleNodes_ associated with its parent _LocalDeviceNode_.
69
+
70
+
**Actions**
71
+
- Add Rule - Create a _D2CRuleNode_ to configure automatic sending of device-to-cloud messages, providing a DSA path to watch and a format for the messages.
72
+
73
+
**Child Nodes**
74
+
- any _D2CRuleNodes_ that have been added.
75
+
76
+
### D2CRuleNode
77
+
78
+
Defines a subscription to a DSA path, which will send its updates to IoT Hub as device-to-cloud messages
79
+
80
+
**Parameters (for the `Add Rule` and `Edit` actions)**
81
+
-`Subscribe Path` - The DSA path to subscribe to.
82
+
-`Properties` - A map of properties to be sent with each D2C message created by this rule. If you want to use the value, timestamp, or status of an update in the properties, use the placeholders `%VALUE%`, `%TIMESTAMP%` and `%STATUS%`.
83
+
- e.g. `{"node_name":"kWh", "timestamp":"%TIMESTAMP%"}`
84
+
-`Body` - The message body. Once again, use %VALUE%, %TIMESTAMP% and %STATUS% as placeholders.
85
+
- e.g. `The new value is %VALUE%`
86
+
- Minimum Refresh Rate: Optional, ensures that at least this many seconds elapse between updates. This means that the DSLink will suppress updates that are too close together. (Leave this parameter as 0 to not use this feature.)
87
+
- Maximum Refresh Rate: Optional, ensures that an update gets sent every this many seconds. This means that if the DSA value updates too infrequently, the DSLink will send duplicate updates. (Leave this parameter as 0 to not use this feature.)
88
+
65
89
### Methods
66
90
67
91
Holds _DirectMethodNodes_ associated with its parent _LocalDeviceNode_.
0 commit comments