Simple EnOcean MQTT Client
Das Export Modul "Simple EnOcean MQTT Client" stellt die Verbindung zu einem MQTT Broker her und veröffentlicht Nachrichten unter verschiedenen Topics.
Es können mehrere Export Instanzen angelegt werden, jedoch immer nur eine Instanz pro Broker URL.
Nachrichten werden grundsätzlich als String übertragen und sind im Regelfall als JSON Objekte formatiert.
Im Bereich IoT Export der Web Konfiguration oder der BSC Remote können die Export Verbindung angelegt, sowie die Parameter konfiguriert werden.
Es werden TCP/SSL sowie Web Socket (http/https) Verbindungen unterstützt. Die Authentifizierung ist per Nutzername und Passwort oder Client Zertifikat möglich.
Die entsprechenden Zertifikate oder Zugangsdaten können während der Konfiguration hinterlegt werden.
Es besteht die Möglichkeit die Basis Topics zum veröffentlichen von Nachrichten anzupassen.
Parameter | Standardwert | Mögliche Werte | Beschreibung |
EnOcean Topic Prefix | enocean | | Alle Thing updates werden in Topics mit diesem Prefix veröffentlicht. |
Gateway Topic Prefix | gateway |
| Status Nachrichten bezüglich des Gateways werden unter diesem Prefix veröffentlicht |
Alle Nachrichten werden als JSON Objekte übertragen.
Grundlegende Informationen für die Zuordnung von Nachrichten sind in allen Objekten vorhanden.
Feld | Datentype | Beschreibung |
nodeId | String | Eine eindeutige ID, welche das Gateway identifiziert. |
timestamp | Number | Unterschied, gemessen in Sekunden, zwischen der aktuellen Zeit und dem 01.01.1970 00:00 Uhr basierend auf der UTC Zeitzone. |
Neben den Basis Feldern sind die folgende Felder im Geräte Objekt verfügbar.
Feld | Datentype | Beschreibung |
name | String | Der für das Gerät hinterlegte Name. |
eurid | String | Die eindeutige EnOcean EURID des Gerätes. |
refId | String | Ein eindeutiger interner Bezichner des Geräte Types. |
channels | Array | Eine Liste von verfügbaren Kanälen und deren Werte. Der Key ist gleichzeitig die Kanal ID, der Wert ist entweder eine Nummer oder ein Text. |
Neben den Basis Feldern sind die folgende Felder im Gateway Status Objekt verfügbar.
Feld | Datentype | Beschreibung |
version | String | Die aktuell verwendete Software Version. |
online | Boolean | Gibt an ob das Gerät aktuell online ist. |
Die genutzte Topic Struktur unterteilt sich in Daten und Kommando Topics.
Über die Daten Topics versendet das Gateway seine und die Status Meldungen der verbundenen Geräte.
Als Basis dient das in der Konfiguration unter "EnOcean Topic Prefix" hinterlegte Topic.
Dieser Pfad wird um die EURID des Gerätes erweitert und dort die Geräte Nachricht veröffentlicht.
Beispiel Topic:
Als Basis dient das in der Konfiguration unter "Gateway Topic Prefix" hinterlegte Topic.
Dieser Pfad wird um die Hardware ID des Gerätes erweitert und dort die Status Nachricht veröffentlicht.
Beispiel Topic:
Über die Kommando Topics ist eine einfach Möglichkeit der Steuerung des Gateways umgesetzt.
Als Basis dient das in der Konfiguration unter "EnOcean Topic Prefix" hinterlegte Topic und ermöglicht es Aktoren zu schalten.
Dieser Pfad wird um die EURID des Gerätes sowie die Kanal ID erweitert. Als Nutzdaten wird der neue Wert als String erwartet.
Beispiel Topic:
Beispiel Nutzdaten:
Als Basis dient das in der Konfiguration unter "Gateway Topic Prefix" hinterlegte Topic.
Dieser Pfad wird um die Hardware ID des Gerätes sowie das auszuführende Kommando erweitert. Als Nutzdaten wird ein JSON Objekt mit den entsprechenden Parametern erwartet.
Verfübare Kommandos:
Kommando | Payload | Beschreibung |
pairing | on oder off Zeitangabe in Sekunden: on=90 | Schalten den Modus zum automatischen anlernen von neuen Geräten ein oder aus. Optional kann eine Zeitangabe in Sekunden erfolgen nach welcher der Modus automatisch wieder abgeschaltet wird. |
delete | Eine Geräte EURID | Es wird versucht das betreffende Gerät zu löschen. |
Beispiel Topic:
Beispiel Nutzdaten:
