Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 59.1
edited by Dilisi S
on 2025/03/06 04:25
Change comment: Mar 5 edits
To version 35.1
edited by Dilisi S
on 2025/03/04 19:34
Change comment: Uploaded new attachment "data-converter-list.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -15,12 +15,10 @@
15 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]]
21 +[[image:ThingsBoard-Device.png]]
24 24  
25 25  
26 26  On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
... ... @@ -29,50 +29,7 @@
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'**.
65 -
66 -
67 -[[image:mqtt-command-1.png||height="228" width="700"]]
68 -
69 -
70 -
71 -
72 -[[image:new-device-telemetry-test.png||height="520" width="500"]]
73 -
74 -
75 -
76 76  = Data Converters =
77 77  
78 78  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.
... ... @@ -83,7 +83,7 @@
83 83  In the left navigation, click **Integrations center**, and then click **Data converters**.
84 84  
85 85  
86 -[[image:data-converter-list-page.png]]
41 +[[image:ThingsBoard-Data-Converters.png]]
87 87  
88 88  
89 89  On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
... ... @@ -92,7 +92,7 @@
92 92  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
93 93  
94 94  
95 -The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
50 +The **Add data converter** window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as **Uplink**.
96 96  
97 97  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.
98 98  
... ... @@ -222,14 +222,13 @@
222 222  Click on the **Add** button.
223 223  
224 224  
225 -[[image:uplink-data-converter.png||height="529" width="500"]]
180 +[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
226 226  
227 227  
228 -
229 229  You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
230 230  
231 231  
232 -[[image:data-converter-list-showing-uplink-dc.png]]
186 +[[image:Data-converter-list-uplink-only.png]]
233 233  
234 234  
235 235  == Downlink ==
... ... @@ -240,7 +240,7 @@
240 240  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
241 241  
242 242  
243 -The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
197 +The **Add data converter** window will appear. Name it ‘**UDP Downlink Converter NB/CB**’ and select the Type as **Downlink**.
244 244  
245 245  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.
246 246  
... ... @@ -278,14 +278,13 @@
278 278  Click on the **Add** button.
279 279  
280 280  
281 -[[image:downlink-data-converter.png||height="530" width="500"]]
235 +[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
282 282  
283 283  
284 -
285 285  You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
286 286  
287 287  
288 -[[image:data-converter-list.png]]
241 +[[image:Data-converter-list.png]]
289 289  
290 290  
291 291  = Add Integration =
... ... @@ -295,7 +295,7 @@
295 295  On the **Integrations** page, click on the '**+**' button.
296 296  
297 297  
298 -[[image:data-converter-list-page.png]]
251 +[[image:ThingsBoard-add-integration.png]]
299 299  
300 300  
301 301  The **Add integration** window appears.
... ... @@ -305,8 +305,8 @@
305 305  
306 306  **Basic settings:**
307 307  
308 -* **Integration type**: MQTT
309 -* **Name**: MQTT integration NB/CB
261 +* **Integration type**: UDP
262 +* **Name**: UDP Integration NB/CB
310 310  
311 311  Click **Next** button.
312 312  
... ... @@ -314,53 +314,41 @@
314 314  [[image:add-integration-basic-settings.png||height="511" width="500"]]
315 315  
316 316  
317 -
318 318  **Uplink data converter:**
319 319  
320 320  * Click on the **Select existing** button.
321 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
273 +* **Uplink data converter**: Select **UDP Uplink Converter NB/CB **from the dropdown list.
322 322  
323 323  Click **Next** button.
324 324  
325 325  
326 -[[image:add-integration-uplink-data-converter.png||width="500"]]
278 +[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
327 327  
328 328  
329 -
330 330  **Downlink data converter:**
331 331  
332 332  * Click on the **Select existing** button.
333 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
284 +* **Downlink data converter**: Select **UDP Downlink Converter NB/CB **from the dropdown list.
334 334  
335 335  Click **Next** button.
336 336  
337 337  
338 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
289 +[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
339 339  
340 340  
341 -
342 342  **Connection:**
343 343  
344 -* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
345 -* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
346 -* **Credentials**: Basic
347 -* **Username**: Access token (This is the access token you copied from the device)
348 -* **Password** - Leave it as blank
349 -* **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')
350 -* **QoS** - 0-At most once
294 +* **Port**: 11582
295 +* **Size of the buffer for inbound socket (in KB)**: 64
296 +* **Cache Size**: 10000000
297 +* **Cache time to live in minutes**: 1440
351 351  
352 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
299 +Copy the two keys, **Integration key** and **Integration secret** into a text editor, as you will need them in the section ‘xxxxx’.
353 353  
354 -
355 -[[image:add-integration-connection.png||width="500"]]
356 -
357 -
358 -If the connection is successful, you will see the **Connected** message.
359 -
360 360  Click on the **Add** button.
361 361  
362 362  
363 -[[image:add-connection-success.png||height="511" width="500"]]
304 +[[image:add-integration-connection.png||height="511" width="500"]]
364 364  
365 365  
366 366  You should see that the newly added integration is listed on the **Integrations** page.
... ... @@ -367,11 +367,12 @@
367 367  
368 368  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
369 369  
311 +[[image:Integrations-list.png]]
370 370  
371 371  
372 -[[image:integrations-list-added-pending.png]]
373 -
374 -
375 375  = Verifying the receipt of data from the device =
376 376  
377 377  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.
317 +
318 +
319 +
add-connection-success.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
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
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
ThingsBoard-Device.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +225.5 KB
Content
ThingsBoard-add-integration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content