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 49.1
edited by Dilisi S
on 2025/03/05 15:12
Change comment: Mar 5 edits - part 1

Summary

Details

Page properties
Content
... ... @@ -8,9 +8,11 @@
8 8  
9 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.
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**.
13 13  
15 +
14 14  = Add New Device =
15 15  
16 16  In the left navigation, click **Entities** and then click **Devices**.
... ... @@ -19,7 +19,7 @@
19 19  [[image:ThingsBoard-Device.png]]
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.
24 +On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
23 23  
24 24  
25 25  [[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
... ... @@ -28,24 +28,26 @@
28 28  
29 29  = Data Converters =
30 30  
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.
31 31  
35 +
32 32  == Uplink ==
33 33  
34 -In the left navigation, click ‘Integrations center’, and then click ‘Data converters’.
38 +In the left navigation, click **Integrations center**, and then click **Data converters**.
35 35  
36 36  
37 -[[image:ThingsBoard-Data-Converters.png]]
41 +[[image:data-converter-list-page.png]]
38 38  
39 39  
40 -On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
44 +On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
41 41  
42 42  
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’.
50 +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:
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.
49 49  
50 50  {{code language="JavaScript"}}
51 51  //Version: 0.1
... ... @@ -170,26 +170,30 @@
170 170  
171 171  {{/code}}
172 172  
173 -Click on the ‘Add’ button.
177 +Click on the **Add** button.
174 174  
175 175  
176 -[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
180 +[[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
180 180  
184 +You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
181 181  
186 +
187 +[[image:data-converter-list-showing-uplink-dc.png]]
188 +
189 +
182 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.
192 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
185 185  
186 186  
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**’.
198 +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:
200 +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"}}
... ... @@ -225,27 +225,35 @@
225 225  Click on the **Add** button.
226 226  
227 227  
228 -[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
236 +[[image:downlink-data-converter.png||height="530" width="500"]]
229 229  
230 230  
239 +
240 +You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
241 +
242 +
243 +[[image:data-converter-list.png]]
244 +
245 +
231 231  = Add Integration =
232 232  
233 -In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
248 +In the left navigation, click **Integrations center**, and then click **Integrations**.
234 234  
235 -On the ‘Integrations’ page, click on the “+” button.
250 +On the **Integrations** page, click on the '**+**' button.
236 236  
237 237  
238 -[[image:ThingsBoard-add-integration.png]]
253 +[[image:data-converter-list-page.png]]
239 239  
240 240  
241 -The ‘Add integration’ window appears.
256 +The **Add integration** window appears.
242 242  
243 -In the Add Integration window, configure the following settings:
258 +In the **Add integration** window, configure the following settings:
244 244  
260 +
245 245  **Basic settings:**
246 246  
247 -* **Integration type**: UDP
248 -* **Name**: UDP Integration NB/CB
263 +* **Integration type**: MQTT
264 +* **Name**: MQTT integration NB/CB
249 249  
250 250  Click **Next** button.
251 251  
... ... @@ -253,52 +253,67 @@
253 253  [[image:add-integration-basic-settings.png||height="511" width="500"]]
254 254  
255 255  
272 +
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.
275 +* Click on the **Select existing** button.
276 +* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
260 260  
261 261  Click **Next** button.
262 262  
263 263  
264 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
281 +[[image:add-integration-uplink-data-converter.png||width="500"]]
265 265  
266 266  
284 +
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.
287 +* Click on the **Select existing** button.
288 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
271 271  
272 -
273 273  Click **Next** button.
274 274  
275 275  
276 -[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
293 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
277 277  
278 278  
296 +
279 279  **Connection:**
280 280  
281 -**Port**: 11582
299 +* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
300 +* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
301 +* **Credentials**: Basic
302 +* **Username**: Access token (This is the access token you copied from the device)
303 +* **Password** - Leave it as blank
304 +* **Topic** - v1/devices/+/telemetry (sightly modify the topic 'v1/devices/me/telemetry' you copied for the device to enable receiving data from any 'device name')
305 +* **QoS** - 0-At most once
282 282  
283 -**Size of the buffer for inbound socket (in KB)**: 64
307 +Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
284 284  
285 -**Cache Size**: 10000000
286 286  
287 -**Cache time to live in minutes**: 1440
310 +[[image:add-integration-connection.png||width="500"]]
288 288  
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’.
313 +If the connection is successful, you will see the **Connected** message.
291 291  
292 292  Click on the **Add** button.
293 293  
294 294  
295 -[[image:add-integration-connection.png||height="511" width="500"]]
318 +[[image:add-connection-success.png||height="511" width="500"]]
296 296  
297 297  
298 298  
299 -= Verifying the receipt of data from the device =
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  
303 303  
304 -
325 +
326 +You should see that the newly added integration is listed on the **Integrations** page.
327 +
328 +Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
329 +
330 +[[image:Integrations-list.png]]
331 +
332 +
333 += Verifying the receipt of data from the device =
334 +
335 +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-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
downlink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +207.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