Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 125.1
edited by Dilisi S
on 2025/03/08 20:47
Change comment: There is no comment for this version
To version 10.1
edited by Dilisi S
on 2025/03/03 02:31
Change comment: Uploaded new attachment "ThingsBoard-add-integration.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -2,371 +2,9 @@
2 2  
3 3  {{toc/}}
4 4  
5 -{{warning}}
6 -Draft Document
7 -{{/warning}}
8 8  
6 += Introduction =
9 9  
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.
10 10  
11 -
12 -= 1. Introduction =
13 -
14 -
15 -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.
16 -
17 -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**.
18 -
19 -
20 -= 2. Prerequisites =
21 -
22 -To complete this tutorial, you need to have the following:
23 -
24 -* ThingsBoard cloud account
25 -* HiveMQ Cloud account
26 -
27 -== 2.1 ThingsBoard Cloud ==
28 -
29 -
30 -Go to [[https:~~/~~/thingsboard.io/>>https://thingsboard.io/]]
31 -
32 -Click on the **Try it now**.
33 -
34 -
35 -[[image:thingsboard-1.png]]
36 -
37 -
38 -Select either the **North America** or **Europe** region. Here, we use the Europe region.
39 -
40 -[[image:thingsboard-2.png]]
41 -
42 -
43 -You can sign up with your Google, GitHub, Facebook, or Apple account. If not you can create an account with providing your name, email address and a password.
44 -
45 -[[image:thingsboard-3.png||height="651" width="500"]]
46 -
47 -
48 -== 2.2 HiveMQ Cloud ==
49 -
50 -
51 -Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
52 -
53 -Click on the **Start Free** button.
54 -
55 -[[image:hivwmq-1.png]]
56 -
57 -
58 -Click on the **Sign Up FREE Now** button in the **HIVEMQ CLOUD** section.
59 -
60 -[[image:hivemq-2.png]]
61 -
62 -
63 -Click on the **Sign Up** button.
64 -
65 -You can sign up with HiveMQ using your **GitHub**, **Google**, or **LinkedIn** account.
66 -
67 -If not, provide your **email address** and a **password** to create an account by clicking on the **Sign Up** button.
68 -
69 -
70 -[[image:hivemq-3.png]]
71 -
72 -
73 -You will receive an email to verify your email address. Click on the **Confirm my account** button.
74 -
75 -
76 -[[image:hivemq-4.jpg||height="889" width="400"]]
77 -
78 -
79 -You will be redirected to a page asking you to complete your profile. Once done, click the **Continue** button.
80 -
81 -
82 -[[image:hivemq-5.png||height="655" width="700"]]
83 -
84 -
85 -Select the CloudMQ Cloud plan you need. For testing purposes, select the **Serverless FREE** plan by clicking on the **Create Serverless Cluster** button.
86 -
87 -
88 -[[image:hivemq-6.png]]
89 -
90 -
91 -You will be navigated to the **Your Clusters** page. Click on the **Manage Cluster** button.
92 -
93 -[[image:hivemq-7.png]]
94 -
95 -
96 -In your cluster page, you can find some useful parameters you need to create a MQTT connection.
97 -
98 -**URL**: This is the host name. Click on the copy button to copy it.
99 -
100 -**Port**: 8883
101 -
102 -
103 -Click on the **Getting Started** tab to setup the username and the password as the connection credentials.
104 -
105 -
106 -[[image:hivemq-8.png]]
107 -
108 -
109 -In the '**Create Connection Credentials**' section, provide a **username** and **password**, then click the **Add** button.
110 -
111 -
112 -[[image:hivemq-9.png]]
113 -
114 -
115 -
116 -If everything is successful, you will see the following message.
117 -
118 -
119 -[[image:hivemq-10.png||height="206" width="500"]]
120 -
121 -
122 -You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
123 -
124 -
125 -= 3. Data Converters =
126 -
127 -
128 -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.
129 -
130 -
131 -== 3.1 Uplink ==
132 -
133 -
134 -In the left navigation, click **Integrations center**, and then click **Data converters**.
135 -
136 -
137 -
138 -[[image:data-converters-list-empty.png]]
139 -
140 -
141 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
142 -
143 -
144 -
145 -[[image:create-new-converter-menu.png||height="259" width="500"]]
146 -
147 -
148 -The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
149 -
150 -Click on the **TBEL** button if not selected it by default. Delete the existing decoder function in the code editor. Now copy and paste the following decoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This decoder function is compatible for both NB and CB series devices.
151 -
152 -{{code language="JavaScript"}}
153 -/** Decoder **/
154 -
155 -// decode payload to string
156 -var payloadStr = decodeToString(payload);
157 -var data = JSON.parse(payloadStr);
158 -
159 -var deviceName = metadata.topic.split("/")[3];
160 -// decode payload to JSON
161 -var deviceType = 'sensor';
162 -
163 -// Result object with device attributes/telemetry data
164 -var result = {
165 - deviceName: deviceName,
166 - deviceType: deviceType,
167 - attributes: {
168 - integrationName: metadata['integrationName'],
169 - },
170 - telemetry: {
171 - temperature: data.temperature,
172 - humidity: data.humidity,
173 - }
174 -};
175 -
176 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
177 -
178 -return result;
179 -{{/code}}
180 -
181 -
182 -Click on the **Add** button.
183 -
184 -
185 -
186 -[[image:add-uplink-data-converter.png||height="529" width="500"]]
187 -
188 -
189 -You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
190 -
191 -[[image:data-converter-list-showing-uplink-dc.png]]
192 -
193 -
194 -
195 -== 3.2 Downlink ==
196 -
197 -
198 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
199 -
200 -
201 -[[image:create-new-converter-menu.png||width="500"]]
202 -
203 -
204 -
205 -The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
206 -
207 -Click on the **TBEL** button if not selected it by default. Now copy and paste the following encoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This encoder function is compatible for both NB and CB series devices.
208 -
209 -
210 -{{code language="JavaScript"}}
211 -// Encode downlink data from incoming Rule Engine message
212 -
213 -// msg - JSON message payload downlink message json
214 -// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
215 -// metadata - list of key-value pairs with additional data about the message
216 -// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
217 -
218 -/** Encoder **/
219 -
220 -var data = {};
221 -
222 -// Process data from incoming message and metadata
223 -
224 -data.tempFreq = msg.temperatureUploadFrequency;
225 -data.humFreq = msg.humidityUploadFrequency;
226 -
227 -data.devSerialNumber = metadata['ss_serialNumber'];
228 -
229 -// Result object with encoded downlink payload
230 -var result = {
231 -
232 - // downlink data content type: JSON, TEXT or BINARY (base64 format)
233 - contentType: "JSON",
234 -
235 - // downlink data
236 - data: JSON.stringify(data),
237 -
238 - // Optional metadata object presented in key/value format
239 - metadata: {
240 - topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
241 - }
242 -
243 -};
244 -
245 -return result;
246 -{{/code}}
247 -
248 -
249 -Click on the **Add** button.
250 -
251 -
252 -
253 -[[image:add-downlink-data-converter.png||height="529" width="500"]]
254 -
255 -
256 -You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
257 -
258 -
259 -[[image:data-converters-list.png]]
260 -
261 -
262 -
263 -= 4. Add Integration =
264 -
265 -
266 -In the left navigation, click **Integrations center**, and then click **Integrations**.
267 -
268 -
269 -[[image:integrations-list-empty.png]]
270 -
271 -
272 -On the **Integrations** page, click on the '**+**' button.
273 -
274 -
275 -The **Add integration** window appears.
276 -
277 -In the **Add integration** window, configure the following settings:
278 -
279 -
280 -**Basic settings:**
281 -
282 -* **Integration type**: MQTT
283 -* **Name**: MQTT integration NB/CB
284 -* **Enable integration**: YES
285 -* **Allows create devices or assets**: YES
286 -
287 -Click **Next** button.
288 -
289 -
290 -
291 -[[image:add-integration-basic-settings.png||height="511" width="500"]]
292 -
293 -
294 -**Uplink data converter:**
295 -
296 -* Click on the **Select existing** button.
297 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
298 -
299 -Click **Next** button.
300 -
301 -
302 -
303 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
304 -
305 -
306 -**Downlink data converter:**
307 -
308 -* Click on the **Select existing** button.
309 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
310 -
311 -Click **Next** button.
312 -
313 -
314 -
315 -[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
316 -
317 -
318 -**Connection:**
319 -
320 -* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
321 -* **Port**: 8883
322 -* **Credentials**: Basic
323 -* **Enable SSL**: YES
324 -* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
325 -* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
326 -* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
327 -* **QoS:** 0-At most once
328 -
329 -[[image:add-integration-connection.png||height="511" width="500"]]
330 -
331 -
332 -Click on the **Advanced settings** button.
333 -
334 -* **Clean session:** NO
335 -* **Retained**: NO
336 -
337 -[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
338 -
339 -
340 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
341 -
342 -
343 -[[image:check-connection.png||height="83" width="300"]]
344 -
345 -
346 -If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.
347 -
348 -
349 -[[image:connection-success.png||height="511" width="500"]]
350 -
351 -
352 -Click on the **Add** button.
353 -
354 -You should see that the newly added integration is listed on the **Integrations** page.
355 -
356 -Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
357 -
358 -
359 -
360 -[[image:new-integration-pending.png]]
361 -
362 -
363 -= 5. Verifying the receipt of data from the device =
364 -
365 -
366 -On the terminal, issue the following MQTT command which simulates the device S31B-NB.
367 -
368 -{{code language="none"}}
369 -mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
370 -{{/code}}
371 -
372 -If the integration was performed without errors, after the transmission of the first telemetry, a new device with the name “S31B-NB” 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.
10 +
add-downlink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -175.2 KB
Content
add-integration-basic-settings.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -122.5 KB
Content
add-integration-connection-advanced-settings.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -155.2 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
add-integration-uplink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -120.7 KB
Content
add-uplink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -174.1 KB
Content
check-connection.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -14.7 KB
Content
connection-success.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -90.0 KB
Content
create-new-converter-menu.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -31.5 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-converters-list-empty.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -260.7 KB
Content
data-converters-list.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -212.2 KB
Content
hivemq-10.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -82.7 KB
Content
hivemq-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -300.7 KB
Content
hivemq-3.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -535.2 KB
Content
hivemq-4.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -309.8 KB
Content
hivemq-5.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -115.0 KB
Content
hivemq-6.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -321.0 KB
Content
hivemq-7.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -203.5 KB
Content
hivemq-8.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -268.7 KB
Content
hivemq-9.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -303.7 KB
Content
hivwmq-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -380.3 KB
Content
integrations-list-empty.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -264.5 KB
Content
new-integration-pending.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -199.7 KB
Content
thingsboard-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -1.9 MB
Content
thingsboard-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -901.1 KB
Content
thingsboard-3.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -146.3 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-Device.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +225.5 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-data-converter.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
ThingsBoard-add-new-device.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +89.7 KB
Content
ThingsBoard-new-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +100.3 KB
Content