aaisp to mqtt

Service AAISP vers MQTT

Un script pour publier le quota de haut débit Andrews & Arnold / AAISP et synchroniser les taux avec MQTT.

Il utilise la version 2 de l'API CHAOS de l'AAISP.

Utile pour intégrer et afficher les propriétés de la ligne AAISP dans les applications domotiques, telles que Home Assistant ou openHAB.

Cas d'utilisation

• Affichage des propriétés de ligne dans Home Assistant / openHAB
• Demander à Amazon Alexa Echo le quota restant
• Faire clignoter une lumière au bureau lorsque le taux de synchronisation en aval diminue
• Envoi d'informations sur la ligne à Crouton

Exemple montrant des lignes dans Home Assistant...

Configuration

Créez un fichier de configuration, par exemple dans /etc/aaisp-mqtt.conf, minimal viable sans authentification MQTT :

 [aaisp]
username = aa@1
password = LongAccountPassword

[mqtt]
broker = 127.0.0.1
port = 1883
topic_prefix = aaisp

Vous pouvez également éventuellement spécifier le nom d'utilisateur et le mot de passe MQTT :

 [aaisp]
username = aa@1
password = LongAccountPassword

[mqtt]
broker = 127.0.0.1
port = 1883
topic_prefix = aaisp
username = aaisp-service
password = AnotherLongPassword

Installez les dépendances :

 $ pip install -r requirements.txt

Exécutez le service :

 $ aaisp-to-mqtt.py /etc/aaisp-mqtt.conf

Il affichera une sortie de débogage similaire à :

 INFO [2016-11-16 01:24:07,069] Connecting to AAISP CHAOSv2 endpoint
INFO [2016-11-16 01:24:07,338] Got 3 circuits
INFO [2016-11-16 01:24:07,338] * Lines: 32891, 37835, 37964
INFO [2016-11-16 01:24:07,338] * Logins: [email protected], [email protected], [email protected]
INFO [2016-11-16 01:24:07,339] Connecting to MQTT broker mqtt.gorras.hw.esgob.com:1883
INFO [2016-11-16 01:24:07,345] Connected OK to MQTT
INFO [2016-11-16 01:24:07,346] Published version and index messages
INFO [2016-11-16 01:24:07,350] Published details for 3 circuits
INFO [2016-11-16 01:24:07,350] Disconnecting from MQTT

Planifiez le script via une crontab pour qu'il s'exécute toutes les heures ou 30 minutes.

Sujets

Compte unique :

 aaisp/$lines                                    32891
aaisp/$logins                                   [email protected]
aaisp/$version                                  0.1
aaisp/login/[email protected]/postcode                   SA65 9RR
aaisp/login/[email protected]/quota/monthly              100000000000
aaisp/login/[email protected]/quota/monthly/human        100 GB
aaisp/login/[email protected]/quota/remaining            84667320096
aaisp/login/[email protected]/quota/remaining/human      84.67 GB
aaisp/login/[email protected]/syncrate/down              5181000
aaisp/login/[email protected]/syncrate/down/human        5.18 MB
aaisp/login/[email protected]/syncrate/up                1205000
aaisp/login/[email protected]/syncrate/up/human          1.21 MB

Pour plusieurs comptes :

 aaisp/$lines                                    32891,37835,37964
aaisp/$logins                                   [email protected],[email protected],[email protected]
aaisp/$version                                  0.1
aaisp/login/[email protected]/postcode                    SA62 5EY
aaisp/login/[email protected]/quota/monthly               1000000000000
aaisp/login/[email protected]/quota/monthly/human         1 TB
aaisp/login/[email protected]/quota/remaining             752408843915
aaisp/login/[email protected]/quota/remaining/human       752.41 GB
aaisp/login/[email protected]/syncrate/down               68083000
aaisp/login/[email protected]/syncrate/down/human         68.08 MB
aaisp/login/[email protected]/syncrate/up                 19999000
aaisp/login/[email protected]/syncrate/up/human           20 MB
aaisp/login/[email protected]/postcode                    SA62 5EY
aaisp/login/[email protected]/quota/monthly               1000000000000
aaisp/login/[email protected]/quota/monthly/human         1 TB
aaisp/login/[email protected]/quota/remaining             819343151266
aaisp/login/[email protected]/quota/remaining/human       819.34 GB
aaisp/login/[email protected]/syncrate/down               74425000
aaisp/login/[email protected]/syncrate/down/human         74.42 MB
aaisp/login/[email protected]/syncrate/up                 19978000
aaisp/login/[email protected]/syncrate/up/human           19.98 MB
aaisp/login/[email protected]/postcode                   SA65 9RR
aaisp/login/[email protected]/quota/monthly              100000000000
aaisp/login/[email protected]/quota/monthly/human        100 GB
aaisp/login/[email protected]/quota/remaining            84667320096
aaisp/login/[email protected]/quota/remaining/human      84.67 GB
aaisp/login/[email protected]/syncrate/down              5181000
aaisp/login/[email protected]/syncrate/down/human        5.18 MB
aaisp/login/[email protected]/syncrate/up                1205000
aaisp/login/[email protected]/syncrate/up/human          1.21 MB

Docker

Construisez l'image Docker avec :

 docker build -t aaisp-mqtt .

Exécutez le conteneur avec un fichier de configuration monté sur le volume :

 docker run -d -v <path_to_config>:/app/config.cfg --name AAISPmqtt aaisp-mqtt

Installation

FAIRE

Licence

MIT

Lignes directrices de contribution

• Forkez le dépôt
• Créer une succursale
• Apportez vos modifications
• Ouvrez une pull request depuis votre branche pour masteriser dans ce dépôt

Vous avez trouvé un bug ? ouvrir un problème.