ph_zwaveset PowerHome formula function
Description
Queues a "set" command to control a
previously defined Z-Wave device (a node ID/instance/CC/extra associated to a
PowerHome Z-Wave
device ID)
Syntax
ph_zwaveset ( as_id, ai_value )
| Argument | Description |
| as_id | String. The PowerHome Z-Wave Device ID to
queue the "set" command for |
| ai_value | Integer. The value you wish to set. Must be in
the range of 0 to 255 |
Return value
Integer. Returns 0 if the set
command is successfully queued. Returns -100 if Z-Wave ID in as_id does not
exist. Returns -1 if the controller associated with the Z-Wave ID is not found
or active. Returns -52, -53, -54 if the internal node ID, instance, and CC are
out of range. Returns -55 if the value to set (ai_value) is
out of range
Usage
Use this function to queue a "set" command
to a previously defined Z-Wave device within PowerHome. Similar to the
ph_zwaverawset( ) function except all the extra parameters such as
controller, node ID, instance, and CC are associate with the Z-Wave Device
ID specified in as_id making this function simpler
to call
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_zwaveset("KITCHENLIGHT",99) -
Returns 0 if the set command is successfully queued. The example assumes
that the Z-Wave Device ID "KITCHENLIGHT" is already defined within
the Z-Wave Explorer (Devices tab) within PowerHome. This screen allows you
to associate a Z-Wave controller, node ID, instance, and CC to a PowerHome
Z-Wave Device ID. If the "KITCHENLIGHT" ID had a CC value of 38 (Switch
Multilevel), the value to set of 99 would tell the light to turn on at
100%