Zum Inhalt springen

Wiki-Quellcode von Datenbus

Version 2.1 von admin am 2021/11/08 18:17
Zeige letzte Bearbeiter
1 (% class="wikigeneratedid" id="HDatenbus" %)
2 Der Space wird eine Menge von Aktoren, Sensoren und aktuell noch nicht definierte Dinge betreiben. Damit nicht jedesmal ein neues Protokoll zur Kommunikation gelernt werden muss wurde beschlossen mit Dingen über MQTT zu kommunizieren.
3
4 == MQTT ==
5
6 MQTT ist ein offenes und standardisiertes Protokoll. Die Standardisierung wird durch die Organization for the Advancement of Structured Information Standards geleitet[[http://mqtt.org/]]. Das Format der zu übertragenden Daten, der eigentlich Payload, bleibt dabei dem Anwender überlassen. MQTT regelt hierbei nur den Austausch der selbst definierten Daten.
7
8 === Topics ===
9
10 MQTT kann Daten einfach sortieren/kontextualisieren. Dafür werden sogenannte Topics verwendet. Topics bilden Pfade (ähnlich Dateipfaden) in den man Daten veröffentlichen oder von denen man Daten lesen kann (schreiben und lesen wird auch publish und subscribe genannt). So kann man zum Beispiel folgende Struktur erstellen:
11
12 {{code}}
13 * /space/livingroom/temperature
14 {{/code}}
15
16 {{code}}
17 * /space/woodworkshop/temperature
18 {{/code}}
19
20 {{code}}
21 * /space/meetingroom/temperature
22 {{/code}}
23
24 {{code}}* /space/meetingroom/moisture{{/code}} Wenn man alle Temperaturen empfangen will (subscribe) kann man mit Wildcards arbeiten. So kann man im folgendem Beispiel alle defineirten Temperaturen empfangen:
25
26 {{code}}* /space/+/temperature{{/code}} Will man alle Werte empfangen kann man folgende Definition verwenden:
27
28 {{code}}* /space/#{{/code}} Das # Zeichen darf nur am Ende der Topic Definition eingesetzt werden.
29
30 ==== Topicstruktur des ZTL ====
31
32 Innerhalb des Spaces wird folgende Struktur für Topics empfohlen:
33
34 {{code}}
35 * /typ/space/room/nodename/debug
36 {{/code}}
37
38 So kann eine Lampe namens "LedStripe1" im Aufenthaltsraum mit folgender Struktur adressiert werden:
39
40 {{code}}
41 * /light/space/livingroom/LedStripe1/debug
42 {{/code}}
43
44 ===== Beispiel für Licht =====
45
46 Damit nur die Lampe "LedStripe1" gesteuert wird sendet man Meldungen an
47
48 {{code}}* /light/space/livingroom/LedStripe1{{/code}} Damit alle Lampen im "livingroom" gesteuert werden sendet man Meldungen an
49
50 {{code}}* /light/space/livingroom{{/code}} Damit alle Lampen im "space" gesteuert werden sendet man Meldungen an
51
52 {{code}}* /light/space{{/code}} Debug Informationen für Lampe "LedStripe1"
53
54 {{code}}* /light/space/livingroom/LedStripe1/debug{{/code}} Debug Informationen für alle Lampen
55
56 {{code}}
57 * /light/#/#/#/debug
58 {{/code}}
59
60 === Payload ===
61
62 Die später verwendeten Dinge werden unterschiedliche Anforderungen für den Datenaustausch haben. Im folgenden Abschnitt werden diese Anforderungen Kategorisiert. Für die Implementierung soll eine möglichst flache JSON Struktur verwendet werden. Dinge könne mehrere dieser Anforderungen gleichzeitig implementiert haben.
63
64 ==== Command ====
65
66 Der Typ Command wird für Kommunikation benötigt bei der das Ding den Payload nur empfängt und intern verarbeitet. Das Ding wird keine Rückmeldung an den Empfänger senden. Beipiel:
67
68 {{code}}
69 * Licht -> an oder aus
70 {{/code}}
71
72 {{code}}
73 {
74 //Command to device
75 "type": "cmd", //Used by the client to identify type of communication
76 "device":"name", //Used by the client to check if relevant to this device -> if not set group needs to have a value
77 "group": "name", //Used by the client to check if relevant to a group it belongs to -> if not set device needs to have a value
78 "cmd": "light", //Used by the client to identify action
79 "state": "on", //Used by the client to set the action to the requested state
80 "r": 255, //Used by the client to set the action red color -> ignored if device can only on/off
81 "g": 255, //Used by the client to set the action green color -> ignored if device can only on/off
82 "b": 255, //Used by the client to set the action blue color -> ignored if device can only on/off
83 "w": 255 //Used by the client to set the action white color -> ignored if device can only on/off
84 }
85 {{/code}}
86
87 ==== Request ====
88
89 Der Typ Request wird für Kommunikation benötigt bei der der Sender Werte vom Ding anfordert. Beispiel:
90
91 {{code}}
92 * Abfrage einer Raumtemperatur
93 {{/code}}
94
95 {{code}}
96
97 //Request to device
98 {
99 "type": "req", //Used by the client to identify type of communication
100 "req": "temp", //Used by the client to identify action
101 "device":"name", //Used by the client to check if relevant to this device -> if not set group needs to have a value
102 "group": "name", //Used by the client to check if relevant to a group it belongs to -> if not set device needs to have a value
103 "reqId" "uid" //Device will return this value in the response, Used by sender
104 }
105 //Response to sender
106 {
107 "type": "resp", //Used by the sender to identify type of communication
108 "device":"name", //Used by the sender to check if relevant
109 "group": "name", //Used by the sender to check if relevant
110 "resp": "temp", //Used by the sender to identify action
111 "value": 20.5, //Used by the sender to identify value
112 "unit": "C", //UOM
113 "reqId" "uid" //Used by the sender to match to request
114 }
115 {{/code}}
116
117 ==== State ====
118
119 Der Typ State wird verwendet damit das Ding selbständig Werte an einen Empfänger senden kann. Beispiel:
120
121 {{code}}
122 * zykliches Übermitteln der Luftfeuchte für Trenddaten
123 {{/code}}
124
125 {{code}}
126
127 // Moisture sended every Minute
128 {
129 "type": "state", //Used by the receiver to identify type of communication
130 "device": "name", //Used by the receiver to check if relevant
131 "group": "name", //Used by the receiver to check if relevant
132 "category": "moisture", //Used to define type of measurement
133 "value": "50", //Value of changed state
134 "uom": "%" //UoM of value
135 }
136 {{/code}}
137
138 {{code}}
139 * wenn Fenster auf oder zu detektiert wird
140 {{/code}}
141
142 {{code}}
143
144 // example when window is closed
145 {
146 "type": "state", //Used by the receiver to identify type of communication
147 "device": "window1", //Used by the receiver to check if relevant
148 "group": "name", //Used by the receiver to check if relevant
149 "category": "switch", //Used to define type of measurement
150 "value": "closed", //Value of changed state
151 "uom": "" //UoM of value
152 }
153 {{/code}}
154
155 === Typen ===
156
157 Typen definieren die möglichen Aktoren/Sensoren im Netzwerk. Die Datenstruktur wird im jeweiligen Wiki Beitrag gepflegt. Die möglichen Typen werden hier aufgeführt.
158
159 Typen:
160
161 {{code}}
162 [[projekte:licht|Licht]]
163 {{/code}}