TimeSpec_Syntax modified by jef2000

jef2000 — Fri, 20 Jun 2014 06:26:46 -0000

General
Constant:
Variable:
Sunrise, sunset and noon:

General

The type of timespec is determined by the type attribute.
Supported values for this attribute are: constant and variable (default is const). Since version 0.0.1.25, sunrise, sunset and noon are also available.

Constant:

Optional attributes year, month, day, hour and min are numbers and define together one or more points in time matching the timespec. The default value is -1 and is considered as a wildcard value.
Optional attribute wdays is a string containing the days of the week where the timespec can match. 1 is monday and 7 is sunday (e.g. "67" means the timespec will match only during weekend days). Default value is "1234567".
Optional attribute exception tells if the timespec must match taking into account the exception days defined in services section of configuration.
Value true or yes means the timespec will match only during exception days.
Value false or no means the timespec will not match during exception days.
If exception attribute is not specified, the default value is dont-care and means
that the exception days list is not taken into account.
Examples:
<at hour="7" min="30" wdays="12345" exception="no" /> will match at 7:30 AM every weekday except days in the exception days list.
<at hour="10" min="0" wdays="12345" exception="yes" /> will match at 10:00 AM every weekday that is also in the exception days list.
<at hour="7" min="30" wdays="12345" /> will match at 7:30 AM every weekday whatever is in the exception days list.

Variable:

Similar to constant timespec, but with additional optional time and date attributes referring to objects of type EIS3 and EIS4 respectively. For every wildcard in the timespec, the value will be obtained from the correcponding object.
Examples:
<at type="variable" time="wakeup_time" wdays="12345"> will match at the time stored in object "wakeup_time" every weekday.
<at type="variable" hour="22" min="00" date="alarm_date"> will match at 10:00 PM on the day stored in "alarm_date".

Sunrise, sunset and noon:

These timespec types are only available since version 0.0.1.25.
This needs a new entry in <services> section of configuration file to specify the geographic coordinates (longitude and latitude). Example:
<location lon="-4.20" lat="50.54"/>

In <at .../> or <until .../> elements, you can set type attribute to sunrise , sunset or noon. Of course, using hour and min attributes is useless, but day, month and year still works, even if in most case you will use wdays and/or exception instead. The offset is a number of seconds added to the computed sunrise/set time. (negative offset should be possible also). A number followed by letter "d", "h", "m" or "s" will be interpreted as a number of days, hours, minutes or seconds.

Here is an example of condition that becomes true on modays and tuesdays 2 hours before sunrise and becomes false the same days at 23:58. :

Recent changes to TimeSpec_Syntax

TimeSpec_Syntax modified by jef2000

General

Constant:

Variable:

Sunrise, sunset and noon: