Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 62.1
edited by Dilisi S
on 2025/03/06 13:28
Change comment: Uploaded new attachment "virtual-device-active.png", version {1}
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
Content
... ... @@ -6,276 +6,134 @@
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.
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 -= Data Converters =
85 -
86 -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.
87 -
88 -
89 -== Uplink ==
90 -
91 -In the left navigation, click **Integrations center**, and then click **Data converters**.
92 -
93 -
94 -[[image:data-converter-list-page.png]]
95 -
96 -
97 -On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
98 -
99 -
100 -[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
101 -
102 -
103 103  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
104 104  
105 -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.
106 106  
107 107  {{code language="JavaScript"}}
108 -//Version: 0.1
51 +/** Decoder **/
52 +
109 109  // decode payload to string
110 110  var payloadStr = decodeToString(payload);
55 +var data = JSON.parse(payloadStr);
111 111  
57 +var deviceName = metadata.topic.split("/")[3];
112 112  // decode payload to JSON
113 -var objdata = {};
114 -var obj1 = {};
115 -var data = decodeToJson(payload);
116 -var deviceName = data.IMEI;
117 -delete data.IMEI;
118 -var modelname = "Dragino " + data.Model;
119 -//var mod = data.mod
120 -delete data.Model;
121 -//delete data.mod
122 -var timestamp = new Date().getTime();
59 +var deviceType = 'sensor';
123 123  
124 -for (var key in data) {
125 -
126 - if (Number(key)) {
127 - obj1[key] = data[key];
128 - obj1[key][obj1[key].length - 1] = Number(new Date(
129 - obj1[key][obj1[key].length - 1]));
130 -
131 - }
132 -//Alec submitted25/02/25
133 -//turn old key into new
134 - else if (key === "Reading") {
135 - objdata["reading"] = data[key];
136 - } else if (key === "work mode") {
137 - objdata["work_mode"] = data[key];
138 - } else if (key === "hum") {
139 - objdata["humidity"] = data[key];
140 - }else if (key === "hum2") {
141 - objdata["humidity2"] = data[key];
142 - } else if (key === "hum3") {
143 - objdata["humidity3"] = data[key];
144 - } else if (key === "tem") {
145 - objdata["temperature"] = data[key];
146 - } else if (key === "tem2") {
147 - objdata["temperature2"] = data[key];
148 - } else if (key === "tem3") {
149 - objdata["temperature3"] = data[key];
150 - } else if (key === "DS18B20_Temp") {
151 - objdata["temperature_pro"] = data[key];
152 - } else if (key === "ds18b20_temperature") {
153 - objdata["temperature_pro"] = data[key];
154 - } else if (key === "DS18B20_temperature_pro") {
155 - objdata["temperature_pro"] = data[key];
156 - } else if (key === "tdc send flag") {
157 - objdata["tdc_send_flag"] = data[key];
158 - } else if (key === "trigger mode") {
159 - objdata["trigger_mode"] = data[key];
160 - } else if (key === "soil dielectric constant") {
161 - objdata["soil_dielectric_constant"] = data[key];
162 - } else if (key === "door open num") {
163 - objdata["door_open_num"] = data[key];
164 - } else if (key === "door duration") {
165 - objdata["door_duration"] = data[key];
166 - } else if (key === "count time") {
167 - objdata["count_time"] = data[key];
168 - } else if (key === "last open time2") {
169 - objdata["last_open_time2"] = data[key];
170 - } else if (key === "last open time3") {
171 - objdata["last_open_time3"] = data[key];
172 - }
173 -//Alec submitted25/02/25
174 - else {
175 - objdata[key] = data[key]
176 - }
177 -}
178 -var listdata = [{
179 - "ts": timestamp,
180 - "values": objdata
181 -}]
182 -for (var key1 in obj1) {
183 - if (modelname == "Dragino RS485-NB") {
184 - listdata.push({
185 - "ts": obj1[key1][obj1[key1].length - 1],
186 - "values": {
187 - "Payload": obj1[key1][0],
188 - }
189 - })
190 - } else {
191 - listdata.push({
192 - "ts": obj1[key1][obj1[key1].length - 1],
193 - "values": {
194 - "values": obj1[key1]
195 - },
196 - })
197 - }
198 -}
61 +// Result object with device attributes/telemetry data
199 199  var result = {
200 -
201 201   deviceName: deviceName,
202 - deviceType: modelname,
64 + deviceType: deviceType,
203 203   attributes: {
204 - model: modelname,
205 - //customerName: "NB-CB",
206 - //groupName: "NB-CB",
207 - //integrationName: metadata['integrationName']
208 -
66 + integrationName: metadata['integrationName'],
209 209   },
210 - telemetry: listdata
211 -}
68 + telemetry: {
69 + temperature: data.temperature,
70 + humidity: data.humidity,
71 + }
72 +};
212 212  
213 -function decodeToString(payload) {
214 - return String.fromCharCode.apply(String, payload);
215 -}
74 +/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
216 216  
217 -function decodeToJson(payload) {
218 - // covert payload to string.
219 - var str = decodeToString(payload);
220 -
221 - // parse string to JSON
222 - var data = JSON.parse(str);
223 - return data;
224 -}
225 -
226 226  return result;
227 -
228 228  {{/code}}
229 229  
79 +
230 230  Click on the **Add** button.
231 231  
232 232  
233 -[[image:uplink-data-converter.png||height="529" width="500"]]
234 234  
84 +[[image:add-uplink-data-converter.png||height="529" width="500"]]
235 235  
236 236  
237 -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.
238 238  
239 -
240 240  [[image:data-converter-list-showing-uplink-dc.png]]
241 241  
242 242  
243 -== Downlink ==
92 +== 3.2 Downlink ==
244 244  
94 +
245 245  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
246 246  
247 -
248 248  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
249 249  
250 250  
251 251  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
252 252  
253 -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.
254 254  
255 255  
256 256  {{code language="JavaScript"}}
257 -function hexToBase64(hexString) {
258 - // 将16进制字符串两个字符转换为一个字节
259 - var bytes = hexString.match(/.{2}/g);
260 - // 对每个字节进行解析，并转换为对应的字符
261 - var binaryString = bytes.map(function(byte) {
262 - return String.fromCharCode(parseInt(byte, 16));
263 - }).join('');
264 -
265 - // 使用btoa进行base64编码
266 - return btoa(binaryString);
267 -}
106 +// Encode downlink data from incoming Rule Engine message
268 268  
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 +
269 269  // Result object with encoded downlink payload
270 270  var result = {
126 +
271 271   // downlink data content type: JSON, TEXT or BINARY (base64 format)
272 - contentType: "BINARY",
128 + contentType: "JSON",
273 273  
274 274   // downlink data
275 - data:hexToBase64(metadata.shared_value)
131 + data: JSON.stringify(data),
276 276  
277 277   // Optional metadata object presented in key/value format
278 - //metadata: {}
134 + metadata: {
135 + topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
136 + }
279 279  
280 280  };
281 281  
... ... @@ -286,23 +286,23 @@
286 286  Click on the **Add** button.
287 287  
288 288  
289 -[[image:downlink-data-converter.png||height="530" width="500"]]
290 290  
148 +[[image:add-downlink-data-converter.png||height="529" width="500"]]
291 291  
292 292  
293 -You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
151 +You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
294 294  
295 295  
296 -[[image:data-converter-list.png]]
297 297  
155 +[[image:data-converters-list.png]]
298 298  
299 -= Add Integration =
157 += 3. Add Integration =
300 300  
159 +
301 301  In the left navigation, click **Integrations center**, and then click **Integrations**.
302 302  
303 303  On the **Integrations** page, click on the '**+**' button.
304 304  
305 -
306 306  [[image:data-converter-list-page.png]]
307 307  
308 308  
... ... @@ -318,11 +318,9 @@
318 318  
319 319  Click **Next** button.
320 320  
321 -
322 322  [[image:add-integration-basic-settings.png||height="511" width="500"]]
323 323  
324 324  
325 -
326 326  **Uplink data converter:**
327 327  
328 328  * Click on the **Select existing** button.
... ... @@ -330,11 +330,9 @@
330 330  
331 331  Click **Next** button.
332 332  
333 -
334 334  [[image:add-integration-uplink-data-converter.png||width="500"]]
335 335  
336 336  
337 -
338 338  **Downlink data converter:**
339 339  
340 340  * Click on the **Select existing** button.
... ... @@ -342,24 +342,24 @@
342 342  
343 343  Click **Next** button.
344 344  
345 -
346 346  [[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
347 347  
348 348  
349 -
350 350  **Connection:**
351 351  
352 -* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
353 -* **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
354 354  * **Credentials**: Basic
355 -* **Username**: Access token (This is the access token you copied from the device)
356 -* **Password** - Leave it as blank
357 -* **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')
358 -* **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
359 359  
360 360  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
361 361  
362 -
363 363  [[image:add-integration-connection.png||width="500"]]
364 364  
365 365  
... ... @@ -367,7 +367,6 @@
367 367  
368 368  Click on the **Add** button.
369 369  
370 -
371 371  [[image:add-connection-success.png||height="511" width="500"]]
372 372  
373 373  
... ... @@ -375,11 +375,18 @@
375 375  
376 376  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
377 377  
231 +[[image:integrations-list-added-pending.png]]
378 378  
379 379  
380 -[[image:integrations-list-added-pending.png]]
234 += 5. Verifying the receipt of data from the device =
381 381  
382 382  
383 -= Verifying the receipt of data from the device =
237 +On the terminal, issue the following MQTT command which simulates the device S31B-NB.
384 384  
385 -Connect **S31B-NB** to transfer information. If the integration was performed without errors, after the transmission of the first telemetry, a new device with the name “xxxxx” 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.
239 +{{code language="none"}}
240 +mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
241 +{{/code}}
242 +
243 +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.
244 +
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-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