Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 65.1
edited by Xiaoling
on 2025/03/07 11:48
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
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Xiaoling
1 +XWiki.pradeeka
Content
... ... @@ -2,384 +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. Add New Device =
21 -
22 -
23 -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.
24 -
25 -In the left navigation, click **Entities** and then click **Devices**.
26 -
27 -[[image:device-list-empty.png]]
28 -
29 -
30 -On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
31 -
32 -[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
33 -
34 -
35 -The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
36 -
37 -Click on the **Next: Credentials** button.
38 -
39 -[[image:new-device-device-details.png||height="529" width="500"]]
40 -
41 -
42 -Click the **Access token** button if it is not selected by default.
43 -
44 -Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
45 -
46 -Click on the **Add** button.
47 -
48 -[[image:new-device-access-token.png||height="528" width="500"]]
49 -
50 -
51 -Click on the **MQTT** button.
52 -
53 -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.
54 -
55 -Copy the MQTT pub command in the '**Execute the following command**' section.
56 -
57 -{{code language="none"}}
58 -mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/me/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:25}"
59 -{{/code}}
60 -
61 -Note that the **State** is still shown as **'Inactive'** in the **Latest telemetry** section.
62 -
63 -[[image:new-device-check-connectivity.png||height="522" width="500"]]
64 -
65 -
66 -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'**. Of course, you can replace **'me'** with a device name or use the wildcard character **'+'** to match any device name.
67 -
68 -
69 -[[image:mqtt-command-1.png||height="228" width="700"]]
70 -
71 -
72 -If the command is successful, you can see the telemetry data you sent under the **Latest telemetry** section. Note that the **State** is now **'Active'** in the **Latest telemetry** section.
73 -
74 -
75 -[[image:new-device-telemetry-test.png||height="520" width="500"]]
76 -
77 -
78 -Send the same command again, only changing the **temperature** value, to see how the **Latest telemetry** section updates its data.
79 -
80 -Once you are done experimenting with this, close the window by clicking the **Close** button.
81 -
82 -
83 -[[image:mqtt-command-2.png||height="227" width="700"]]
84 -
85 -
86 -
87 -[[image:virtual-device-active.png]]
88 -
89 -
90 -= 3. Data Converters =
91 -
92 -
93 -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.
94 -
95 -
96 -== 3.1 Uplink ==
97 -
98 -
99 -In the left navigation, click **Integrations center**, and then click **Data converters**.
100 -
101 -[[image:data-converter-list-page.png]]
102 -
103 -
104 -On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
105 -
106 -[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
107 -
108 -
109 -The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
110 -
111 -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.
112 -
113 -{{code language="JavaScript"}}
114 -//Version: 0.1
115 -// decode payload to string
116 -var payloadStr = decodeToString(payload);
117 -
118 -// decode payload to JSON
119 -var objdata = {};
120 -var obj1 = {};
121 -var data = decodeToJson(payload);
122 -var deviceName = data.IMEI;
123 -delete data.IMEI;
124 -var modelname = "Dragino " + data.Model;
125 -//var mod = data.mod
126 -delete data.Model;
127 -//delete data.mod
128 -var timestamp = new Date().getTime();
129 -
130 -for (var key in data) {
131 -
132 - if (Number(key)) {
133 - obj1[key] = data[key];
134 - obj1[key][obj1[key].length - 1] = Number(new Date(
135 - obj1[key][obj1[key].length - 1]));
136 -
137 - }
138 -//Alec submitted25/02/25
139 -//turn old key into new
140 - else if (key === "Reading") {
141 - objdata["reading"] = data[key];
142 - } else if (key === "work mode") {
143 - objdata["work_mode"] = data[key];
144 - } else if (key === "hum") {
145 - objdata["humidity"] = data[key];
146 - }else if (key === "hum2") {
147 - objdata["humidity2"] = data[key];
148 - } else if (key === "hum3") {
149 - objdata["humidity3"] = data[key];
150 - } else if (key === "tem") {
151 - objdata["temperature"] = data[key];
152 - } else if (key === "tem2") {
153 - objdata["temperature2"] = data[key];
154 - } else if (key === "tem3") {
155 - objdata["temperature3"] = data[key];
156 - } else if (key === "DS18B20_Temp") {
157 - objdata["temperature_pro"] = data[key];
158 - } else if (key === "ds18b20_temperature") {
159 - objdata["temperature_pro"] = data[key];
160 - } else if (key === "DS18B20_temperature_pro") {
161 - objdata["temperature_pro"] = data[key];
162 - } else if (key === "tdc send flag") {
163 - objdata["tdc_send_flag"] = data[key];
164 - } else if (key === "trigger mode") {
165 - objdata["trigger_mode"] = data[key];
166 - } else if (key === "soil dielectric constant") {
167 - objdata["soil_dielectric_constant"] = data[key];
168 - } else if (key === "door open num") {
169 - objdata["door_open_num"] = data[key];
170 - } else if (key === "door duration") {
171 - objdata["door_duration"] = data[key];
172 - } else if (key === "count time") {
173 - objdata["count_time"] = data[key];
174 - } else if (key === "last open time2") {
175 - objdata["last_open_time2"] = data[key];
176 - } else if (key === "last open time3") {
177 - objdata["last_open_time3"] = data[key];
178 - }
179 -//Alec submitted25/02/25
180 - else {
181 - objdata[key] = data[key]
182 - }
183 -}
184 -var listdata = [{
185 - "ts": timestamp,
186 - "values": objdata
187 -}]
188 -for (var key1 in obj1) {
189 - if (modelname == "Dragino RS485-NB") {
190 - listdata.push({
191 - "ts": obj1[key1][obj1[key1].length - 1],
192 - "values": {
193 - "Payload": obj1[key1][0],
194 - }
195 - })
196 - } else {
197 - listdata.push({
198 - "ts": obj1[key1][obj1[key1].length - 1],
199 - "values": {
200 - "values": obj1[key1]
201 - },
202 - })
203 - }
204 -}
205 -var result = {
206 -
207 - deviceName: deviceName,
208 - deviceType: modelname,
209 - attributes: {
210 - model: modelname,
211 - //customerName: "NB-CB",
212 - //groupName: "NB-CB",
213 - //integrationName: metadata['integrationName']
214 -
215 - },
216 - telemetry: listdata
217 -}
218 -
219 -function decodeToString(payload) {
220 - return String.fromCharCode.apply(String, payload);
221 -}
222 -
223 -function decodeToJson(payload) {
224 - // covert payload to string.
225 - var str = decodeToString(payload);
226 -
227 - // parse string to JSON
228 - var data = JSON.parse(str);
229 - return data;
230 -}
231 -
232 -return result;
233 -
234 -{{/code}}
235 -
236 -
237 -Click on the **Add** button.
238 -
239 -[[image:uplink-data-converter.png||height="529" width="500"]]
240 -
241 -
242 -You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
243 -
244 -[[image:data-converter-list-showing-uplink-dc.png]]
245 -
246 -
247 -== 3.2 Downlink ==
248 -
249 -
250 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
251 -
252 -[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
253 -
254 -
255 -The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
256 -
257 -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.
258 -
259 -
260 -{{code language="JavaScript"}}
261 -function hexToBase64(hexString) {
262 - // 将16进制字符串两个字符转换为一个字节
263 - var bytes = hexString.match(/.{2}/g);
264 - // 对每个字节进行解析，并转换为对应的字符
265 - var binaryString = bytes.map(function(byte) {
266 - return String.fromCharCode(parseInt(byte, 16));
267 - }).join('');
268 268  
269 - // 使用btoa进行base64编码
270 - return btoa(binaryString);
271 -}
272 -
273 -// Result object with encoded downlink payload
274 -var result = {
275 - // downlink data content type: JSON, TEXT or BINARY (base64 format)
276 - contentType: "BINARY",
277 -
278 - // downlink data
279 - data:hexToBase64(metadata.shared_value)
280 -
281 - // Optional metadata object presented in key/value format
282 - //metadata: {}
283 -
284 -};
285 -
286 -return result;
287 -{{/code}}
288 -
289 -
290 -Click on the **Add** button.
291 -
292 -[[image:downlink-data-converter.png||height="530" width="500"]]
293 -
294 -
295 -You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
296 -
297 -[[image:data-converter-list.png]]
298 -
299 -
300 -= 4. Add Integration =
301 -
302 -
303 -In the left navigation, click **Integrations center**, and then click **Integrations**.
304 -
305 -On the **Integrations** page, click on the '**+**' button.
306 -
307 -[[image:data-converter-list-page.png]]
308 -
309 -
310 -The **Add integration** window appears.
311 -
312 -In the **Add integration** window, configure the following settings:
313 -
314 -
315 -**Basic settings:**
316 -
317 -* **Integration type**: MQTT
318 -* **Name**: MQTT integration NB/CB
319 -
320 -Click **Next** button.
321 -
322 -[[image:add-integration-basic-settings.png||height="511" width="500"]]
323 -
324 -
325 -**Uplink data converter:**
326 -
327 -* Click on the **Select existing** button.
328 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
329 -
330 -Click **Next** button.
331 -
332 -[[image:add-integration-uplink-data-converter.png||width="500"]]
333 -
334 -
335 -**Downlink data converter:**
336 -
337 -* Click on the **Select existing** button.
338 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
339 -
340 -Click **Next** button.
341 -
342 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
343 -
344 -
345 -**Connection:**
346 -
347 -* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
348 -* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
349 -* **Credentials**: Basic
350 -* **Username**: Access token (This is the access token you copied from the device)
351 -* **Password** - Leave it as blank
352 -* **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')
353 -* **QoS** - 0-At most once
354 -
355 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
356 -
357 -[[image:add-integration-connection.png||width="500"]]
358 -
359 -
360 -If the connection is successful, you will see the **Connected** message.
361 -
362 -Click on the **Add** button.
363 -
364 -[[image:add-connection-success.png||height="511" width="500"]]
365 -
366 -
367 -You should see that the newly added integration is listed on the **Integrations** page.
368 -
369 -Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
370 -
371 -[[image:integrations-list-added-pending.png]]
372 -
373 -
374 -= 5. Verifying the receipt of data from the device =
375 -
376 -
377 -On the terminal, issue the following MQTT command which simulates the device S31B-NB.
378 -
379 -{{code language="none"}}
380 -mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
381 -{{/code}}
382 -
383 -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.
384 -
385 -
add-connection-success.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 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.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
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
device-list-empty.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
mqtt-command-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
mqtt-command-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
new-device-access-token.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
new-device-check-connectivity.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 KB
Content
new-device-device-details.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -88.4 KB
Content
new-device-telemetry-test.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
virtual-device-active.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -202.8 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-integration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content