Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 61.1
edited by Dilisi S
on 2025/03/06 13:08
Change comment: Mar 6 edits - part 1
To version 14.1
edited by Dilisi S
on 2025/03/03 02:40
Change comment: Uploaded new attachment "add-integration-downlink-data-converter.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -2,107 +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.
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 84  = Data Converters =
85 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 87  
88 -
89 89  == Uplink ==
90 90  
91 -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’.
92 92  
93 93  
94 -[[image:data-converter-list-page.png]]
34 +[[image:ThingsBoard-Data-Converters.png]]
95 95  
96 96  
97 -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.
98 98  
99 99  
100 100  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
101 101  
102 102  
103 -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’.
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.
45 +Click on the ‘JavaScript’ button. Now copy and paste the following script to the ‘Decoder function’ section:
106 106  
107 107  {{code language="JavaScript"}}
108 108  //Version: 0.1
... ... @@ -227,30 +227,26 @@
227 227  
228 228  {{/code}}
229 229  
230 -Click on the **Add** button.
170 +Click on the ‘Add’ button.
231 231  
232 232  
233 -[[image:uplink-data-converter.png||height="529" width="500"]]
173 +[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
234 234  
235 235  
176 +The uplink data converter is added to ThingsBoard and appears on the ‘Data Converters’ page
236 236  
237 -You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
238 238  
239 -
240 -[[image:data-converter-list-showing-uplink-dc.png]]
241 -
242 -
243 243  == Downlink ==
244 244  
245 -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.
246 246  
247 247  
248 248  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
249 249  
250 250  
251 -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**’.
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.
189 +Click on the ‘**JavaScript**’ button. Now copy and paste the following script to the ‘**Encoder function**’ section:
254 254  
255 255  
256 256  {{code language="JavaScript"}}
... ... @@ -286,100 +286,32 @@
286 286  Click on the **Add** button.
287 287  
288 288  
289 -[[image:downlink-data-converter.png||height="530" width="500"]]
225 +[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
290 290  
291 291  
292 -
293 -You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
294 -
295 -
296 -[[image:data-converter-list.png]]
297 -
298 -
299 299  = Add Integration =
300 300  
301 -In the left navigation, click **Integrations center**, and then click **Integrations**.
230 +In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
302 302  
303 -On the **Integrations** page, click on the '**+**' button.
232 +On the ‘Integrations’ page, click on the “+” button.
304 304  
305 305  
306 -[[image:data-converter-list-page.png]]
235 +[[image:ThingsBoard-add-integration.png]]
307 307  
308 308  
309 -The **Add integration** window appears.
238 +The ‘Add integration’ window appears.
310 310  
311 -In the **Add integration** window, configure the following settings:
240 +In the Add Integration window, configure the following settings:
312 312  
313 -
314 314  **Basic settings:**
315 315  
316 -* **Integration type**: MQTT
317 -* **Name**: MQTT integration NB/CB
244 +* **Integration type**: UDP
245 +* **Name**: UDP Integration NB/CB
318 318  
319 319  Click **Next** button.
320 320  
321 321  
322 -[[image:add-integration-basic-settings.png||height="511" width="500"]]
323 323  
324 324  
325 325  
326 -**Uplink data converter:**
327 -
328 -* Click on the **Select existing** button.
329 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
330 -
331 -Click **Next** button.
332 -
333 -
334 -[[image:add-integration-uplink-data-converter.png||width="500"]]
335 -
336 -
337 -
338 -**Downlink data converter:**
339 -
340 -* Click on the **Select existing** button.
341 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
342 -
343 -Click **Next** button.
344 -
345 -
346 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
347 -
348 -
349 -
350 -**Connection:**
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)
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
359 -
360 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
361 -
362 -
363 -[[image:add-integration-connection.png||width="500"]]
364 -
365 -
366 -If the connection is successful, you will see the **Connected** message.
367 -
368 -Click on the **Add** button.
369 -
370 -
371 -[[image:add-connection-success.png||height="511" width="500"]]
372 -
373 -
374 -You should see that the newly added integration is listed on the **Integrations** page.
375 -
376 -Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
377 -
378 -
379 -
380 -[[image:integrations-list-added-pending.png]]
381 -
382 -
383 -= Verifying the receipt of data from the device =
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.
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
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
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