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 15.1
edited by Dilisi S
on 2025/03/03 02:41
Change comment: Uploaded new attachment "add-integration-connection.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -2,138 +2,216 @@
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 11  
12 -= 1. Introduction =
11 += Add New Device =
13 13  
13 +In the left navigation, click **Entities** and then click **Devices**.
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.
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**.
16 +[[image:ThingsBoard-Device.png]]
18 18  
19 19  
19 +On the ‘**Devices**’ page, click on the ‘**+**’ button, and then click on the ‘**Add new device**’ from the dropdown menu.
20 20  
21 21  
22 +[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
22 22  
23 -= 2. Data Converters =
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.
26 += Data Converters =
27 27  
28 28  
29 -== 2.1 Uplink ==
29 +== Uplink ==
30 30  
31 +In the left navigation, click ‘Integrations center’, and then click ‘Data converters’.
31 31  
32 -In the left navigation, click **Integrations center**, and then click **Data converters**.
33 33  
34 +[[image:ThingsBoard-Data-Converters.png]]
34 34  
35 35  
36 -[[image:data-converters-list-empty.png]]
37 +On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
37 37  
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 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
40 40  
41 41  
43 +The ‘Add data converter’ window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as ‘Uplink’.
42 42  
43 -[[image:create-new-converter-menu.png||height="259" width="500"]]
45 +Click on the ‘JavaScript’ button. Now copy and paste the following script to the ‘Decoder function’ section:
44 44  
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 -
48 +//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';
53 +var objdata = {};
54 +var obj1 = {};
55 +var data = decodeToJson(payload);
56 +var deviceName = data.IMEI;
57 +delete data.IMEI;
58 +var modelname = "Dragino " + data.Model;
59 +//var mod = data.mod
60 +delete data.Model;
61 +//delete data.mod
62 +var timestamp = new Date().getTime();
60 60  
61 -// Result object with device attributes/telemetry data
64 +for (var key in data) {
65 +
66 + if (Number(key)) {
67 + obj1[key] = data[key];
68 + obj1[key][obj1[key].length - 1] = Number(new Date(
69 + obj1[key][obj1[key].length - 1]));
70 +
71 + }
72 +//Alec submitted25/02/25
73 +//turn old key into new
74 + else if (key === "Reading") {
75 + objdata["reading"] = data[key];
76 + } else if (key === "work mode") {
77 + objdata["work_mode"] = data[key];
78 + } else if (key === "hum") {
79 + objdata["humidity"] = data[key];
80 + }else if (key === "hum2") {
81 + objdata["humidity2"] = data[key];
82 + } else if (key === "hum3") {
83 + objdata["humidity3"] = data[key];
84 + } else if (key === "tem") {
85 + objdata["temperature"] = data[key];
86 + } else if (key === "tem2") {
87 + objdata["temperature2"] = data[key];
88 + } else if (key === "tem3") {
89 + objdata["temperature3"] = data[key];
90 + } else if (key === "DS18B20_Temp") {
91 + objdata["temperature_pro"] = data[key];
92 + } else if (key === "ds18b20_temperature") {
93 + objdata["temperature_pro"] = data[key];
94 + } else if (key === "DS18B20_temperature_pro") {
95 + objdata["temperature_pro"] = data[key];
96 + } else if (key === "tdc send flag") {
97 + objdata["tdc_send_flag"] = data[key];
98 + } else if (key === "trigger mode") {
99 + objdata["trigger_mode"] = data[key];
100 + } else if (key === "soil dielectric constant") {
101 + objdata["soil_dielectric_constant"] = data[key];
102 + } else if (key === "door open num") {
103 + objdata["door_open_num"] = data[key];
104 + } else if (key === "door duration") {
105 + objdata["door_duration"] = data[key];
106 + } else if (key === "count time") {
107 + objdata["count_time"] = data[key];
108 + } else if (key === "last open time2") {
109 + objdata["last_open_time2"] = data[key];
110 + } else if (key === "last open time3") {
111 + objdata["last_open_time3"] = data[key];
112 + }
113 +//Alec submitted25/02/25
114 + else {
115 + objdata[key] = data[key]
116 + }
117 +}
118 +var listdata = [{
119 + "ts": timestamp,
120 + "values": objdata
121 +}]
122 +for (var key1 in obj1) {
123 + if (modelname == "Dragino RS485-NB") {
124 + listdata.push({
125 + "ts": obj1[key1][obj1[key1].length - 1],
126 + "values": {
127 + "Payload": obj1[key1][0],
128 + }
129 + })
130 + } else {
131 + listdata.push({
132 + "ts": obj1[key1][obj1[key1].length - 1],
133 + "values": {
134 + "values": obj1[key1]
135 + },
136 + })
137 + }
138 +}
62 62  var result = {
140 +
63 63   deviceName: deviceName,
64 - deviceType: deviceType,
142 + deviceType: modelname,
65 65   attributes: {
66 - integrationName: metadata['integrationName'],
144 + model: modelname,
145 + //customerName: "NB-CB",
146 + //groupName: "NB-CB",
147 + //integrationName: metadata['integrationName']
148 +
67 67   },
68 - telemetry: {
69 - temperature: data.temperature,
70 - humidity: data.humidity,
71 - }
72 -};
150 + telemetry: listdata
151 +}
73 73  
74 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
153 +function decodeToString(payload) {
154 + return String.fromCharCode.apply(String, payload);
155 +}
75 75  
76 -return result;
77 -{{/code}}
157 +function decodeToJson(payload) {
158 + // covert payload to string.
159 + var str = decodeToString(payload);
78 78  
161 + // parse string to JSON
162 + var data = JSON.parse(str);
163 + return data;
164 +}
79 79  
80 -Click on the **Add** button.
166 +return result;
81 81  
168 +{{/code}}
82 82  
170 +Click on the ‘Add’ button.
83 83  
84 -[[image:add-uplink-data-converter.png||height="529" width="500"]]
85 85  
173 +[[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]]
176 +The uplink data converter is added to ThingsBoard and appears on the ‘Data Converters’ page
90 90  
91 91  
92 -== 3.2 Downlink ==
179 +== Downlink ==
93 93  
181 +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**.
187 +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.
189 +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
193 +function hexToBase64(hexString) {
194 + // 将16进制字符串两个字符转换为一个字节
195 + var bytes = hexString.match(/.{2}/g);
196 + // 对每个字节进行解析，并转换为对应的字符
197 + var binaryString = bytes.map(function(byte) {
198 + return String.fromCharCode(parseInt(byte, 16));
199 + }).join('');
200 +
201 + // 使用btoa进行base64编码
202 + return btoa(binaryString);
203 +}
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",
208 + contentType: "BINARY",
129 129  
130 130   // downlink data
131 - data: JSON.stringify(data),
211 + 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 - }
214 + //metadata: {}
137 137  
138 138  };
139 139  
... ... @@ -144,102 +144,32 @@
144 144  Click on the **Add** button.
145 145  
146 146  
225 +[[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  
228 += Add Integration =
150 150  
151 -You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
230 +In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
152 152  
232 +On the ‘Integrations’ page, click on the “+” button.
153 153  
154 154  
155 -[[image:data-converters-list.png]]
235 +[[image:ThingsBoard-add-integration.png]]
156 156  
157 -= 3. Add Integration =
158 158  
238 +The ‘Add integration’ window appears.
159 159  
160 -In the left navigation, click **Integrations center**, and then click **Integrations**.
240 +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
244 +* **Integration type**: UDP
245 +* **Name**: UDP Integration NB/CB
176 176  
177 177  Click **Next** button.
178 178  
179 -[[image:add-integration-basic-settings.png||height="511" width="500"]]
180 180  
181 181  
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.
186 186  
187 -Click **Next** button.
188 -
189 -[[image:add-integration-uplink-data-converter.png||width="500"]]
190 -
191 -
192 -**Downlink data converter:**
193 -
194 -* Click on the **Select existing** button.
195 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
196 -
197 -Click **Next** button.
198 -
199 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
200 -
201 -
202 -**Connection:**
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
214 -
215 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
216 -
217 -[[image:add-integration-connection.png||width="500"]]
218 -
219 -
220 -If the connection is successful, you will see the **Connected** message.
221 -
222 -Click on the **Add** button.
223 -
224 -[[image:add-connection-success.png||height="511" width="500"]]
225 -
226 -
227 -You should see that the newly added integration is listed on the **Integrations** page.
228 -
229 -Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
230 -
231 -[[image:integrations-list-added-pending.png]]
232 -
233 -
234 -= 5. Verifying the receipt of data from the device =
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