ph_getanalogcalcstat PowerHome formula function
Description
Retrieves the current calculated value of a Analog 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_getanalogcalcstat ( )
ph_getanalogcalcstat ( as_id )
| Argument |
Description |
|
as_id
|
String (Optional). The ID of the analog device to
retrieve the calculated value for. If this parameter is omitted, the system variable ANALOG will be used for the ID
|
Return value
String. Returns the currently stored calculated value for the specified analog device.
Usage
This function does not cause the controller to query the value. Use ph_getanalog to have the controller query the current raw value and calculate a new calculated value.
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_getanalogcalcstat("TEMPERATURE")
- Returns the calculated value for the TEMPERATURE Analog I/O device. This value
will be the same as that displayed in the Device Status
screen