ph_getzwaverawvalrt PowerHome formula function
Description
Requests the Z-Wave controller to query the
specified Z-Wave device and retrieve its current status in
real time
Syntax
ph_getzwaverawvalrt ( as_id, ad_timeout )
| Argument | Description |
| as_id | String. The PowerHome Z-Wave device ID whose
status you would like to have queried in real time |
| ad_timeout | Double. The number of seconds to wait for the
returned raw value before timing out |
Return value
Long. Returns the raw value associated
the the Z-Wave device after the controller has queried the device
in real time
Usage
Use this function to force the Z-Wave
controller to query the specified Z-Wave device and wait (up to the ad_timeout
value in seconds) for the return value. Use care when using this function
as all PowerHome processing will be "paused" while this function is waiting for
the controller to return. It is advisable that you set your ad_timeout parameter
appropriately. If you would like the Z-Wave controller to query the device for
current status but don't necessarily need to wait for that status to be returned
in real time, use the ph_zwaveget(
) instead.
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_getzwaverawvalrt("FAMILYRM",10)