aaisp to mqtt

AAISP-zu-MQTT-Dienst

Ein Skript zum Veröffentlichen von Andrews & Arnold / AAISP-Breitbandkontingenten und zum Synchronisieren von Raten mit MQTT.

Es verwendet Version 2 der CHAOS-API von AAISP.

Nützlich für die Integration und Anzeige von AAISP-Leitungseigenschaften in Hausautomationsanwendungen wie Home Assistant oder openHAB.

Anwendungsfälle

• Leitungseigenschaften im Home Assistant / openHAB anzeigen
• Bitten Sie Amazon Alexa Echo um das verbleibende Kontingent
• Im Büro blinkt ein Licht, wenn die Downstream-Synchronisierungsrate sinkt
• Leitungsinformationen werden an Crouton gesendet

Beispiel für die Anzeige von Linien im Home Assistant ...

Konfiguration

Erstellen Sie eine Konfigurationsdatei, zum Beispiel in /etc/aaisp-mqtt.conf, minimal machbar ohne MQTT-Authentifizierung:

 [aaisp]
username = aa@1
password = LongAccountPassword

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

Sie können optional auch einen MQTT-Benutzernamen und ein MQTT-Passwort angeben:

 [aaisp]
username = aa@1
password = LongAccountPassword

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

Installieren Sie die Abhängigkeiten:

 $ pip install -r requirements.txt

Führen Sie den Dienst aus:

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

Es wird eine Debug-Ausgabe ähnlich der folgenden angezeigt:

 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

Planen Sie das Skript über eine Crontab so, dass es jede Stunde oder 30 Minuten ausgeführt wird.

Themen

Einzelkonto:

 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

Für mehrere Konten:

 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

Erstellen Sie das Docker-Image mit:

 docker build -t aaisp-mqtt .

Führen Sie den Container mit einer auf dem Volume bereitgestellten Konfigurationsdatei aus:

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

Aufstellen

TODO

Lizenz

MIT

Mitwirkende Richtlinien

• Forken Sie das Repo
• Erstellen Sie einen Zweig
• Nehmen Sie Ihre Änderungen vor
• Öffnen Sie in diesem Repo eine Pull-Anfrage zurück von Ihrer Filiale zum Master

Einen Fehler gefunden? ein Problem eröffnen.