Documentation
xAAL Specifications
Specification
Latest Stable
Former
- xAAL v0.7r1b (en)
- xAAL v0.7r1 (en): using cbor for messages
- xAAL v0.6 (en): using cbor for messages
- xAAL v0.5r2 (en): Legacy stable
- xAAL v0.5r1 (en): adding security to xAAL v0.4
- xAAL v0.4 (en)
- xAAL v0.3 (en)
- xAAL v0.2 (en)
- xAAL v0.2 (fr)
- xAAL v0.1-json (fr)
- xAAL v0.1-bin (fr)
Available components
Several xAAL components are already coded and available.
Current home-automation protocols supported by our elementary gateways: X10, Z-Wave, Enocean, KNX, RFXcom, Aqara, Tuya, etc. (Run those you need.)
Several HMI (web) are also proposed.
Protocol
Following format specifications are provided to check the form of xAAL messages (i.e., for debugging purpose).
- xAAL v0.7: xAAL_07_security-layer.cddl and xAAL_07_application-layer.cddl (CDDL)
- xAAL v0.6: xAAL_06_security-layer.cddl and xAAL_06_application-layer.cddl (CDDL)
- xAAL v0.5: xAAL_05_security-layer and xAAL_05_application-layer (Json Schemas)
- xAAL v0.4: xAAL_04_message (Json Schema)
Schemas
xAAL devices are described by schemas. These are Json object of a specific form that must validates a given template:
- xAAL v0.7: xAAL_07_schema.cddl This is a CDDL specification.
- xAAL v0.4 to v0.6: xAAL_05_schema This is a Json Schema.
Each xAAL devices vendor has the responsability to provide consistent schemas.
Latest Stable Schemas (xAAL 0.7)
Details on the dedicated svn repository
- basic.basic: Generic schema for any devices
- hmi.basic: Basic Human Machine Interface
- metadatadb.basic: Simple metatdata database to manage tags associated with devices
- cache.basic: Simple cache that can be queried about attributes of devices
- gateway.basic: Simple gateway that manage physical devices
- scenario.basic: Simple Scenario
- lamp.basic: Simple lamp
- lamp.dimmer: Simple dimmable lamp
- lamp.color: Color-changing lamp
- lamp.toggle: Simple lamp with toggle function - Note that a toggle function may leads to undefined state due to its stateful nature; its usage should be avoided.
- powerrelay.basic: Simple power relay device
- powerrelay.toggle: Power relay with toggle function - Note that a toggle function may leads to undefined state due to its stateful nature; its usage should be avoided.
- switch.basic: Simple switch button device
- button.basic: Simple button device
- button.remote: Simple remote device with several buttons
- powermeter.basic: Simple powermeter
- linkquality.basic: Report on quality of a transmission link
- battery.basic: Report on state of a battery
- door.basic: Simple door device
- window.basic: Simple window device
- shutter.basic: Simple shutter
- shutter.position: Shutter with a position managment
- worktop.basic: Simple worktop
- thermometer.basic: Simple thermometer
- hygrometer.basic: Simple hygrometer
- barometer.basic: Simple barometer
- co2meter.basic: Simple CO2 meter
- luxmeter.basic: Simple luxmeter
- lightgauge.basic: Simple light gauge
- soundmeter.basic: Simple soundmeter
- raingauge.basic: Simple rain gauge
- windgauge.basic: Simple wind gauge
- scale.basic: Simple scale
- motion.basic: Simple motion detector device
- contact.basic: Simple contact-sensor device; e.g. door or window opening sensor
- falldetector.basic: Simple fall detection device
- tts.basic: Text-To-Speech device