Skip to Content

Changes for page ThingsBoard

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

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.pradeeka
1 +XWiki.Xiaoling
Content
... ... @@ -6,46 +6,109 @@
6 6  Draft Document
7 7  {{/warning}}
8 8  
9 -= Introduction =
10 10  
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.
12 12  
13 13  
14 -= Add New Device =
12 += 1. Introduction =
15 15  
16 -In the left navigation, click **Entities** and then click **Devices**.
17 17  
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.
18 18  
19 -[[image:ThingsBoard-Device.png]]
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**.
20 20  
21 21  
22 -On the ‘**Devices**’ page, click on the ‘**+**’ button, and then click on the ‘**Add new device**’ from the dropdown menu.
20 += 2. Add New Device =
23 23  
24 24  
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 +
25 25  [[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
26 26  
27 27  
35 +The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
28 28  
29 -= Data Converters =
37 +Click on the **Next: Credentials** button.
30 30  
39 +[[image:new-device-device-details.png||height="529" width="500"]]
31 31  
32 -== Uplink ==
33 33  
34 -In the left navigation, click ‘Integrations center’, and then click ‘Data converters’.
42 +Click the **Access token** button if it is not selected by default.
35 35  
44 +Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
36 36  
37 -[[image:ThingsBoard-Data-Converters.png]]
46 +Click on the **Add** button.
38 38  
48 +[[image:new-device-access-token.png||height="528" width="500"]]
39 39  
40 -On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
41 41  
51 +Click on the **MQTT** button.
42 42  
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 +
43 43  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
44 44  
45 45  
46 -The ‘Add data converter’ window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as ‘Uplink’.
109 +The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
47 47  
48 -Click on the ‘JavaScript’ button. Now copy and paste the following script to the ‘Decoder function’ section:
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.
49 49  
50 50  {{code language="JavaScript"}}
51 51  //Version: 0.1
... ... @@ -170,26 +170,28 @@
170 170  
171 171  {{/code}}
172 172  
173 -Click on the ‘Add’ button.
174 174  
237 +Click on the **Add** button.
175 175  
176 -[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
239 +[[image:uplink-data-converter.png||height="529" width="500"]]
177 177  
178 178  
179 -The uplink data converter is added to ThingsBoard and appears on the ‘Data Converters’ page
242 +You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
180 180  
244 +[[image:data-converter-list-showing-uplink-dc.png]]
181 181  
182 -== Downlink ==
183 183  
184 -On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
247 +== 3.2 Downlink ==
185 185  
186 186  
250 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
251 +
187 187  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
188 188  
189 189  
190 -The ‘**Add data converter**’ window will appear. Name it ‘**UDP Downlink Converter NB/CB**’ and select the Type as ‘**Downlink**’.
255 +The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
191 191  
192 -Click on the ‘**JavaScript**’ button. Now copy and paste the following script to the ‘**Encoder function**’ section:
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.
193 193  
194 194  
195 195  {{code language="JavaScript"}}
... ... @@ -224,81 +224,97 @@
224 224  
225 225  Click on the **Add** button.
226 226  
292 +[[image:downlink-data-converter.png||height="530" width="500"]]
227 227  
228 -[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
229 229  
295 +You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
230 230  
231 -= Add Integration =
297 +[[image:data-converter-list.png]]
232 232  
233 -In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
234 234  
235 -On the ‘Integrations’ page, click on the “+” button.
300 += 4. Add Integration =
236 236  
237 237  
238 -[[image:ThingsBoard-add-integration.png]]
303 +In the left navigation, click **Integrations center**, and then click **Integrations**.
239 239  
305 +On the **Integrations** page, click on the '**+**' button.
240 240  
241 -The ‘Add integration’ window appears.
307 +[[image:data-converter-list-page.png]]
242 242  
243 -In the Add Integration window, configure the following settings:
244 244  
310 +The **Add integration** window appears.
311 +
312 +In the **Add integration** window, configure the following settings:
313 +
314 +
245 245  **Basic settings:**
246 246  
247 -* **Integration type**: UDP
248 -* **Name**: UDP Integration NB/CB
317 +* **Integration type**: MQTT
318 +* **Name**: MQTT integration NB/CB
249 249  
250 250  Click **Next** button.
251 251  
252 -
253 253  [[image:add-integration-basic-settings.png||height="511" width="500"]]
254 254  
255 255  
256 256  **Uplink data converter:**
257 257  
258 -* Click on the ‘**Select existing**’ button.
259 -* Uplink data converter: Select ‘**UDP Uplink Converter NB/CB**’ from the dropdown list.
327 +* Click on the **Select existing** button.
328 +* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
260 260  
261 261  Click **Next** button.
262 262  
332 +[[image:add-integration-uplink-data-converter.png||width="500"]]
263 263  
264 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
265 265  
266 -
267 267  **Downlink data converter:**
268 268  
269 -* Click on the ‘**Select existing**’ button.
270 -* Downlink data converter: Select ‘**UDP Downlink Converter NB/CB**’ from the dropdown list.
337 +* Click on the **Select existing** button.
338 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
271 271  
272 -
273 273  Click **Next** button.
274 274  
342 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
275 275  
276 -[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
277 277  
278 -
279 279  **Connection:**
280 280  
281 -**Port**: 11582
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
282 282  
283 -**Size of the buffer for inbound socket (in KB)**: 64
355 +Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
284 284  
285 -**Cache Size**: 10000000
357 +[[image:add-integration-connection.png||width="500"]]
286 286  
287 -**Cache time to live in minutes**: 1440
288 288  
360 +If the connection is successful, you will see the **Connected** message.
289 289  
290 -Copy the two keys, **Integration key** and **Integration secret** into a text editor, as you will need them in the section ‘xxxxx’.
291 -
292 292  Click on the **Add** button.
293 293  
364 +[[image:add-connection-success.png||height="511" width="500"]]
294 294  
295 -[[image:add-integration-connection.png||height="511" width="500"]]
296 296  
367 +You should see that the newly added integration is listed on the **Integrations** page.
297 297  
369 +Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
298 298  
299 -= Verifying the receipt of data from the device =
371 +[[image:integrations-list-added-pending.png]]
300 300  
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.
302 302  
374 += 5. Verifying the receipt of data from the device =
303 303  
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 +
304 304  
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
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
virtual-device-active.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content