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 13.1
edited by Dilisi S
on 2025/03/03 02:38
Change comment: Uploaded new attachment "add-integration-uplink-data-converter.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -2,111 +2,47 @@
2 2  
3 3  {{toc/}}
4 4  
5 -{{warning}}
6 -Draft Document
7 -{{/warning}}
8 8  
9 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.
8 +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.
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  
15 -
16 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.
19 -
20 20  In the left navigation, click **Entities** and then click **Devices**.
21 21  
22 22  
23 -[[image:device-list-empty.png]]
16 +[[image:ThingsBoard-Device.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.
19 +On the ‘**Devices**’ page, click on the ‘**+**’ button, and then click on the ‘**Add new device**’ from the dropdown menu.
27 27  
28 28  
29 29  [[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
30 30  
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.
35 -
36 -
37 -[[image:new-device-device-details.png||height="529" width="500"]]
38 -
39 -
40 -Click the **Access token** button if it is not selected by default.
41 -
42 -Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
43 -
44 -Click on the **Add** button.
45 -
46 -[[image:new-device-access-token.png||height="528" width="500"]]
47 -
48 -
49 -Click on the **MQTT** button.
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.
52 -
53 -Copy the MQTT pub command in the '**Execute the following command**' section.
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 88  = Data Converters =
89 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 91  
92 -
93 93  == Uplink ==
94 94  
95 -In the left navigation, click **Integrations center**, and then click **Data converters**.
31 +In the left navigation, click ‘Integrations center’, and then click ‘Data converters’.
96 96  
97 97  
98 -[[image:data-converter-list-page.png]]
34 +[[image:ThingsBoard-Data-Converters.png]]
99 99  
100 100  
101 -On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
37 +On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
102 102  
103 103  
104 104  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
105 105  
106 106  
107 -The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
43 +The ‘Add data converter’ window will appear. Name it ‘**UDP 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.
45 +Click on the ‘JavaScript’ button. Now copy and paste the following script to the ‘Decoder function’ section:
110 110  
111 111  {{code language="JavaScript"}}
112 112  //Version: 0.1
... ... @@ -231,30 +231,26 @@
231 231  
232 232  {{/code}}
233 233  
234 -Click on the **Add** button.
170 +Click on the ‘Add’ button.
235 235  
236 236  
237 -[[image:uplink-data-converter.png||height="529" width="500"]]
173 +[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
238 238  
239 239  
176 +The uplink data converter is added to ThingsBoard and appears on the ‘Data Converters’ page
240 240  
241 -You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
242 242  
243 -
244 -[[image:data-converter-list-showing-uplink-dc.png]]
245 -
246 -
247 247  == Downlink ==
248 248  
249 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
181 +On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
250 250  
251 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**.
187 +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.
189 +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"}}
... ... @@ -290,107 +290,32 @@
290 290  Click on the **Add** button.
291 291  
292 292  
293 -[[image:downlink-data-converter.png||height="530" width="500"]]
225 +[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
294 294  
295 295  
296 -
297 -You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
298 -
299 -
300 -[[image:data-converter-list.png]]
301 -
302 -
303 303  = Add Integration =
304 304  
305 -In the left navigation, click **Integrations center**, and then click **Integrations**.
230 +In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
306 306  
307 -On the **Integrations** page, click on the '**+**' button.
232 +On the ‘Integrations’ page, click on the “+” button.
308 308  
309 309  
310 -[[image:data-converter-list-page.png]]
235 +[[image:ThingsBoard-add-integration.png]]
311 311  
312 312  
313 -The **Add integration** window appears.
238 +The ‘Add integration’ window appears.
314 314  
315 -In the **Add integration** window, configure the following settings:
240 +In the Add Integration window, configure the following settings:
316 316  
317 -
318 318  **Basic settings:**
319 319  
320 -* **Integration type**: MQTT
321 -* **Name**: MQTT integration NB/CB
244 +* **Integration type**: UDP
245 +* **Name**: UDP Integration NB/CB
322 322  
323 323  Click **Next** button.
324 324  
325 325  
326 -[[image:add-integration-basic-settings.png||height="511" width="500"]]
327 327  
328 328  
329 329  
330 -**Uplink data converter:**
331 -
332 -* Click on the **Select existing** button.
333 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
334 -
335 -Click **Next** button.
336 -
337 -
338 -[[image:add-integration-uplink-data-converter.png||width="500"]]
339 -
340 -
341 -
342 -**Downlink data converter:**
343 -
344 -* Click on the **Select existing** button.
345 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
346 -
347 -Click **Next** button.
348 -
349 -
350 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
351 -
352 -
353 -
354 -**Connection:**
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)
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
363 -
364 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
365 -
366 -
367 -[[image:add-integration-connection.png||width="500"]]
368 -
369 -
370 -If the connection is successful, you will see the **Connected** message.
371 -
372 -Click on the **Add** button.
373 -
374 -
375 -[[image:add-connection-success.png||height="511" width="500"]]
376 -
377 -
378 -You should see that the newly added integration is listed on the **Integrations** page.
379 -
380 -Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
381 -
382 -
383 -
384 -[[image:integrations-list-added-pending.png]]
385 -
386 -
387 -= Verifying the receipt of data from the device =
388 -
389 -On the terminal, issue the following MQTT command which simulates the device S31B-NB.
390 -
391 -
392 -{{code language="none"}}
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 -{{/code}}
395 -
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.
253 +
add-connection-success.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 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
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