Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 94.1
edited by Dilisi S
on 2025/03/08 04:04
Change comment: There is no comment for this version
To version 64.2
edited by Xiaoling
on 2025/03/07 11:46
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.pradeeka
1 +XWiki.Xiaoling
Content
... ... @@ -6,9 +6,6 @@
6 6  Draft Document
7 7  {{/warning}}
8 8  
9 -
10 -
11 -
12 12  = 1. Introduction =
13 13  
14 14  
... ... @@ -17,79 +17,235 @@
17 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  
19 19  
17 += 2. Add New Device =
20 20  
21 21  
20 +First, we will add a device to simulate data using MQTT. This device does not represent a real physical device but serves as a common virtual device for all Dragino NB/CB devices.
22 22  
23 -= 2. Data Converters =
22 +In the left navigation, click **Entities** and then click **Devices**.
24 24  
24 +[[image:device-list-empty.png]]
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  
27 +On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
28 28  
29 -== 2.1 Uplink ==
30 30  
30 +[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
31 31  
32 -In the left navigation, click **Integrations center**, and then click **Data converters**.
33 33  
33 +The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
34 34  
35 +Click on the **Next: Credentials** button.
35 35  
36 -[[image:data-converters-list-empty.png]]
37 37  
38 +[[image:new-device-device-details.png||height="529" width="500"]]
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  
41 +Click the **Access token** button if it is not selected by default.
41 41  
43 +Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
42 42  
43 -[[image:create-new-converter-menu.png||height="259" width="500"]]
45 +Click on the **Add** button.
44 44  
47 +[[image:new-device-access-token.png||height="528" width="500"]]
45 45  
49 +
50 +Click on the **MQTT** button.
51 +
52 +Then, select the operating system you are going to use with the **Mosquitto MQTT Broker**. This example shows sending a command from a computer running **MacOS**. First, install the necessary client tools on your computer.
53 +
54 +Copy the MQTT pub command in the '**Execute the following command**' section.
55 +
56 +{{code language="none"}}
57 +mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/me/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:25}"
58 +{{/code}}
59 +
60 +Note that the **State** is still shown as **'Inactive'** in the **Latest telemetry** section.
61 +
62 +[[image:new-device-check-connectivity.png||height="522" width="500"]]
63 +
64 +
65 +On the terminal, enter the command you copied. This command sends the MQTT payload **{temperature:25}** as telemetry data from a virtual device named **'me'**. Of course, you can replace **'me'** with a device name or use the wildcard character **'+'** to match any device name.
66 +
67 +
68 +[[image:mqtt-command-1.png||height="228" width="700"]]
69 +
70 +
71 +If the command is successful, you can see the telemetry data you sent under the **Latest telemetry** section. Note that the **State** is now **'Active'** in the **Latest telemetry** section.
72 +
73 +
74 +[[image:new-device-telemetry-test.png||height="520" width="500"]]
75 +
76 +
77 +Send the same command again, only changing the **temperature** value, to see how the **Latest telemetry** section updates its data.
78 +
79 +Once you are done experimenting with this, close the window by clicking the **Close** button.
80 +
81 +
82 +[[image:mqtt-command-2.png||height="227" width="700"]]
83 +
84 +
85 +
86 +[[image:virtual-device-active.png]]
87 +
88 +
89 += 3. Data Converters =
90 +
91 +
92 +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.
93 +
94 +
95 +== 3.1 Uplink ==
96 +
97 +
98 +In the left navigation, click **Integrations center**, and then click **Data converters**.
99 +
100 +[[image:data-converter-list-page.png]]
101 +
102 +
103 +On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
104 +
105 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
106 +
107 +
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.
110 +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 -
113 +//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';
118 +var objdata = {};
119 +var obj1 = {};
120 +var data = decodeToJson(payload);
121 +var deviceName = data.IMEI;
122 +delete data.IMEI;
123 +var modelname = "Dragino " + data.Model;
124 +//var mod = data.mod
125 +delete data.Model;
126 +//delete data.mod
127 +var timestamp = new Date().getTime();
60 60  
61 -// Result object with device attributes/telemetry data
129 +for (var key in data) {
130 +
131 + if (Number(key)) {
132 + obj1[key] = data[key];
133 + obj1[key][obj1[key].length - 1] = Number(new Date(
134 + obj1[key][obj1[key].length - 1]));
135 +
136 + }
137 +//Alec submitted25/02/25
138 +//turn old key into new
139 + else if (key === "Reading") {
140 + objdata["reading"] = data[key];
141 + } else if (key === "work mode") {
142 + objdata["work_mode"] = data[key];
143 + } else if (key === "hum") {
144 + objdata["humidity"] = data[key];
145 + }else if (key === "hum2") {
146 + objdata["humidity2"] = data[key];
147 + } else if (key === "hum3") {
148 + objdata["humidity3"] = data[key];
149 + } else if (key === "tem") {
150 + objdata["temperature"] = data[key];
151 + } else if (key === "tem2") {
152 + objdata["temperature2"] = data[key];
153 + } else if (key === "tem3") {
154 + objdata["temperature3"] = data[key];
155 + } else if (key === "DS18B20_Temp") {
156 + objdata["temperature_pro"] = data[key];
157 + } else if (key === "ds18b20_temperature") {
158 + objdata["temperature_pro"] = data[key];
159 + } else if (key === "DS18B20_temperature_pro") {
160 + objdata["temperature_pro"] = data[key];
161 + } else if (key === "tdc send flag") {
162 + objdata["tdc_send_flag"] = data[key];
163 + } else if (key === "trigger mode") {
164 + objdata["trigger_mode"] = data[key];
165 + } else if (key === "soil dielectric constant") {
166 + objdata["soil_dielectric_constant"] = data[key];
167 + } else if (key === "door open num") {
168 + objdata["door_open_num"] = data[key];
169 + } else if (key === "door duration") {
170 + objdata["door_duration"] = data[key];
171 + } else if (key === "count time") {
172 + objdata["count_time"] = data[key];
173 + } else if (key === "last open time2") {
174 + objdata["last_open_time2"] = data[key];
175 + } else if (key === "last open time3") {
176 + objdata["last_open_time3"] = data[key];
177 + }
178 +//Alec submitted25/02/25
179 + else {
180 + objdata[key] = data[key]
181 + }
182 +}
183 +var listdata = [{
184 + "ts": timestamp,
185 + "values": objdata
186 +}]
187 +for (var key1 in obj1) {
188 + if (modelname == "Dragino RS485-NB") {
189 + listdata.push({
190 + "ts": obj1[key1][obj1[key1].length - 1],
191 + "values": {
192 + "Payload": obj1[key1][0],
193 + }
194 + })
195 + } else {
196 + listdata.push({
197 + "ts": obj1[key1][obj1[key1].length - 1],
198 + "values": {
199 + "values": obj1[key1]
200 + },
201 + })
202 + }
203 +}
62 62  var result = {
205 +
63 63   deviceName: deviceName,
64 - deviceType: deviceType,
207 + deviceType: modelname,
65 65   attributes: {
66 - integrationName: metadata['integrationName'],
209 + model: modelname,
210 + //customerName: "NB-CB",
211 + //groupName: "NB-CB",
212 + //integrationName: metadata['integrationName']
213 +
67 67   },
68 - telemetry: {
69 - temperature: data.temperature,
70 - humidity: data.humidity,
71 - }
72 -};
215 + telemetry: listdata
216 +}
73 73  
74 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
218 +function decodeToString(payload) {
219 + return String.fromCharCode.apply(String, payload);
220 +}
75 75  
222 +function decodeToJson(payload) {
223 + // covert payload to string.
224 + var str = decodeToString(payload);
225 +
226 + // parse string to JSON
227 + var data = JSON.parse(str);
228 + return data;
229 +}
230 +
76 76  return result;
232 +
77 77  {{/code}}
78 78  
79 79  
80 80  Click on the **Add** button.
81 81  
238 +[[image:uplink-data-converter.png||height="529" width="500"]]
82 82  
83 83  
84 -[[image:add-uplink-data-converter.png||height="529" width="500"]]
241 +You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
85 85  
243 +[[image:data-converter-list-showing-uplink-dc.png]]
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 -
90 -
91 -[[image:create-new-converter-menu.png||width="500"]]
92 -
93 93  == 3.2 Downlink ==
94 94  
95 95  
... ... @@ -100,41 +100,32 @@
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.
256 +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
260 +function hexToBase64(hexString) {
261 + // 将16进制字符串两个字符转换为一个字节
262 + var bytes = hexString.match(/.{2}/g);
263 + // 对每个字节进行解析，并转换为对应的字符
264 + var binaryString = bytes.map(function(byte) {
265 + return String.fromCharCode(parseInt(byte, 16));
266 + }).join('');
267 +
268 + // 使用btoa进行base64编码
269 + return btoa(binaryString);
270 +}
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",
275 + contentType: "BINARY",
130 130  
131 131   // downlink data
132 - data: JSON.stringify(data),
278 + 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 - }
281 + //metadata: {}
138 138  
139 139  };
140 140  
... ... @@ -144,20 +144,17 @@
144 144  
145 145  Click on the **Add** button.
146 146  
291 +[[image:downlink-data-converter.png||height="530" width="500"]]
147 147  
148 148  
149 -[[image:add-downlink-data-converter.png||height="529" width="500"]]
294 +You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
150 150  
296 +[[image:data-converter-list.png]]
151 151  
152 -You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
153 153  
299 += 4. Add Integration =
154 154  
155 155  
156 -[[image:data-converters-list.png]]
157 -
158 -= 3. Add Integration =
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.
... ... @@ -202,16 +202,13 @@
202 202  
203 203  **Connection:**
204 204  
205 -* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
206 -* **Port**: 8883
346 +* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
347 +* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
207 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
349 +* **Username**: Access token (This is the access token you copied from the device)
350 +* **Password** - Leave it as blank
351 +* **Topic** - v1/devices/+/telemetry (sightly modify the topic 'v1/devices/me/telemetry' you copied from the device to enable receiving data from any 'device name')
352 +* **QoS** - 0-At most once
215 215  
216 216  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
217 217  
... ... @@ -243,3 +243,4 @@
243 243  
244 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 245  
384 +
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-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-connection-success.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 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
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-showing-uplink-dc.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +194.9 KB
Content
data-converter-list.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
device-list-empty.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
integrations-list-added-pending.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
mqtt-command-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
mqtt-command-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
new-device-access-token.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
new-device-check-connectivity.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
new-device-device-details.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +88.4 KB
Content
new-device-telemetry-test.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.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
virtual-device-active.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content