Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 14.1
edited by Dilisi S
on 2025/03/03 02:40
Change comment: Uploaded new attachment "add-integration-downlink-data-converter.png", version {1}
To version 96.1
edited by Dilisi S
on 2025/03/08 04:12
Change comment: Uploaded new attachment "integrations-list-empty.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -2,216 +2,139 @@
2 2  
3 3  {{toc/}}
4 4  
5 +{{warning}}
6 +Draft Document
7 +{{/warning}}
5 5  
6 -= Introduction =
7 7  
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.
9 9  
10 10  
11 -= Add New Device =
12 += 1. Introduction =
12 12  
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.
15 15  
16 -[[image:ThingsBoard-Device.png]]
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**.
17 17  
18 18  
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"]]
23 23  
23 += 2. Data Converters =
24 24  
25 25  
26 -= Data Converters =
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  
28 28  
29 -== Uplink ==
29 +== 2.1 Uplink ==
30 30  
31 -In the left navigation, click ‘Integrations center’, and then click ‘Data converters’.
32 32  
32 +In the left navigation, click **Integrations center**, and then click **Data converters**.
33 33  
34 -[[image:ThingsBoard-Data-Converters.png]]
35 35  
36 36  
37 -On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
36 +[[image:data-converters-list-empty.png]]
38 38  
39 39  
40 -[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
39 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
41 41  
42 42  
43 -The ‘Add data converter’ window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as ‘Uplink’.
44 44  
45 -Click on the ‘JavaScript’ button. Now copy and paste the following script to the ‘Decoder function’ section:
43 +[[image:create-new-converter-menu.png||height="259" width="500"]]
46 46  
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 +
47 47  {{code language="JavaScript"}}
48 -//Version: 0.1
51 +/** Decoder **/
52 +
49 49  // decode payload to string
50 50  var payloadStr = decodeToString(payload);
55 +var data = JSON.parse(payloadStr);
51 51  
57 +var deviceName = metadata.topic.split("/")[3];
52 52  // decode payload to JSON
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();
59 +var deviceType = 'sensor';
63 63  
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 -}
61 +// Result object with device attributes/telemetry data
139 139  var result = {
140 -
141 141   deviceName: deviceName,
142 - deviceType: modelname,
64 + deviceType: deviceType,
143 143   attributes: {
144 - model: modelname,
145 - //customerName: "NB-CB",
146 - //groupName: "NB-CB",
147 - //integrationName: metadata['integrationName']
148 -
66 + integrationName: metadata['integrationName'],
149 149   },
150 - telemetry: listdata
151 -}
68 + telemetry: {
69 + temperature: data.temperature,
70 + humidity: data.humidity,
71 + }
72 +};
152 152  
153 -function decodeToString(payload) {
154 - return String.fromCharCode.apply(String, payload);
155 -}
74 +/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
156 156  
157 -function decodeToJson(payload) {
158 - // covert payload to string.
159 - var str = decodeToString(payload);
76 +return result;
77 +{{/code}}
160 160  
161 - // parse string to JSON
162 - var data = JSON.parse(str);
163 - return data;
164 -}
165 165  
166 -return result;
80 +Click on the **Add** button.
167 167  
168 -{{/code}}
169 169  
170 -Click on the ‘Add’ button.
171 171  
84 +[[image:add-uplink-data-converter.png||height="529" width="500"]]
172 172  
173 -[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
174 174  
87 +You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
175 175  
176 -The uplink data converter is added to ThingsBoard and appears on the ‘Data Converters’ page
177 177  
178 178  
179 -== Downlink ==
91 +[[image:create-new-converter-menu.png||width="500"]]
180 180  
181 -On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
93 +== 3.2 Downlink ==
182 182  
183 183  
96 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
97 +
184 184  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
185 185  
186 186  
187 -The ‘**Add data converter**’ window will appear. Name it ‘**UDP Downlink Converter NB/CB**’ and select the Type as ‘**Downlink**’.
101 +The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
188 188  
189 -Click on the ‘**JavaScript**’ button. Now copy and paste the following script to the ‘**Encoder function**’ section:
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.
190 190  
191 191  
192 192  {{code language="JavaScript"}}
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 +// Encode downlink data from incoming Rule Engine message
204 204  
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 +
205 205  // Result object with encoded downlink payload
206 206  var result = {
127 +
207 207   // downlink data content type: JSON, TEXT or BINARY (base64 format)
208 - contentType: "BINARY",
129 + contentType: "JSON",
209 209  
210 210   // downlink data
211 - data:hexToBase64(metadata.shared_value)
132 + data: JSON.stringify(data),
212 212  
213 213   // Optional metadata object presented in key/value format
214 - //metadata: {}
135 + metadata: {
136 + topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
137 + }
215 215  
216 216  };
217 217  
... ... @@ -222,32 +222,101 @@
222 222  Click on the **Add** button.
223 223  
224 224  
225 -[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
226 226  
149 +[[image:add-downlink-data-converter.png||height="529" width="500"]]
227 227  
228 -= Add Integration =
229 229  
230 -In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
152 +You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
231 231  
232 -On the ‘Integrations’ page, click on the “+” button.
233 233  
234 234  
235 -[[image:ThingsBoard-add-integration.png]]
156 +[[image:data-converters-list.png]]
236 236  
158 += 3. Add Integration =
237 237  
238 -The ‘Add integration’ window appears.
239 239  
240 -In the Add Integration window, configure the following settings:
161 +In the left navigation, click **Integrations center**, and then click **Integrations**.
241 241  
163 +On the **Integrations** page, click on the '**+**' button.
164 +
165 +[[image:data-converter-list-page.png]]
166 +
167 +
168 +The **Add integration** window appears.
169 +
170 +In the **Add integration** window, configure the following settings:
171 +
172 +
242 242  **Basic settings:**
243 243  
244 -* **Integration type**: UDP
245 -* **Name**: UDP Integration NB/CB
175 +* **Integration type**: MQTT
176 +* **Name**: MQTT integration NB/CB
246 246  
247 247  Click **Next** button.
248 248  
180 +[[image:add-integration-basic-settings.png||height="511" width="500"]]
249 249  
250 250  
183 +**Uplink data converter:**
251 251  
185 +* Click on the **Select existing** button.
186 +* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
252 252  
253 -
188 +Click **Next** button.
189 +
190 +[[image:add-integration-uplink-data-converter.png||width="500"]]
191 +
192 +
193 +**Downlink data converter:**
194 +
195 +* Click on the **Select existing** button.
196 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
197 +
198 +Click **Next** button.
199 +
200 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
201 +
202 +
203 +**Connection:**
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
215 +
216 +Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
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 +Click on the **Add** button.
224 +
225 +[[image:add-connection-success.png||height="511" width="500"]]
226 +
227 +
228 +You should see that the newly added integration is listed on the **Integrations** page.
229 +
230 +Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
231 +
232 +[[image:integrations-list-added-pending.png]]
233 +
234 +
235 += 5. Verifying the receipt of data from the device =
236 +
237 +
238 +On the terminal, issue the following MQTT command which simulates the device S31B-NB.
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 +
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-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-converter-list-showing-uplink-dc.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +194.9 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
integrations-list-empty.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +264.5 KB
Content