Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 34.1
edited by Dilisi S
on 2025/03/04 19:32
Change comment: Deleted image "Data-converter-list.png"
To version 59.1
edited by Dilisi S
on 2025/03/06 04:25
Change comment: Mar 5 edits

Summary

Details

Page properties
Content
... ... @@ -15,10 +15,12 @@
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 +
18 18  In the left navigation, click **Entities** and then click **Devices**.
19 19  
20 20  
21 -[[image:ThingsBoard-Device.png]]
23 +[[image:device-list-empty.png]]
22 22  
23 23  
24 24  On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
... ... @@ -27,7 +27,50 @@
27 27  [[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
28 28  
29 29  
32 +The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
30 30  
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 +
31 31  = Data Converters =
32 32  
33 33  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.
... ... @@ -38,7 +38,7 @@
38 38  In the left navigation, click **Integrations center**, and then click **Data converters**.
39 39  
40 40  
41 -[[image:ThingsBoard-Data-Converters.png]]
86 +[[image:data-converter-list-page.png]]
42 42  
43 43  
44 44  On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
... ... @@ -47,7 +47,7 @@
47 47  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
48 48  
49 49  
50 -The **Add data converter** window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as **Uplink**.
95 +The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
51 51  
52 52  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.
53 53  
... ... @@ -177,13 +177,14 @@
177 177  Click on the **Add** button.
178 178  
179 179  
180 -[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
225 +[[image:uplink-data-converter.png||height="529" width="500"]]
181 181  
182 182  
228 +
183 183  You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
184 184  
185 185  
186 -[[image:Data-converter-list-uplink-only.png]]
232 +[[image:data-converter-list-showing-uplink-dc.png]]
187 187  
188 188  
189 189  == Downlink ==
... ... @@ -194,7 +194,7 @@
194 194  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
195 195  
196 196  
197 -The **Add data converter** window will appear. Name it ‘**UDP Downlink Converter NB/CB**’ and select the Type as **Downlink**.
243 +The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
198 198  
199 199  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.
200 200  
... ... @@ -232,13 +232,14 @@
232 232  Click on the **Add** button.
233 233  
234 234  
235 -[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
281 +[[image:downlink-data-converter.png||height="530" width="500"]]
236 236  
237 237  
284 +
238 238  You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
239 239  
240 240  
241 -[[image:Data-converter-list.png]]
288 +[[image:data-converter-list.png]]
242 242  
243 243  
244 244  = Add Integration =
... ... @@ -248,7 +248,7 @@
248 248  On the **Integrations** page, click on the '**+**' button.
249 249  
250 250  
251 -[[image:ThingsBoard-add-integration.png]]
298 +[[image:data-converter-list-page.png]]
252 252  
253 253  
254 254  The **Add integration** window appears.
... ... @@ -258,8 +258,8 @@
258 258  
259 259  **Basic settings:**
260 260  
261 -* **Integration type**: UDP
262 -* **Name**: UDP Integration NB/CB
308 +* **Integration type**: MQTT
309 +* **Name**: MQTT integration NB/CB
263 263  
264 264  Click **Next** button.
265 265  
... ... @@ -267,41 +267,53 @@
267 267  [[image:add-integration-basic-settings.png||height="511" width="500"]]
268 268  
269 269  
317 +
270 270  **Uplink data converter:**
271 271  
272 272  * Click on the **Select existing** button.
273 -* **Uplink data converter**: Select **UDP Uplink Converter NB/CB **from the dropdown list.
321 +* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
274 274  
275 275  Click **Next** button.
276 276  
277 277  
278 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
326 +[[image:add-integration-uplink-data-converter.png||width="500"]]
279 279  
280 280  
329 +
281 281  **Downlink data converter:**
282 282  
283 283  * Click on the **Select existing** button.
284 -* **Downlink data converter**: Select **UDP Downlink Converter NB/CB **from the dropdown list.
333 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
285 285  
286 286  Click **Next** button.
287 287  
288 288  
289 -[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
338 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
290 290  
291 291  
341 +
292 292  **Connection:**
293 293  
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
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
298 298  
299 -Copy the two keys, **Integration key** and **Integration secret** into a text editor, as you will need them in the section ‘xxxxx’.
352 +Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
300 300  
354 +
355 +[[image:add-integration-connection.png||width="500"]]
356 +
357 +
358 +If the connection is successful, you will see the **Connected** message.
359 +
301 301  Click on the **Add** button.
302 302  
303 303  
304 -[[image:add-integration-connection.png||height="511" width="500"]]
363 +[[image:add-connection-success.png||height="511" width="500"]]
305 305  
306 306  
307 307  You should see that the newly added integration is listed on the **Integrations** page.
... ... @@ -308,12 +308,11 @@
308 308  
309 309  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
310 310  
311 -[[image:Integrations-list.png]]
312 312  
313 313  
314 -= Verifying the receipt of data from the device =
372 +[[image:integrations-list-added-pending.png]]
315 315  
316 -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 317  
375 += Verifying the receipt of data from the device =
318 318  
319 -
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.
ThingsBoard-Device.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -225.5 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.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
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
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