This function carries out an action on a Z-Wave device, returns information about a Z-Wave device, or issues a Z-Wave protocol command over the Z-Wave network.
|
Parameter |
Type |
Description |
|
dvRef |
object |
This is EITHER a device object reference (DeviceClass) or the device's unique device reference ID (Integer) |
|
ActionType |
integer |
This is the numerical value of the action type that you wish to perform - See the table below. |
|
Parameter1 (optional) |
object |
This is parameter 1, and its use varies depending upon the ActionType - See the table below. |
Return value: status/information
Type: string
Description: This returns device information, status, or error information
depending upon the ActionType.
|
Action Type Value |
Parameter Used? |
Description |
|
1 |
Yes |
Add an association between the device (source) and HomeSeer. Parameter1 is used to indicate the group number for the association. If Parameter1 is not provided, group 1 is assumed. |
|
2 |
Yes |
Remove an association between the device (source) and HomeSeer. Parameter1 is used to indicate the group number for the association. If Parameter1 is not provided, group 1 is assumed. |
|
3 |
No |
This returns the name programmed into the node. The node must support the Node Naming class. |
|
4 |
No |
The current HomeSeer device name is programmed into the node as its node name. The node must support the Node Naming class. Node names are 16 characters or less - longer names will be truncated. |
|
5 |
No |
This returns the location name programmed into the node. The node must support the Node Naming class. |
|
6 |
No |
The current HomeSeer device location is programmed into the node as its node location name. The node must support the Node Naming class. Node names are 16 characters or less - longer names will be truncated. |
|
7 |
No |
This returns a comma separated list of classes that the Z-Wave node supports. |
|
8 |
No |
The current level of the node is returned as a string. Values are in the range of 0-255. |
|
9 |
No |
Returns the current Protection setting of the device/node. The node must support the Protection class. |
|
10 |
No |
Returns the current indicator level of the device/node. The node must support the Indicator class. |
|
11 |
Yes |
Returns the current setting/value of the alarm, for the given mode. Parameter1 is used to indicate the desired mode, and if not provided will default to mode 1. The node must support the Alarm class. The Alarm class is also known as the Panic Mode feature on Cooper Wiring Devices products. |
|
12 |
Yes |
This returns a comma separated list of node numbers associated with the device/node for the given association group. Parameter1 is used to indicate which association group to retrieve the association information from. |
|
13 |
No |
Version information is returned in the form of the Lib (Z-Wave library) and App (manufacturer's application version). For example: Lib: 2.40 App: 1.16 |
|
|
|
|
|
|
|
|
The script sample below is included with this help file - click on the script below for options to open or save a copy of the script.