Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 20.1
edited by Dilisi S
on 2025/03/04 04:18
Change comment: Uploaded new attachment "Data-converter-list-uplink-only.png", version {1}
To version 51.1
edited by Dilisi S
on 2025/03/06 03:38
Change comment: Deleted image "ThingsBoard-Device.png"

Summary

Details

Page properties
Content
... ... @@ -8,9 +8,9 @@
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.
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 +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 15  
16 16  = Add New Device =
... ... @@ -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.
24 +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,24 +30,26 @@
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.
33 33  
35 +
34 34  == Uplink ==
35 35  
36 -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**.
37 37  
38 38  
39 -[[image:ThingsBoard-Data-Converters.png]]
41 +[[image:data-converter-list-page.png]]
40 40  
41 41  
42 -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.
43 43  
44 44  
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’.
50 +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:
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.
51 51  
52 52  {{code language="JavaScript"}}
53 53  //Version: 0.1
... ... @@ -172,26 +172,30 @@
172 172  
173 173  {{/code}}
174 174  
175 -Click on the ‘Add’ button.
177 +Click on the **Add** button.
176 176  
177 177  
178 -[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
180 +[[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
182 182  
184 +You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
183 183  
186 +
187 +[[image:data-converter-list-showing-uplink-dc.png]]
188 +
189 +
184 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.
192 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
187 187  
188 188  
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**’.
198 +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:
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.
195 195  
196 196  
197 197  {{code language="JavaScript"}}
... ... @@ -227,27 +227,35 @@
227 227  Click on the **Add** button.
228 228  
229 229  
230 -[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
236 +[[image:downlink-data-converter.png||height="530" width="500"]]
231 231  
232 232  
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 +
233 233  = Add Integration =
234 234  
235 -In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
248 +In the left navigation, click **Integrations center**, and then click **Integrations**.
236 236  
237 -On the ‘Integrations’ page, click on the “+” button.
250 +On the **Integrations** page, click on the '**+**' button.
238 238  
239 239  
240 -[[image:ThingsBoard-add-integration.png]]
253 +[[image:data-converter-list-page.png]]
241 241  
242 242  
243 -The ‘Add integration’ window appears.
256 +The **Add integration** window appears.
244 244  
245 -In the Add Integration window, configure the following settings:
258 +In the **Add integration** window, configure the following settings:
246 246  
260 +
247 247  **Basic settings:**
248 248  
249 -* **Integration type**: UDP
250 -* **Name**: UDP Integration NB/CB
263 +* **Integration type**: MQTT
264 +* **Name**: MQTT integration NB/CB
251 251  
252 252  Click **Next** button.
253 253  
... ... @@ -255,51 +255,67 @@
255 255  [[image:add-integration-basic-settings.png||height="511" width="500"]]
256 256  
257 257  
272 +
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.
275 +* Click on the **Select existing** button.
276 +* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
262 262  
263 263  Click **Next** button.
264 264  
265 265  
266 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
281 +[[image:add-integration-uplink-data-converter.png||width="500"]]
267 267  
268 268  
284 +
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.
287 +* Click on the **Select existing** button.
288 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
273 273  
274 274  Click **Next** button.
275 275  
276 276  
277 -[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
293 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
278 278  
279 279  
296 +
280 280  **Connection:**
281 281  
282 -**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
283 283  
284 -**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.
285 285  
286 -**Cache Size**: 10000000
287 287  
288 -**Cache time to live in minutes**: 1440
310 +[[image:add-integration-connection.png||width="500"]]
289 289  
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’.
313 +If the connection is successful, you will see the **Connected** message.
292 292  
293 293  Click on the **Add** button.
294 294  
295 295  
296 -[[image:add-integration-connection.png||height="511" width="500"]]
318 +[[image:add-connection-success.png||height="511" width="500"]]
297 297  
298 298  
299 299  
300 -= Verifying the receipt of data from the device =
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  
304 304  
305 -
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.
Data-converter-list-uplink-only.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
Data-converter-list.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,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
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
uplink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content