Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 95.1
edited by Dilisi S
on 2025/03/08 04:07
Change comment: Uploaded new attachment "data-converter-list-showing-uplink-dc.png", version {1}
To version 46.1
edited by Dilisi S
on 2025/03/05 14:48
Change comment: Uploaded new attachment "add-integration-downlink-data-converter.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -6,135 +6,223 @@
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 ==
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.
30 30  
31 31  
36 +== Uplink ==
37 +
32 32  In the left navigation, click **Integrations center**, and then click **Data converters**.
33 33  
34 34  
41 +[[image:data-converter-list-page.png]]
35 35  
36 -[[image:data-converters-list-empty.png]]
37 37  
44 +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  
47 +[[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"]]
44 -
45 -
46 46  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
47 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.
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.
49 49  
50 50  {{code language="JavaScript"}}
51 -/** Decoder **/
52 -
55 +//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';
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();
60 60  
61 -// Result object with device attributes/telemetry data
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 +}
62 62  var result = {
147 +
63 63   deviceName: deviceName,
64 - deviceType: deviceType,
149 + deviceType: modelname,
65 65   attributes: {
66 - integrationName: metadata['integrationName'],
151 + model: modelname,
152 + //customerName: "NB-CB",
153 + //groupName: "NB-CB",
154 + //integrationName: metadata['integrationName']
155 +
67 67   },
68 - telemetry: {
69 - temperature: data.temperature,
70 - humidity: data.humidity,
71 - }
72 -};
157 + telemetry: listdata
158 +}
73 73  
74 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
160 +function decodeToString(payload) {
161 + return String.fromCharCode.apply(String, payload);
162 +}
75 75  
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 +
76 76  return result;
174 +
77 77  {{/code}}
78 78  
79 -
80 80  Click on the **Add** button.
81 81  
82 82  
180 +[[image:uplink-data-converter.png||height="529" width="500"]]
83 83  
84 -[[image:add-uplink-data-converter.png||height="529" width="500"]]
85 85  
86 86  
87 -You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
184 +You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
88 88  
89 89  
187 +[[image:data-converter-list-showing-uplink-dc.png]]
90 90  
91 -[[image:create-new-converter-menu.png||width="500"]]
92 92  
93 -== 3.2 Downlink ==
190 +== Downlink ==
94 94  
95 -
96 96  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
97 97  
194 +
98 98  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
99 99  
100 100  
101 101  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
102 102  
103 -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 +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.
104 104  
105 105  
106 106  {{code language="JavaScript"}}
107 -// Encode downlink data from incoming Rule Engine message
204 +function hexToBase64(hexString) {
205 + // 将16进制字符串两个字符转换为一个字节
206 + var bytes = hexString.match(/.{2}/g);
207 + // 对每个字节进行解析，并转换为对应的字符
208 + var binaryString = bytes.map(function(byte) {
209 + return String.fromCharCode(parseInt(byte, 16));
210 + }).join('');
211 +
212 + // 使用btoa进行base64编码
213 + return btoa(binaryString);
214 +}
108 108  
109 -// msg - JSON message payload downlink message json
110 -// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
111 -// metadata - list of key-value pairs with additional data about the message
112 -// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
113 -
114 -/** Encoder **/
115 -
116 -var data = {};
117 -
118 -// Process data from incoming message and metadata
119 -
120 -data.tempFreq = msg.temperatureUploadFrequency;
121 -data.humFreq = msg.humidityUploadFrequency;
122 -
123 -data.devSerialNumber = metadata['ss_serialNumber'];
124 -
125 125  // Result object with encoded downlink payload
126 126  var result = {
127 -
128 128   // downlink data content type: JSON, TEXT or BINARY (base64 format)
129 - contentType: "JSON",
219 + contentType: "BINARY",
130 130  
131 131   // downlink data
132 - data: JSON.stringify(data),
222 + data:hexToBase64(metadata.shared_value)
133 133  
134 134   // Optional metadata object presented in key/value format
135 - metadata: {
136 - topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
137 - }
225 + //metadata: {}
138 138  
139 139  };
140 140  
... ... @@ -145,26 +145,26 @@
145 145  Click on the **Add** button.
146 146  
147 147  
236 +[[image:downlink-data-converter.png||height="530" width="500"]]
148 148  
149 -[[image:add-downlink-data-converter.png||height="529" width="500"]]
150 150  
151 151  
152 -You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
240 +You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
153 153  
154 154  
243 +[[image:data-converter-list.png]]
155 155  
156 -[[image:data-converters-list.png]]
157 157  
158 -= 3. Add Integration =
246 += Add Integration =
159 159  
160 -
161 161  In the left navigation, click **Integrations center**, and then click **Integrations**.
162 162  
163 163  On the **Integrations** page, click on the '**+**' button.
164 164  
165 -[[image:data-converter-list-page.png]]
166 166  
253 +[[image:ThingsBoard-add-integration.png]]
167 167  
255 +
168 168  The **Add integration** window appears.
169 169  
170 170  In the **Add integration** window, configure the following settings:
... ... @@ -172,11 +172,12 @@
172 172  
173 173  **Basic settings:**
174 174  
175 -* **Integration type**: MQTT
176 -* **Name**: MQTT integration NB/CB
263 +* **Integration type**: UDP
264 +* **Name**: UDP Integration NB/CB
177 177  
178 178  Click **Next** button.
179 179  
268 +
180 180  [[image:add-integration-basic-settings.png||height="511" width="500"]]
181 181  
182 182  
... ... @@ -183,63 +183,49 @@
183 183  **Uplink data converter:**
184 184  
185 185  * Click on the **Select existing** button.
186 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
275 +* **Uplink data converter**: Select **UDP Uplink Converter NB/CB **from the dropdown list.
187 187  
188 188  Click **Next** button.
189 189  
190 -[[image:add-integration-uplink-data-converter.png||width="500"]]
191 191  
280 +[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
192 192  
282 +
193 193  **Downlink data converter:**
194 194  
195 195  * Click on the **Select existing** button.
196 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
286 +* **Downlink data converter**: Select **UDP Downlink Converter NB/CB **from the dropdown list.
197 197  
198 198  Click **Next** button.
199 199  
200 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
201 201  
291 +[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
202 202  
293 +
203 203  **Connection:**
204 204  
205 -* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
206 -* **Port**: 8883
207 -* **Credentials**: Basic
208 -* **Enable SSL**: YES
209 -* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
210 -* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
211 -* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
212 -* **QoS:** 0-At most once
213 -* **Clean session:** NO
214 -* **Retained**: NO
296 +* **Port**: 11582
297 +* **Size of the buffer for inbound socket (in KB)**: 64
298 +* **Cache Size**: 10000000
299 +* **Cache time to live in minutes**: 1440
215 215  
216 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
301 +Copy the two keys, **Integration key** and **Integration secret** into a text editor, as you will need them in the section ‘xxxxx’.
217 217  
218 -[[image:add-integration-connection.png||width="500"]]
219 -
220 -
221 -If the connection is successful, you will see the **Connected** message.
222 -
223 223  Click on the **Add** button.
224 224  
225 -[[image:add-connection-success.png||height="511" width="500"]]
226 226  
306 +[[image:add-integration-connection.png||height="511" width="500"]]
227 227  
308 +
228 228  You should see that the newly added integration is listed on the **Integrations** page.
229 229  
230 230  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
231 231  
232 -[[image:integrations-list-added-pending.png]]
313 +[[image:Integrations-list.png]]
233 233  
234 234  
235 -= 5. Verifying the receipt of data from the device =
316 += Verifying the receipt of data from the device =
236 236  
318 +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.
237 237  
238 -On the terminal, issue the following MQTT command which simulates the device S31B-NB.
239 239  
240 -{{code language="none"}}
241 -mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
242 -{{/code}}
243 -
244 -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.
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-Device.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +225.5 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-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-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
data-converter-list-page.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +190.8 KB
Content
data-converter-list.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
downlink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +207.8 KB
Content
uplink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content