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 34.1
edited by Dilisi S
on 2025/03/04 19:32
Change comment: Deleted image "Data-converter-list.png"

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Xiaoling
1 +XWiki.pradeeka
Content
... ... @@ -6,24 +6,21 @@
6 6  Draft Document
7 7  {{/warning}}
8 8  
9 -= 1. Introduction =
9 += Introduction =
10 10  
11 -
12 12  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.
13 13  
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 =
16 += Add New Device =
18 18  
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 -
22 22  In the left navigation, click **Entities** and then click **Devices**.
23 23  
24 -[[image:device-list-empty.png]]
25 25  
21 +[[image:ThingsBoard-Device.png]]
26 26  
23 +
27 27  On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
28 28  
29 29  
... ... @@ -30,82 +30,27 @@
30 30  [[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
31 31  
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.
31 += Data Converters =
36 36  
37 -
38 -[[image:new-device-device-details.png||height="529" width="500"]]
39 -
40 -
41 -Click the **Access token** button if it is not selected by default.
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 -
45 -Click on the **Add** button.
46 -
47 -[[image:new-device-access-token.png||height="528" width="500"]]
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 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 93  
94 94  
95 -== 3.1 Uplink ==
36 +== Uplink ==
96 96  
97 -
98 98  In the left navigation, click **Integrations center**, and then click **Data converters**.
99 99  
100 -[[image:data-converter-list-page.png]]
101 101  
41 +[[image:ThingsBoard-Data-Converters.png]]
102 102  
43 +
103 103  On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
104 104  
46 +
105 105  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
106 106  
107 107  
108 -The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
50 +The **Add data converter** window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as **Uplink**.
109 109  
110 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.
111 111  
... ... @@ -232,26 +232,27 @@
232 232  
233 233  {{/code}}
234 234  
235 -
236 236  Click on the **Add** button.
237 237  
238 -[[image:uplink-data-converter.png||height="529" width="500"]]
239 239  
180 +[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
240 240  
182 +
241 241  You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
242 242  
243 -[[image:data-converter-list-showing-uplink-dc.png]]
244 244  
186 +[[image:Data-converter-list-uplink-only.png]]
245 245  
246 -== 3.2 Downlink ==
247 247  
189 +== Downlink ==
248 248  
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  
193 +
251 251  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
252 252  
253 253  
254 -The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
197 +The **Add data converter** window will appear. Name it ‘**UDP Downlink Converter NB/CB**’ and select the Type as **Downlink**.
255 255  
256 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.
257 257  
... ... @@ -288,24 +288,26 @@
288 288  
289 289  Click on the **Add** button.
290 290  
291 -[[image:downlink-data-converter.png||height="530" width="500"]]
292 292  
235 +[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
293 293  
237 +
294 294  You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
295 295  
296 -[[image:data-converter-list.png]]
297 297  
241 +[[image:Data-converter-list.png]]
298 298  
299 -= 4. Add Integration =
300 300  
244 += Add Integration =
301 301  
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.
305 305  
306 -[[image:data-converter-list-page.png]]
307 307  
251 +[[image:ThingsBoard-add-integration.png]]
308 308  
253 +
309 309  The **Add integration** window appears.
310 310  
311 311  In the **Add integration** window, configure the following settings:
... ... @@ -313,11 +313,12 @@
313 313  
314 314  **Basic settings:**
315 315  
316 -* **Integration type**: MQTT
317 -* **Name**: MQTT integration NB/CB
261 +* **Integration type**: UDP
262 +* **Name**: UDP Integration NB/CB
318 318  
319 319  Click **Next** button.
320 320  
266 +
321 321  [[image:add-integration-basic-settings.png||height="511" width="500"]]
322 322  
323 323  
... ... @@ -324,61 +324,50 @@
324 324  **Uplink data converter:**
325 325  
326 326  * Click on the **Select existing** button.
327 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
273 +* **Uplink data converter**: Select **UDP Uplink Converter NB/CB **from the dropdown list.
328 328  
329 329  Click **Next** button.
330 330  
331 -[[image:add-integration-uplink-data-converter.png||width="500"]]
332 332  
278 +[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
333 333  
280 +
334 334  **Downlink data converter:**
335 335  
336 336  * Click on the **Select existing** button.
337 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
284 +* **Downlink data converter**: Select **UDP Downlink Converter NB/CB **from the dropdown list.
338 338  
339 339  Click **Next** button.
340 340  
341 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
342 342  
289 +[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
343 343  
291 +
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)
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
294 +* **Port**: 11582
295 +* **Size of the buffer for inbound socket (in KB)**: 64
296 +* **Cache Size**: 10000000
297 +* **Cache time to live in minutes**: 1440
353 353  
354 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
299 +Copy the two keys, **Integration key** and **Integration secret** into a text editor, as you will need them in the section ‘xxxxx’.
355 355  
356 -[[image:add-integration-connection.png||width="500"]]
357 -
358 -
359 -If the connection is successful, you will see the **Connected** message.
360 -
361 361  Click on the **Add** button.
362 362  
363 -[[image:add-connection-success.png||height="511" width="500"]]
364 364  
304 +[[image:add-integration-connection.png||height="511" width="500"]]
365 365  
306 +
366 366  You should see that the newly added integration is listed on the **Integrations** page.
367 367  
368 368  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
369 369  
370 -[[image:integrations-list-added-pending.png]]
311 +[[image:Integrations-list.png]]
371 371  
372 372  
373 -= 5. Verifying the receipt of data from the device =
314 += Verifying the receipt of data from the device =
374 374  
316 +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.
375 375  
376 -On the terminal, issue the following MQTT command which simulates the device S31B-NB.
377 377  
378 -{{code language="none"}}
379 -mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
380 -{{/code}}
381 -
382 -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.
383 -
384 384  
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.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
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
virtual-device-active.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 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-integration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content