Skip to content
Snippets Groups Projects
Commit 0f5be632 authored by KERDREUX Jerome's avatar KERDREUX Jerome
Browse files

Migration

parent ed6e7f70
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
README.rst
+ 10
− 10
View file @ 0f5be632
......@@ -8,7 +8,7 @@ Requirements
.. sectnum::
To install xAAL for Python, you need Python-3 (version 3.8 or above). And limited stack exists
for Python-2, you can find more informations `here <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/py2-backport>`_.
for Python-2, you can find more informations `here <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/py2-backport>`_.
Un*x like
~~~~~~~~~
......@@ -77,27 +77,27 @@ Download sources from SVN:
.. code-block:: bash
$ svn checkout https://redmine.imt-atlantique.fr/svn/xaal/code/Python/branches/0.7/ xaal_svn
$ git clone https://gitlab.imt-atlantique.fr/xaal/code/python.git xaal_git
First, install the xaal.lib package:
.. code-block:: bash
$ cd xaal_svn/libs/lib/
$ pip install .
$ cd xaal_git/libs/lib/
$ pip install -e .
Install the monitor lib (needed by Dashboard, REST API..)
.. code-block:: bash
$ cd xaal_svn/libs/monitor/
$ cd xaal_git/libs/monitor/
$ pip install -e .
Install the schemas (needed by some devices)
.. code-block:: bash
$ cd xaal_svn/libs/schemas/
$ cd xaal_git/libs/schemas/
$ pip install -e .
......@@ -105,7 +105,7 @@ Install the tools
.. code-block:: bash
$ cd xaal_svn/apps/tools
$ cd xaal_git/apps/tools
$ pip install -e .
You can remove the *-e* in pip install command , but modification in source files
......@@ -116,7 +116,7 @@ Create the configuration file in your home directory:
.. code-block:: bash
$ mkdir ~/.xaal/
$ cp xaal_svn/libs/lib/xaal.ini.sample ~/.xaal/xaal.ini
$ cp xaal_git/libs/lib/xaal.ini.sample ~/.xaal/xaal.ini
$ xaal-keygen
xaal-keygen will compute an key for a given passphrase. Edit the xaal.ini
......@@ -214,9 +214,9 @@ register every package on a single Python interpreter.
Links
~~~~~
- The repository contains a large number of devices, gateways and tools. You can find
the `packages list here <packages.html>`_.
the `packages list here <packages.rst>`_.
- You can find the `xAAL lib documentation here. <./libs/lib/README.html>`_
- You can find the `xAAL lib documentation here. <./libs/lib/README.rst>`_
Notes
......
packages.rst
+ 39
− 38
View file @ 0f5be632
......@@ -2,10 +2,11 @@
xAAL Python packages
====================
This page contains a curated list of Python packages for xAAL.
* Most packages are available on `PyPI <https://pypi.org/search/?q=xaal>`_ and can be installed with pip: ``pip install xaal.<package>``
* Some packages are not yet on PyPI, you can install them from the SVN (ie): ``pip install svn+https://redmine.imt-atlantique.fr/svn/xaal/code/Python/branches/0.7/libs/lib``
* Some packages are not yet on PyPI, you can install them from the Gitlab repository.
Libs
====
......@@ -19,9 +20,9 @@ Commons libs used to develop applications and gateways.
========================================================================================================================================== ============================================================
Package Description
========================================================================================================================================== ============================================================
`xaal.lib <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/libs/lib>`_ core xAAL lib
`xaal.monitor <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/libs/monitor>`_ lib used to monitor the all devices
`xaal.schemas <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/libs/schemas>`_ devices skeletons generated from schemas
`xaal.lib <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/libs/lib>`_ core xAAL lib
`xaal.monitor <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/libs/monitor>`_ lib used to monitor the all devices
`xaal.schemas <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/libs/schemas>`_ devices skeletons generated from schemas
========================================================================================================================================== ============================================================
Apps
......@@ -34,12 +35,12 @@ General purpose applications: command line, dashboard and geeks stuff.
========================================================================================================================================== ============================================================
Package Description
========================================================================================================================================== ============================================================
`xaal.tools <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/apps/tools>`_ xAAL command line tools
`xaal.legacytools <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/apps/legacytools>`_ same as xaal.tools but using the old lib (easy to read)
`xaal.dashboard <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/apps/dashboard>`_ simple SocketIO xAAL dashboard
`xaal.rest <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/apps/rest>`_ REST webserver
`xaal.fuse <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/apps/fuse>`_ xAAL FUSE filesystem
`xaal.conky <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/apps/conky>`_ simple conky integration script
`xaal.tools <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/apps/tools>`_ xAAL command line tools
`xaal.legacytools <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/apps/legacytools>`_ same as xaal.tools but using the old lib (easy to read)
`xaal.dashboard <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/apps/dashboard>`_ simple SocketIO xAAL dashboard
`xaal.rest <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/apps/rest>`_ REST webserver
`xaal.fuse <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/apps/fuse>`_ xAAL FUSE filesystem
`xaal.conky <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/apps/conky>`_ simple conky integration script
========================================================================================================================================== ============================================================
Core
......@@ -52,7 +53,7 @@ xAAL bus core devices.
========================================================================================================================================== ============================================================
Package Description
========================================================================================================================================== ============================================================
`xaal.metadb <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/core/metadb>`_ xAAL Metadata server
`xaal.metadb <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/core/metadb>`_ xAAL Metadata server
========================================================================================================================================== ============================================================
Tests
......@@ -65,8 +66,8 @@ Fakes devices used to test the xAAL bus and automations.
========================================================================================================================================== ============================================================
Package Description
========================================================================================================================================== ============================================================
`xaal.dummy <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/tests/dummy>`_ command line fake lamps, bots
`xaal.fakeinput <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/tests/fakeinput>`_ web based fake contacts/switches/buttons
`xaal.dummy <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/tests/dummy>`_ command line fake lamps, bots
`xaal.fakeinput <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/tests/fakeinput>`_ web based fake contacts/switches/buttons
========================================================================================================================================== ============================================================
......@@ -80,8 +81,8 @@ xAAL devices than can receive notifications.
=================================================================================================================================================== ============================================================
Package Description
=================================================================================================================================================== ============================================================
`xaal.gtknotify <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/notifications/gtk-notify>`_ Gtk notification script
`xaal.pushbullet <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/notifications/pushbullet>`_ Phone (pushbullet) notification
`xaal.gtknotify <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/notifications/gtk-notify>`_ Gtk notification script
`xaal.pushbullet <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/notifications/pushbullet>`_ Phone (pushbullet) notification
=================================================================================================================================================== ============================================================
......@@ -95,20 +96,20 @@ xAAL gateways for common protcols.
============================================================================================================================================= ============================================================
Package Description
============================================================================================================================================= ============================================================
`xaal.zwave <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/ZWave>`_ ZWave gateway
`xaal.knx <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/KNX>`_ KNX gateway
`xaal.homekit <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/HomeKit>`_ HomeKit gateway
`xaal.esphome <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/ESPHome>`_ ESPHome gateway
`xaal.aqara <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/Aqara>`_ Aqara (Xiaomi) gateway
`xaal.tuya <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/Tuya>`_ Tuya gateway
`xaal.yeelight <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/Yeelight>`_ Yeelight gateway
`xaal.meross <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/Meross>`_ Meross gateway
`xaal.sensfloor <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/SensFloor>`_ SensFloor gateway
`xaal.edisio <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/Edisio>`_ Edisio gateway
`xaal.netatmo <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/Netatmo>`_ Netatmo gateway
`xaal.ipx800 <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/IPX-800>`_ IPX-800 gateway
`xaal.bugone <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/bugOne>`_ bugOne gateway
`xaal.hq433 <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/protocols/HQ433>`_ Arduino serial gateway (example)
`xaal.zwave <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/ZWave>`_ ZWave gateway
`xaal.knx <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/KNX>`_ KNX gateway
`xaal.homekit <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/HomeKit>`_ HomeKit gateway
`xaal.esphome <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/ESPHome>`_ ESPHome gateway
`xaal.aqara <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/Aqara>`_ Aqara (Xiaomi) gateway
`xaal.tuya <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/Tuya>`_ Tuya gateway
`xaal.yeelight <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/Yeelight>`_ Yeelight gateway
`xaal.meross <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/Meross>`_ Meross gateway
`xaal.sensfloor <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/SensFloor>`_ SensFloor gateway
`xaal.edisio <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/Edisio>`_ Edisio gateway
`xaal.netatmo <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/Netatmo>`_ Netatmo gateway
`xaal.ipx800 <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/IPX-800>`_ IPX-800 gateway
`xaal.bugone <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/bugOne>`_ bugOne gateway
`xaal.hq433 <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/protocols/HQ433>`_ Arduino serial gateway (example)
============================================================================================================================================= ============================================================
......@@ -122,9 +123,9 @@ Some examples and test devices
============================================================================================================================================ ============================================================
Package Description
============================================================================================================================================ ============================================================
`xaal.owm <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/weather/OpenWeatherMap>`_ OpenWeatherMap device (temperature / humidity / wind)
`xaal.lmsensors <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/sensors/lm_sensors>`_ LM sensors gateway
`xaal.htu21d <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/sensors/HTU21D>`_ HTU21D (temperature / humidity sensor) I2C example
`xaal.owm <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/weather/OpenWeatherMap>`_ OpenWeatherMap device (temperature / humidity / wind)
`xaal.lmsensors <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/sensors/lm_sensors>`_ LM sensors gateway
`xaal.htu21d <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/sensors/HTU21D>`_ HTU21D (temperature / humidity sensor) I2C example
============================================================================================================================================ ============================================================
......@@ -138,9 +139,9 @@ xAAL devices used to log data.
============================================================================================================================================ ============================================================
Package Description
============================================================================================================================================ ============================================================
`xaal.warp10 <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/loggers/warp10>`_ Push data into a warp10 DB.
`xaal.mqtt <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/loggers/mqtt>`_ Push data into a mqtt server
`xaal.influxdb <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/loggers/influxdb>`_ Push data into a influxdb server (unmaintained)
`xaal.warp10 <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/loggers/warp10>`_ Push data into a warp10 DB.
`xaal.mqtt <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/loggers/mqtt>`_ Push data into a mqtt server
`xaal.influxdb <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/loggers/influxdb>`_ Push data into a influxdb server (unmaintained)
============================================================================================================================================ ============================================================
......@@ -154,7 +155,7 @@ xAAL devices emulated in another protocol.
========================================================================================================================================== ============================================================
Package Description
========================================================================================================================================== ============================================================
`xaal.fauxmo <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/emulations/Fauxmo>`_ Belkin WeMo emulation layer for xAAL (Alexa compliant)
`xaal.fauxmo <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/emulations/Fauxmo>`_ Belkin WeMo emulation layer for xAAL (Alexa compliant)
========================================================================================================================================== ============================================================
......@@ -168,10 +169,10 @@ Support for voice assitants.
========================================================================================================================================== ============================================================
Package Description
========================================================================================================================================== ============================================================
`xaal.alexa <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/0.7/devices/assistants/Alexa>`_ Amazon Alexa support (Alexa TTS only right now)
`xaal.alexa <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/devices/assistants/Alexa>`_ Amazon Alexa support (Alexa TTS only right now)
========================================================================================================================================== ============================================================
==
Last updated : 2024-07-16
Last updated : 2024-09-25
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment