Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 10.1
edited by Dilisi S
on 2025/03/03 02:31
Change comment: Uploaded new attachment "ThingsBoard-add-integration.png", version {1}
To version 93.1
edited by Dilisi S
on 2025/03/08 03:59
Change comment: Mar 7 edits -part 1

Summary

Details

Page properties
Content
... ... @@ -2,9 +2,244 @@
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  
11 +
12 += 1. Introduction =
13 +
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 +
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 +
19 +
20 +
21 +
22 +
23 += 2. Data Converters =
24 +
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 +
28 +
29 +== 2.1 Uplink ==
30 +
31 +
32 +In the left navigation, click **Integrations center**, and then click **Data converters**.
33 +
34 +
35 +
36 +[[image:data-converters-list-empty.png]]
37 +
38 +
39 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
40 +
41 +
42 +
43 +[[image:create-new-converter-menu.png||height="259" width="500"]]
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 +{{code language="JavaScript"}}
51 +/** Decoder **/
52 +
53 +// decode payload to string
54 +var payloadStr = decodeToString(payload);
55 +var data = JSON.parse(payloadStr);
56 +
57 +var deviceName = metadata.topic.split("/")[3];
58 +// decode payload to JSON
59 +var deviceType = 'sensor';
60 +
61 +// Result object with device attributes/telemetry data
62 +var result = {
63 + deviceName: deviceName,
64 + deviceType: deviceType,
65 + attributes: {
66 + integrationName: metadata['integrationName'],
67 + },
68 + telemetry: {
69 + temperature: data.temperature,
70 + humidity: data.humidity,
71 + }
72 +};
73 +
74 +/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
75 +
76 +return result;
77 +{{/code}}
78 +
79 +
80 +Click on the **Add** button.
81 +
82 +
83 +
84 +[[image:add-uplink-data-converter.png||height="529" width="500"]]
85 +
86 +
87 +You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
88 +
89 +[[image:data-converter-list-showing-uplink-dc.png]]
90 +
91 +
92 +== 3.2 Downlink ==
93 +
94 +
95 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
96 +
97 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
98 +
99 +
100 +The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
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.
103 +
104 +
105 +{{code language="JavaScript"}}
106 +// Encode downlink data from incoming Rule Engine message
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 +// Result object with encoded downlink payload
125 +var result = {
126 +
127 + // downlink data content type: JSON, TEXT or BINARY (base64 format)
128 + contentType: "JSON",
129 +
130 + // downlink data
131 + data: JSON.stringify(data),
132 +
133 + // Optional metadata object presented in key/value format
134 + metadata: {
135 + topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
136 + }
137 +
138 +};
139 +
140 +return result;
141 +{{/code}}
142 +
143 +
144 +Click on the **Add** button.
145 +
146 +
147 +
148 +[[image:add-downlink-data-converter.png||height="529" width="500"]]
149 +
150 +
151 +You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
152 +
153 +
154 +
155 +[[image:data-converters-list.png]]
156 +
157 += 3. Add Integration =
158 +
159 +
160 +In the left navigation, click **Integrations center**, and then click **Integrations**.
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 +**Basic settings:**
173 +
174 +* **Integration type**: MQTT
175 +* **Name**: MQTT integration NB/CB
176 +
177 +Click **Next** button.
178 +
179 +[[image:add-integration-basic-settings.png||height="511" width="500"]]
180 +
181 +
182 +**Uplink data converter:**
183 +
184 +* Click on the **Select existing** button.
185 +* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
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 +
10 10  
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-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-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