ph_timedeventsinfo PowerHome formula function
Description
Returns the requested info for the specified
Timedevent
ID.
Syntax
ph_timedeventsinfo ( id, command
)
| Argument |
Description |
| id |
String. The ID of the Timedevent whose info you're trying to
receive. |
|
command
|
String. Specifies the type of data you'd
like to retrieve for the timedevent. See
usage below.
|
Return value
String. Returns either the ID of the next
timedevent or a string containing the date and time for when the specified
timedevent ID is going to fire. Returns empty string if the command parameter is
invalid or the timedevent ID is not found.
The valid values for the
command parameter are detailed in the table below:
| nextevent |
This value will cause the function to return the timedevent
ID of the next timedevent to fire. Set the ID parameter to empty string ""
when using this option. |
|
nexttime
|
This value will cause the function to
return a formatted string (yyyy-mm-dd hh:mm:ss) for the next date/time
when the specified timedevent ID will
be fired.
|
Usage
Use this function to retrieve information
concerning Timedevents.
Examples
The following examples demonstrate typical syntax/usage for this function.
ph_timedeventsinfo("SUNRISE","nexttime")
The above
example will return the date/time for when the SUNRISE timed event will next be
fired.
ph_timedeventsinfo("","nextevent")
The above example will
return the ID of the next timedevent that will be
fired.