| Table of contents |
CONTROL.BASIC Message Specification
- Class = CONTROL
- Type = BASIC
The control.basic schema is used to exert control over any output device on an xPL network, such as a light, a dimmer, a slider, or a relay.
XPL-TRIG Structure
There is no Trigger Message Structure for CONTROL.BASIC. If an output device (such as a dimmer) wishes to report it's status to the network, it should use the sensor.basic message schema.
XPL-CMND Structure
CONTROL.BASIC
{
DEVICE=<sensor name>
TYPE=<sensor type>
CURRENT=<value to which device should be set>
[DATA1=<additional data>]
[NAME=]
}
In terms of setting items: Where current= can explain it all that should be used e.g. current=HIGH or LOW or INC or DEC but where it needs more info like increment counter by 4 you would use
CURRENT=INC DATA1=4
XPL-STAT Structure
Not Applicable
HBEAT.*
{
(hbeat items)
}
Schema Specific Notes
The following device types are currently supported:
- balance - -100 to +100
- flag - SET, CLEAR, NEUTRAL
- infrared - SEND, ENABLE_RX, DISABLE_RX, ENABLE_TX, DISABLE_TX, SENDX (send x times)
- input - ENABLE, DISABLE
- macro - ENABLE, DISABLE, DO
- mute - YES, NO
- output - ENABLE, DISABLE, HIGH, LOW, TOGGLE, PULSE
- variable - INC, DEC, 0-255 (for set)
- periodic - STARTED, ENABLE, DISABLE
- scheduled - STARTED, ENABLE, DISABLE
- slider -
nn = set to value (0-255)
+nn = increment by nn
-nn = decrement by nn
nn% = set to nn (where nn is a percentage - 0-100%)
- timer - WENT OFF, START, STOP, HALT, RESUME
The above list may be expanded over time to facilitate additional device types.
