Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 65.1
edited by Xiaoling
on 2025/03/07 11:48
Change comment: There is no comment for this version
To version 16.1
edited by Dilisi S
on 2025/03/03 02:45
Change comment: Mar 2 edits - part 2

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Xiaoling
1 +XWiki.pradeeka
Content
... ... @@ -6,109 +6,46 @@
6 6  Draft Document
7 7  {{/warning}}
8 8  
9 += Introduction =
9 9  
11 +This document guides you on integrating Dragino -NB and -CB series devices with ThingsBoard. For this guide, we use ThingsBoard Cloud, which is one of the ThingsBoard versions that allows you to try it for free.
10 10  
11 11  
12 -= 1. Introduction =
14 += Add New Device =
13 13  
16 +In the left navigation, click **Entities** and then click **Devices**.
14 14  
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.
16 16  
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**.
19 +[[image:ThingsBoard-Device.png]]
18 18  
19 19  
20 -= 2. Add New Device =
22 +On the ‘**Devices**’ page, click on the ‘**+**’ button, and then click on the ‘**Add new device**’ from the dropdown menu.
21 21  
22 22  
23 -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.
24 -
25 -In the left navigation, click **Entities** and then click **Devices**.
26 -
27 -[[image:device-list-empty.png]]
28 -
29 -
30 -On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
31 -
32 32  [[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
33 33  
34 34  
35 -The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
36 36  
37 -Click on the **Next: Credentials** button.
29 += Data Converters =
38 38  
39 -[[image:new-device-device-details.png||height="529" width="500"]]
40 40  
32 +== Uplink ==
41 41  
42 -Click the **Access token** button if it is not selected by default.
34 +In the left navigation, click ‘Integrations center’, and then click ‘Data converters’.
43 43  
44 -Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
45 45  
46 -Click on the **Add** button.
37 +[[image:ThingsBoard-Data-Converters.png]]
47 47  
48 -[[image:new-device-access-token.png||height="528" width="500"]]
49 49  
40 +On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
50 50  
51 -Click on the **MQTT** button.
52 52  
53 -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.
54 -
55 -Copy the MQTT pub command in the '**Execute the following command**' section.
56 -
57 -{{code language="none"}}
58 -mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/me/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:25}"
59 -{{/code}}
60 -
61 -Note that the **State** is still shown as **'Inactive'** in the **Latest telemetry** section.
62 -
63 -[[image:new-device-check-connectivity.png||height="522" width="500"]]
64 -
65 -
66 -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.
67 -
68 -
69 -[[image:mqtt-command-1.png||height="228" width="700"]]
70 -
71 -
72 -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.
73 -
74 -
75 -[[image:new-device-telemetry-test.png||height="520" width="500"]]
76 -
77 -
78 -Send the same command again, only changing the **temperature** value, to see how the **Latest telemetry** section updates its data.
79 -
80 -Once you are done experimenting with this, close the window by clicking the **Close** button.
81 -
82 -
83 -[[image:mqtt-command-2.png||height="227" width="700"]]
84 -
85 -
86 -
87 -[[image:virtual-device-active.png]]
88 -
89 -
90 -= 3. Data Converters =
91 -
92 -
93 -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.
94 -
95 -
96 -== 3.1 Uplink ==
97 -
98 -
99 -In the left navigation, click **Integrations center**, and then click **Data converters**.
100 -
101 -[[image:data-converter-list-page.png]]
102 -
103 -
104 -On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
105 -
106 106  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
107 107  
108 108  
109 -The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
46 +The ‘Add data converter’ window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as ‘Uplink’.
110 110  
111 -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 ‘JavaScript’ button. Now copy and paste the following script to the ‘Decoder function’ section:
112 112  
113 113  {{code language="JavaScript"}}
114 114  //Version: 0.1
... ... @@ -233,28 +233,26 @@
233 233  
234 234  {{/code}}
235 235  
173 +Click on the ‘Add’ button.
236 236  
237 -Click on the **Add** button.
238 238  
239 -[[image:uplink-data-converter.png||height="529" width="500"]]
176 +[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
240 240  
241 241  
242 -You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
179 +The uplink data converter is added to ThingsBoard and appears on the ‘Data Converters’ page
243 243  
244 -[[image:data-converter-list-showing-uplink-dc.png]]
245 245  
182 +== Downlink ==
246 246  
247 -== 3.2 Downlink ==
184 +On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
248 248  
249 249  
250 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
251 -
252 252  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
253 253  
254 254  
255 -The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
190 +The ‘**Add data converter**’ window will appear. Name it ‘**UDP 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.
192 +Click on the ‘**JavaScript**’ button. Now copy and paste the following script to the ‘**Encoder function**’ section:
258 258  
259 259  
260 260  {{code language="JavaScript"}}
... ... @@ -289,97 +289,81 @@
289 289  
290 290  Click on the **Add** button.
291 291  
292 -[[image:downlink-data-converter.png||height="530" width="500"]]
293 293  
228 +[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
294 294  
295 -You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
296 296  
297 -[[image:data-converter-list.png]]
231 += Add Integration =
298 298  
233 +In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
299 299  
300 -= 4. Add Integration =
235 +On the ‘Integrations’ page, click on the “+” button.
301 301  
302 302  
303 -In the left navigation, click **Integrations center**, and then click **Integrations**.
238 +[[image:ThingsBoard-add-integration.png]]
304 304  
305 -On the **Integrations** page, click on the '**+**' button.
306 306  
307 -[[image:data-converter-list-page.png]]
241 +The ‘Add integration’ window appears.
308 308  
243 +In the Add Integration window, configure the following settings:
309 309  
310 -The **Add integration** window appears.
311 -
312 -In the **Add integration** window, configure the following settings:
313 -
314 -
315 315  **Basic settings:**
316 316  
317 -* **Integration type**: MQTT
318 -* **Name**: MQTT integration NB/CB
247 +* **Integration type**: UDP
248 +* **Name**: UDP Integration NB/CB
319 319  
320 320  Click **Next** button.
321 321  
252 +
322 322  [[image:add-integration-basic-settings.png||height="511" width="500"]]
323 323  
324 324  
325 325  **Uplink data converter:**
326 326  
327 -* Click on the **Select existing** button.
328 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
258 +* Click on the ‘**Select existing**’ button.
259 +* Uplink data converter: Select ‘**UDP Uplink Converter NB/CB**’ from the dropdown list.
329 329  
330 330  Click **Next** button.
331 331  
332 -[[image:add-integration-uplink-data-converter.png||width="500"]]
333 333  
264 +[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
334 334  
266 +
335 335  **Downlink data converter:**
336 336  
337 -* Click on the **Select existing** button.
338 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
269 +* Click on the ‘**Select existing**’ button.
270 +* Downlink data converter: Select ‘**UDP Downlink Converter NB/CB**’ from the dropdown list.
339 339  
272 +
340 340  Click **Next** button.
341 341  
342 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
343 343  
276 +[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
344 344  
278 +
345 345  **Connection:**
346 346  
347 -* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
348 -* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
349 -* **Credentials**: Basic
350 -* **Username**: Access token (This is the access token you copied from the device)
351 -* **Password** - Leave it as blank
352 -* **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')
353 -* **QoS** - 0-At most once
281 +**Port**: 11582
354 354  
355 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
283 +**Size of the buffer for inbound socket (in KB)**: 64
356 356  
357 -[[image:add-integration-connection.png||width="500"]]
285 +**Cache Size**: 10000000
358 358  
287 +**Cache time to live in minutes**: 1440
359 359  
360 -If the connection is successful, you will see the **Connected** message.
361 361  
290 +Copy the two keys, **Integration key** and **Integration secret** into a text editor, as you will need them in the section ‘xxxxx’.
291 +
362 362  Click on the **Add** button.
363 363  
364 -[[image:add-connection-success.png||height="511" width="500"]]
365 365  
295 +[[image:add-integration-connection.png||height="511" width="500"]]
366 366  
367 -You should see that the newly added integration is listed on the **Integrations** page.
368 368  
369 -Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
370 370  
371 -[[image:integrations-list-added-pending.png]]
299 += Verifying the receipt of data from the device =
372 372  
301 +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.
373 373  
374 -= 5. Verifying the receipt of data from the device =
375 375  
376 -
377 -On the terminal, issue the following MQTT command which simulates the device S31B-NB.
378 -
379 -{{code language="none"}}
380 -mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
381 -{{/code}}
382 -
383 -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.
384 -
385 385  
add-connection-success.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 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
ThingsBoard-Data-Converters.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +100.3 KB
Content
ThingsBoard-Device.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +225.5 KB
Content
ThingsBoard-add-data-converter-downlink.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content
ThingsBoard-add-data-converter-uplink.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content
ThingsBoard-add-integration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content