Documentation
IPS_SetEventCyclicTimeFrom
Require: IP-Symcon >= 3.1
boolean IPS_SetEventCyclicTimeFrom (int $EventID, int $Hour, int $Minute, int $Second)
Parameters
| EventID | ID of the cyclic event to be changed |
| Hour | Start hour (0..23) |
| Minute | Start minute (0..59) |
| Second | Start second (0..59) |
Returns
If the command succeeds, it returns TRUE, otherwise FALSE.
Description
This command defines the start time of a cyclic event. The start time defines the first execution of the event.
The start time is especially relevant when an event should run slightly shifted. This is usual to prevent all events at once at a full minute. For example, when the start time 00:00:05 is set and the event runs every minute, the script is always run five seconds after a full minute.
Example
//Set 7:15:00 as start time
IPS_SetEventCyclicTimeFrom($EventID, 7, 15, 0);