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 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,217 +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  
26 +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.
30 30  
31 -= Data Converters =
32 32  
29 +== 2.1 Uplink ==
33 33  
34 -== Uplink ==
35 35  
36 -In the left navigation, click ‘Integrations center’, and then click ‘Data converters’.
32 +In the left navigation, click **Integrations center**, and then click **Data converters**.
37 37  
38 38  
39 -[[image:ThingsBoard-Data-Converters.png]]
40 40  
36 +[[image:data-converters-list-empty.png]]
41 41  
42 -On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
43 43  
39 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
44 44  
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’.
43 +[[image:create-new-converter-menu.png||height="259" width="500"]]
49 49  
50 -Click on the ‘JavaScript’ button. Now copy and paste the following script to the ‘Decoder function’ section:
51 51  
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 +
52 52  {{code language="JavaScript"}}
53 -//Version: 0.1
51 +/** Decoder **/
52 +
54 54  // decode payload to string
55 55  var payloadStr = decodeToString(payload);
55 +var data = JSON.parse(payloadStr);
56 56  
57 +var deviceName = metadata.topic.split("/")[3];
57 57  // decode payload to JSON
58 -var objdata = {};
59 -var obj1 = {};
60 -var data = decodeToJson(payload);
61 -var deviceName = data.IMEI;
62 -delete data.IMEI;
63 -var modelname = "Dragino " + data.Model;
64 -//var mod = data.mod
65 -delete data.Model;
66 -//delete data.mod
67 -var timestamp = new Date().getTime();
59 +var deviceType = 'sensor';
68 68  
69 -for (var key in data) {
70 -
71 - if (Number(key)) {
72 - obj1[key] = data[key];
73 - obj1[key][obj1[key].length - 1] = Number(new Date(
74 - obj1[key][obj1[key].length - 1]));
75 -
76 - }
77 -//Alec submitted25/02/25
78 -//turn old key into new
79 - else if (key === "Reading") {
80 - objdata["reading"] = data[key];
81 - } else if (key === "work mode") {
82 - objdata["work_mode"] = data[key];
83 - } else if (key === "hum") {
84 - objdata["humidity"] = data[key];
85 - }else if (key === "hum2") {
86 - objdata["humidity2"] = data[key];
87 - } else if (key === "hum3") {
88 - objdata["humidity3"] = data[key];
89 - } else if (key === "tem") {
90 - objdata["temperature"] = data[key];
91 - } else if (key === "tem2") {
92 - objdata["temperature2"] = data[key];
93 - } else if (key === "tem3") {
94 - objdata["temperature3"] = data[key];
95 - } else if (key === "DS18B20_Temp") {
96 - objdata["temperature_pro"] = data[key];
97 - } else if (key === "ds18b20_temperature") {
98 - objdata["temperature_pro"] = data[key];
99 - } else if (key === "DS18B20_temperature_pro") {
100 - objdata["temperature_pro"] = data[key];
101 - } else if (key === "tdc send flag") {
102 - objdata["tdc_send_flag"] = data[key];
103 - } else if (key === "trigger mode") {
104 - objdata["trigger_mode"] = data[key];
105 - } else if (key === "soil dielectric constant") {
106 - objdata["soil_dielectric_constant"] = data[key];
107 - } else if (key === "door open num") {
108 - objdata["door_open_num"] = data[key];
109 - } else if (key === "door duration") {
110 - objdata["door_duration"] = data[key];
111 - } else if (key === "count time") {
112 - objdata["count_time"] = data[key];
113 - } else if (key === "last open time2") {
114 - objdata["last_open_time2"] = data[key];
115 - } else if (key === "last open time3") {
116 - objdata["last_open_time3"] = data[key];
117 - }
118 -//Alec submitted25/02/25
119 - else {
120 - objdata[key] = data[key]
121 - }
122 -}
123 -var listdata = [{
124 - "ts": timestamp,
125 - "values": objdata
126 -}]
127 -for (var key1 in obj1) {
128 - if (modelname == "Dragino RS485-NB") {
129 - listdata.push({
130 - "ts": obj1[key1][obj1[key1].length - 1],
131 - "values": {
132 - "Payload": obj1[key1][0],
133 - }
134 - })
135 - } else {
136 - listdata.push({
137 - "ts": obj1[key1][obj1[key1].length - 1],
138 - "values": {
139 - "values": obj1[key1]
140 - },
141 - })
142 - }
143 -}
61 +// Result object with device attributes/telemetry data
144 144  var result = {
145 -
146 146   deviceName: deviceName,
147 - deviceType: modelname,
64 + deviceType: deviceType,
148 148   attributes: {
149 - model: modelname,
150 - //customerName: "NB-CB",
151 - //groupName: "NB-CB",
152 - //integrationName: metadata['integrationName']
153 -
66 + integrationName: metadata['integrationName'],
154 154   },
155 - telemetry: listdata
156 -}
68 + telemetry: {
69 + temperature: data.temperature,
70 + humidity: data.humidity,
71 + }
72 +};
157 157  
158 -function decodeToString(payload) {
159 - return String.fromCharCode.apply(String, payload);
160 -}
74 +/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
161 161  
162 -function decodeToJson(payload) {
163 - // covert payload to string.
164 - var str = decodeToString(payload);
76 +return result;
77 +{{/code}}
165 165  
166 - // parse string to JSON
167 - var data = JSON.parse(str);
168 - return data;
169 -}
170 170  
171 -return result;
80 +Click on the **Add** button.
172 172  
173 -{{/code}}
174 174  
175 -Click on the ‘Add’ button.
176 176  
84 +[[image:add-uplink-data-converter.png||height="529" width="500"]]
177 177  
178 -[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
179 179  
87 +You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
180 180  
181 -The uplink data converter is added to ThingsBoard and appears on the ‘Data Converters’ page
89 +[[image:data-converter-list-showing-uplink-dc.png]]
182 182  
183 183  
184 -== Downlink ==
92 +== 3.2 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.
187 187  
95 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
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**’.
100 +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:
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.
195 195  
196 196  
197 197  {{code language="JavaScript"}}
198 -function hexToBase64(hexString) {
199 - // 将16进制字符串两个字符转换为一个字节
200 - var bytes = hexString.match(/.{2}/g);
201 - // 对每个字节进行解析，并转换为对应的字符
202 - var binaryString = bytes.map(function(byte) {
203 - return String.fromCharCode(parseInt(byte, 16));
204 - }).join('');
205 -
206 - // 使用btoa进行base64编码
207 - return btoa(binaryString);
208 -}
106 +// Encode downlink data from incoming Rule Engine message
209 209  
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 +
210 210  // Result object with encoded downlink payload
211 211  var result = {
126 +
212 212   // downlink data content type: JSON, TEXT or BINARY (base64 format)
213 - contentType: "BINARY",
128 + contentType: "JSON",
214 214  
215 215   // downlink data
216 - data:hexToBase64(metadata.shared_value)
131 + data: JSON.stringify(data),
217 217  
218 218   // Optional metadata object presented in key/value format
219 - //metadata: {}
134 + metadata: {
135 + topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
136 + }
220 220  
221 221  };
222 222  
... ... @@ -227,79 +227,102 @@
227 227  Click on the **Add** button.
228 228  
229 229  
230 -[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
231 231  
148 +[[image:add-downlink-data-converter.png||height="529" width="500"]]
232 232  
233 -= Add Integration =
234 234  
235 -In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
151 +You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
236 236  
237 -On the ‘Integrations’ page, click on the “+” button.
238 238  
239 239  
240 -[[image:ThingsBoard-add-integration.png]]
155 +[[image:data-converters-list.png]]
241 241  
157 += 3. Add Integration =
242 242  
243 -The ‘Add integration’ window appears.
244 244  
245 -In the Add Integration window, configure the following settings:
160 +In the left navigation, click **Integrations center**, and then click **Integrations**.
246 246  
162 +On the **Integrations** page, click on the '**+**' button.
163 +
164 +[[image:data-converter-list-page.png]]
165 +
166 +
167 +The **Add integration** window appears.
168 +
169 +In the **Add integration** window, configure the following settings:
170 +
171 +
247 247  **Basic settings:**
248 248  
249 -* **Integration type**: UDP
250 -* **Name**: UDP Integration NB/CB
174 +* **Integration type**: MQTT
175 +* **Name**: MQTT integration NB/CB
251 251  
252 252  Click **Next** button.
253 253  
254 -
255 255  [[image:add-integration-basic-settings.png||height="511" width="500"]]
256 256  
257 257  
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.
184 +* Click on the **Select existing** button.
185 +* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
262 262  
263 263  Click **Next** button.
264 264  
189 +[[image:add-integration-uplink-data-converter.png||width="500"]]
265 265  
266 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
267 267  
268 -
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.
194 +* Click on the **Select existing** button.
195 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
273 273  
274 274  Click **Next** button.
275 275  
199 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
276 276  
277 -[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
278 278  
279 -
280 280  **Connection:**
281 281  
282 -**Port**: 11582
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
283 283  
284 -**Size of the buffer for inbound socket (in KB)**: 64
215 +Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
285 285  
286 -**Cache Size**: 10000000
217 +[[image:add-integration-connection.png||width="500"]]
287 287  
288 -**Cache time to live in minutes**: 1440
289 289  
220 +If the connection is successful, you will see the **Connected** message.
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’.
292 -
293 293  Click on the **Add** button.
294 294  
224 +[[image:add-connection-success.png||height="511" width="500"]]
295 295  
296 -[[image:add-integration-connection.png||height="511" width="500"]]
297 297  
227 +You should see that the newly added integration is listed on the **Integrations** page.
298 298  
229 +Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
299 299  
300 -= Verifying the receipt of data from the device =
231 +[[image:integrations-list-added-pending.png]]
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  
234 += 5. Verifying the receipt of data from the device =
304 304  
236 +
237 +On the terminal, issue the following MQTT command which simulates the device S31B-NB.
238 +
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 +
305 305  
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-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
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