ph_getmultistate PowerHome formula function (Deprecated)
Description
Retrieves the value of a Multi-state input point defined in the Analog I/O screen.
Syntax
ph_getmultistate ( id )
| Argument |
Description |
|
id
|
The ID of the multi-state input as defined within the Analog I/O screen.
|
Return value
Long. Returns the value associated with ID of the specified multi-state input. Returns - 100 if the ID cannot be found. When this function is executed, the controller, unit, and point is looked up within the Analog I/O table and these values are then passed to the controller. If these values are entered improperly in the Analog I/O screen, then the following errors may be returned: - 1 is returned if the controller is not available, - 3 is returned if the unit is out of range, - 4 is returned if the point is out of range.
Usage
Use this function to return the raw state of Elk multi-state inputs (0, 1, 2, or 3). Elk multi-state inputs are defined within the Analog I/O screen as "Elk Input". The multi-state input functions go direct to the controller to access the value stored there. Use the ph_getanalog and ph_getotheranalog functions to get the data stored within the PowerHome database for multi-state inputs.