====================
xAAL Python packages
====================

This page contains a curated list of Python packages for xAAL.


Libs
====
.. sectnum::

Commons libs used to develop applications and gateways.

.. table::
    :widths: 20, 80

    ==========================================================================================================================================  ============================================================
    Package                                                                                                                                     Description
    ==========================================================================================================================================  ============================================================
    `xaal.lib <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/libs/lib>`_                           core xAAL lib
    `xaal.monitor <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/libs/monitor>`_                   lib used to monitor the all devices
    `xaal.schemas <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/libs/schemas>`_                   devices skeletons generated from schemas
    ==========================================================================================================================================  ============================================================

Apps
====
General purpose applications: command line, dashboard and geeks stuff.

.. table::
    :widths: 20, 80

    ==========================================================================================================================================  ============================================================
    Package                                                                                                                                     Description
    ==========================================================================================================================================  ============================================================
    `xaal.tools <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/apps/tools>`_                       xAAL command line tools
    `xaal.legacytools <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/apps/legacytools>`_           same as xaal.tools but using the old lib (easy to read)
    `xaal.dashboard <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/apps/dashboard>`_               simple SocketIO xAAL dashboard
    `xaal.rest <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/apps/rest>`_                         REST webserver
    `xaal.fuse <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/apps/fuse>`_                         xAAL FUSE filesystem 
    `xaal.conky <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/apps/conky>`_                       simple conky integration script
    ==========================================================================================================================================  ============================================================

Core
====
xAAL bus core devices.

.. table::
    :widths: 20, 80

    ==========================================================================================================================================  ============================================================
    Package                                                                                                                                     Description
    ==========================================================================================================================================  ============================================================
    `xaal.metadb <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/core/metadb>`_                     xAAL Metadata server
    ==========================================================================================================================================  ============================================================

Tests
=====
Fakes devices used to test the xAAL bus and automations.

.. table::
    :widths: 20, 80

    ==========================================================================================================================================  ============================================================
    Package                                                                                                                                     Description
    ==========================================================================================================================================  ============================================================
    `xaal.dummy <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/tests/dummy>`_              command line fake lamps, bots
    `xaal.fakeinput <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/tests/fakeinput>`_      web based fake contacts/switches/buttons
    ==========================================================================================================================================  ============================================================


Notifications
=============
xAAL devices than can receive notifications. 

.. table::
    :widths: 20, 80

    ================================================================================================================================================  ============================================================
    Package                                                                                                                                           Description
    ================================================================================================================================================  ============================================================
    `xaal.gtknotify <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/notifications/gtk-notify>`_   Gtk notification script
    `xaal.pushbullet <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/notifications/pushbullet>`_  Phone (pushbullet) notification
    ================================================================================================================================================  ============================================================


Protocols
=========
xAAL gateways for common protcols.

.. table::
    :widths: 20, 80

    ==========================================================================================================================================  ============================================================
    Package                                                                                                                                     Description
    ==========================================================================================================================================  ============================================================
    `xaal.zwave <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/protocols/ZWave>`_          ZWave gateway
    `xaal.knx <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/protocols/KNX>`_              KNX gateway
    `xaal.homekit <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/protocols/HomeKit>`_      HomeKit gateway
    `xaal.aqara <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/protocols/Aqara>`_          Aqara (Xiaomi) gateway
    `xaal.tuya <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/protocols/Tuya>`_            Tuya gateway
    `xaal.yeelight <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/protocols/Yeelight>`_    Yeelight gateway
    `xaal.sensfloor <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/protocols/SensFloor>`_  SensFloor gateway
    `xaal.edisio <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/protocols/Edisio>`_        Edisio gateway
    `xaal.netatmo <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/protocols/Netatmo>`_      Netatmo gateway
    `xaal.ipx800 <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/protocols/IPX-800>`_       IPX-800 gateway
    `xaal.bugone <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/protocols/bugOne>`_        bugOne gateway
    `xaal.hq433 <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/protocols/HQ433>`_          Arduino serial gateway (example)
    ==========================================================================================================================================  ============================================================


Other devices
=============
Some examples and test devices

.. table::
    :widths: 20, 80

    ==========================================================================================================================================  ============================================================
    Package                                                                                                                                     Description
    ==========================================================================================================================================  ============================================================
    `xaal.owm <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/weather/OpenWeatherMap>`_     OpenWeatherMap device (temperature / humidity / wind)
    `xaal.lmsensors <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/sensors/lm_sensors>`_   LM sensors gateway
    `xaal.htu21d <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/sensors/HTU21D>`_          HTU21D (temperature / humidity sensor) I2C example
    ==========================================================================================================================================  ============================================================


Loggers
=======
xAAL devices used to log data. 

.. table::
    :widths: 20, 80

    ==========================================================================================================================================  ============================================================
    Package                                                                                                                                     Description
    ==========================================================================================================================================  ============================================================
    `xaal.warp10 <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/loggers/warp10>`_          Push data into a warp10 DB.
    `xaal.mqtt <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/loggers/mqtt>`_              Push data into a mqtt server
    `xaal.influxdb <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/loggers/influxdb>`_      Push data into a influxdb server (unmaintained)
    ==========================================================================================================================================  ============================================================


Emulations
==========
xAAL devices emulated in another protocol.

.. table::
    :widths: 20, 80

    ==========================================================================================================================================  ============================================================
    Package                                                                                                                                     Description
    ==========================================================================================================================================  ============================================================
    `xaal.fauxmo <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/emulations/Fauxmo>`_        Belkin WeMo emulation layer for xAAL (Alexa compliant)
    ==========================================================================================================================================  ============================================================


Assistants
==========
Support for voice assitants.

.. table::
    :widths: 20, 80

    ==========================================================================================================================================  ============================================================
    Package                                                                                                                                     Description
    ==========================================================================================================================================  ============================================================
    `xaal.alexa <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/0.7/devices/assistants/Alexa>`_          Amazon Alexa support (Alexa TTS only right now)
    ==========================================================================================================================================  ============================================================


==

Last updated : 2022-03-02