Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 93.1
edited by Dilisi S
on 2025/03/08 03:59
Change comment: Mar 7 edits -part 1
To version 18.1
edited by Dilisi S
on 2025/03/04 04:01
Change comment: Mar 3 edits - part 2

Summary

Details

Page properties
Content
... ... @@ -6,134 +6,217 @@
6 6  Draft Document
7 7  {{/warning}}
8 8  
9 += Introduction =
9 9  
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.
10 10  
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.
11 11  
12 -= 1. Introduction =
13 13  
16 += Add New Device =
14 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.
18 +In the left navigation, click **Entities** and then click **Devices**.
16 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 18  
21 +[[image:ThingsBoard-Device.png]]
19 19  
20 20  
24 +On the ‘**Devices**’ page, click on the ‘**+**’ button, and then click on the ‘**Add new device**’ from the dropdown menu.
21 21  
22 22  
23 -= 2. Data Converters =
27 +[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
24 24  
25 25  
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.
27 27  
31 += Data Converters =
28 28  
29 -== 2.1 Uplink ==
30 30  
34 +== Uplink ==
31 31  
32 -In the left navigation, click **Integrations center**, and then click **Data converters**.
36 +In the left navigation, click ‘Integrations center’, and then click ‘Data converters’.
33 33  
34 34  
39 +[[image:ThingsBoard-Data-Converters.png]]
35 35  
36 -[[image:data-converters-list-empty.png]]
37 37  
42 +On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
38 38  
39 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
40 40  
45 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
41 41  
42 42  
43 -[[image:create-new-converter-menu.png||height="259" width="500"]]
48 +The ‘Add data converter’ window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as ‘Uplink’.
44 44  
50 +Click on the ‘JavaScript’ button. Now copy and paste the following script to the ‘Decoder function’ section:
45 45  
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 -
50 50  {{code language="JavaScript"}}
51 -/** Decoder **/
52 -
53 +//Version: 0.1
53 53  // decode payload to string
54 54  var payloadStr = decodeToString(payload);
55 -var data = JSON.parse(payloadStr);
56 56  
57 -var deviceName = metadata.topic.split("/")[3];
58 58  // decode payload to JSON
59 -var deviceType = 'sensor';
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();
60 60  
61 -// Result object with device attributes/telemetry data
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 +}
62 62  var result = {
145 +
63 63   deviceName: deviceName,
64 - deviceType: deviceType,
147 + deviceType: modelname,
65 65   attributes: {
66 - integrationName: metadata['integrationName'],
149 + model: modelname,
150 + //customerName: "NB-CB",
151 + //groupName: "NB-CB",
152 + //integrationName: metadata['integrationName']
153 +
67 67   },
68 - telemetry: {
69 - temperature: data.temperature,
70 - humidity: data.humidity,
71 - }
72 -};
155 + telemetry: listdata
156 +}
73 73  
74 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
158 +function decodeToString(payload) {
159 + return String.fromCharCode.apply(String, payload);
160 +}
75 75  
76 -return result;
77 -{{/code}}
162 +function decodeToJson(payload) {
163 + // covert payload to string.
164 + var str = decodeToString(payload);
78 78  
166 + // parse string to JSON
167 + var data = JSON.parse(str);
168 + return data;
169 +}
79 79  
80 -Click on the **Add** button.
171 +return result;
81 81  
173 +{{/code}}
82 82  
175 +Click on the ‘Add’ button.
83 83  
84 -[[image:add-uplink-data-converter.png||height="529" width="500"]]
85 85  
178 +[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
86 86  
87 -You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
88 88  
89 -[[image:data-converter-list-showing-uplink-dc.png]]
181 +The uplink data converter is added to ThingsBoard and appears on the ‘Data Converters’ page
90 90  
91 91  
92 -== 3.2 Downlink ==
184 +== Downlink ==
93 93  
186 +On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
94 94  
95 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
96 96  
97 97  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
98 98  
99 99  
100 -The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
192 +The ‘**Add data converter**’ window will appear. Name it ‘**UDP Downlink Converter NB/CB**’ and select the Type as ‘**Downlink**’.
101 101  
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.
194 +Click on the ‘**JavaScript**’ button. Now copy and paste the following script to the ‘**Encoder function**’ section:
103 103  
104 104  
105 105  {{code language="JavaScript"}}
106 -// Encode downlink data from incoming Rule Engine message
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 +}
107 107  
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 -
124 124  // Result object with encoded downlink payload
125 125  var result = {
126 -
127 127   // downlink data content type: JSON, TEXT or BINARY (base64 format)
128 - contentType: "JSON",
213 + contentType: "BINARY",
129 129  
130 130   // downlink data
131 - data: JSON.stringify(data),
216 + data:hexToBase64(metadata.shared_value)
132 132  
133 133   // Optional metadata object presented in key/value format
134 - metadata: {
135 - topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
136 - }
219 + //metadata: {}
137 137  
138 138  };
139 139  
... ... @@ -144,102 +144,79 @@
144 144  Click on the **Add** button.
145 145  
146 146  
230 +[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
147 147  
148 -[[image:add-downlink-data-converter.png||height="529" width="500"]]
149 149  
233 += Add Integration =
150 150  
151 -You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
235 +In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
152 152  
237 +On the ‘Integrations’ page, click on the “+” button.
153 153  
154 154  
155 -[[image:data-converters-list.png]]
240 +[[image:ThingsBoard-add-integration.png]]
156 156  
157 -= 3. Add Integration =
158 158  
243 +The ‘Add integration’ window appears.
159 159  
160 -In the left navigation, click **Integrations center**, and then click **Integrations**.
245 +In the Add Integration window, configure the following settings:
161 161  
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 -
172 172  **Basic settings:**
173 173  
174 -* **Integration type**: MQTT
175 -* **Name**: MQTT integration NB/CB
249 +* **Integration type**: UDP
250 +* **Name**: UDP Integration NB/CB
176 176  
177 177  Click **Next** button.
178 178  
254 +
179 179  [[image:add-integration-basic-settings.png||height="511" width="500"]]
180 180  
181 181  
182 182  **Uplink data converter:**
183 183  
184 -* Click on the **Select existing** button.
185 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
260 +* Click on the ‘**Select existing**’ button.
261 +* Uplink data converter: Select ‘**UDP Uplink Converter NB/CB**’ from the dropdown list.
186 186  
187 187  Click **Next** button.
188 188  
189 -[[image:add-integration-uplink-data-converter.png||width="500"]]
190 190  
266 +[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
191 191  
268 +
192 192  **Downlink data converter:**
193 193  
194 -* Click on the **Select existing** button.
195 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
271 +* Click on the ‘**Select existing**’ button.
272 +* Downlink data converter: Select ‘**UDP Downlink Converter NB/CB**’ from the dropdown list.
196 196  
197 197  Click **Next** button.
198 198  
199 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
200 200  
277 +[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
201 201  
279 +
202 202  **Connection:**
203 203  
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
282 +**Port**: 11582
214 214  
215 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
284 +**Size of the buffer for inbound socket (in KB)**: 64
216 216  
217 -[[image:add-integration-connection.png||width="500"]]
286 +**Cache Size**: 10000000
218 218  
288 +**Cache time to live in minutes**: 1440
219 219  
220 -If the connection is successful, you will see the **Connected** message.
221 221  
291 +Copy the two keys, **Integration key** and **Integration secret** into a text editor, as you will need them in the section ‘xxxxx’.
292 +
222 222  Click on the **Add** button.
223 223  
224 -[[image:add-connection-success.png||height="511" width="500"]]
225 225  
296 +[[image:add-integration-connection.png||height="511" width="500"]]
226 226  
227 -You should see that the newly added integration is listed on the **Integrations** page.
228 228  
229 -Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
230 230  
231 -[[image:integrations-list-added-pending.png]]
300 += Verifying the receipt of data from the device =
232 232  
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.
233 233  
234 -= 5. Verifying the receipt of data from the device =
235 235  
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 -
245 245  
add-downlink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -175.2 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
create-new-converter-menu.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -31.5 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
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
add-integration-basic-settings.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +122.5 KB
Content
add-integration-connection.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +124.4 KB
Content
add-integration-downlink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +123.0 KB
Content
add-integration-uplink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +120.7 KB
Content