Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 64.2
edited by Xiaoling
on 2025/03/07 11:46
Change comment: There is no comment for this version
To version 93.1
edited by Dilisi S
on 2025/03/08 03:59
Change comment: Mar 7 edits -part 1

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Xiaoling
1 +XWiki.pradeeka
Content
... ... @@ -6,6 +6,9 @@
6 6  Draft Document
7 7  {{/warning}}
8 8  
9 +
10 +
11 +
9 9  = 1. Introduction =
10 10  
11 11  
... ... @@ -14,232 +14,75 @@
14 14  The **NB series** devices end with the suffix **-NB**, and the **CB series** devices end with the suffix **-CB**. For example, **S31B-NB** is an **NB device**, and **S31-CB** is a **CB device**.
15 15  
16 16  
17 -= 2. Add New Device =
18 18  
19 19  
20 -First, we will add a device to simulate data using MQTT. This device does not represent a real physical device but serves as a common virtual device for all Dragino NB/CB devices.
21 21  
22 -In the left navigation, click **Entities** and then click **Devices**.
23 += 2. Data Converters =
23 23  
24 -[[image:device-list-empty.png]]
25 25  
26 +In **ThingsBoard**, **Data Converters** are components used to transform incoming or outgoing data between different formats, typically to convert raw telemetry data from devices into a structured format that ThingsBoard can understand, or vice versa.
26 26  
27 -On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
28 28  
29 +== 2.1 Uplink ==
29 29  
30 -[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
31 31  
32 +In the left navigation, click **Integrations center**, and then click **Data converters**.
32 32  
33 -The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
34 34  
35 -Click on the **Next: Credentials** button.
36 36  
36 +[[image:data-converters-list-empty.png]]
37 37  
38 -[[image:new-device-device-details.png||height="529" width="500"]]
39 39  
39 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
40 40  
41 -Click the **Access token** button if it is not selected by default.
42 42  
43 -Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
44 44  
45 -Click on the **Add** button.
43 +[[image:create-new-converter-menu.png||height="259" width="500"]]
46 46  
47 -[[image:new-device-access-token.png||height="528" width="500"]]
48 48  
49 -
50 -Click on the **MQTT** button.
51 -
52 -Then, select the operating system you are going to use with the **Mosquitto MQTT Broker**. This example shows sending a command from a computer running **MacOS**. First, install the necessary client tools on your computer.
53 -
54 -Copy the MQTT pub command in the '**Execute the following command**' section.
55 -
56 -{{code language="none"}}
57 -mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/me/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:25}"
58 -{{/code}}
59 -
60 -Note that the **State** is still shown as **'Inactive'** in the **Latest telemetry** section.
61 -
62 -[[image:new-device-check-connectivity.png||height="522" width="500"]]
63 -
64 -
65 -On the terminal, enter the command you copied. This command sends the MQTT payload **{temperature:25}** as telemetry data from a virtual device named **'me'**. Of course, you can replace **'me'** with a device name or use the wildcard character **'+'** to match any device name.
66 -
67 -
68 -[[image:mqtt-command-1.png||height="228" width="700"]]
69 -
70 -
71 -If the command is successful, you can see the telemetry data you sent under the **Latest telemetry** section. Note that the **State** is now **'Active'** in the **Latest telemetry** section.
72 -
73 -
74 -[[image:new-device-telemetry-test.png||height="520" width="500"]]
75 -
76 -
77 -Send the same command again, only changing the **temperature** value, to see how the **Latest telemetry** section updates its data.
78 -
79 -Once you are done experimenting with this, close the window by clicking the **Close** button.
80 -
81 -
82 -[[image:mqtt-command-2.png||height="227" width="700"]]
83 -
84 -
85 -
86 -[[image:virtual-device-active.png]]
87 -
88 -
89 -= 3. Data Converters =
90 -
91 -
92 -In **ThingsBoard**, **Data Converters** are components used to transform incoming or outgoing data between different formats, typically to convert raw telemetry data from devices into a structured format that ThingsBoard can understand, or vice versa.
93 -
94 -
95 -== 3.1 Uplink ==
96 -
97 -
98 -In the left navigation, click **Integrations center**, and then click **Data converters**.
99 -
100 -[[image:data-converter-list-page.png]]
101 -
102 -
103 -On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
104 -
105 -[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
106 -
107 -
108 108  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
109 109  
110 -Click on the **JavaScript** button. Now copy and paste the following JavaScript to the **Decoder function** section. This decoder function is valid for both NB and CB series devices.
48 +Click on the **TBEL** button if not selected it by default. Delete the existing decoder function in the code editor. Now copy and paste the following decoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This decoder function is compatible for both NB and CB series devices.
111 111  
112 112  {{code language="JavaScript"}}
113 -//Version: 0.1
51 +/** Decoder **/
52 +
114 114  // decode payload to string
115 115  var payloadStr = decodeToString(payload);
55 +var data = JSON.parse(payloadStr);
116 116  
57 +var deviceName = metadata.topic.split("/")[3];
117 117  // decode payload to JSON
118 -var objdata = {};
119 -var obj1 = {};
120 -var data = decodeToJson(payload);
121 -var deviceName = data.IMEI;
122 -delete data.IMEI;
123 -var modelname = "Dragino " + data.Model;
124 -//var mod = data.mod
125 -delete data.Model;
126 -//delete data.mod
127 -var timestamp = new Date().getTime();
59 +var deviceType = 'sensor';
128 128  
129 -for (var key in data) {
130 -
131 - if (Number(key)) {
132 - obj1[key] = data[key];
133 - obj1[key][obj1[key].length - 1] = Number(new Date(
134 - obj1[key][obj1[key].length - 1]));
135 -
136 - }
137 -//Alec submitted25/02/25
138 -//turn old key into new
139 - else if (key === "Reading") {
140 - objdata["reading"] = data[key];
141 - } else if (key === "work mode") {
142 - objdata["work_mode"] = data[key];
143 - } else if (key === "hum") {
144 - objdata["humidity"] = data[key];
145 - }else if (key === "hum2") {
146 - objdata["humidity2"] = data[key];
147 - } else if (key === "hum3") {
148 - objdata["humidity3"] = data[key];
149 - } else if (key === "tem") {
150 - objdata["temperature"] = data[key];
151 - } else if (key === "tem2") {
152 - objdata["temperature2"] = data[key];
153 - } else if (key === "tem3") {
154 - objdata["temperature3"] = data[key];
155 - } else if (key === "DS18B20_Temp") {
156 - objdata["temperature_pro"] = data[key];
157 - } else if (key === "ds18b20_temperature") {
158 - objdata["temperature_pro"] = data[key];
159 - } else if (key === "DS18B20_temperature_pro") {
160 - objdata["temperature_pro"] = data[key];
161 - } else if (key === "tdc send flag") {
162 - objdata["tdc_send_flag"] = data[key];
163 - } else if (key === "trigger mode") {
164 - objdata["trigger_mode"] = data[key];
165 - } else if (key === "soil dielectric constant") {
166 - objdata["soil_dielectric_constant"] = data[key];
167 - } else if (key === "door open num") {
168 - objdata["door_open_num"] = data[key];
169 - } else if (key === "door duration") {
170 - objdata["door_duration"] = data[key];
171 - } else if (key === "count time") {
172 - objdata["count_time"] = data[key];
173 - } else if (key === "last open time2") {
174 - objdata["last_open_time2"] = data[key];
175 - } else if (key === "last open time3") {
176 - objdata["last_open_time3"] = data[key];
177 - }
178 -//Alec submitted25/02/25
179 - else {
180 - objdata[key] = data[key]
181 - }
182 -}
183 -var listdata = [{
184 - "ts": timestamp,
185 - "values": objdata
186 -}]
187 -for (var key1 in obj1) {
188 - if (modelname == "Dragino RS485-NB") {
189 - listdata.push({
190 - "ts": obj1[key1][obj1[key1].length - 1],
191 - "values": {
192 - "Payload": obj1[key1][0],
193 - }
194 - })
195 - } else {
196 - listdata.push({
197 - "ts": obj1[key1][obj1[key1].length - 1],
198 - "values": {
199 - "values": obj1[key1]
200 - },
201 - })
202 - }
203 -}
61 +// Result object with device attributes/telemetry data
204 204  var result = {
205 -
206 206   deviceName: deviceName,
207 - deviceType: modelname,
64 + deviceType: deviceType,
208 208   attributes: {
209 - model: modelname,
210 - //customerName: "NB-CB",
211 - //groupName: "NB-CB",
212 - //integrationName: metadata['integrationName']
213 -
66 + integrationName: metadata['integrationName'],
214 214   },
215 - telemetry: listdata
216 -}
68 + telemetry: {
69 + temperature: data.temperature,
70 + humidity: data.humidity,
71 + }
72 +};
217 217  
218 -function decodeToString(payload) {
219 - return String.fromCharCode.apply(String, payload);
220 -}
74 +/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
221 221  
222 -function decodeToJson(payload) {
223 - // covert payload to string.
224 - var str = decodeToString(payload);
225 -
226 - // parse string to JSON
227 - var data = JSON.parse(str);
228 - return data;
229 -}
230 -
231 231  return result;
232 -
233 233  {{/code}}
234 234  
235 235  
236 236  Click on the **Add** button.
237 237  
238 -[[image:uplink-data-converter.png||height="529" width="500"]]
239 239  
240 240  
241 -You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
84 +[[image:add-uplink-data-converter.png||height="529" width="500"]]
242 242  
86 +
87 +You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
88 +
243 243  [[image:data-converter-list-showing-uplink-dc.png]]
244 244  
245 245  
... ... @@ -253,32 +253,41 @@
253 253  
254 254  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
255 255  
256 -Click on the **JavaScript** button. Now copy and paste the following JavaScript to the **Encoder function **section. This encoder function is valid for both NB and CB series devices.
102 +Click on the **TBEL** button if not selected it by default. Now copy and paste the following encoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This encoder function is compatible for both NB and CB series devices.
257 257  
258 258  
259 259  {{code language="JavaScript"}}
260 -function hexToBase64(hexString) {
261 - // 将16进制字符串两个字符转换为一个字节
262 - var bytes = hexString.match(/.{2}/g);
263 - // 对每个字节进行解析，并转换为对应的字符
264 - var binaryString = bytes.map(function(byte) {
265 - return String.fromCharCode(parseInt(byte, 16));
266 - }).join('');
267 -
268 - // 使用btoa进行base64编码
269 - return btoa(binaryString);
270 -}
106 +// Encode downlink data from incoming Rule Engine message
271 271  
108 +// msg - JSON message payload downlink message json
109 +// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
110 +// metadata - list of key-value pairs with additional data about the message
111 +// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
112 +
113 +/** Encoder **/
114 +
115 +var data = {};
116 +
117 +// Process data from incoming message and metadata
118 +
119 +data.tempFreq = msg.temperatureUploadFrequency;
120 +data.humFreq = msg.humidityUploadFrequency;
121 +
122 +data.devSerialNumber = metadata['ss_serialNumber'];
123 +
272 272  // Result object with encoded downlink payload
273 273  var result = {
126 +
274 274   // downlink data content type: JSON, TEXT or BINARY (base64 format)
275 - contentType: "BINARY",
128 + contentType: "JSON",
276 276  
277 277   // downlink data
278 - data:hexToBase64(metadata.shared_value)
131 + data: JSON.stringify(data),
279 279  
280 280   // Optional metadata object presented in key/value format
281 - //metadata: {}
134 + metadata: {
135 + topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
136 + }
282 282  
283 283  };
284 284  
... ... @@ -288,17 +288,20 @@
288 288  
289 289  Click on the **Add** button.
290 290  
291 -[[image:downlink-data-converter.png||height="530" width="500"]]
292 292  
293 293  
294 -You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
148 +[[image:add-downlink-data-converter.png||height="529" width="500"]]
295 295  
296 -[[image:data-converter-list.png]]
297 297  
151 +You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
298 298  
299 -= 4. Add Integration =
300 300  
301 301  
155 +[[image:data-converters-list.png]]
156 +
157 += 3. Add Integration =
158 +
159 +
302 302  In the left navigation, click **Integrations center**, and then click **Integrations**.
303 303  
304 304  On the **Integrations** page, click on the '**+**' button.
... ... @@ -343,13 +343,16 @@
343 343  
344 344  **Connection:**
345 345  
346 -* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
347 -* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
204 +* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
205 +* **Port**: 8883
348 348  * **Credentials**: Basic
349 -* **Username**: Access token (This is the access token you copied from the device)
350 -* **Password** - Leave it as blank
351 -* **Topic** - v1/devices/+/telemetry (sightly modify the topic 'v1/devices/me/telemetry' you copied from the device to enable receiving data from any 'device name')
352 -* **QoS** - 0-At most once
207 +* **Enable SSL**: YES
208 +* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
209 +* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
210 +* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
211 +* **QoS:** 0-At most once
212 +* **Clean session:** NO
213 +* **Retained**: NO
353 353  
354 354  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
355 355  
ThingsBoard-add-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
ThingsBoard-add-new-device.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -89.7 KB
Content
ThingsBoard-new-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -100.3 KB
Content
add-connection-success.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
add-integration-basic-settings.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -122.5 KB
Content
add-integration-connection.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -124.4 KB
Content
add-integration-downlink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -123.0 KB
Content
add-integration-uplink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -120.7 KB
Content
data-converter-list-page.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -190.8 KB
Content
data-converter-list-showing-uplink-dc.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -194.9 KB
Content
data-converter-list.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
device-list-empty.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
downlink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -207.8 KB
Content
integrations-list-added-pending.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
mqtt-command-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
mqtt-command-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
new-device-access-token.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
new-device-check-connectivity.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
new-device-device-details.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -88.4 KB
Content
new-device-telemetry-test.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
uplink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
virtual-device-active.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
add-downlink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +175.2 KB
Content
add-uplink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +174.1 KB
Content
create-new-converter-menu.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +31.5 KB
Content
data-converters-list-empty.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +260.7 KB
Content
data-converters-list.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +212.2 KB
Content