Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 64.1
edited by Dilisi S
on 2025/03/07 00:17
Change comment: Mar 6 edits - part 2
To version 95.1
edited by Dilisi S
on 2025/03/08 04:07
Change comment: Uploaded new attachment "data-converter-list-showing-uplink-dc.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -6,280 +6,135 @@
6 6  Draft Document
7 7  {{/warning}}
8 8  
9 -= Introduction =
10 10  
11 -This document guides you on integrating Dragino **-NB** and **-CB** series devices data with ThingsBoard. For this guide, we use ThingsBoard Cloud, which is one of the ThingsBoard versions that allows you to try it for free.
12 12  
13 -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**.
14 14  
12 += 1. Introduction =
15 15  
16 -= Add New Device =
17 17  
18 -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.
15 +This document guides you on integrating Dragino **-NB** and **-CB** series devices data with ThingsBoard. For this guide, we use ThingsBoard Cloud, which is one of the ThingsBoard versions that allows you to try it for free.
19 19  
20 -In the left navigation, click **Entities** and then click **Devices**.
17 +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**.
21 21  
22 22  
23 -[[image:device-list-empty.png]]
24 24  
25 25  
26 -On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
27 27  
23 += 2. Data Converters =
28 28  
29 -[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
30 30  
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.
31 31  
32 -The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
33 33  
34 -Click on the **Next: Credentials** button.
29 +== 2.1 Uplink ==
35 35  
36 36  
37 -[[image:new-device-device-details.png||height="529" width="500"]]
32 +In the left navigation, click **Integrations center**, and then click **Data converters**.
38 38  
39 39  
40 -Click the **Access token** button if it is not selected by default.
41 41  
42 -Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
36 +[[image:data-converters-list-empty.png]]
43 43  
44 -Click on the **Add** button.
45 45  
46 -[[image:new-device-access-token.png||height="528" width="500"]]
39 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
47 47  
48 48  
49 -Click on the **MQTT** button.
50 50  
51 -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.
43 +[[image:create-new-converter-menu.png||height="259" width="500"]]
52 52  
53 -Copy the MQTT pub command in the '**Execute the following command**' section.
54 54  
55 -{{code language="none"}}
56 -mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/me/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:25}"
57 -{{/code}}
58 -
59 -Note that the **State** is still shown as **'Inactive'** in the **Latest telemetry** section.
60 -
61 -[[image:new-device-check-connectivity.png||height="522" width="500"]]
62 -
63 -
64 -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.
65 -
66 -
67 -[[image:mqtt-command-1.png||height="228" width="700"]]
68 -
69 -
70 -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.
71 -
72 -
73 -[[image:new-device-telemetry-test.png||height="520" width="500"]]
74 -
75 -
76 -Send the same command again, only changing the **temperature** value, to see how the **Latest telemetry** section updates its data.
77 -
78 -Once you are done experimenting with this, close the window by clicking the **Close** button.
79 -
80 -
81 -[[image:mqtt-command-2.png||height="227" width="700"]]
82 -
83 -
84 -
85 -[[image:virtual-device-active.png]]
86 -
87 -
88 -= Data Converters =
89 -
90 -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.
91 -
92 -
93 -== Uplink ==
94 -
95 -In the left navigation, click **Integrations center**, and then click **Data converters**.
96 -
97 -
98 -[[image:data-converter-list-page.png]]
99 -
100 -
101 -On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
102 -
103 -
104 -[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
105 -
106 -
107 107  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
108 108  
109 -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.
110 110  
111 111  {{code language="JavaScript"}}
112 -//Version: 0.1
51 +/** Decoder **/
52 +
113 113  // decode payload to string
114 114  var payloadStr = decodeToString(payload);
55 +var data = JSON.parse(payloadStr);
115 115  
57 +var deviceName = metadata.topic.split("/")[3];
116 116  // decode payload to JSON
117 -var objdata = {};
118 -var obj1 = {};
119 -var data = decodeToJson(payload);
120 -var deviceName = data.IMEI;
121 -delete data.IMEI;
122 -var modelname = "Dragino " + data.Model;
123 -//var mod = data.mod
124 -delete data.Model;
125 -//delete data.mod
126 -var timestamp = new Date().getTime();
59 +var deviceType = 'sensor';
127 127  
128 -for (var key in data) {
129 -
130 - if (Number(key)) {
131 - obj1[key] = data[key];
132 - obj1[key][obj1[key].length - 1] = Number(new Date(
133 - obj1[key][obj1[key].length - 1]));
134 -
135 - }
136 -//Alec submitted25/02/25
137 -//turn old key into new
138 - else if (key === "Reading") {
139 - objdata["reading"] = data[key];
140 - } else if (key === "work mode") {
141 - objdata["work_mode"] = data[key];
142 - } else if (key === "hum") {
143 - objdata["humidity"] = data[key];
144 - }else if (key === "hum2") {
145 - objdata["humidity2"] = data[key];
146 - } else if (key === "hum3") {
147 - objdata["humidity3"] = data[key];
148 - } else if (key === "tem") {
149 - objdata["temperature"] = data[key];
150 - } else if (key === "tem2") {
151 - objdata["temperature2"] = data[key];
152 - } else if (key === "tem3") {
153 - objdata["temperature3"] = data[key];
154 - } else if (key === "DS18B20_Temp") {
155 - objdata["temperature_pro"] = data[key];
156 - } else if (key === "ds18b20_temperature") {
157 - objdata["temperature_pro"] = data[key];
158 - } else if (key === "DS18B20_temperature_pro") {
159 - objdata["temperature_pro"] = data[key];
160 - } else if (key === "tdc send flag") {
161 - objdata["tdc_send_flag"] = data[key];
162 - } else if (key === "trigger mode") {
163 - objdata["trigger_mode"] = data[key];
164 - } else if (key === "soil dielectric constant") {
165 - objdata["soil_dielectric_constant"] = data[key];
166 - } else if (key === "door open num") {
167 - objdata["door_open_num"] = data[key];
168 - } else if (key === "door duration") {
169 - objdata["door_duration"] = data[key];
170 - } else if (key === "count time") {
171 - objdata["count_time"] = data[key];
172 - } else if (key === "last open time2") {
173 - objdata["last_open_time2"] = data[key];
174 - } else if (key === "last open time3") {
175 - objdata["last_open_time3"] = data[key];
176 - }
177 -//Alec submitted25/02/25
178 - else {
179 - objdata[key] = data[key]
180 - }
181 -}
182 -var listdata = [{
183 - "ts": timestamp,
184 - "values": objdata
185 -}]
186 -for (var key1 in obj1) {
187 - if (modelname == "Dragino RS485-NB") {
188 - listdata.push({
189 - "ts": obj1[key1][obj1[key1].length - 1],
190 - "values": {
191 - "Payload": obj1[key1][0],
192 - }
193 - })
194 - } else {
195 - listdata.push({
196 - "ts": obj1[key1][obj1[key1].length - 1],
197 - "values": {
198 - "values": obj1[key1]
199 - },
200 - })
201 - }
202 -}
61 +// Result object with device attributes/telemetry data
203 203  var result = {
204 -
205 205   deviceName: deviceName,
206 - deviceType: modelname,
64 + deviceType: deviceType,
207 207   attributes: {
208 - model: modelname,
209 - //customerName: "NB-CB",
210 - //groupName: "NB-CB",
211 - //integrationName: metadata['integrationName']
212 -
66 + integrationName: metadata['integrationName'],
213 213   },
214 - telemetry: listdata
215 -}
68 + telemetry: {
69 + temperature: data.temperature,
70 + humidity: data.humidity,
71 + }
72 +};
216 216  
217 -function decodeToString(payload) {
218 - return String.fromCharCode.apply(String, payload);
219 -}
74 +/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
220 220  
221 -function decodeToJson(payload) {
222 - // covert payload to string.
223 - var str = decodeToString(payload);
224 -
225 - // parse string to JSON
226 - var data = JSON.parse(str);
227 - return data;
228 -}
229 -
230 230  return result;
231 -
232 232  {{/code}}
233 233  
79 +
234 234  Click on the **Add** button.
235 235  
236 236  
237 -[[image:uplink-data-converter.png||height="529" width="500"]]
238 238  
84 +[[image:add-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.
87 +You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
242 242  
243 243  
244 -[[image:data-converter-list-showing-uplink-dc.png]]
245 245  
91 +[[image:create-new-converter-menu.png||width="500"]]
246 246  
247 -== Downlink ==
93 +== 3.2 Downlink ==
248 248  
95 +
249 249  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
250 250  
251 -
252 252  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
253 253  
254 254  
255 255  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
256 256  
257 -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.
103 +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.
258 258  
259 259  
260 260  {{code language="JavaScript"}}
261 -function hexToBase64(hexString) {
262 - // 将16进制字符串两个字符转换为一个字节
263 - var bytes = hexString.match(/.{2}/g);
264 - // 对每个字节进行解析，并转换为对应的字符
265 - var binaryString = bytes.map(function(byte) {
266 - return String.fromCharCode(parseInt(byte, 16));
267 - }).join('');
268 -
269 - // 使用btoa进行base64编码
270 - return btoa(binaryString);
271 -}
107 +// Encode downlink data from incoming Rule Engine message
272 272  
109 +// msg - JSON message payload downlink message json
110 +// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
111 +// metadata - list of key-value pairs with additional data about the message
112 +// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
113 +
114 +/** Encoder **/
115 +
116 +var data = {};
117 +
118 +// Process data from incoming message and metadata
119 +
120 +data.tempFreq = msg.temperatureUploadFrequency;
121 +data.humFreq = msg.humidityUploadFrequency;
122 +
123 +data.devSerialNumber = metadata['ss_serialNumber'];
124 +
273 273  // Result object with encoded downlink payload
274 274  var result = {
127 +
275 275   // downlink data content type: JSON, TEXT or BINARY (base64 format)
276 - contentType: "BINARY",
129 + contentType: "JSON",
277 277  
278 278   // downlink data
279 - data:hexToBase64(metadata.shared_value)
132 + data: JSON.stringify(data),
280 280  
281 281   // Optional metadata object presented in key/value format
282 - //metadata: {}
135 + metadata: {
136 + topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
137 + }
283 283  
284 284  };
285 285  
... ... @@ -290,23 +290,23 @@
290 290  Click on the **Add** button.
291 291  
292 292  
293 -[[image:downlink-data-converter.png||height="530" width="500"]]
294 294  
149 +[[image:add-downlink-data-converter.png||height="529" width="500"]]
295 295  
296 296  
297 -You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
152 +You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
298 298  
299 299  
300 -[[image:data-converter-list.png]]
301 301  
156 +[[image:data-converters-list.png]]
302 302  
303 -= Add Integration =
158 += 3. Add Integration =
304 304  
160 +
305 305  In the left navigation, click **Integrations center**, and then click **Integrations**.
306 306  
307 307  On the **Integrations** page, click on the '**+**' button.
308 308  
309 -
310 310  [[image:data-converter-list-page.png]]
311 311  
312 312  
... ... @@ -322,11 +322,9 @@
322 322  
323 323  Click **Next** button.
324 324  
325 -
326 326  [[image:add-integration-basic-settings.png||height="511" width="500"]]
327 327  
328 328  
329 -
330 330  **Uplink data converter:**
331 331  
332 332  * Click on the **Select existing** button.
... ... @@ -334,11 +334,9 @@
334 334  
335 335  Click **Next** button.
336 336  
337 -
338 338  [[image:add-integration-uplink-data-converter.png||width="500"]]
339 339  
340 340  
341 -
342 342  **Downlink data converter:**
343 343  
344 344  * Click on the **Select existing** button.
... ... @@ -346,24 +346,24 @@
346 346  
347 347  Click **Next** button.
348 348  
349 -
350 350  [[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
351 351  
352 352  
353 -
354 354  **Connection:**
355 355  
356 -* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
357 -* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
205 +* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
206 +* **Port**: 8883
358 358  * **Credentials**: Basic
359 -* **Username**: Access token (This is the access token you copied from the device)
360 -* **Password** - Leave it as blank
361 -* **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')
362 -* **QoS** - 0-At most once
208 +* **Enable SSL**: YES
209 +* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
210 +* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
211 +* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
212 +* **QoS:** 0-At most once
213 +* **Clean session:** NO
214 +* **Retained**: NO
363 363  
364 364  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
365 365  
366 -
367 367  [[image:add-integration-connection.png||width="500"]]
368 368  
369 369  
... ... @@ -371,7 +371,6 @@
371 371  
372 372  Click on the **Add** button.
373 373  
374 -
375 375  [[image:add-connection-success.png||height="511" width="500"]]
376 376  
377 377  
... ... @@ -379,18 +379,17 @@
379 379  
380 380  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
381 381  
382 -
383 -
384 384  [[image:integrations-list-added-pending.png]]
385 385  
386 386  
387 -= Verifying the receipt of data from the device =
235 += 5. Verifying the receipt of data from the device =
388 388  
237 +
389 389  On the terminal, issue the following MQTT command which simulates the device S31B-NB.
390 390  
391 -
392 392  {{code language="none"}}
393 393  mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
394 394  {{/code}}
395 395  
396 396  If the integration was performed without errors, after the transmission of the first telemetry, a new device with the name “S31B-NB” will appear in the Devices → All. Also, you can verify the input and output data, respectively, before and after conversion in Data converters → UDP Uplink Converter NB/CB → Events.
245 +
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.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