community italiana di domotica personale
 
Integrare componenti Z-Wave su Home Assistant via OpenZWave

Integrare componenti Z-Wave su Home Assistant via OpenZWave

4 minuti di lettura
SCOPI DELLA GUIDA:
CONCETTI AFFRONTATI:
  • Utilizzo e configurazione software
COMPONENTI SOFTWARE UTILIZZATE:
PREREQUISITI:
DISPOSITIVI FISICI UTILIZZATI:
GUIDA maggiormente indicatA per:

Ambienti CORE HASSIO

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

Z-Wave via OpenZWave su Home Assistant

Abstract

Non ci stiamo a dilungare più di tanto: se si è raggiunta questa guida, è perché si sa già che OpenZWave è un BRIDGE/Gateway software implementato in proprio per la gestione di componenti Z-Wave diverse (e di diverse marche) e Home Assistant è l’HUB personale per la gestione della propria domotica personale.

Lo scopo di questa guida, quindi, è quello di integrare facilmente OpenZWave (e quindi le componenti Z-Wave ad esso associate) con il proprio HUB, così da controllare/censire tramite esso le componenti Z-Wave di cui sopra.

N.b. Questa guida è adatta sia agli utenti Home Assistant CORE che HASSIO.

Si parte

Assunti

Si assume che OpenZWave sia già operativo; qualora non lo sia, si rimanda all’elenco di modalità di installazioni disponibili sulla nostra scheda ad esso dedicata.

Si assume altresì che, ovviamente, anche Home Assistant sia già operativo.

Come funziona

Prima di proseguire, porsi la domanda: conosco MQTT? Se la risposta sì, bene, altrimenti provvedere a un approfondimento su questo protocollo. La guida dà per scontato che, quando si fa riferimento a comandi e telemetrie MQTT, si sappia di che si sta parlando, almeno a grandi linee.

Dunque, come funziona OpenZWave, e perché ci consente di integrare componenti Z-Wave?
Arrivati sin qui dovrebbe già essere chiaro, ma qualora non lo fosse, repetita iuvant.

OpenZWave funge da ponte tra il protocollo Z-Wave e il protocollo MQTT; quest’ultimo è ben compreso e gestito da Home Assistant, il quale riesce così ad integrare eventuali componenti Z-Wave compatibili con OpenZWave. Questo “fare ponte” significa “tradurre” il protocollo Z-Wave in messaggi MQTT, da e per il componente. OpenZWave è poi esso stesso un client MQTT pertanto, per comandarne i comportamenti suoi e dei componenti Z-Wave ad esso connessi, va da sé che si si usino messaggi MQTT.

Quando si collega un componente Z-Wave a OpenZWave (procedura di pairing), esso ne registra – per così dire – l’identità univoca, generando così un set di telemetrie e di comandi MQTT da e per il componente. Quando arriverà una telemetria via Z-Wave dal componente (per esempio, una temperatura da un sensore termico), pubblicherà sul broker MQTT il messaggio di telemetria, ovviamente “battezzato” col “nome” del componente che l’ha generata. Dato che OpenZWave avrà anche sottoscritto sul broker gli eventuali topic di comando per quel componente, se si pubblicherà un comando MQTT sul broker OpenZWave lo riceverà e lo girerà al componente via Z-Wave. E via così.

Dunque, è chiaro come OpenZWave non si colleghi direttamente a Home Assistant, ma si limiti a “parlarci” tramite il broker MQTT.

OpenZWave architecture

MQTT & Home Assistant

Dato che questa integrazione utilizza MQTT come tramite, va da sé che si debba avere a disposizione un broker MQTT – ma se OpenZWave è già operativo, va da sé che sia a sua volta già operativo anche tale elemento (altrimenti OpenZWave non funzionerebbe).

Assunto quindi che il broker MQTT sia già disponibile, è altresì necessario configurare l’integrazione MQTT presso Home Assistant, al fine di rendere quest’ultimo in grado di dialogare tramite tale protocollo. Se si è già configurata tale integrazione è possibile saltare al prossimo paragrafo; diversamente, qui spieghiamo come provvedere a tale rapida integrazione.

Home Assistant

Home Assistant, una volta messa in funzione la sua integrazione MQTT col broker, è pronto a definire delle entità le quali accolgano le metriche e i comandi esposti dai componenti Z-Wave associati a OpenZWave.

Per farlo ci sono due strade: una semplice e una un po’ più complicata:

  1. AUTOMATICA: lasciare fare a tutto a OpenZWave/Home Assistant. Configurata l’integrazione tra i due, ogni qual volta un nuovo componente Z-Wave viene associato a OpenZWave automaticamente vengono anche create le relative entità lato Home Assistant;
  2. MANUALE: è lasciare che OpenZWave pubblichi su broker MQTT, come da suo design, i topic telemetrici (oltre a stare in ascolto di eventuali topic di comando) e che la definizione delle entità venga effettuata manualmente dall’utente lato Home Assistant.

Integrazione Automatica

L’integrazione, in modalità automatica, è più automatica che mai.
Recandosi alla voce “Configurazione” > “Integrazioni” di Home Assistant, oppure direttamente usando il link che segue:

 

è possibile cercare e configurare l’integrazione “OpenZWave“.

Cliccando sull’integrazione, una volta trovata, laddove OpenZWave sia in corretta esecuzione così come l’integrazione MQTT su Home Assistant, apparirà automaticamente la dicitura:

Home Assistant - Integrazione OpenZWave - 1

NOTA per utenti HASSIO: In caso si utilizzi tale distribuzione e OpenZWave sia stato installato ed eseguito sotto forma di add-on, all’atto della configurazione dell’integrazione essa domanderà se si voglia lasciare al componente l’onere di configurarsi da sé oppure se piuttosto si voglia “Usare il componente aggiuntivo OpenZWave Supervisor”:

Home Assistant - Integrazione OpenZWave - Hassio

Si consiglia di non spuntare la voce e proseguire con “INVIA“.

Se qualcosa dovesse andare storto, apparirà sì il box relativo all’integrazione, ma cliccando su “Configura” apparirà questa dicitura:

Home Assistant - Integrazione OpenZWave - Fail

In tal caso, verificare che MQTT sia correttamente configurato e che OpenZWave sia correttamente in esecuzione. Ritentare solo dopo le necessarie verifiche. Diversamente, se tutto andrà per il verso giusto apparirà all’incirca il box di riepilogo che segue:

Home Assistant - Integrazione OpenZWave - Fail

Infine, cliccando in alto su “NODI” sarà possibile visualizzare l’elenco dei device Z-Wave così integrati all’HUB e le relative entità corrispondenti.

Integrazione manuale

Laddove – per motivi che possono essere i più diversi a partire dalla volontà di personalizzazione spinta – non si voglia utilizzare l’auto-discovery, OpenZWave lascia la libertà all’utente di configurare, come meglio crede, le proprie entità presso Home Assistant. Per farlo è necessario far riferimento al database di componenti supportati: ogni componente ha la propria lista di codici da aggiungere alla configurazione di Home Assistant.

Cancellazione

Cancellare: dipende cosa si intende. Una cosa è cancellare l’entità presso Home Assistant, una cosa è rimuovere il pairing di un componente Z-Wave presso OpenZWave.

Nel primo caso, la pratica da effettuare varia in base a come è stata creata: automaticamente (tramite auto-discovery) o manualmente (tramite configurazione manuale). In quest’ultimo caso, per eliminare l’entità dall’HUB (ma non da OpenZWave) è sufficiente rimuovere la configurazione manuale effettuata e riavviare Home Assistant. Nel primo caso (auto-discovery) è necessario rimuovere il pairing del componente presso OpenZWave.

Per rimuovere il pairing di un componente è sufficiente cliccare sull’icona del cestino (sempre presso l‘interfaccia web di OpenZWave).

Ricapitolando e concludendo:

  • gli utenti che utilizzino la procedura automatica di integrazione possono limitarsi rimuovere il parining presso OpenZWave (le entità presso Home Assistant spariranno da sole);
  • gli utenti configurati manualmente devono prima rimuovere presso Home Assistant le configurazioni relativa al componente in questione; successivamente possono rimuovere il pairing lato OpenZWave.


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