What can we improve?

Documentation

(Edit)

IPS_SetEventCyclicTimeBounds

 boolean IPS_SetEventCyclicTimeBounds (int $EventID, float $FromTime, float $ToTime) 

Parameters

EventID

ID of the cyclic event to be changed

FromTime

Time as a Unix timestamp

ToTime

Time as a Unix timestamp

Returns

If the command succeeds, it returns TRUE, otherwise FALSE.

Description

(warnig: This command is deprecated since IP-Symcon 3.1. It is merely emulated to grant downwards compatibility. Please use the commands (link: /service/dokumentation/befehlsreferenz/ereignisverwaltung/ips-seteventcyclictimefrom text: IPS_SetEventCyclicTimeFrom) and (link: /service/dokumentation/befehlsreferenz/ereignisverwaltung/ips-seteventcyclictimeto text: IPS_SetEventCyclicTimeTo) instead.)

This command defines the start and end time for a cyclic 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.

The date must be passed as an Unix timestamp. ([Wikipedia:Unix time](http://de.wikipedia.org/wiki/Unix time))

If a parameter is 0, no start and/or end time is set.

Example

//Assign no start / end times to the event.
IPS_SetEventCyclicTimeBounds($EventID, 0, 0);
//Start event at 7:30 
IPS_SetEventCyclicTimeBounds($EventID, mktime(7, 30, 0), 0);