Skip to main content

xaal.lib

xaal.lib is the official Python stack to develop home-automation devices and gateways with the xAAL protocol. For a full description of the protocol check out http://recherche.imt-atlantique.fr/xaal/

Dependencies

xaal.lib depends on :
  • cbor2

  • pysodium

  • configobj

  • coloredlogs

  • decorator

  • tabulate

  • aioconsole

Install

Please refer to the official full documentation to install the lib in a virtualenv

Usage

The main goal of xaal.lib is to provide an API to easily develop devices & gateways. xaal.lib.Engine send / receive / parse to|from xAAL Bus.

To receive / parse / display incoming xAAL messages, you can simply try something like this:

from xaal.lib import Engine

def display(msg):
    print(msg)

eng = Engine()
eng.subscribe(display)
eng.run()

The Engine will call the display function every time it receive a xAAL message.

Let’s take a look at a simple lamp device :

from xaal.lib import Device,Engine,tools

# create and configure the lamp device, with a random address
dev = Device("lamp.basic", tools.get_random_uuid())
dev.product_id = 'Dummy Lamp'
dev.url  = 'http://www.acme.org'
dev.info = 'My fake lamp'

# add an xAAL attribute 'light'
light = dev.new_attribute('light')

# declare two device methods ON & OFF
def on():
    light.value = True

def off():
    light.value = False

dev.add_method('turn_on',on)
dev.add_method('turn_off',off)

# last step, create an engine and register the lamp
eng = Engine()
eng.add_device(dev)
eng.run()

To avoid to rewrite the same code for each device, you can use the xaal.schemas package. This package provides a set of predefined devices, you can use them as a template to create your own device.

from xaal.schemas import devices
from xaal.lib import Engine

# create and configure the lamp device
dev = devices.lamp()

# last step, create an engine and register the lamp
eng = Engine()
eng.add_device(dev)
eng.run()

FAQ

The core engine run forever so how can I use it in webserver, GUI or to develop device with IO. The whole API is absolutely not thread safe, so don’t use threads unless you exactly know what’s going on. Anyways, you have several options to fix this issue:

  • You can use you own loop and periodically call eng.loop() for example, you can do something like this:

    while 1:
        do_some_stuff()
        eng.loop()
  • You can use a engine timer, to perform some stuff.

    def read_io():
        pass
    
    # call the read_io function every 10 sec
    eng.add_timer(read_io,10)
    eng.run()
  • Use the AsyncEngine. Python version > 3.8 provides async programming with asyncio package. AsyncEngine use the same API as Engine, but it is a asynchronous engine. You can use coroutines in device methods, timers functions and callbacks. It provides additionals features like the on_start and on_stop callbacks.

  • Use an alternate coroutine lib, you can use gevent or greenlet for example. Look at apps/rest for a simple greenlet example.

Metadata

Release files for xaal.lib 0.7.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xaal.lib 0.7.10
File Size Uploaded Provenance Actions
xaal_lib-0.7.10.tar.gz 30.0 kB Without provenance Details for xaal_lib-0.7.10.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for xaal.lib 0.7.10
File Interpreter ABI Platform Actions
xaal.lib-0.7.10-py3-none-any.whl Python 3 none any Details for xaal.lib-0.7.10-py3-none-any.whl

Total release size: 61.6 kB

Release files / xaal_lib-0.7.10.tar.gz

Download URL xaal_lib-0.7.10.tar.gz
Size 30.0 kB
Tags Source
SHA-256 checksum
How to use checksums
e30c4229c777b79b26290b55fd26a8ce4672eb3dc0c287be93393b3c7b693db5
BLAKE2b-256 checksum
How to use checksums
1668ebde2d0d7f3931627d07c27fae8994926fc3a4434a076a121de020b65f53
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.13.0

Release files / xaal.lib-0.7.10-py3-none-any.whl

Download URL xaal.lib-0.7.10-py3-none-any.whl
Size 31.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
422c2d431ead9bc249322c7d05cbcc6c3d9376dcaa24e76148d89acec561dba8
BLAKE2b-256 checksum
How to use checksums
03d1d5301af675f90b86a851dd87079ba7528f0e63d6dc6bf974f1e2601c1fc5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.13.0

Security for xaal.lib 0.7.10

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page