Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From 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}
To version 61.1
edited by Dilisi S
on 2025/03/06 13:08
Change comment: Mar 6 edits - part 1

Summary

Details

Page properties
Content
... ... @@ -2,47 +2,107 @@
2 2  
3 3  {{toc/}}
4 4  
5 +{{warning}}
6 +Draft Document
7 +{{/warning}}
5 5  
6 6  = Introduction =
7 7  
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.
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.
9 9  
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**.
10 10  
15 +
11 11  = Add New Device =
12 12  
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 +
13 13  In the left navigation, click **Entities** and then click **Devices**.
14 14  
15 15  
16 -[[image:ThingsBoard-Device.png]]
23 +[[image:device-list-empty.png]]
17 17  
18 18  
19 -On the ‘**Devices**’ page, click on the ‘**+**’ button, and then click on the ‘**Add new device**’ from the dropdown menu.
26 +On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
20 20  
21 21  
22 22  [[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
23 23  
24 24  
32 +The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
25 25  
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 +
26 26  = Data Converters =
27 27  
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.
28 28  
88 +
29 29  == Uplink ==
30 30  
31 -In the left navigation, click ‘Integrations center’, and then click ‘Data converters’.
91 +In the left navigation, click **Integrations center**, and then click **Data converters**.
32 32  
33 33  
34 -[[image:ThingsBoard-Data-Converters.png]]
94 +[[image:data-converter-list-page.png]]
35 35  
36 36  
37 -On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
97 +On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
38 38  
39 39  
40 40  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
41 41  
42 42  
43 -The ‘Add data converter’ window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as ‘Uplink’.
103 +The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
44 44  
45 -Click on the ‘JavaScript’ button. Now copy and paste the following script to the ‘Decoder function’ section:
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.
46 46  
47 47  {{code language="JavaScript"}}
48 48  //Version: 0.1
... ... @@ -167,26 +167,30 @@
167 167  
168 168  {{/code}}
169 169  
170 -Click on the ‘Add’ button.
230 +Click on the **Add** button.
171 171  
172 172  
173 -[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
233 +[[image:uplink-data-converter.png||height="529" width="500"]]
174 174  
175 175  
176 -The uplink data converter is added to ThingsBoard and appears on the ‘Data Converters’ page
177 177  
237 +You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
178 178  
239 +
240 +[[image:data-converter-list-showing-uplink-dc.png]]
241 +
242 +
179 179  == Downlink ==
180 180  
181 -On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
245 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
182 182  
183 183  
184 184  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
185 185  
186 186  
187 -The ‘**Add data converter**’ window will appear. Name it ‘**UDP Downlink Converter NB/CB**’ and select the Type as ‘**Downlink**’.
251 +The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
188 188  
189 -Click on the ‘**JavaScript**’ button. Now copy and paste the following script to the ‘**Encoder function**’ section:
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.
190 190  
191 191  
192 192  {{code language="JavaScript"}}
... ... @@ -222,32 +222,100 @@
222 222  Click on the **Add** button.
223 223  
224 224  
225 -[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
289 +[[image:downlink-data-converter.png||height="530" width="500"]]
226 226  
227 227  
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 +
228 228  = Add Integration =
229 229  
230 -In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
301 +In the left navigation, click **Integrations center**, and then click **Integrations**.
231 231  
232 -On the ‘Integrations’ page, click on the “+” button.
303 +On the **Integrations** page, click on the '**+**' button.
233 233  
234 234  
235 -[[image:ThingsBoard-add-integration.png]]
306 +[[image:data-converter-list-page.png]]
236 236  
237 237  
238 -The ‘Add integration’ window appears.
309 +The **Add integration** window appears.
239 239  
240 -In the Add Integration window, configure the following settings:
311 +In the **Add integration** window, configure the following settings:
241 241  
313 +
242 242  **Basic settings:**
243 243  
244 -* **Integration type**: UDP
245 -* **Name**: UDP Integration NB/CB
316 +* **Integration type**: MQTT
317 +* **Name**: MQTT integration NB/CB
246 246  
247 247  Click **Next** button.
248 248  
249 249  
322 +[[image:add-integration-basic-settings.png||height="511" width="500"]]
250 250  
251 251  
252 252  
253 -
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.
ThingsBoard-Data-Converters.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -100.3 KB
Content
ThingsBoard-Device.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -225.5 KB
Content
ThingsBoard-add-data-converter-downlink.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
ThingsBoard-add-data-converter-uplink.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
ThingsBoard-add-integration.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
add-connection-success.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
add-integration-connection.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +124.4 KB
Content
add-integration-downlink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +123.0 KB
Content
data-converter-list-page.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +190.8 KB
Content
data-converter-list-showing-uplink-dc.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +194.9 KB
Content
data-converter-list.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
device-list-empty.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
downlink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +207.8 KB
Content
integrations-list-added-pending.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
mqtt-command-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
mqtt-command-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
new-device-access-token.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
new-device-check-connectivity.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
new-device-device-details.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +88.4 KB
Content
new-device-telemetry-test.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
uplink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content