Datahub Benutzerbuch
Suchen Sie das DataHub-Benutzerhandbuch?
1. Einleitung
Sentinum Datahub 2.0 bietet einen zuverlässigen MQTT-Zugriff auf die Telemetrie, Konfiguration und Diagnose von Sentinum-Sensoren. Es handelt sich um die Weiterentwicklung des bisherigen Brokers unter data.sentinum.de und ist unter broker.sentinum.de verfügbar.
Hinweis zur Migration: Der bisherige Broker data.sentinum.de ist veraltet und wird spätestens Ende 2026 abgeschaltet. Eine Migration zum neuen Broker broker.sentinum.de wird dringend empfohlen.
Funktionen
- Hohe Zuverlässigkeit und Sicherheit durch eine Cluster-Architektur, die in der Europäischen Union gehostet wird.
- Ausgelegt für die Verwaltung großer Geräteflotten.
- Unterstützung für MQTT 3.0, 3.1 und 5.0.
- Strenge ACL-Regeln, sodass Sensoren und Gerätedaten nur für autorisierte Eigentümer zugänglich sind.
- Shadow-basierte Geräteparametrisierung für eine einfache Integration in externe Anwendungen.
- Kundenspezifische Schnittstellen- und Protokollanpassungen, einschließlich Transformationen, direkter Datenbank-Schreibzugriffe und Bridging.
- Verwaltung öffentlicher TLS-Zertifikate ohne Dienstunterbrechungen während der Zertifikatserneuerung.
- Client-Überwachung für verbesserte Sicherheit und Fehlererkennung.
Abwärtskompatibilität
- Unter
devices/#steht ein schreibgeschützter Spiegel des alten Themenbaums zur Verfügung, um eine schrittweise Migration zu unterstützen. - Bestehende Client-Anmeldedaten wurden auf broker.sentinum.de migriert.
- MQTT 3.0- und 3.1-Clients werden weiterhin unterstützt.
Einschränkungen
- Der Broker erfordert MQTTS mit TLS auf Port 8883 oder sichere WebSockets auf Port 8084.
- Einfaches MQTT auf Port 1883 ist nicht mehr verfügbar.
- Die ACL-Regeln sind strenger als zuvor. Clients können nur in ausdrücklich zugelassenen Themen veröffentlichen.
- Shadow-Verwaltung und Geräteinformationen sind für mobilfunkbasierte Sensoren ab Hauptversion 2 verfügbar.
Anmeldedaten
Jeder Client authentifiziert sich mit einem Benutzernamen und einem Passwort, die auf Anfrage von Sentinum vergeben werden. Diese Anmeldedaten sind unabhängig von den Benutzerkonten auf my.sentinum.de.
Derselbe Benutzername und dasselbe Passwort können von mehreren Clients verwendet werden. Jeder Client sollte dennoch eine eindeutige MQTT-Client-ID verwenden.
2. Themenbaum und Berechtigungen
Datahub 2.0 nutzt einen strukturierten Themenbaum, der Telemetrie, Konfigurationsmanagement und Gerätestatus vereint.
Basisthema
Alle gerätespezifischen Themen verwenden dieses Basisthema:
Platzhalter:
| Platzhalter | Beschreibung |
|---|---|
| <customerName> | Kundenname, wie er auf my.sentinum.de verwendet wird, in Kleinbuchstaben und mit durch Unterstriche ersetzten Leerzeichen. |
| <deviceBaseType> | Sensorserie, zum Beispiel apollon, febris, juno oder helios. |
| <deviceSubType> | Name der Unterserie. Dieser ist für spezielle Anwendungsfälle, Anpassungen und zukünftige Updates reserviert. Es ist unbedenklich, hier den Wert von <deviceBaseType> zu übernehmen. |
| <deviceId> | Eindeutige Geräte-ID im Format <series>_<transport>_<identifier>, zum Beispiel apollon_mioty_FCA84A01000036C7, apollon_cellular_355025930266075 oder febris_lora_FCA84A0900000134. |
In den folgenden Abschnitten wird <baseTopic> als Kurzform für das vollständige Basisthema verwendet.
Schreibgeschützte Themen
Clients können diese Themen abonnieren. Das Veröffentlichen in diesen Themen ist untersagt und kann zur Trennung der Verbindung des Clients führen.
| Thema | Beschreibung |
|---|---|
| <baseTopic>/up | Echtzeit-Telemetrie. Das Gerät übermittelt Sensordaten je nach Konfiguration in regelmäßigen Abständen oder bei Eintreten bestimmter Ereignisse. |
| <baseTopic>/reported_shadow | Die derzeit auf dem Gerät angewendete vollständige Konfiguration. Wenn ein gewünschtes Shadow-Delta vorliegt, erscheint die neue Konfiguration hier, nachdem das Gerät sie empfangen und bestätigt hat, dass sie erfolgreich angewendet wurde. |
| <baseTopic>/desired_shadow | Für den Downlink geplante, aber vom Gerät noch nicht bestätigte Konfiguration. Neue Konfigurationen können über MQTT, REST, my.sentinum.de oder die Benutzeroberfläche der Sentinum-Registrierung erstellt werden. Nach erfolgreicher Anwendung durch den Sensor wird dieser Wert wieder auf ein leeres Objekt zurückgesetzt: {}. |
| <baseTopic>/device_info | Zusätzliche Geräteinformationen, die für Telemetrie-Metadaten zu umfangreich sind, einschließlich detaillierterer FOTA- sowie Verbindungs- und Netzwerkinformationen. |
Schreibgeschützte Themen
Clients können Beiträge zu diesen Themen veröffentlichen. Sie können diese Themen jedoch nicht abonnieren. Abonnementversuche werden abgelehnt und können dazu führen, dass die Verbindung des Clients unterbrochen wird.
| Thema | Beschreibung |
|---|---|
| <baseTopic>/update_shadow | Veröffentlicht eine neue Konfiguration, die auf das Gerät angewendet werden soll. Gültige Konfigurationselemente erscheinen in desired_shadow, bis der Sensor sie anwendet. Nach erfolgreicher Anwendung wird reported_shadow aktualisiert. Verwenden Sie reported_shadow, um das für eine update_shadow-Nachricht erforderliche Schema abzuleiten. |
| <baseTopic>/get_shadow | Löst bei Datahub die erneute Veröffentlichung der aktuellen Werte für reported_shadow, desired_shadow und device_info aus. Die Nutzlast der Anfrage wird ignoriert und kann leer sein. |
Shadow-Nutzdaten verwenden die Grundform {"config": {}, "cmd": {}}. Verwenden Sie config für Konfigurationswerte und cmd für Befehle. Beide Abschnitte sind nach Sentos-Modulen gruppiert.
3. Beispiele
Telemetrie und Gerätestatus abonnieren
datahub/acme_corp/apollon/apollon/apollon_cellular_012345678901236/reported_shadow
datahub/acme_corp/apollon/apollon/apollon_cellular_012345678901236/desired_shadow
datahub/acme_corp/apollon/apollon/apollon_cellular_012345678901236/device_info
Eine Schattenaktualisierung auslösen
Veröffentlichen Sie eine beliebige Nutzlast unter:
Beispiel für eine Nutzlast:
"config": {},
"cmd": {}
}
Datahub veröffentlicht anschließend die aktuellen Werte für reported_shadow, desired_shadow und device_info in den jeweiligen schreibgeschützten Themen.
Gerätekonfiguration aktualisieren
Veröffentlichen Sie das gewünschte Konfigurations-Delta unter:
Beispiel für die Nutzlast:
"config": {
"apollon": {
"period": 60
}
},
"cmd": {}
}
Die Änderung wird in desired_shadow angezeigt, bis das Gerät sie empfangen und angewendet hat. Nach der Bestätigung enthält reported_shadow den aktiven Wert und desired_shadow kehrt zu {} zurück.
© Sentinum GmbH – Alle Rechte vorbehalten.
Alle Inhalte dieses Dokuments, einschließlich Text, Tabellen und Bilder, sind urheberrechtlich geschützt und Eigentum der Sentinum GmbH.
Alle Bilder unterliegen dem Urheberrecht der Sentinum GmbH, sofern nicht anders angegeben.
Eine Vervielfältigung, Verbreitung oder Nutzung – auch auszugsweise – ist ohne vorherige schriftliche Zustimmung nicht gestattet.
Spezifikationen können ohne Ankündigung geändert werden. Alle bereitgestellten Informationen werden ohne Garantie bereitgestellt.