ph_gettetime PowerHome formula function
Description
Returns either the start DateTime or reference DateTime for a Timed Event
Syntax
ph_gettetime ( ai_type )
ph_gettetime ( as_id, ai_type )
| Argument | Description |
| as_id | String (Optional). The ID of the Timed Event to return
the DateTime for. If this parameter is omitted, the system variable TIMEDEVENT will be used |
| ai_type | Integer. The type of DateTime to be returned. Use 0 for the Start Time. Any other value returns the Reference Time |
Return value
Datetime. A DateTime value for the
specified Timed Event ID and type. If the specified Timed Event doesnt exist,
a DateTime value equivalent to 01-01-0000 00:00:00 will be returned
Usage
Use this function to return either the
current Start DateTime or Reference DateTime for a
Timed Event
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_gettetime("SPRINKLERMON",0) -
Returns the next scheduled Start time for the SPRINKLERMON timed
event