Contents |
TIMER Message Specification
- Class = TIMER
- Type = BASIC
This schema allows controling timers (start, stop, pause, resume)
XPL-CMND Structure
timer.basic
{
action=halt|resume|stop|start
device=<name of the timer>
[duration=0 or empty|integer]
[frequence=integer]
[range=local|global]
}
Duration element : Indicates how many seconds the timer with exist.
- If an integer value is provided the timer will count down to zero.
- If 0 or empty value is provided the timer will count endless until it receives a stop message
Frequence element : If a value is provided, the status of this timer will be triggered on this frequency base (a tick every x seconds).
Range element : Indicates wheter events related to this timer will be adressed to '*' or only the module starting it. By default, if this element is absent, the timer will be considered as local.
timer.request
{
device=<name of the timer>
}
Please note that no status is returned for stopped timers
XPL-TRIG Structure
A trigger is fired on every event for a timer : pause, resume, start stop, went off
timer.basic
{
device=<name of the timer>
current=halted|resumed|stopped|started|went off
elapsed=<number of seconds between start and stop>
}
XPL-STAT Structure
A stat message is sent to answer timer.request messages or frequency based
timer.basic
{
device=<name of the timer>
type=generic|
current=halted|resumed|stopped|started
elapsed=<number of seconds since start>
}