ph_timedeventsctrl PowerHome formula function
Description
Allows control and status of PowerHome Timed Events.
Syntax
ph_timedeventsctrl ( command, data )
Argument Description
command String. The command or query you wish to perform.
data Integer. Data to be passed for the command.
Return value
Long. Returns data if the command is a query otherwise returns 0.
Usage
Use this command to programmatically control and query PowerHome Timed Events. Use "on" for command to turn timed events on. Use a data value of 1 to execute past due timed events. Use a data value of 0 to not execute past due timed events. Use "off" for command to turn timed events off. Use "status" for command to determine whether timed events are currently on or off. If timed events are on, 1 will be returned. If timed events are off, 0 will be returned. Use "pdec" for command (Past Due Event Count) to return how many timed events are past due.
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_timedeventsctrl ( "on", 1 )
• ph_timedeventsctrl ( "off", 0 )