aaisp to mqtt

Serviço AAISP para MQTT

Um script para publicar cotas de banda larga Andrews & Arnold / AAISP e taxas de sincronização para MQTT.

Ele usa a versão 2 da API CHAOS da AAISP.

Útil para integrar e exibir propriedades da linha AAISP em aplicações de automação residencial, como Home Assistant ou openHAB.

Casos de uso

• Exibindo propriedades de linha no Home Assistant / openHAB
• Pedindo ao Amazon Alexa Echo a cota restante
• Uma luz piscando no escritório quando a taxa de sincronização downstream cai
• Enviando informações da linha para Crouton

Exemplo mostrando linhas no Home Assistant...

Configuração

Crie um arquivo de configuração, por exemplo em /etc/aaisp-mqtt.conf, mínimo viável sem autenticação MQTT:

 [aaisp]
username = aa@1
password = LongAccountPassword

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

Você também pode especificar opcionalmente o nome de usuário e a senha do MQTT:

 [aaisp]
username = aa@1
password = LongAccountPassword

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

Instale as dependências:

 $ pip install -r requirements.txt

Execute o serviço:

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

Ele exibirá uma saída de depuração semelhante a:

 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

Agende o script por meio de um crontab para ser executado a cada hora ou 30 minutos.

Tópicos

Conta única:

 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

Para várias contas:

 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

Construa a imagem Docker com:

 docker build -t aaisp-mqtt .

Execute o contêiner com um arquivo de configuração montado no volume:

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

Configurar

PENDÊNCIA

Licença

MIT

Diretrizes de contribuição

• Bifurque o repositório
• Crie uma filial
• Faça suas alterações
• Abra uma solicitação pull de seu branch para master neste repositório

Encontrou um bug? abra um problema.