ph_ctlrcontrol PowerHome formula function
Description
This function allows you to control
(connect, disconnect, restart) a preconfigured PowerHome
controller
Syntax
ph_ctlrcontrol ( ctlr, control
)
Argument |
Description |
ctlr |
String. The ID of the PowerHome controller that you
wish to control. |
control
|
String. The type of action you'd
like to
be performed.
|
Return value
Integer. Returns 0 if
successful. 1 if the specified controller ID does not exist. 2 if
PowerHome is not registered. 3 if the control string
is invalid.
Usage
Valid control strings are:
"connect"
"disconnect"
"restart"
This function
replaces the deprecated functions ph_connect and ph_disconnect
Examples
The following examples demonstrate typical syntax/usage for this function.
ph_ctlrcontrol("ELK","disconnect") This call
will cause the controller "ELK" to be
disconnected.