ph_zwavegetconfig PowerHome formula function
Description
Queues a request with the Z-Wave controller
to query and retrieve a configuration parameter for the specified Z-Wave
node ID
Syntax
ph_zwavegetconfig ( as_controller, ai_nodeid, ai_instance, ai_parm )
| Argument | Description |
| as_controller | String. The ID of the Z-Wave controller to
queue the request with |
| ai_nodeid | Integer. The Z-Wave node number. Must be in
the range of 1 to 255 |
| ai_instance | Integer. The instance number for the node you
wish to query. Must be in the range of 0 to 255 |
| ai_parm | Integer. The parameter number you wish to
query. Must be in the range of 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 if the node,
instance, or parm parameters are
out of range
Usage
Use this function to queue a request to
retrieve a configuration parameter for a Z-Wave node/instance.
This function queues a Z-Wave Command Class (CC) 112 with
the specified controller. The parameter value to pass needs to be obtained
from the particular Z-Wave device's documentation. Z-Wave
configuration parameters are numbers from 0 to 255. Each number represents
a different configuration parameter that is specific to that particular
manufacturer and device type. PowerHome does not attempt to keep track of
manufacturer device types and their specific configuration parameters and it is
up to the user to glean this information
from the device documentation. You can enter and
store the configuration parameters for each unique node
ID in the Z-Wave Explorer on the "Node
Config" tab
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_zwavegetconfig("RAZ",3,0,20) -
Returns 0 if successful. Assuming that node ID 3 is a Fibaro Motion sensor,
parameter 20 is a request to retrieve the "Tamper
Sensitivity"