ph_insteonctrl PowerHome formula function
Description
Sets the operating parameters for the Insteon controller.
Syntax
ph_insteonctrl ( ctlrid, parm, data )
| Argument | Description |
| ctlrid |
String. The ID of the Insteon controller. |
| parm |
String. The specific parameter you would like
to change. See usage below for valid values. |
| data |
Double. The value to be set to the parameter. |
Return value
Integer. Returns 0 if successful. Returns - 1 if the controller ID cannot be found, returns - 100 if the parameter is not valid.
Usage
Use this function to on-the-fly programmatically change the operating parameters of the specified Insteon controller. Parameters must be a string (enclosed by single or double quotes). Valid parameters are:
pollinterval - Poll Interval. Data should contain the poll interval in seconds.
statusscan - Status Scan. Data should be 0 to disable status scan and 1 to enable.
lrxscan - Level / Ramprate / X10 Scan. Data should be 0 to disable and 1 to enable.
lrxwrite - Level / Ramprate / X10 Write. Data should be 0 to disable and 1 to enable.
linkscan - Link Scan. Data should be 0 to disable and 1 to enable the scanning of links.
maxfailures - Max Failures. Data should be an integer representing the maximum number of COMM failures before a device is flagged as failed.
plcgroupcu - PLC Group Cleanup messages. Data should be 0 to disable and 1 to enable.
ackupdate - Update on ACK's. Data should be 0 to disable and 1 to enable.
linkspider - Allow Link Spidering. Data should be 0 to disable and 1 to enable.
echofile -
Echo Raw Log to File. Data should be 0 to disable and 1 to enable.
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_insteonctrl("PLM","echofile",1)
The above example will enable the Echo Raw Log to File option for the Insteon controller identifed by PLM.