X10.EXTENDED schema

[John B]

Hi all,

The XPL CM12U Windows service is coming along nicely - should be able to
start
testing later today hopefully.

Whilst looking at the x10 schema, I noticed we have no way of sending
extended
codes, such as those required to
set an LD11 directly to a specific level.

Therefore, I'd like to propose an extension to the x10.basic schema - the
x10.extended schema.

Basically it's just the addition of a new X10 command - EXTENDED, and two
new
optional elements - DATA1 and DATA2,
which hold the two bytes of extended code data.

If anyone can suggest any modifications/improvements, then they're welcome
to do
so.

I've included the full schema definition below.

Regards,

John



Schema Definition
-----------------

Class = X10
Type = EXTENDED

This Schema provides X10 command functionality to an xpl implementation
In addition to the functionality provided by the x10.basic schema, this
schema
provides support for X10 extended codes.


XPL-TRIG Structure
------------------
X10.EXTENDED
{
COMMAND=<x10 command>, see notes
Either,
DEVICE=<list of x10 devices, comma seperated>
or
HOUSE=<list of house codes e.g. AFG>
[LEVEL=<dim/bright level 0 to 100>]
[DATA1=<first byte of extended data 0 to 255>]
[DATA2=<second byte of extended data 0 to 255>]
}


XPL-CMND Structure
------------------
X10.EXTENDED
{
COMMAND=<x10 command>, see notes
Either,
DEVICE=<list of x10 devices, comma seperated>
or
HOUSE=<list of house codes e.g. AFG>
[LEVEL=<dim/bright level 0 to 100>]
[DATA1=<first byte of extended data 0 to 255>]
[DATA2=<second byte of extended data 0 to 255>]
}

*** THE MESSAGE MUST BE ECHOED BACK AS AN XPL-TRIG MESSAGE


XPL-STAT Structure
------------------
HBEAT.*
{
(hbeat items)
}


Schema Specific Notes
---------------------
X10 COMMAND=
SELECT
ALL_UNITS_OFF
ALL_LIGHTS_ON / ALL_LIGHTS_OFF
ON / OFF
DIM / BRIGHT
STATUS
EXTENDED

Any device/application implementing this schema MUST echo back each
xpl-cmnd
as an xpl-trig to confirm that the action was received

Any devices/applications that need to monitor x10 commands (not
controllers)
should
always (preferably) listen for xpl-trig messages

When the command is EXTENDED, the DATA1 and DATA2 sections of the XPL
message
must be present, and must contain the two bytes
of data to be sent as part of the extended code. The values of DATA1 and
DATA2
should be in decimal form, between 0 and 255.

Standard Notes
--------------
HBEAT.* = hbeat.basic or hbeat.app etc
(hbeat items) = standard .basic or .app heartbeat items
[<something>] = optional