ph_insteonrawgroup PowerHome formula function
Description
Sends commands to an Insteon PLC's groups.
Syntax
ph_insteonrawgroup ( ctlr, group, cmd1, cmd2 )
| Argument |
Description |
|
ctlr
|
String. The ID of the Insteon controller.
|
|
group
|
Integer. An Insteon PLC group number from 1 to 254.
|
|
cmd1
|
Integer. The command 1 to send to the group.
|
|
cmd2
|
Integer. The command 2 to send to the group.
|
Return value
Integer. Returns a 0 if successful. -1 is returned if the controller is not available, -2 is returned if the controller does not support Insteon.
Usage
Use this funciton to send Insteon commands to a PLC group. Valid commands are 17 for on, 18 for fast on, 19 for off, 20 for fast off, 21 to brighten, and 22 to dim. You can also use the enumerated values: ion, ifaston, ioff, ifastoff, ibright, idim. Set cmd2 to 0 for all cmd1 values. Using a cmd1 value of 17 will cause the group to turn on to their individual group values using their individual ramprates. An 18 command (ifaston) causes all devices in the group to go full on ignoring the ramprate. Add 1000 to the standard Insteon commands to always force a group cleanup regardless of the controller setting. Add 2000 to the standard Insteon commands to never send a group cleanup regardless of the controller setting.