Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 18.1
edited by Dilisi S
on 2025/03/04 04:01
Change comment: Mar 3 edits - part 2
To version 64.2
edited by Xiaoling
on 2025/03/07 11:46
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,48 +6,108 @@
6 6  Draft Document
7 7  {{/warning}}
8 8  
9 -= Introduction =
9 += 1. 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.
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.
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.
14 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 -= Add New Device =
17 17  
18 -In the left navigation, click **Entities** and then click **Devices**.
17 += 2. Add New Device =
19 19  
20 20  
21 -[[image:ThingsBoard-Device.png]]
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.
22 22  
22 +In the left navigation, click **Entities** and then click **Devices**.
23 23  
24 -On the ‘**Devices**’ page, click on the ‘**+**’ button, and then click on the ‘**Add new device**’ from the dropdown menu.
24 +[[image:device-list-empty.png]]
25 25  
26 26  
27 +On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
28 +
29 +
27 27  [[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
28 28  
29 29  
33 +The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
30 30  
31 -= Data Converters =
35 +Click on the **Next: Credentials** button.
32 32  
33 33  
34 -== Uplink ==
38 +[[image:new-device-device-details.png||height="529" width="500"]]
35 35  
36 -In the left navigation, click ‘Integrations center’, and then click ‘Data converters’.
37 37  
41 +Click the **Access token** button if it is not selected by default.
38 38  
39 -[[image:ThingsBoard-Data-Converters.png]]
43 +Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
40 40  
45 +Click on the **Add** button.
41 41  
42 -On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
47 +[[image:new-device-access-token.png||height="528" width="500"]]
43 43  
44 44  
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 +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 +
94 +
95 +== 3.1 Uplink ==
96 +
97 +
98 +In the left navigation, click **Integrations center**, and then click **Data converters**.
99 +
100 +[[image:data-converter-list-page.png]]
101 +
102 +
103 +On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
104 +
45 45  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
46 46  
47 47  
48 -The ‘Add data converter’ window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as ‘Uplink’.
108 +The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
49 49  
50 -Click on the ‘JavaScript’ button. Now copy and paste the following script to the ‘Decoder function’ section:
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.
51 51  
52 52  {{code language="JavaScript"}}
53 53  //Version: 0.1
... ... @@ -172,26 +172,28 @@
172 172  
173 173  {{/code}}
174 174  
175 -Click on the ‘Add’ button.
176 176  
236 +Click on the **Add** button.
177 177  
178 -[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
238 +[[image:uplink-data-converter.png||height="529" width="500"]]
179 179  
180 180  
181 -The uplink data converter is added to ThingsBoard and appears on the ‘Data Converters’ page
241 +You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
182 182  
243 +[[image:data-converter-list-showing-uplink-dc.png]]
183 183  
184 -== Downlink ==
185 185  
186 -On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
246 +== 3.2 Downlink ==
187 187  
188 188  
249 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
250 +
189 189  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
190 190  
191 191  
192 -The ‘**Add data converter**’ window will appear. Name it ‘**UDP Downlink Converter NB/CB**’ and select the Type as ‘**Downlink**’.
254 +The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
193 193  
194 -Click on the ‘**JavaScript**’ button. Now copy and paste the following script to the ‘**Encoder function**’ section:
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.
195 195  
196 196  
197 197  {{code language="JavaScript"}}
... ... @@ -226,80 +226,97 @@
226 226  
227 227  Click on the **Add** button.
228 228  
291 +[[image:downlink-data-converter.png||height="530" width="500"]]
229 229  
230 -[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
231 231  
294 +You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
232 232  
233 -= Add Integration =
296 +[[image:data-converter-list.png]]
234 234  
235 -In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
236 236  
237 -On the ‘Integrations’ page, click on the “+” button.
299 += 4. Add Integration =
238 238  
239 239  
240 -[[image:ThingsBoard-add-integration.png]]
302 +In the left navigation, click **Integrations center**, and then click **Integrations**.
241 241  
304 +On the **Integrations** page, click on the '**+**' button.
242 242  
243 -The ‘Add integration’ window appears.
306 +[[image:data-converter-list-page.png]]
244 244  
245 -In the Add Integration window, configure the following settings:
246 246  
309 +The **Add integration** window appears.
310 +
311 +In the **Add integration** window, configure the following settings:
312 +
313 +
247 247  **Basic settings:**
248 248  
249 -* **Integration type**: UDP
250 -* **Name**: UDP Integration NB/CB
316 +* **Integration type**: MQTT
317 +* **Name**: MQTT integration NB/CB
251 251  
252 252  Click **Next** button.
253 253  
254 -
255 255  [[image:add-integration-basic-settings.png||height="511" width="500"]]
256 256  
257 257  
258 258  **Uplink data converter:**
259 259  
260 -* Click on the ‘**Select existing**’ button.
261 -* Uplink data converter: Select ‘**UDP Uplink Converter NB/CB**’ from the dropdown list.
326 +* Click on the **Select existing** button.
327 +* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
262 262  
263 263  Click **Next** button.
264 264  
331 +[[image:add-integration-uplink-data-converter.png||width="500"]]
265 265  
266 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
267 267  
268 -
269 269  **Downlink data converter:**
270 270  
271 -* Click on the ‘**Select existing**’ button.
272 -* Downlink data converter: Select ‘**UDP Downlink Converter NB/CB**’ from the dropdown list.
336 +* Click on the **Select existing** button.
337 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
273 273  
274 274  Click **Next** button.
275 275  
341 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
276 276  
277 -[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
278 278  
279 -
280 280  **Connection:**
281 281  
282 -**Port**: 11582
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
283 283  
284 -**Size of the buffer for inbound socket (in KB)**: 64
354 +Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
285 285  
286 -**Cache Size**: 10000000
356 +[[image:add-integration-connection.png||width="500"]]
287 287  
288 -**Cache time to live in minutes**: 1440
289 289  
359 +If the connection is successful, you will see the **Connected** message.
290 290  
291 -Copy the two keys, **Integration key** and **Integration secret** into a text editor, as you will need them in the section ‘xxxxx’.
292 -
293 293  Click on the **Add** button.
294 294  
363 +[[image:add-connection-success.png||height="511" width="500"]]
295 295  
296 -[[image:add-integration-connection.png||height="511" width="500"]]
297 297  
366 +You should see that the newly added integration is listed on the **Integrations** page.
298 298  
368 +Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
299 299  
300 -= Verifying the receipt of data from the device =
370 +[[image:integrations-list-added-pending.png]]
301 301  
302 -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.
303 303  
373 += 5. Verifying the receipt of data from the device =
304 304  
375 +
376 +On the terminal, issue the following MQTT command which simulates the device S31B-NB.
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 +
305 305  
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