ph_getzwavecalcval PowerHome formula function
Description
Retrieves the current calculated value of
a Z-Wave device in the Device Status Screen. This function DOES NOT cause
the controller to retrieve the values and only returns what is currently stored
within PowerHome
Syntax
ph_getzwavecalcval ( )
ph_getzwavecalcval ( as_id )
| Argument | Description |
| as_id | String (Optional). The ID of the Z-Wave device. If this parameter is not supplied, the System variable ZWAVE will be used for the ID. |
Return value
String. Returns the currently
stored calculated value for
the specified Z-Wave device.
Usage
This function does not cause the controller
to query the value. If you need to first have the controller query the Z-Wave
device for it's current status, first call the ph_getzwaverawvalrt( )
and then call this function. You can also use the ph_zwaveget( )
function to have the controller queue a request for the Z-Wave device to update
its status. When a request is made to query the status of a Z-Wave device, either
real
time with ph_getzwaverawvalrt( ) or queued with
ph_zwaveget( ), the raw value will be retrieved and then the calculated value
will be updated based upon the
raw value.
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_getzwavecalcval("FAMILYRM") -
Returns the calculated value for the FAMILYRM Z-Wave device that is currently
stored in the
database