Integrare Shelly Button1 a Home Assistant via MQTT

6 minuti di lettura
Scopi della guida:
  • Integrare il sensore Shelly Button1 all’HUB di domotica personale Home Assistant e utilizzarlo per innescare eventuali automazioni
  • Livello di difficoltà: bassa
  • Categoria d’integrazione: Local Push
Concetti affrontati:
  • Configurazione software
Componenti software utilizzate:
Prerequisiti:
  • Home Assistant configurato e funzionante
  • Componente/i Shelly da integrare già configurato/i in Wi-Fi
Dispositivi fisici utilizzati:
GUIDA maggiormente indicatA per:

Tutti gli ambienti

Note e disclaimer
  • qualsiasi eventuale modifica agli impianti domestici dev'essere progettata ed realizzata SOLO da personale qualificato;
  • qualsiasi modifica attuata in proprio è a propria responsabilità personale nonché a proprio rischio e pericolo (i contenuti della presenta pagina hanno puro scopo didattico);
  • qualsiasi modifica attuata in proprio a un dispositivo ne fa decadere garanzia, omologazioni e certificazioni di qualità.
Revisione guida: 1.0

Shelly Button1 - Home Assistant

Abstract

Shelly Button1

Uno dei grandi vantaggi della linea Shelly (rispetto per esempio alla diretta rivale, la ITEAD Sonoff, o altre analoghe) è quella di installare sui propri componenti di firmware in grado di offrire supporto allo standard MQTT.

MQTT (Message Queue Telemetry Transport) è uno standard particolarmente apprezzato in domotica personale per prestazioni e semplicità; la sua adozione consente di integrare con estrema facilità (e nel modo preferibile, il Local Push) qualunque componente che lo utilizzi con i più svariati ambienti operativi quali, in domotica, gli HUB personali.

Home Assistant è uno degli HUB personali con i quali è più semplice far dialogare i componenti Shelly sfruttando il protocollo MQTT: in questa guida vedremo come predisporre le funzionalità dello Shelly Button1 e come configurare Home Assistant affinché lo integri in tutte le sue funzioni.

N.b. Sebbene esistano componenti specifici per integrare “facilmente” i device della linea Shelly (come per esempio quello nativo di Home Assistant), la metodologia MQTT qui descritta rimane quella più comprovatamente sicura, efficiente e dai risultati più certi nel tempo – nonché quella che consigliamo caldamente di adottare. In alternativa, è possibile utilizzare anche il componente ShellyForHASS (vedi guida) o altri.

Assunti

Per l’implementazione della presente guida è necessario che sulla propria rete sia presente un broker MQTT; in primis però è importante capire come MQTT funzioni: per far questo, è importante la lettura di questa scheda scritta appositamente per capire il ruolo del broker MQTT all’interno della propria rete – a prescindere dai componenti che supportino MQTT presenti nel proprio ambiente.

Per dotarsi di  un broker e per attivare le funzioni client MQTT su Home Assistant si rimanda a questa guida.

Si assume inoltre che lo/gli Shelly in questione siano già stati installati e poi configurati presso l’app Shelly Cloud (per Android e iOS) e quindi siano già parte della propria rete domestica.

Si parte

Modalità LAN e MQTT

La prima cosa da fare è connettere il nostro Shelly al broker MQTT presente sulla nostra rete (must-have indicato negli assunti). Per farlo è necessario attivare la modalità LAN disponibile sul firmware dell’unità, fornire le coordinate del broker (e gli eventuali username e password di autenticazione).

Per effettuare la configurazione è necessario utilizzare un qualsiasi browser tramite il quale collegarsi all’interfaccia web offerta dal componente. Non è possibile effettuare questa configurazione tramite app mobile, e il perché è semplice: alcune impostazioni (tipo questa) sull’app semplicemente non figurano.

Avremo dunque bisogno dell’indirizzo IP a cui collegarci: lo si potrà trovare facilmente tramite l’interfaccia web del proprio modem/router oppure con un qualsiasi tool di scansione reti (eg. Fing). Se l’IP assegnato sarà (per esempio) il 192.168.1.100, l’interfaccia web alla quale collegarsi sarà disponibile all’indirizzo http://192.168.1.100.

N.b. Shelly Button1, per essere raggiunto via web, deve essere ovviamente collegato alla Wi-Fi. Per far sì che la connessione sia presente e sia stabile, alimentarlo via USB. Alimentato a batteria, per sua natura, dopo tot secondi di inattività esso infatti si disconnette.

Una volta connessi apparirà un’interfaccia estremamente elementare. Tappare sulla voce “Internet & Security“:

Shelly Cloud - Intenet e security

Entrare poi nella sezione “Advanced – Developer Settings“.
La schermata che segue consente di inserire username, password e indirizzo (e porta) del proprio broker MQTT:

Shelly - Configurazione MQTT

Per quanto riguarda l’indirizzo e porta del server, esso deve essere espresso in termini di IP:PORTA (eg. 192.168.1.100:1883). La porta standard del broker MQTT è 1883 (a meno che non l’abbiate modificata).

Il resto va impostato come da configurazione (raccomandiamo la retain non abilitata e la QoS a 0 oppure a 1 (addirittura 2, in caso di specifiche necessità).

Cliccare poi su “Use Custom MQTT Prefix” per definire il “nome” MQTT del componente:

Shelly - MQTT - Custom MQTT Prefix

La scelta del nome è personale; si tratta di un passaggio cardine rispetto alla configurazione che effettueremo, successivamente, su Home Assistant.

Una volta completata la configurazione, cliccare su “SAVE“.

N.b. Attivare MQTT – quindi la cosiddetta modalità “LAN” di fatto disconnette il componente dal cloud Shelly, il che non consentirà più di controllare l’unità via app (da remoto, perché localmente continuerà a funzionare). Tale comportamento è più normale: il controllo remoto sarà garantito attraverso Home Assistant e non più dall’app Shelly Cloud.

Modalità d’uso dello Shelly

Prima di passare a Home Assistant, alcune considerazioni lato Shelly sono doverose.

Shelly Button1 è un pulsante wireless che consente di inviare sulla rete quattro diversi eventi:

  • pressione singola
  • pressione doppia
  • pressione tripla
  • pressione prolungata

Tali eventi vengono pubblicati sotto forma di topic MQTT con relativi payload:

shellies/NOME_SHELLY/input_event/0 {"event”:”S”,”event_cnt":1}
shellies/NOME_SHELLY/input_event/0 {"event”:”SS”,”event_cnt":1}
shellies/NOME_SHELLY/input_event/0 {"event”:”SSS”,”event_cnt":1}
shellies/NOME_SHELLY/input_event/0 {"event”:”L”,”event_cnt":1}

Va da sé che Home Assistant (o comunque qualunque HUB personale dotato di client MQTT) possa, per ognuno dei quattro binomi topic+payload gestire delle automazioni tramite essi innescate.

Mettiamo per esempio di voler invertire lo stato di un punto luce (spegnerlo se è acceso / accenderlo se spento) tramite la singola pressione dello Shelly Button1: basterà utilizzare il primo binomio di cui sopra come trigger e innescare il servizio light.toggle puntando all’entità luce che ci interessa. Facilissimo,

Home Assistant

Vederemo ora come provvedere all’integrazione del sensore.

Questa guida, a differenza di quasi tutte le altre dedicate all’integrazione di componenti Shelly via MQTT, non genererà alcuna entità di tipo “Switch” o “Binary Sensor” (come si potrebbe immaginare) – si andrà, infatti, ad integrare direttamente la(e) funzionalità del sensore, intese come la possibilità di innescare automazioni.

L’approccio che descriveremo sarà duplice: la definizione di tante automazioni quante sono le gesture inviabili dal sensore, oppure una singola automazione che, in base alla gesture, effettui determinate azioni.

Il primo scenario viene utile quando per esempio si voglia maggiore leggibilità oppure si voglia la possibilità di disattivare, selettivamente (sia in modo manuale che programmatico), una o più delle singole automazioni; il secondo, invece, riduce a una singola automazione che, per alcuni, può sembrare il modo più corretto e pulito di agire.

Diverse automazioni

Per scrivere quattro automazioni è necessario capire che il trigger sarà sempre lo stesso, ovvero la ricezione da parte del client MQTT di Home Assistant del topic MQTT

shellies/NOME_SHELLY/input_event/0

dove il valore NOME_SHELLY è ovviamente da personalizzare: tale nome viene impostato nella fase di configurazione MQTT già effettuata in precedenza.

A fare la differenza sarà pertanto il payload, il quale verrà analizzato nel blocco condition.
Ecco le risultanti automazioni:

automation:
  - alias: "Shelly Button1 - pressione singola"
    trigger:
      platform: mqtt
      topic: "shellies/NOME_SHELLY/input_event/0"
    condition:
      condition: template
      value_template: "{{ trigger.payload_json.event == 'S' }}"
    action: []

  - alias: "Shelly Button1 - pressione doppia"
    trigger:
      platform: mqtt
      topic: "shellies/NOME_SHELLY/input_event/0"
    condition:
      condition: template
      value_template: "{{ trigger.payload_json.event == 'SS' }}"
    action: []

  - alias: "Shelly Button1 - pressione tripla"
    trigger:
      platform: mqtt
      topic: "shellies/NOME_SHELLY/input_event/0"
    condition:
      condition: template
      value_template: "{{ trigger.payload_json.event == 'SSS' }}"
    action: []

  - alias: "Shelly Button1 - pressione lunga"
    trigger:
      platform: mqtt
      topic: "shellies/NOME_SHELLY/input_event/0"
    condition:
      condition: template
      value_template: "{{ trigger.payload_json.event == 'L' }}"
    action: []

Ovviamente sarà poi il blocco action di ogni automazione a terminare “cosa fare” a fronte della ricezione della gesture.

Singola automazione

Vediamo ora come risolvere la questione con un’unica automazione:

automation:
  - alias: "Shelly Button1"
      trigger:
        platform: mqtt
        topic: "shellies/NOME_SHELLY/input_event/0"
      condition: []
      action:
      - service: script.turn_on
        data_template:
          entity_id:
            {% if trigger.payload_json.event == "S" %}
              script.shelly_button1_pressione_singola
            {% if trigger.payload_json.event == "SS" %}
              script.shelly_button1_pressione_doppia
            {% if trigger.payload_json.event == "SSS" %}
              script.shelly_button1_pressione_tripla
            {% if trigger.payload_json.event == "L" %}
              script.shelly_button1_pressione_prolungata
            {% endif %}

Questa automazione approccia in modo diverso: viene sempre eseguita quando viene ricevuto il topic telemetrico dallo Shelly Button1, ma è nel blocco action a decidersi “cosa fare”: in base al payload, viene eseguito uno script piuttosto che un altro.

Ulteriori alternative

Non volendo operare come descritto sopra, ma volendosi dotare di “MQTT Binary Sensor” – uno per ogni gesture – è sicuramente possibile farlo. Bisogna però tenere in considerazione che lo Shelly Button eroga solo lo stato relativo alla gesture, non al ritorno a riposo (non avrebbe senso), pertanto un sensore di questo tipo andrà gestito tramite un’automazione che pubblichi un topic MQTT “fake” tale da riposizionare in OFF il sensore dopo l’avvenuta attivazione.

In pratica, quello che abbiamo descritto in quest’altra guida. Il procedimento è lo stesso.

Batteria

Comodo, inoltre, avere un sensore che ci comunichi il livello della batteria:

sensor:
  - platform: mqtt
    name: "Batteria"
    state_topic: "shellies/NOME_SHELLY/sensor/battery"
    value_template: "{{ value }}"
    unit_of_measurement: "%"
    icon: mdi:battery

Questa configurazione genererà un’entità di tipo “Sensor” chiamata sensor.batteria.

Ricapitolo telemetrie MQTT

Di seguito la lista dei topic telemetrici MQTT pubblicati (ciclicamente o al cambio di determinati stati) del sensore:

shellies/NOME_SHELLY/input_event/0 {"event”:”S”,”event_cnt":1}
shellies/NOME_SHELLY/input_event/0 {"event”:”SS”,”event_cnt":1}
shellies/NOME_SHELLY/input_event/0 {"event”:”SSS”,”event_cnt":1}
shellies/NOME_SHELLY/input_event/0 {"event”:”L”,”event_cnt":1}
shellies/ShellyButton/announce {"id":"ShellyButton","mac":"FFFFFFFFFF","ip":"192.168.1.1","new_fw":false, "fw_ver":"20200625-102446/v1.7.3@2aa0993a"}
shellies/ShellyButton/sensor/battery 100

Comandi speciali

La presenza dello standard MQTT consente agli Shelly di essere configurati e interrogati tramite comandi diretti MQTT (nonché API REST via HTTP). A tale aspetto abbiamo dedicato la scheda che segue:

Shelly, MQTT e HTTP: comandi utili



Home Assistant Official Logo ATTENZIONE: ricorda che sul nostro community FORUM c'è una sezione ad hoc dedica a Home Assistant, per qualsiasi dubbio, domanda, informazione nel merito specifico di queste componenti.


Telegram News Channel