ph_getothermultistate PowerHome formula function (Deprecated)
Description
Retrieves the value of a Multi-state input point defined in the Analog I/O screen.
Syntax
ph_getothermultistate ( id, unit, point )
| Argument |
Description |
|
id
|
The ID of the controller whiose multi-state input you wish to have returned.
|
|
unit
|
The Unit of multi-state input.
|
|
point
|
The Point of the multi-state input.
|
Return value
Long. Returns the value associated with the specified multi-state input. Returns - 1 if the specified ontroller ID cannot be found. - 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". This function is similar to the ph_getmultistate function except that the multi-state input does not have to be defined within the Analog I/O screen. 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.