Scopi della guida:
Concetti affrontati:
|
Componenti software utilizzate:
Prerequisiti:
Dispositivi fisici utilizzati:
|
GUIDA INDICATA A UTENTI CON ISTALLAZIONE: |
|
NOTE E DISCLAIMER
|
|
| Revisione guida: 2.1 | |
Abstract
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 1PM (“Power Metering”) e come configurare Home Assistant affinché lo integri in tutte le sue possibili funzioni.
| N.b. La metodologia MQTT qui descritta rimane tra quelle più comprovatamente sicure, efficienti. In assoluto, però, si consiglia l’utilizzo della piattaforma di integrazione inclusa nativamente su Home Assistant, in quanto ormai più che rodata, affidabile e, tutto sommato, più semplice da attuare. Inoltre, essa rende inutile la presenza di un broker MQTT il quale, va da sé, rappresenta un single-point-of-failure in più nella catena d’integrazione. |
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 configurati fornendogli accesso alla propria rete Wi-Fi, cosa che può essere fatta sia tramite l’app Shelly Cloud (per Android e iOS) sia attraverso l’access point da essi fornito a fronte di un reset alle impostazioni di fabbrica.
Si parte
- Abilitare la modalità LAN e MQTT su Shelly
- Modalità d’uso dello Shelly
- Home Assistant
- Interruttore
- Sensori
- di assorbimento istantaneo e consumo cumulativo
- di consumo giornaliero
- di consumo mensile
- termico
- di surriscaldamento
- di overpower (sovraccarico)
- valore di overpower
- Automazione per il censimento iniziale dello stato
- Comandi speciali
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 dall’attuatore. 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.
Una volta connessi apparirà un’interfaccia estremamente elementare. Tappare sulla voce “Internet & 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:
Per quanto riguarda l’indirizzo e porta del server, esso deve essere espresso in termini di IP:PORTA (eg. 192.168.1.1: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 dell’attuatore:
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.
Trattandosi di un attuatore a singolo canale, esso viene tipicamente utilizzato per controllare un punto luce, una presa elettrica o comunque un carico generico: va da sé che la prima integrazione da realizzare sia questa, ovvero dotarsi di uno “Switch” per attivare/disattivare tale interruttore.
Secondariamente ma cosa non meno importante, lo Shelly 1PM è anche un rilevatore di assorbimento elettrico: integrare queste metriche permette di definire:
- un sensore di assorbimento istantaneo, espresso in Watt;
- un contatore di consumo giornaliero, espresso in kWh/giorno;
- un contatore di consumo mensile, espresso in kWh/mese;
inoltre, l’assorbimento può essere utilizzato come strumento per dedurre lo stato di un elettrodomestico.
Infine, l’unità Shelly 1PM è dotata di un sensore di temperatura e uno di surriscaldamento, entrambi integrabili così da conoscere la temperatura istantanea dall’interno dell’unità ed eventuali pericolosi stati di surriscaldamento.
Nei paragrafi che seguono scopriremo come integrare via MQTT tutti questi diversi elementi.
Home Assistant
Vediamo ora come provvedere all’integrazione dell’attuatore, ipotizzando l’uso come “Relay”, nonché come sensori di diversa natura sopra descritti.
Interruttore
Ipotizziamo di aver collegato un carico al singolo canale d’uscita dello Shelly 1PM e un pulsante/interruttore murale per controllare il canale.
Uno schema elettrico analogo ai seguenti, per capirci:
L’obiettivo dell’integrazione dev’essere dunque quello di dotarsi, presso Home Assistant, di uno “Switch” il quale non solo agisca sullo Shelly in modo da poter attivare il canale, ma anche da visualizzarne lo stato operativo aggiornato in caso di variazione effettuata tramite i pulsanti/interruttori murali.
Allo scopo utilizzeremo la piattaforma “MQTT Switch“.
L’implementazione è semplice. Sarà infatti sufficiente inserire in configurazione (personalizzandola, come spiegato a seguire) il seguente blocco (integrando eventuali switch già presenti):
mqtt:
switch:
- name: "Interruttore"
state_topic: "shellies/NOME_SHELLY/relay/0"
command_topic: "shellies/NOME_SHELLY/relay/0/command"
availability_topic: "shellies/NOME_SHELLY/online"
qos: 1
value_template: "{% if value == 'on' %} on {% else %} off {% endif %}"
payload_on: "on"
payload_off: "off"
payload_available: "true"
payload_not_available: "false"
optimistic: false
retain: false
Il valore NOME_SHELLY è ovviamente da personalizzare: tale nome viene impostato nella fase di configurazione MQTT già effettuata precedentemente. Ovviamente il tutto è personalizzabile, inclusi (in primis) i nomi dei due interruttori (campo “name“), o per esempio l’icona (campo “icon“) usando il solito materialicondesign.com per la scelta dell’icona appropriata (in questo caso, una lampadina).
QoS, come spesso capita, è impostato a 1 per una maggiore certezza dell’esecuzione dei comandi.
Dopo aver variato la configurazione di Home Assistant, riavviarlo. Verranno create un’entità (nel caso dell’esempio, switch.interruttore). a rappresentazione presso l’interfaccia dell’HUB è la seguente:
Sensori
Vediamo ora come definire i vari sensori. Si noti però come in ogni configurazione il NOME_SHELLY presente nel codice di configurazione proposto vada personalizzato come spiegato sopra.
ASSORBIMENTO E CONSUMO
Il primo sensore che andremo a definire sarà quello che fornirà alla domotica la lettura istantanea dell’assorbimento espresso in Watt, che ci servirà come fonte alimentante per creare i due contatori (giornaliero e mensile, o altri).
La configurazione è la seguente:
mqtt
sensor:
- name: "Shelly 1PM Assorbimento"
state_topic: "shellies/NOME_SHELLY/relay/0/power"
availability_topic: "shellies/NOME_SHELLY/online"
payload_available: "true"
payload_not_available: "false"
unit_of_measurement: "Watt"
Il sensore (chiamato sensor.shelly_1pm_assorbimento) indicherà, istantaneamente, quanto il carico applicato allo Shelly (ovviamente con l’interruttore su ON) stia assorbendo, in Watt.
Dopo l’implementazione di tale sensore si consideri, ovviamente, la possibilità di implementare delle notifiche legate al superamento di specifiche soglie.
| N.b. Quando si parla di sensori di questo tipo si consiglia sempre di valutare l’adozione di misure atte a ridurre il numero di dati scritti sul database. |
A questo punto possiamo dotarci di un generico sensore di consumo cumulativo il quale esprima l’assorbimento in kWh, il quale utilizzi il sensore di assorbimento istantaneo precedentemente definito come sorgente dati:
sensor:
- platform: integration
source: sensor.shelly_1pm_assorbimento
name: "Shelly 1PM Consumo"
unit_prefix: k
round: 2
Il sensore, chiamato sensor.shelly_dimmer_consumo, riporterà il cumulativo in kWh. Al conteggio (giornaliero, mensile o di altri periodi) provvederanno le entità di tipo “Utility Meter” che vedremo ora.
CONSUMO GIORNALIERO
In questo caso sfrutteremo la piattaforma “Utility Meter“, utilizzata per definire dei contabilizzatori.
utility_meter: shelly_1pm_consumo_giornaliero: source: sensor.shelly_1pm_consumo cycle: daily
Il sensore utility.meter.shelly_1pm_consumo_giornaliero riporterà il cumulativo giornaliero espresso in kWh, azzerandosi automaticamente alla mezzanotte (e riportando, nei propri attributi, il consumo giornaliero precedente).
CONSUMO MENSILE
In questo caso sfrutteremo nuovamente la piattaforma “Utility Meter”, ma stavolta per definire un contatore mensile:
utility_meter: shelly_1pm_consumo_mensile: source: sensor.shelly_1pm_consumo cycle: monthly
Il sensore utility.meter.shelly_1pm_consumo_mensile riporterà il cumulativo mensile espresso in kWh, azzerandosi automaticamente il primo giorno di ogni mese (e riportando, nei propri attributi, il consumo mensile del mese precedente).
TERMICO
Tramite i topic e i payload pubblicati è possibile catturare la lettura del sensore termico presente a bordo dello Shelly 1PM.
Per farlo, il codice di configurazione (il quale utilizza la piattaforma “MQTT Sensor”) è il seguente:
mqtt:
sensor:
- name: "Shelly 1PM - Temperatura"
state_topic: "shellies/NOME_SHELLY/temperature"
availability_topic: "shellies/NOME_SHELLY/online"
value_template: "{{ value }}"
unit_of_measurement: "°C"
payload_available: "true"
payload_not_available: "false"
Il valore NOME_SHELLY è ovviamente da personalizzare: tale nome viene impostato nella fase di configurazione MQTT già effettuata precedentemente. Ovviamente tutto è personalizzabile, inclusi (in primis) il nome dell’entità (campo “name“, qui valorizzato a “Shelly 1PM – Temperatura“).
Dopo aver variato la configurazione di Home Assistant, riavviarlo. Verrà creata un’entità di tipo “Sensor” (nel caso dell’esempio, sensor.shelly_1pm_temperatura). La rappresentazione presso l’interfaccia dell’HUB è la seguente:
Cliccando sull’icona, i dettagli saranno visualizzati come segue:
| N.b. Quando si parla di sensori di questo tipo si consiglia sempre di valutare l’adozione di misure atte a ridurre il numero di dati scritti sul database. |
SURRISCALDAMENTO – STATUS TERMICO
Sulla base del valore relativo alla temperatura interna dello Shelly viene pubblicato un topic dal payload indicante lo status termico del dispositivo, utile in caso di temperature elevate che potrebbero comportare rischi per la sicurezza.
Per poter integrare anche questo sensore, il codice di configurazione è il seguente:
mqtt:
sensor:
- name: "Shelly 1PM - Status Termico"
state_topic: "shellies/NOME_SHELLY/temperature_status"
availability_topic: "shellies/NOME_SHELLY/online"
payload_available: "true"
payload_not_available: "false"
L’entità derivante, ovvero sensor.shelly_1pm_status_termico, potrà essere facilmente usata come trigger per una qualsiasi automazione (dalle notifiche allo spegnimento dell’unità stessa, eccetera).
OVERPOWER
Ci doteremo infine di un ulteriore “Binary Sensor” il quale si attivi quando l’unità Shelly 1PM dovesse segnalare un problema di sovraccarico:
mqtt:
binary_sensor:
- name: "Shelly 1PM Overpower"
state_topic: "shellies/NOME_SHELLY/relay/0"
value_template: "{% if value == 'overpower' %} on {% else %} off {% endif %}"
payload_on: "on"
payload_off: "off"
availability_topic: "shellies/NOME_SHELLY/online"
payload_available: "true"
payload_not_available: "false"
device_class: "problem"
qos: 0
Nota: modificando il valore di “PROTEZIONE MASSIMA POTENZA” presso le impostazioni dell’attuatore si modifica anche il comportamento del sensore. Senza modifiche, il sensore scatta al superamento dei 3500 watt, altrimenti la soglia è quella impostata dall’utente.
VALORE OVERPOWER
Ultimo, ma non meno importante, è un sensore che ci fornirà la lettura del valore (espresso in Watt) che ha fatto scattare la protezione del nostro dispositivo Shelly per overpower, ovvero superamento della potenza limite impostata nel passaggio precedente.
Anche in questo caso ci doteremo di un “MQTT Sensor”, configurato in questo modo:
mqtt
sensor:
- name: "Shelly 1PM - Valore Overpower"
state_topic: "shellies/NOME_SHELLY/overpower_value"
availability_topic: "shellies/NOME_SHELLY/online"
value_template: "{{ value }}"
unit_of_measurement: "W"
payload_available: "true"
payload_not_available: "false"
Ci saremo quindi dotati di un sensore chiamato sensor.shelly_1pm_status_termico in grado di fornirci questa informazione.
Automazione per il censimento iniziale dello stato
All’avvio, Home Assistant non conosce lo stato dello/degli Shelly; per far in modo che tali stati vengano raccolti immediatamente, aggiungere la seguente automazione all’elenco di quelle esistenti:
automation:
- alias: MQTT Announce
trigger:
- event: start
platform: homeassistant
condition: []
action:
- service: mqtt.publish
data:
payload: update
topic: shellies/command
Pubblicando il topic “shellies/command“, tutti gli Shelly presenti sulla rete connessi al broker MQTT risponderanno fornendo il proprio stato.
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:
|
⚠️ Se di Home Assistant ne sai poco ma sei interessato a capirne di più, ti suggeriamo di partire da qui. |
| Questa pagina è redatta, manutenuta e aggiornata dallo staff di inDomus, un gruppo di persone molto diverse tra loro che trovi, per domande e supporto, sul forum e sulla chat del sito. Alcuni link sono taggati in qualità di affiliati Amazon e riceviamo un compenso dagli acquisti idonei, utile al sostenimento del sito, ma le nostre recensioni sono tutte indipendenti e non sponsorizzate. Se ti sei perso, a tua disposizione c'è la mappa. |