X10 Schema

From XAP Automation
Jump to: navigation, search

X10

Core schema

Mandatory for all adaptors.

class = xap-x10.request

sent from xAP to X10

xap-x10.request
{
command=(on | off)
-- mandatory
device=(X10 device being addressed eg, A1 | B8 | M10 etc)
-- mandatory
}

or

xap-x10.request
{
command=(bright | dim)
-- mandatory
device=(X10 device being addressed eg, A1 | B8 | M10 etc)
-- mandatory
count=(0-100)
-- mandatory
}

or

xap-x10.request
{
command=(all_lights_on | all_lights_off | all_units_off)
-- mandatory
device=(X10 house code being addressed A-P)
-- mandatory
}

class = xap-x10.event

sent from X10 to xAP

xap-x10.event
{
event=(on | off)
-- mandatory
device=(X10 device active eg, A1 | B8 | M10 etc)
-- mandatory
}

or

xap-x10.event
{
event=(dim | bright)
-- mandatory
device=(X10 device active eg, A1 | B8 | M10 etc)
-- mandatory
count=(0-100)
-- mandatory
}

or

xap-x10.event
{
command=(all_lights_on | all_lights_off | all_units_off)
-- mandatory
device=(X10 house code being addressed A-P)
-- mandatory
}

Schema Extensions

Additional event request and commands Each adaptor implementation can define event or request messages for some or all of the following X10 commands.

  • hail_req
  • hail_ack
  • preset_dim_1
  • preset_dim_2
  • status_on
  • status_off
  • status_req
  • ext_data

Multiple device request addressing

A comma separated list of devices can be specified for the device parameter of the request message. For example:

xap-x10.request
{
command=on
device=A1,A2,B7,M10
}

Devices on the same house code will be addressed as a set and then 'commanded', devices on separate house codes will be treated in alphabetical order. Consolidation of multiple X10 addressed devices Multiple devices will also be reported for event messages if more than one device is addressed and commanded (on a single house code) by another X10 controller. For example:

xap-x10.event
{
command=on
device=B3,B5
}