Einleitung
Der Thingsboard Frost Adapter ist ein FastAPI‑Microservice, der Gerätedaten aus ThingsBoard in einen FROST‑Server (Referenzimplementierung der OGC SensorThings API) überführt. Er bildet Geräte, Standorte, Geräteprofile und Telemetrie‑Felder aus ThingsBoard auf die entsprechenden SensorThings‑API‑Entitäten ab (siehe Datenmodell: ThingsBoard auf SensorThings abbilden) und legt für jede eingehende Telemetrie‑Nachricht eine Observation im FROST‑Server an.
Der Adapter ist mandantenfähig: Er bedient mehrere Mandanten gleichzeitig, und ein Mandant ist die Zusammenfassung eines ThingsBoard‑Mandanten mit genau einem FROST‑Server. Adressiert wird ein Mandant über seinen unveränderlichen Slug in der Ingest‑URL.
Einen Überblick über die beteiligten Komponenten und den Datenfluss liefert die Seite Architekturüberblick.
Aufbau dieser Dokumentation
Die technische Dokumentation gliedert sich in neun weitere Seiten. Sie stehen in Leserichtung: die ersten fünf beschreiben den Adapter, die letzten beiden richten sich an andere Leser.
Einstieg
-
Repository und Entwicklungsumgebung – Was im Repository liegt, wie die Entwicklungsumgebung hochkommt, wie die Tests laufen und welche Einstellung wohin gehört.
Architektur
-
Architekturüberblick – Überblick über die beteiligten Komponenten und den Datenfluss.
-
Architektur im Detail: Modulschichten – Der innere Aufbau des Adapters: die vier Schichten, die Abhängigkeitsregel und die Verträge zwischen den Schichten.
-
Frontend (Streamlit) – Die Streamlit‑Verwaltungsoberfläche als eigenständige zweite Anwendung.
Daten und Regeln
-
Datenbankschema des Adapters – Die sechs Tabellen der Adapter‑Datenbank: Mandanten‑Registry und Stammdaten.
-
Datenmodell: ThingsBoard auf SensorThings abbilden – Woher jedes Feld der angelegten SensorThings‑Entitäten stammt.
-
Geschäftsregeln für Stammdaten (Business Rules) – Geschäftsregeln zum Schutz der Stammdaten vor inkonsistenten Zuständen und der Lebenszyklus eines Mandanten.
Referenz und Betrieb
-
Schnittstellenbeschreibung SensorThings API (FROST‑Server) – Kurzreferenz für den lesenden Zugriff auf die SensorThings API eines FROST‑Servers.
-
Betriebsanleitungen (Runbooks) – Die Abläufe, die ein Betreiber von Hand ausführt: Bereitstellen, Verteilen der Rule Chain, Stilllegen, Wiederherstellen.
|
Wer die Software benutzt statt sie zu ändern, findet die schrittweisen Anleitungen in der Nutzerdokumentation. |