Guida alla prima configurazione di SLSys Gateway (BRIDGE/Gateway ZigBee/Bluetooth)

Abstract

Se, per la propria domotica personale scegliendo un BRIDGE/Gateway di tipo ZigBee↔︎TCP/IP (nonché Bluetooth↔︎TCP/IP) si è scelto di dotarsi del “gateway russo“, ovvero SLSys Gateway, dopo essersi procurati l’hardware necessario per assemblarlo è altresì necessario configurarlo al primo utilizzo.

Il vantaggio di questo componente sta nel fatto di funzionare in modo totalmente indipendente: da una parte funge da coordinator ZigBee, dall’altra espone sulla rete Wi-Fi, via TCP/IP, la possibilità di interrogare o ricevere informazioni dai componenti ZigBee su di esso attestati. Il proprio HUB personale, sempre via TCP/IP, “parla” poi con tale componente, consentendo quindi l’indiretta integrazione dei suddetti componenti ZigBee presso la propria domotica.

Analogo discorso per componenti Bluetooth, i quali potranno essere gestiti in analogia con quanto spiegato per lo ZigBee. Purtroppo la gestione software del modulo Bluetooth (con medesime funzioni della ZigBee) non è ancora disponibile. Modificheremo questa parte di guida non appena lo sarà.

Questa guida illustra sostanzialmente quali siano i passi necessari per mettere in esercizio, dal punto di vista logico, lo SLSys Gateway.

Si parte

• Assunti
• Accesso Wi-Fi
• Configurazione
  • Antenna ZigBee
  • Antenna Bluetooth
  • MQTT
  • NTP
  • ZigBee

Assunti

La presente guida assume che il proprio SLSys Gateway sia già stato assemblato e che i singoli componenti (ESP32, CC253x ecc.) siano stati  programmati in modo appropriato (il tutto con le possibili tecniche illustrate nella scheda ad esso dedicata).

Assumeremo altresì l’esistenza, sulla propria rete Wi-Fi, di un broker MQTT pienamente operativo, come per esempio uno (Mosquitto) installato sul proprio Raspberry Pi (anche su Docker, volendo), oppure su Windows, su Linux Debian o su altri sistemi.

Accesso Wi-Fi

In primis è necessario far sì che il SLSys Gateway entri sulla propria rete Wi-Fi. Per far sì che ciò accada, è sufficiente alimentarlo: al boot, il BRUDGE/Gateway esporrà un proprio access point Wi-Fi (solitamente riconoscibile dal SSID “zgwXXXX“) sul quale collegarsi tramite computer o smartphone/tablet.

Una volta collegati, si aprirà un captive portal (una pagina web) che consentirà di indicare al componente il SSID della propria Wi-Fi nonché la password di accesso; sarà inoltre possibile indicare un nome mDNS (se il servizio è attivo presso il proprio router), in modo da potervisi successivamente collegare direttamente (eg. “slsys.local“). In caso il captive portal non si apra, provate collegandovi col browser all’indirizzo http://192.168.1.1.

Una volta effettuata la configurazione e riavviato il componente, esso entrerà automaticamente nella propria Wi-Fi.

Configurazione

A questo punto collegarsi, sempre via browser, all’interfaccia web del SLSys Gateway (usando il nome mDNS precedentemente impostato, eg. http://slys.local oppure l’indirizzo IP assegnatogli dal router, eg. http://192.168.1.54).

A seguire uno screenshot dell’interfaccia che apparirà. Si noti come nell’esempio proposto alcune cose risulteranno già configurate, come per esempio il supporto all’antenna ZigBee, a MQTT e NTP, tutte funzionalità che configureremo a seguire):

A questo punto provvederemo alla configurazione delle varie funzionalità del BRIDGE/Gateway.

Antenna ZigBee

Ottenuto accesso all’interfaccia, è il momento di configurare l’antenna ZigBee rispetto alle sue connessioni verso l’ESP32 GPIO. 
Recarsi dunque alla voce di menu “Settings” > “Hardware“. Qui si selezioni la tipologia di antenna presente e i contatti GPIO relativi a TX e RX. Salvare: il gateway si riavvierà.

Antenna Bluetooth

Purtroppo la gestione software del modulo Bluetooth (con medesime funzioni della ZigBee) non è ancora disponibile. Modificheremo questa parte di guida non appena lo sarà.

MQTT

Una volta riavviato portarsi su “Settings” > “Link” > “MQTT Setup” per impostare i parametri di collegamento verso il proprio broker MQTT.

Nei campi proposti andrà indicato l’indirizzo IP del proprio broker, la porta (solitamente la 1883), nome utente e password (se prevista) nonché il topic distintivo del gateway in ambito MQTT (in questo esempio, “Zigbee7634“). Inoltre, consigliamo di non abilitare la retain (campo “Retain states“) salvo casi eccezionali, visto che abilitandola qualsiasi messaggio sarà pubblicato con tale flag attiva (con tutto quello che ne consegue in termini di eventuali problemi).

Discorso a sé va fatto invece per l’LWT (campo “MQTT Retain lwt“), per il quale invece consigliamo la retain attiva. In questo modo infatti sapremo in qualsiasi momento se il BRIDGE/Gateway è realmente connesso al broker MQTT oppure no.

NTP

Completata la configurazione MQTT è il momento di configurare, velocemente, il servizio NTP, il quale consente al SLSys Gateway di allinearsi in termini di data e ora. Recarsi dunque alla voce di menu “Settings” > “Time” abilitando NTP e impostando la timezone “UTC-2.00” (lasciando il server indicato, oppure indicandone uno di proprio piacimento).

ZigBee

Infine, resta solo da configurare il comparto ZigBee.
Recarsi alla voce di menu “ZigBee” > “Config” per impostare eventualmente il canale radio (“Channel“) e l’ID della rete mesh ZigBee (“PanId“). 

Ancora più importante però è l’impostazione della modalità di pubblicazione dei messaggi MQTT e altro. Noi proponiamo la seguente configurazione ottimale:

Configurando come proposto, si provvede a:

• forzare l’invio dei payload MQTT in formato JSON (ideale in fase di integrazione con gli HUB personali);
• utilizzare nel topic il friendly name del device ZigBee oggetto del messaggio (se impostato);
• aggiungere il modello del device all’interno del payload.

Così configurato, il SLSys Gateway comincia a pubblicare e ricevere telemetrie e comandi MQTT da e per device ZigBee a lui connesso, consentendogli quindi una facile integrazione verso gli HUB personali e/o altre realtà. Una volta effettuata la configurazione, è possibile visualizzare il fluire di tali messaggi MQTT semplicemente mettendosi in ascolto sul broker.

AUTO-DISCOVERY

Se si desidera utilizzare l’auto-discovery – per far sì che l’HUB personale Home Assistant veda direttamente come entità domotiche i componenti ZigBee associati a SLSys Gateway – è necessario abilitare la voce “Home Assistant MQTT Discovery” (vedi immagine sopra).

A tal proposito – ovvero all’integrazione con Home Assistant – è disponibile la guida all’integrazione.

Integrare componenti Zigbee a Home Assistant via SLSys Gateway e MQTT