Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 50.1
edited by Dilisi S
on 2025/03/06 03:34
Change comment: Uploaded new attachment "integrations-list-added-pending.png", version {1}
To version 13.1
edited by Dilisi S
on 2025/03/03 02:38
Change comment: Uploaded new attachment "add-integration-uplink-data-converter.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -2,17 +2,12 @@
2 2  
3 3  {{toc/}}
4 4  
5 -{{warning}}
6 -Draft Document
7 -{{/warning}}
8 8  
9 9  = 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.
8 +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 -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**.
14 14  
15 -
16 16  = Add New Device =
17 17  
18 18  In the left navigation, click **Entities** and then click **Devices**.
... ... @@ -21,7 +21,7 @@
21 21  [[image:ThingsBoard-Device.png]]
22 22  
23 23  
24 -On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
19 +On the ‘**Devices**’ page, click on the ‘**+**’ button, and then click on the ‘**Add new device**’ from the dropdown menu.
25 25  
26 26  
27 27  [[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
... ... @@ -30,26 +30,24 @@
30 30  
31 31  = Data Converters =
32 32  
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.
34 34  
35 -
36 36  == Uplink ==
37 37  
38 -In the left navigation, click **Integrations center**, and then click **Data converters**.
31 +In the left navigation, click ‘Integrations center’, and then click ‘Data converters’.
39 39  
40 40  
41 -[[image:data-converter-list-page.png]]
34 +[[image:ThingsBoard-Data-Converters.png]]
42 42  
43 43  
44 -On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
37 +On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
45 45  
46 46  
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 ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
43 +The ‘Add data converter’ window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as ‘Uplink’.
51 51  
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.
45 +Click on the ‘JavaScript’ button. Now copy and paste the following script to the ‘Decoder function’ section:
53 53  
54 54  {{code language="JavaScript"}}
55 55  //Version: 0.1
... ... @@ -174,30 +174,26 @@
174 174  
175 175  {{/code}}
176 176  
177 -Click on the **Add** button.
170 +Click on the ‘Add’ button.
178 178  
179 179  
180 -[[image:uplink-data-converter.png||height="529" width="500"]]
173 +[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
181 181  
182 182  
176 +The uplink data converter is added to ThingsBoard and appears on the ‘Data Converters’ page
183 183  
184 -You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
185 185  
186 -
187 -[[image:data-converter-list-showing-uplink-dc.png]]
188 -
189 -
190 190  == Downlink ==
191 191  
192 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
181 +On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
193 193  
194 194  
195 195  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
196 196  
197 197  
198 -The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
187 +The ‘**Add data converter**’ window will appear. Name it ‘**UDP Downlink Converter NB/CB**’ and select the Type as ‘**Downlink**’.
199 199  
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.
189 +Click on the ‘**JavaScript**’ button. Now copy and paste the following script to the ‘**Encoder function**’ section:
201 201  
202 202  
203 203  {{code language="JavaScript"}}
... ... @@ -233,103 +233,32 @@
233 233  Click on the **Add** button.
234 234  
235 235  
236 -[[image:downlink-data-converter.png||height="530" width="500"]]
225 +[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
237 237  
238 238  
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 -
246 246  = Add Integration =
247 247  
248 -In the left navigation, click **Integrations center**, and then click **Integrations**.
230 +In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
249 249  
250 -On the **Integrations** page, click on the '**+**' button.
232 +On the ‘Integrations’ page, click on the “+” button.
251 251  
252 252  
253 -[[image:data-converter-list-page.png]]
235 +[[image:ThingsBoard-add-integration.png]]
254 254  
255 255  
256 -The **Add integration** window appears.
238 +The ‘Add integration’ window appears.
257 257  
258 -In the **Add integration** window, configure the following settings:
240 +In the Add Integration window, configure the following settings:
259 259  
260 -
261 261  **Basic settings:**
262 262  
263 -* **Integration type**: MQTT
264 -* **Name**: MQTT integration NB/CB
244 +* **Integration type**: UDP
245 +* **Name**: UDP Integration NB/CB
265 265  
266 266  Click **Next** button.
267 267  
268 268  
269 -[[image:add-integration-basic-settings.png||height="511" width="500"]]
270 270  
271 271  
272 272  
273 -**Uplink data converter:**
274 -
275 -* Click on the **Select existing** button.
276 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
277 -
278 -Click **Next** button.
279 -
280 -
281 -[[image:add-integration-uplink-data-converter.png||width="500"]]
282 -
283 -
284 -
285 -**Downlink data converter:**
286 -
287 -* Click on the **Select existing** button.
288 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
289 -
290 -Click **Next** button.
291 -
292 -
293 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
294 -
295 -
296 -
297 -**Connection:**
298 -
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
306 -
307 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
308 -
309 -
310 -[[image:add-integration-connection.png||width="500"]]
311 -
312 -
313 -If the connection is successful, you will see the **Connected** message.
314 -
315 -Click on the **Add** button.
316 -
317 -
318 -[[image:add-connection-success.png||height="511" width="500"]]
319 -
320 -
321 -
322 -
323 -
324 -
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.
253 +
add-connection-success.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
add-integration-connection.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -124.4 KB
Content
add-integration-downlink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -123.0 KB
Content
data-converter-list-page.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -190.8 KB
Content
data-converter-list-showing-uplink-dc.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -194.9 KB
Content
data-converter-list.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
downlink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -207.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
uplink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
ThingsBoard-Data-Converters.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +100.3 KB
Content
ThingsBoard-add-data-converter-downlink.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content
ThingsBoard-add-data-converter-uplink.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content
ThingsBoard-add-integration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content