CcWakeUp (wakeUp) is a child container of a ZWaveDevice that supports the Wake Up command class, typical for a battery-powered device. This allows the device to “sleep” for periods and then “wake up” occasionally to notify another device (always listening)
that the device is ready to receive queued commands. Typically, (with the JACE operating as the SIS or SUC), this other device
is the JACE.
Read-only properties of this component specify a number of parameters and statistics related to this wake up routine, as follows:
-
Is Awake — Indicates by “true” that a wake-up notification has been received from the device, and the driver is actively reading or writing data from/to the device.
There may be times that a device is actually awake, yet this property indicates “false”. This can occur after a button on
the device has been pushed, which typically keeps the device awake for a fixed period (for example, 10 minutes). The driver
gets the notification when the button is pushed, and then immediately updates received data and executes any queued write
messages. After completing all transactions, the driver then marks this property as false (typical after any “normal” awake
routine). This is necessary because devices do not send any notification when a “button timeout” expires.
-
Request — Shows request status information. For example, if the component’s “Set Wake Up Inteval” action is invoked to set it to 360 (seconds), the string “
setWakeUpInterval posted: 360” would be shown. When the device wakes up and the interval is written, “wakup interval written: 360 30-Jul-10 9:53 AM EDT” would be shown. -
Interval — Reflects the time period, in seconds, that the device periodically wakes up and sends a Wake Up Notification command to the node specified in the “Node Id” property.
A right-click “Set Wake Up Interval” action is available to modify this period, if needed.
-
Min Interval — Minimum wake up interval supported by this battery-powered device.
-
Max Interval — Maximum wake up interval supported by this battery-powered device.
-
Default Interval — Factory-default wake up interval for this battery-powered device.
-
Step Size — Resolution of possible changes to the wake up interval for this battery-powered device.
-
Last Wake Up — Timestamp the last Wake Up Notification message was received from this device.
-
Next Wake Up — Timestamp of the next (anticipated) Wake Up Notification message to be received from this device. If two (2) consecutive wake up interval messages are missed from the device, the parent ZWaveDevice is flagged as “down”.
-
Node Id — The Z-Wave node ID to which this device sends its Wake Up Notification messages. If the JACE is acting as the network’s SIS or SUC (recommended), it is automatically set to the JACE’s node ID (2). Otherwise, it is set to 255, which is the Z-Wave broadcast address.
In addition to properties above, several actions are available on the CcWakeUp (wakeUp) component, described as follows:
-
Set Wake Up Interval — Use to modify the wakeup interval used (and stored) in the device.
-
Post Read Node Info — Forces the driver to request the device to send its Node Information message the next time the device wakes up. You might invoke this to be sure that all of its supported command classes are known to Niagara.
-
Read Device Data — This action is automatically invoked when a Wake Up Notification message is received from the battery-powered device. It forces the driver to read the data from all supported command classes, including any device-resident components as well as any proxy (control) points.
For background details on battery-powered Z-Wave devices, see Battery-powered (non-listening) device considerations.