ph_zwaverawset PowerHome formula function
Description
Allows the user to queue a raw "set"
command for a specific Z-Wave node ID, instance, Command Class, and extra
parameter with the specified
Z-Wave controller
Syntax
ph_zwaverawset ( as_ctlr, ai_node, ai_instance, ai_cmdclass, as_extra, ai_value )
| Argument | Description |
| as_ctlr | String. The Z-Wave controller ID to queue the
set command on |
| ai_node | Integer. The node ID to send the set command
to. Must be a value from 1 to 255 |
| ai_instance | Integer. The instance for the above node ID to
send the set command to. Must be a value from 0 to 255 |
| ai_cmdclass | Integer. The CC for the node ID/instance that
you wish to set. Must be a value from 0 to 255 |
| as_extra | String. The extra parameter for the node
ID/instance. Currently unused. Set to empty string "" |
| ai_value | Integer. The value you would like to set for
the node ID/instance/CC. Must be a value from 0 to 255 |
Return value
Integer. Returns 0 if the request was
successfully queued with the specified Z-Wave controller. Returns -1
if the specified controller does not exist or isnt active. Returns -51 if
the command is not supported. Returns -52, -53, -54, -55 if the
node, instance, CC, or value parameters are
out of range
Usage
Use this function to queue a raw "set"
command to a specific controller, node ID, instance, and CC. If the note
ID, instance, CC is already defined as a Z-Wave device in the Z-Wave
Explorer, you can achieve the same functionality using the ph_zwaveset( )
function with
fewer parameters
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_zwaverawset("RAZ",8,0,38,"",255)
- Returns 0 if successful. This example specifies a CC of 38 which is a
Z-Wave standard "Switch Multilevel" command. The value that is queued to be
set is 255 which tells
the
device to turn on at the last level it was previously on
at