Generic MQTT Client

18min

Einleitung
Das Export Modul "Generic MQTT Client" stellt die Verbindung zu einem MQTT Broker her und veröffentlicht Status Nachrichten unter verschiedenen Topics.
Diese Topics sind von der Struktur her ähnlich aufgebaut wie die URL Struktur des "Generic REST Server" Export Moduls.
Die versendeten Nachrichten verwenden das Generic IoT Datenmodell﻿ innerhalb eines Container Objektes, welches Informationen zur Nachrichten Identifikation bereitstellt.
Es können mehrere Export Instanzen angelegt werden, jedoch immer nur eine Instanz pro Broker URL.
Nachdem die Verbindung zu einem Broker aufgebaut wurde, werden alle verfügbaren Geräte als Update übertragen. Somit ist sichergestellt das der aktuelle Gerätestatus übermittelt wurde.
Nachrichten werden grundsätzlich als String übertragen und sind im Regelfall als JSON Objekte formatiert.
Konfiguration
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
﻿
Parameter
Standardwert
Mögliche Werte
Beschreibung
Thing Topic Prefix
GATEWAY_ID/things
﻿
Alle Thing updates werden in Topics mit diesem Prefix veröffentlicht.
Command Topic
GATEWAY_ID/cmd


Unter diesem Topic können Kommandos an das Gateway gesendet werden.
Status Topic
GATEWAY_ID/status


Unter diesem Topic veröffentlich das Gateway seine Status Informationen.
Der Verbindungsstatus Verbunden/Getrennt kann hier ausgelesen werden.
Notification Topic
GATEWAY_ID/msg


Push Benachrichtigungen für den ausgewählten Benutzer werden unter diesem Topic veröffentlicht.
Basisdaten von Nachrichten
Alle Nachrichten, ausgenommen RAW Nachrichten, werden als JSON Objekte übertragen.
Grundlegende Informationen für die Zuordnung von Nachrichten sind in allen Objekten vorhanden.
Basis Felder
Feld
Datentype
Beschreibung
nodeId
String
Eine eindeutige ID, welche das Gateway identifiziert.
eventId
String
Eine eindeutige ID, welche das auslösende Event identifiziert.
Es ist möglich das mehrere Nachrichten durch das gleiche Event erzeugt werden und somit die gleiche Event ID erhalten. Ein Beispiel dafür wären Geräte Updates. Dort werden Sub Topics verwendet, somit erhalten die einzelnen Kanal Sub Topics Nachrichten mit der gleichen Event ID.
Es ist garantiert das eine Event ID innerhalb von 24 Stunden nur einmalig vorkommt.
timestamp
Number
Unterschied, gemessen in Millisekunden, zwischen der aktuellen Zeit und dem 01.01.1970 00:00 Uhr basierend auf der UTC Zeitzone.
Dieser Zeitstempel kann, zusammen mit der Event ID, auch dazu genutzt werden Nachrichten eindeutig zu identifizieren.
Geräte Topics
Das in der Konfiguration hinterlegte "Thing Topic Prefix" dient als Basis für alle Geräteaktualisierungen. Ein Beispiel dafür wäre "ACDBDA59E9CF/things".
Die eigentlichen Geräteaktualisierungen werden über verschachtelte "Sub Topics" veröffentlicht.
Sub Topics
Die Sub Topics werden nur bei einer Änderung von Werten benachrichtigt.
So kann bei der "Subscription" gezielt entschieden werden, über welche Daten man benachrichtigt wird.
Sub Topic
Beschreibung
/<Thing ID>
Das komplette Thing Objekt.
/<Thing ID>/state
Den Online/Offline Status des Gerätes.
/<Thing ID>/metaInfos
Die Meta Informationen des Gerätes.
/<Thing ID>/<Channel ID>/value
Der Wert eines einzelnen Kanals.
/<Thing ID>/<Channel ID>/value/raw
Der Wert als Plaintext String ohne Nachrichtencontainer.
/<Thing ID>/parameter/<Channel ID>/value
Der Wert eines einzelnen Parameterkanals.
/<Thing ID>/parameter/<Channel ID>/value/raw
Der Wert eines Parametekanals als Plaintext String ohne Nachrichtencontainer.
Ändern von Werten
Die Änderung eines Wertes kann über extra dafür vorgesehenene "Sub Topics" angestoßen werden. Es wird zwischen Kanal- und Parameterwerten unterschieden:
Kanalwerte
/<Thing ID>/<Channel ID>/value/set
Parameterwerte
/<Thing ID>/parameter/<Channel ID>/value/set
Der neue Wert wird einfach als Nachricht an dieses Topic gesendet.
Sobald der Wert (real) geändert wurde, werden entsprechende Aktualisierungen an die vorher schon beschriebenen "Sub Topics" gesendet. 
Alternativ gibt es auch ein Kommando Objekt zum Ändern von Werten, näheres dazu ist im Abschnitt zum Kommando Topic nachzulesen.
Beispiel Daten
ACDBDA59E9CF/things/b9f09ef8-3c3f-459e-841f-66bdaedff183
{
	"nodeId": "ACDBDA59E9CF",
	"eventId": "igu16ksjlsu6m80v",
	"timestamp": 1636543467229,
	"thing": {
		"id": "b9f09ef8-3c3f-459e-841f-66bdaedff183",
		"name": "FSB14",
		"channelGroups": [{
			"channelGroupId": "Sensor Group",
			"channelDescriptionData": null,
			"channels": [{
				"channelId": "Jalousie",
				"channelDescriptionData": {
					"channelTypeEnum": "SHADING",
					"label": {
						"de_DE": "Jalousie",
						"en_US": "shutters"
					}
				},
				"value": "29.0",
				"valueDescriptionData": {
					"valueType": "NUMBER_DOUBLE",
					"unit": "%",
					"min": 0.0,
					"max": 100.0,
					"stepping": 1.0,
					"decimalPartDigits": 1,
					"possibleValues": null
				},
				"writeable": false,
				"metaInfos": {
					"METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#Jalousie",
					"MESSAGE->COUNT": "0",
					"EOAP->CHANGEABLE": "true",
					"MESSAGE->ENABLED": "false",
					"Sensor.Name": "Jalousie",
					"TSYSTEMS->type": "value"
				}
			}, {
				"channelId": "JalousieState",
				"channelDescriptionData": {
					"channelTypeEnum": "SHADING",
					"label": {
						"de_DE": "Jalousie",
						"en_US": "shutters"
					}
				},
				"value": "UNKNOWN",
				"valueDescriptionData": {
					"valueType": "STATE",
					"unit": null,
					"min": null,
					"max": null,
					"stepping": null,
					"decimalPartDigits": null,
					"possibleValues": {
						"UNKNOWN": {
							"de_DE": "Unbekannt",
							"en_US": "unknown"
						},
						"UP": {
							"de_DE": "Herauf",
							"en_US": "up"
						},
						"DOWN": {
							"de_DE": "Herunter",
							"en_US": "down"
						}
					}
				},
				"writeable": false,
				"metaInfos": {
					"METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#JalousieState",
					"MESSAGE->COUNT": "0",
					"EOAP->CHANGEABLE": "false",
					"MESSAGE->ENABLED": "false",
					"Sensor.Name": "Direction",
					"TSYSTEMS->type": "state"
				}
			}, {
				"channelId": "Priority",
				"channelDescriptionData": {
					"channelTypeEnum": "SWITCH",
					"label": {
						"de_DE": "Priorität",
						"en_US": "priority"
					}
				},
				"value": "OFF",
				"valueDescriptionData": {
					"valueType": "STATE",
					"unit": null,
					"min": null,
					"max": null,
					"stepping": null,
					"decimalPartDigits": null,
					"possibleValues": {
						"UNKNOWN": {
							"de_DE": "Unbekannt",
							"en_US": "unknown"
						},
						"ON": {
							"de_DE": "An",
							"en_US": "on"
						},
						"OFF": {
							"de_DE": "Aus",
							"en_US": "off"
						}
					}
				},
				"writeable": false,
				"metaInfos": {
					"METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#Priority",
					"MESSAGE->COUNT": "0",
					"EOAP->CHANGEABLE": "true",
					"MESSAGE->ENABLED": "false",
					"Sensor.Name": "Priority",
					"TSYSTEMS->type": "state"
				}
			}, {
				"channelId": "JalousieSlat",
				"channelDescriptionData": {
					"channelTypeEnum": "SHADING",
					"label": {
						"de_DE": "Jalousie (Lamellen)",
						"en_US": "shutters (slats)"
					}
				},
				"value": "UNKNOWN",
				"valueDescriptionData": {
					"valueType": "STATE",
					"unit": null,
					"min": null,
					"max": null,
					"stepping": null,
					"decimalPartDigits": null,
					"possibleValues": {
						"UNKNOWN": {
							"de_DE": "Unbekannt",
							"en_US": "unknown"
						},
						"UP": {
							"de_DE": "Herauf",
							"en_US": "up"
						},
						"DOWN": {
							"de_DE": "Herunter",
							"en_US": "down"
						}
					}
				},
				"writeable": false,
				"metaInfos": {
					"METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#JalousieSlat",
					"MESSAGE->COUNT": "0",
					"EOAP->CHANGEABLE": "true",
					"MESSAGE->ENABLED": "false",
					"Sensor.Name": "JalousieSlat",
					"TSYSTEMS->type": "state"
				}
			}]
		}],
		"state": "ONLINE",
		"parameterGroups": null,
		"metaInfos": {
			"ALEXA->ALEXA_LIVE_UPDATES": "false",
			"MONITORING->MONITORABLE": "true",
			"TEACHIN->GROUP_DISPLAYNAME": "Test",
			"BSC->SHORT_INFO": "FSB14",
			"METAINFO->id": "ADevice#b9f09ef8-3c3f-459e-841f-66bdaedff183",
			"TEACHIN->REFERENCE_ID": "enocean.eltako.fsb14",
			"EOAP->ACTIVATED": "true",
			"TEACHIN->TRANSMISSION_ID": "default=4291820288",
			"lastModified": "1636543466499",
			"EOAP->ALARM": "false"
		}
	}
}
{
	"nodeId": "ACDBDA59E9CF",
	"eventId": "igu16ksjlsu6m80v",
	"timestamp": 1636543467229,
	"thing": {
		"id": "b9f09ef8-3c3f-459e-841f-66bdaedff183",
		"name": "FSB14",
		"channelGroups": [{
			"channelGroupId": "Sensor Group",
			"channelDescriptionData": null,
			"channels": [{
				"channelId": "Jalousie",
				"channelDescriptionData": {
					"channelTypeEnum": "SHADING",
					"label": {
						"de_DE": "Jalousie",
						"en_US": "shutters"
					}
				},
				"value": "29.0",
				"valueDescriptionData": {
					"valueType": "NUMBER_DOUBLE",
					"unit": "%",
					"min": 0.0,
					"max": 100.0,
					"stepping": 1.0,
					"decimalPartDigits": 1,
					"possibleValues": null
				},
				"writeable": false,
				"metaInfos": {
					"METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#Jalousie",
					"MESSAGE->COUNT": "0",
					"EOAP->CHANGEABLE": "true",
					"MESSAGE->ENABLED": "false",
					"Sensor.Name": "Jalousie",
					"TSYSTEMS->type": "value"
				}
			}, {
				"channelId": "JalousieState",
				"channelDescriptionData": {
					"channelTypeEnum": "SHADING",
					"label": {
						"de_DE": "Jalousie",
						"en_US": "shutters"
					}
				},
				"value": "UNKNOWN",
				"valueDescriptionData": {
					"valueType": "STATE",
					"unit": null,
					"min": null,
					"max": null,
					"stepping": null,
					"decimalPartDigits": null,
					"possibleValues": {
						"UNKNOWN": {
							"de_DE": "Unbekannt",
							"en_US": "unknown"
						},
						"UP": {
							"de_DE": "Herauf",
							"en_US": "up"
						},
						"DOWN": {
							"de_DE": "Herunter",
							"en_US": "down"
						}
					}
				},
				"writeable": false,
				"metaInfos": {
					"METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#JalousieState",
					"MESSAGE->COUNT": "0",
					"EOAP->CHANGEABLE": "false",
					"MESSAGE->ENABLED": "false",
					"Sensor.Name": "Direction",
					"TSYSTEMS->type": "state"
				}
			}, {
				"channelId": "Priority",
				"channelDescriptionData": {
					"channelTypeEnum": "SWITCH",
					"label": {
						"de_DE": "Priorität",
						"en_US": "priority"
					}
				},
				"value": "OFF",
				"valueDescriptionData": {
					"valueType": "STATE",
					"unit": null,
					"min": null,
					"max": null,
					"stepping": null,
					"decimalPartDigits": null,
					"possibleValues": {
						"UNKNOWN": {
							"de_DE": "Unbekannt",
							"en_US": "unknown"
						},
						"ON": {
							"de_DE": "An",
							"en_US": "on"
						},
						"OFF": {
							"de_DE": "Aus",
							"en_US": "off"
						}
					}
				},
				"writeable": false,
				"metaInfos": {
					"METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#Priority",
					"MESSAGE->COUNT": "0",
					"EOAP->CHANGEABLE": "true",
					"MESSAGE->ENABLED": "false",
					"Sensor.Name": "Priority",
					"TSYSTEMS->type": "state"
				}
			}, {
				"channelId": "JalousieSlat",
				"channelDescriptionData": {
					"channelTypeEnum": "SHADING",
					"label": {
						"de_DE": "Jalousie (Lamellen)",
						"en_US": "shutters (slats)"
					}
				},
				"value": "UNKNOWN",
				"valueDescriptionData": {
					"valueType": "STATE",
					"unit": null,
					"min": null,
					"max": null,
					"stepping": null,
					"decimalPartDigits": null,
					"possibleValues": {
						"UNKNOWN": {
							"de_DE": "Unbekannt",
							"en_US": "unknown"
						},
						"UP": {
							"de_DE": "Herauf",
							"en_US": "up"
						},
						"DOWN": {
							"de_DE": "Herunter",
							"en_US": "down"
						}
					}
				},
				"writeable": false,
				"metaInfos": {
					"METAINFO->id": "ASensor#b9f09ef8-3c3f-459e-841f-66bdaedff183#JalousieSlat",
					"MESSAGE->COUNT": "0",
					"EOAP->CHANGEABLE": "true",
					"MESSAGE->ENABLED": "false",
					"Sensor.Name": "JalousieSlat",
					"TSYSTEMS->type": "state"
				}
			}]
		}],
		"state": "ONLINE",
		"parameterGroups": null,
		"metaInfos": {
			"ALEXA->ALEXA_LIVE_UPDATES": "false",
			"MONITORING->MONITORABLE": "true",
			"TEACHIN->GROUP_DISPLAYNAME": "Test",
			"BSC->SHORT_INFO": "FSB14",
			"METAINFO->id": "ADevice#b9f09ef8-3c3f-459e-841f-66bdaedff183",
			"TEACHIN->REFERENCE_ID": "enocean.eltako.fsb14",
			"EOAP->ACTIVATED": "true",
			"TEACHIN->TRANSMISSION_ID": "default=4291820288",
			"lastModified": "1636543466499",
			"EOAP->ALARM": "false"
		}
	}
}
﻿
ACDBDA59E9CF/things/b9f09ef8-3c3f-459e-841f-66bdaedff183/Jalousie/value
{
    "nodeId": "ACDBDA59E9CF",
    "eventId": "igu16ksjlsu6m80v",
    "timestamp": 1636543467229,
    "value": "29.0"
}
{
    "nodeId": "ACDBDA59E9CF",
    "eventId": "igu16ksjlsu6m80v",
    "timestamp": 1636543467229,
    "value": "29.0"
}
﻿
ACDBDA59E9CF/things/b9f09ef8-3c3f-459e-841f-66bdaedff183/Jalousie/value/raw
29.0
29.0
﻿
ACDBDA59E9CF/things/b9f09ef8-3c3f-459e-841f-66bdaedff183/metaInfos
{
    "nodeId": "ACDBDA59E9CF",
    "eventId": "igu16ksjlsu6m80v",
    "timestamp": 1636543467229,
    "metaInfos": {
        "ALEXA->ALEXA_LIVE_UPDATES": "false",
        "MONITORING->MONITORABLE": "true",
        "TEACHIN->GROUP_DISPLAYNAME": "Test",
        "BSC->SHORT_INFO": "FSB14",
        "METAINFO->id": "ADevice#b9f09ef8-3c3f-459e-841f-66bdaedff183",
        "TEACHIN->REFERENCE_ID": "enocean.eltako.fsb14",
        "EOAP->ACTIVATED": "true",
        "TEACHIN->TRANSMISSION_ID": "default=4291820288",
        "lastModified": "1636543466499",
        "EOAP->ALARM": "false"
    }
}
{
    "nodeId": "ACDBDA59E9CF",
    "eventId": "igu16ksjlsu6m80v",
    "timestamp": 1636543467229,
    "metaInfos": {
        "ALEXA->ALEXA_LIVE_UPDATES": "false",
        "MONITORING->MONITORABLE": "true",
        "TEACHIN->GROUP_DISPLAYNAME": "Test",
        "BSC->SHORT_INFO": "FSB14",
        "METAINFO->id": "ADevice#b9f09ef8-3c3f-459e-841f-66bdaedff183",
        "TEACHIN->REFERENCE_ID": "enocean.eltako.fsb14",
        "EOAP->ACTIVATED": "true",
        "TEACHIN->TRANSMISSION_ID": "default=4291820288",
        "lastModified": "1636543466499",
        "EOAP->ALARM": "false"
    }
}
﻿
Kommando Topic
Über das Kommando Topic, welches in der Konfiguration als "Command Topic" hinterlegt ist, können verschiedene Befehle an das Gateway gesendet werden.
Ein Kommando besteht immer aus dem Kommando Type sowie einigen Parametern. Die Parameter sind immer Strings.
Kommando Type
Parameter
Mögliche Werte
Erforderlich
Beschreibung
CHANGE_VALUE
thingId


X
Eindeutige Thing ID des Gerätes.


channelId


X
Die eindeutige Channel ID es Kanals welcher geschaltet werden soll.


newValue


X
Der neue Wert welcher gesetzt werden soll.
AUTO_PAIRING
pairingEnabled
true
false
X
Gibt an ob das automatische Anlenen aktiviert werden soll.
Ist es bereits aktiviert passiert nicht weiter.


targetGrpID
Positiver Wert
X
Die ID der Gruppe, zu welcher neue Geräte hinzugefügt werden sollen.
Sind keine Gruppen vorhanden, muss 0 angegeben werden. Die Geräte werden dadurch ohne Gruppenzuordnung angelegt.


enabledForSec
Positiver Wert
X
Zeit in Sekunden bis der Anlernmodus automatisch wieder ausgeschaltet wird. Ein Wert von 0 deaktiviert die automatische Abschaltung.
DELETE_THING
thingId


X
Eindeutige ID des Thing
CHANGE_PARAMETERVALUE
thingId
﻿
X
Eindeutige ID des Thing
﻿
channelId
﻿
X
Die eindeutige Channel ID es Parameterkanals welcher geschaltet werden soll.
﻿
newValue
﻿
X
Der neue Wert welcher gesetzt werden soll.
Beispiel Kommandos
Status Topic
Über das Status Topic, welches in der Konfiguration als "Status Topic" hinterlegt ist, werden Statusinformationen zum Gateway übertragen.
Insbesondere der Onlinestatus hat hier besondere Bedeutung. Dieser gibt an ob das Gateway mit dem MQTT Broker verbunden ist.
Falls das Gateway nicht mit dem Broker verbunden ist, wird die Event ID der Statusnachricht auf "disconnect" gesetzt und der Timestamp auf -1. Dies kann innerhalb von 24 Stunden mehrfach auftreten!
Status Objekt
Feld
Datentype
Beschreibung
version
String
Die aktuelle Software Version des Gateways.
connected
Boolean
Status ob das Gateway aktuell verbunden ist.
metaInfos
Objekt
Ein Objekt mit zusätzlichen Informationen.
Jedes Feld ist vom Datentype String, der Feldname fungiert als "Key" um eine Map abzubilden.
Verbunden
Getrennt
{
	"nodeId": "ACDBDA59EB17",
	"eventId": "disconnect",
	"timestamp": -1,
	"version": "3.3.1",
	"connected": false,
	"metaInfos": {}
}
{
	"nodeId": "ACDBDA59EB17",
	"eventId": "disconnect",
	"timestamp": -1,
	"version": "3.3.1",
	"connected": false,
	"metaInfos": {}
}
﻿
Benachrichtigungs Topic
Über das Benachrichtigungs Topic, welches in der Konfiguration als "Notification Topic" hinterlegt ist, werden Push Benachrichtigungen übertragen.
Die Push Benachrichtigungen müssen für den unter "User" ausgewählten Benutzer bestimmte sein.
Benachrichtigungs Objekt
Feld
Datentype
Beschreibung
msg
String
Der Text der Push Benachrichtigung.
Es können \n für Zeilenumbrüche enthalten sein.
Benachrichtigungs Objekt
{
	"nodeId": "ACDBDA59EB17",
	"eventId": "ce40i927ri52lcm7",
	"timestamp": 1649843666187,
	"msg": "Admin@SmartNode: Dies ist eine Testnachricht\n\nDer Test wurde erfolgreich durchgeführt\nZeilenumbrüche sind erlaubt"
}
{
	"nodeId": "ACDBDA59EB17",
	"eventId": "ce40i927ri52lcm7",
	"timestamp": 1649843666187,
	"msg": "Admin@SmartNode: Dies ist eine Testnachricht\n\nDer Test wurde erfolgreich durchgeführt\nZeilenumbrüche sind erlaubt"
}
﻿
﻿

Parameter	Standardwert	Beschreibung
Thing Topic Prefix	GATEWAY_ID/things	Alle Thing updates werden in Topics mit diesem Prefix veröffentlicht.
Command Topic	GATEWAY_ID/cmd	Unter diesem Topic können Kommandos an das Gateway gesendet werden.
Status Topic	GATEWAY_ID/status	Unter diesem Topic veröffentlich das Gateway seine Status Informationen. Der Verbindungsstatus Verbunden/Getrennt kann hier ausgelesen werden.
Notification Topic	GATEWAY_ID/msg	Push Benachrichtigungen für den ausgewählten Benutzer werden unter diesem Topic veröffentlicht.

Feld	Datentype	Beschreibung
nodeId	String	Eine eindeutige ID, welche das Gateway identifiziert.
eventId	String	Eine eindeutige ID, welche das auslösende Event identifiziert. Es ist möglich das mehrere Nachrichten durch das gleiche Event erzeugt werden und somit die gleiche Event ID erhalten. Ein Beispiel dafür wären Geräte Updates. Dort werden Sub Topics verwendet, somit erhalten die einzelnen Kanal Sub Topics Nachrichten mit der gleichen Event ID. Es ist garantiert das eine Event ID innerhalb von 24 Stunden nur einmalig vorkommt.
timestamp	Number	Unterschied, gemessen in Millisekunden, zwischen der aktuellen Zeit und dem 01.01.1970 00:00 Uhr basierend auf der UTC Zeitzone. Dieser Zeitstempel kann, zusammen mit der Event ID, auch dazu genutzt werden Nachrichten eindeutig zu identifizieren.

Sub Topic	Beschreibung
/<Thing ID>	Das komplette Thing Objekt.
/<Thing ID>/state	Den Online/Offline Status des Gerätes.
/<Thing ID>/metaInfos	Die Meta Informationen des Gerätes.
/<Thing ID>/<Channel ID>/value	Der Wert eines einzelnen Kanals.
/<Thing ID>/<Channel ID>/value/raw	Der Wert als Plaintext String ohne Nachrichtencontainer.
/<Thing ID>/parameter/<Channel ID>/value	Der Wert eines einzelnen Parameterkanals.
/<Thing ID>/parameter/<Channel ID>/value/raw	Der Wert eines Parametekanals als Plaintext String ohne Nachrichtencontainer.

Kommando Type	Parameter	Mögliche Werte	Erforderlich	Beschreibung
CHANGE_VALUE	thingId		X	Eindeutige Thing ID des Gerätes.
	channelId		X	Die eindeutige Channel ID es Kanals welcher geschaltet werden soll.
	newValue		X	Der neue Wert welcher gesetzt werden soll.
AUTO_PAIRING	pairingEnabled	true false	X	Gibt an ob das automatische Anlenen aktiviert werden soll. Ist es bereits aktiviert passiert nicht weiter.
	targetGrpID	Positiver Wert	X	Die ID der Gruppe, zu welcher neue Geräte hinzugefügt werden sollen. Sind keine Gruppen vorhanden, muss 0 angegeben werden. Die Geräte werden dadurch ohne Gruppenzuordnung angelegt.
	enabledForSec	Positiver Wert	X	Zeit in Sekunden bis der Anlernmodus automatisch wieder ausgeschaltet wird. Ein Wert von 0 deaktiviert die automatische Abschaltung.
DELETE_THING	thingId		X	Eindeutige ID des Thing
CHANGE_PARAMETERVALUE	thingId		X	Eindeutige ID des Thing
	channelId		X	Die eindeutige Channel ID es Parameterkanals welcher geschaltet werden soll.
	newValue		X	Der neue Wert welcher gesetzt werden soll.

Feld	Datentype	Beschreibung
version	String	Die aktuelle Software Version des Gateways.
connected	Boolean	Status ob das Gateway aktuell verbunden ist.
metaInfos	Objekt	Ein Objekt mit zusätzlichen Informationen. Jedes Feld ist vom Datentype String, der Feldname fungiert als "Key" um eine Map abzubilden.

Feld	Datentype	Beschreibung
msg	String	Der Text der Push Benachrichtigung. Es können \n für Zeilenumbrüche enthalten sein.

Aktualisiert 25 Mar 2024

Hat Ihnen diese Seite geholfen?

Generic Web Export

ALS NÄCHSTES

IoT Core MQTT Client

Generic MQTT Client

Einleitung

Konfiguration

Parameter

Basisdaten von Nachrichten

Basis Felder

Geräte Topics

Sub Topics

Ändern von Werten

Kanalwerte

Parameterwerte

Beispiel Daten

Repräsentation eines Gerätes

Einzelner Kanalwert

RAW Kanalwert

Meta Informationen

Kommando Topic

Beispiel Kommandos

Status Topic

Status Objekt

Status Objekt Beispiele

Benachrichtigungs Topic

Benachrichtigungs Objekt

Beispiel Benachrichtigungs Objekt