Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 32.1
edited by Dilisi S
on 2025/03/04 19:31
Change comment: Deleted image "ThingsBoard-add-data-converter-downlink.png"
To version 93.1
edited by Dilisi S
on 2025/03/08 03:59
Change comment: Mar 7 edits -part 1

Summary

Details

Page properties
Content
... ... @@ -6,222 +6,134 @@
6 6  Draft Document
7 7  {{/warning}}
8 8  
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.
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  
12 += 1. Introduction =
15 15  
16 -= Add New Device =
17 17  
18 -In the left navigation, click **Entities** and then click **Devices**.
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.
19 19  
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**.
20 20  
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.
25 25  
26 26  
27 -[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
23 += 2. Data Converters =
28 28  
29 29  
30 -
31 -= Data Converters =
32 -
33 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 35  
36 -== Uplink ==
29 +== 2.1 Uplink ==
37 37  
31 +
38 38  In the left navigation, click **Integrations center**, and then click **Data converters**.
39 39  
40 40  
41 -[[image:ThingsBoard-Data-Converters.png]]
42 42  
36 +[[image:data-converters-list-empty.png]]
43 43  
44 -On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
45 45  
39 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
46 46  
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 ‘**UDP Uplink Converter NB/CB**’ and select the Type as **Uplink**.
43 +[[image:create-new-converter-menu.png||height="259" width="500"]]
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.
53 53  
46 +The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
47 +
48 +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.
49 +
54 54  {{code language="JavaScript"}}
55 -//Version: 0.1
51 +/** Decoder **/
52 +
56 56  // decode payload to string
57 57  var payloadStr = decodeToString(payload);
55 +var data = JSON.parse(payloadStr);
58 58  
57 +var deviceName = metadata.topic.split("/")[3];
59 59  // decode payload to JSON
60 -var objdata = {};
61 -var obj1 = {};
62 -var data = decodeToJson(payload);
63 -var deviceName = data.IMEI;
64 -delete data.IMEI;
65 -var modelname = "Dragino " + data.Model;
66 -//var mod = data.mod
67 -delete data.Model;
68 -//delete data.mod
69 -var timestamp = new Date().getTime();
59 +var deviceType = 'sensor';
70 70  
71 -for (var key in data) {
72 -
73 - if (Number(key)) {
74 - obj1[key] = data[key];
75 - obj1[key][obj1[key].length - 1] = Number(new Date(
76 - obj1[key][obj1[key].length - 1]));
77 -
78 - }
79 -//Alec submitted25/02/25
80 -//turn old key into new
81 - else if (key === "Reading") {
82 - objdata["reading"] = data[key];
83 - } else if (key === "work mode") {
84 - objdata["work_mode"] = data[key];
85 - } else if (key === "hum") {
86 - objdata["humidity"] = data[key];
87 - }else if (key === "hum2") {
88 - objdata["humidity2"] = data[key];
89 - } else if (key === "hum3") {
90 - objdata["humidity3"] = data[key];
91 - } else if (key === "tem") {
92 - objdata["temperature"] = data[key];
93 - } else if (key === "tem2") {
94 - objdata["temperature2"] = data[key];
95 - } else if (key === "tem3") {
96 - objdata["temperature3"] = data[key];
97 - } else if (key === "DS18B20_Temp") {
98 - objdata["temperature_pro"] = data[key];
99 - } else if (key === "ds18b20_temperature") {
100 - objdata["temperature_pro"] = data[key];
101 - } else if (key === "DS18B20_temperature_pro") {
102 - objdata["temperature_pro"] = data[key];
103 - } else if (key === "tdc send flag") {
104 - objdata["tdc_send_flag"] = data[key];
105 - } else if (key === "trigger mode") {
106 - objdata["trigger_mode"] = data[key];
107 - } else if (key === "soil dielectric constant") {
108 - objdata["soil_dielectric_constant"] = data[key];
109 - } else if (key === "door open num") {
110 - objdata["door_open_num"] = data[key];
111 - } else if (key === "door duration") {
112 - objdata["door_duration"] = data[key];
113 - } else if (key === "count time") {
114 - objdata["count_time"] = data[key];
115 - } else if (key === "last open time2") {
116 - objdata["last_open_time2"] = data[key];
117 - } else if (key === "last open time3") {
118 - objdata["last_open_time3"] = data[key];
119 - }
120 -//Alec submitted25/02/25
121 - else {
122 - objdata[key] = data[key]
123 - }
124 -}
125 -var listdata = [{
126 - "ts": timestamp,
127 - "values": objdata
128 -}]
129 -for (var key1 in obj1) {
130 - if (modelname == "Dragino RS485-NB") {
131 - listdata.push({
132 - "ts": obj1[key1][obj1[key1].length - 1],
133 - "values": {
134 - "Payload": obj1[key1][0],
135 - }
136 - })
137 - } else {
138 - listdata.push({
139 - "ts": obj1[key1][obj1[key1].length - 1],
140 - "values": {
141 - "values": obj1[key1]
142 - },
143 - })
144 - }
145 -}
61 +// Result object with device attributes/telemetry data
146 146  var result = {
147 -
148 148   deviceName: deviceName,
149 - deviceType: modelname,
64 + deviceType: deviceType,
150 150   attributes: {
151 - model: modelname,
152 - //customerName: "NB-CB",
153 - //groupName: "NB-CB",
154 - //integrationName: metadata['integrationName']
155 -
66 + integrationName: metadata['integrationName'],
156 156   },
157 - telemetry: listdata
158 -}
68 + telemetry: {
69 + temperature: data.temperature,
70 + humidity: data.humidity,
71 + }
72 +};
159 159  
160 -function decodeToString(payload) {
161 - return String.fromCharCode.apply(String, payload);
162 -}
74 +/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
163 163  
164 -function decodeToJson(payload) {
165 - // covert payload to string.
166 - var str = decodeToString(payload);
167 -
168 - // parse string to JSON
169 - var data = JSON.parse(str);
170 - return data;
171 -}
172 -
173 173  return result;
174 -
175 175  {{/code}}
176 176  
79 +
177 177  Click on the **Add** button.
178 178  
179 179  
180 -[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
181 181  
84 +[[image:add-uplink-data-converter.png||height="529" width="500"]]
182 182  
183 -You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
184 184  
87 +You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
185 185  
186 -[[image:Data-converter-list-uplink-only.png]]
89 +[[image:data-converter-list-showing-uplink-dc.png]]
187 187  
188 188  
189 -== Downlink ==
92 +== 3.2 Downlink ==
190 190  
94 +
191 191  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
192 192  
193 -
194 194  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
195 195  
196 196  
197 -The **Add data converter** window will appear. Name it ‘**UDP Downlink Converter NB/CB**’ and select the Type as **Downlink**.
100 +The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
198 198  
199 -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.
102 +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.
200 200  
201 201  
202 202  {{code language="JavaScript"}}
203 -function hexToBase64(hexString) {
204 - // 将16进制字符串两个字符转换为一个字节
205 - var bytes = hexString.match(/.{2}/g);
206 - // 对每个字节进行解析，并转换为对应的字符
207 - var binaryString = bytes.map(function(byte) {
208 - return String.fromCharCode(parseInt(byte, 16));
209 - }).join('');
210 -
211 - // 使用btoa进行base64编码
212 - return btoa(binaryString);
213 -}
106 +// Encode downlink data from incoming Rule Engine message
214 214  
108 +// msg - JSON message payload downlink message json
109 +// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
110 +// metadata - list of key-value pairs with additional data about the message
111 +// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
112 +
113 +/** Encoder **/
114 +
115 +var data = {};
116 +
117 +// Process data from incoming message and metadata
118 +
119 +data.tempFreq = msg.temperatureUploadFrequency;
120 +data.humFreq = msg.humidityUploadFrequency;
121 +
122 +data.devSerialNumber = metadata['ss_serialNumber'];
123 +
215 215  // Result object with encoded downlink payload
216 216  var result = {
126 +
217 217   // downlink data content type: JSON, TEXT or BINARY (base64 format)
218 - contentType: "BINARY",
128 + contentType: "JSON",
219 219  
220 220   // downlink data
221 - data:hexToBase64(metadata.shared_value)
131 + data: JSON.stringify(data),
222 222  
223 223   // Optional metadata object presented in key/value format
224 - //metadata: {}
134 + metadata: {
135 + topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
136 + }
225 225  
226 226  };
227 227  
... ... @@ -232,25 +232,26 @@
232 232  Click on the **Add** button.
233 233  
234 234  
235 -[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
236 236  
148 +[[image:add-downlink-data-converter.png||height="529" width="500"]]
237 237  
238 -You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
239 239  
151 +You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
240 240  
241 -[[image:Data-converter-list.png]]
242 242  
243 243  
244 -= Add Integration =
155 +[[image:data-converters-list.png]]
245 245  
157 += 3. Add Integration =
158 +
159 +
246 246  In the left navigation, click **Integrations center**, and then click **Integrations**.
247 247  
248 248  On the **Integrations** page, click on the '**+**' button.
249 249  
164 +[[image:data-converter-list-page.png]]
250 250  
251 -[[image:ThingsBoard-add-integration.png]]
252 252  
253 -
254 254  The **Add integration** window appears.
255 255  
256 256  In the **Add integration** window, configure the following settings:
... ... @@ -258,12 +258,11 @@
258 258  
259 259  **Basic settings:**
260 260  
261 -* **Integration type**: UDP
262 -* **Name**: UDP Integration NB/CB
174 +* **Integration type**: MQTT
175 +* **Name**: MQTT integration NB/CB
263 263  
264 264  Click **Next** button.
265 265  
266 -
267 267  [[image:add-integration-basic-settings.png||height="511" width="500"]]
268 268  
269 269  
... ... @@ -270,50 +270,64 @@
270 270  **Uplink data converter:**
271 271  
272 272  * Click on the **Select existing** button.
273 -* **Uplink data converter**: Select **UDP Uplink Converter NB/CB **from the dropdown list.
185 +* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
274 274  
275 275  Click **Next** button.
276 276  
189 +[[image:add-integration-uplink-data-converter.png||width="500"]]
277 277  
278 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
279 279  
280 -
281 281  **Downlink data converter:**
282 282  
283 283  * Click on the **Select existing** button.
284 -* **Downlink data converter**: Select **UDP Downlink Converter NB/CB **from the dropdown list.
195 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
285 285  
286 286  Click **Next** button.
287 287  
199 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
288 288  
289 -[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
290 290  
291 -
292 292  **Connection:**
293 293  
294 -* **Port**: 11582
295 -* **Size of the buffer for inbound socket (in KB)**: 64
296 -* **Cache Size**: 10000000
297 -* **Cache time to live in minutes**: 1440
204 +* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
205 +* **Port**: 8883
206 +* **Credentials**: Basic
207 +* **Enable SSL**: YES
208 +* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
209 +* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
210 +* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
211 +* **QoS:** 0-At most once
212 +* **Clean session:** NO
213 +* **Retained**: NO
298 298  
299 -Copy the two keys, **Integration key** and **Integration secret** into a text editor, as you will need them in the section ‘xxxxx’.
215 +Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
300 300  
301 -Click on the **Add** button.
217 +[[image:add-integration-connection.png||width="500"]]
302 302  
303 303  
304 -[[image:add-integration-connection.png||height="511" width="500"]]
220 +If the connection is successful, you will see the **Connected** message.
305 305  
222 +Click on the **Add** button.
306 306  
224 +[[image:add-connection-success.png||height="511" width="500"]]
225 +
226 +
307 307  You should see that the newly added integration is listed on the **Integrations** page.
308 308  
309 309  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
310 310  
311 -[[image:Integrations-list.png]]
231 +[[image:integrations-list-added-pending.png]]
312 312  
313 313  
314 -= Verifying the receipt of data from the device =
234 += 5. Verifying the receipt of data from the device =
315 315  
316 -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.
317 317  
237 +On the terminal, issue the following MQTT command which simulates the device S31B-NB.
318 318  
239 +{{code language="none"}}
240 +mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
241 +{{/code}}
242 +
243 +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.
244 +
319 319  
Data-converter-list.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 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.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
ThingsBoard-add-new-device.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -89.7 KB
Content
ThingsBoard-new-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -100.3 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 -128.6 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
uplink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
add-downlink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +175.2 KB
Content
add-uplink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +174.1 KB
Content
create-new-converter-menu.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +31.5 KB
Content
data-converters-list-empty.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +260.7 KB
Content
data-converters-list.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +212.2 KB
Content