Skip to Content

Wiki source code of ThingsBoard

Version 101.1 by Dilisi S on 2025/03/08 04:30
Hide last authors
Dilisi S 1.1 1 **Table of Contents:**
2
3 {{toc/}}
4
Dilisi S 16.1 5 {{warning}}
6 Draft Document
7 {{/warning}}
Dilisi S 1.1 8
Xiaoling 65.1 9
10
11
Xiaoling 64.2 12 = 1. Introduction =
Dilisi S 1.1 13
Xiaoling 64.2 14
Dilisi S 21.1 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.
Dilisi S 2.1 16
Dilisi S 21.1 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**.
Dilisi S 11.1 18
Dilisi S 17.1 19
Dilisi S 11.1 20
Xiaoling 64.2 21
Dilisi S 59.1 22
Dilisi S 93.1 23 = 2. Data Converters =
Dilisi S 11.1 24
25
Dilisi S 93.1 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.
Dilisi S 11.1 27
28
Dilisi S 93.1 29 == 2.1 Uplink ==
Dilisi S 11.1 30
31
Dilisi S 93.1 32 In the left navigation, click **Integrations center**, and then click **Data converters**.
Dilisi S 11.1 33
Dilisi S 59.1 34
35
Dilisi S 93.1 36 [[image:data-converters-list-empty.png]]
Dilisi S 59.1 37
38
Dilisi S 93.1 39 On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
Dilisi S 59.1 40
41
42
Dilisi S 93.1 43 [[image:create-new-converter-menu.png||height="259" width="500"]]
Dilisi S 59.1 44
45
Dilisi S 36.1 46 The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
Dilisi S 11.1 47
Dilisi S 93.1 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.
Dilisi S 11.1 49
50 {{code language="JavaScript"}}
Dilisi S 93.1 51 /** Decoder **/
52
Dilisi S 11.1 53 // decode payload to string
54 var payloadStr = decodeToString(payload);
Dilisi S 93.1 55 var data = JSON.parse(payloadStr);
Dilisi S 11.1 56
Dilisi S 93.1 57 var deviceName = metadata.topic.split("/")[3];
Dilisi S 11.1 58 // decode payload to JSON
Dilisi S 93.1 59 var deviceType = 'sensor';
Dilisi S 11.1 60
Dilisi S 93.1 61 // Result object with device attributes/telemetry data
Dilisi S 11.1 62 var result = {
63 deviceName: deviceName,
Dilisi S 93.1 64 deviceType: deviceType,
Dilisi S 11.1 65 attributes: {
Dilisi S 93.1 66 integrationName: metadata['integrationName'],
Dilisi S 11.1 67 },
Dilisi S 93.1 68 telemetry: {
69 temperature: data.temperature,
70 humidity: data.humidity,
71 }
72 };
Dilisi S 11.1 73
Dilisi S 93.1 74 /** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
Dilisi S 11.1 75
76 return result;
77 {{/code}}
78
Xiaoling 64.2 79
Dilisi S 21.1 80 Click on the **Add** button.
Dilisi S 11.1 81
82
83
Dilisi S 93.1 84 [[image:add-uplink-data-converter.png||height="529" width="500"]]
Dilisi S 11.1 85
Dilisi S 93.1 86
87 You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
88
Dilisi S 21.1 89
90
Dilisi S 94.1 91 [[image:create-new-converter-menu.png||width="500"]]
92
Xiaoling 64.2 93 == 3.2 Downlink ==
Dilisi S 11.1 94
Xiaoling 64.2 95
Dilisi S 21.1 96 On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
Dilisi S 11.1 97
98 [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
99
100
Dilisi S 36.1 101 The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
Dilisi S 11.1 102
Dilisi S 93.1 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.
Dilisi S 11.1 104
105
106 {{code language="JavaScript"}}
Dilisi S 93.1 107 // Encode downlink data from incoming Rule Engine message
Dilisi S 11.1 108
Dilisi S 93.1 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
Dilisi S 11.1 125 // Result object with encoded downlink payload
126 var result = {
Dilisi S 93.1 127
Dilisi S 11.1 128 // downlink data content type: JSON, TEXT or BINARY (base64 format)
Dilisi S 93.1 129 contentType: "JSON",
Dilisi S 11.1 130
131 // downlink data
Dilisi S 93.1 132 data: JSON.stringify(data),
Dilisi S 11.1 133
134 // Optional metadata object presented in key/value format
Dilisi S 93.1 135 metadata: {
136 topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
137 }
Dilisi S 11.1 138
139 };
140
141 return result;
142 {{/code}}
143
144
145 Click on the **Add** button.
146
147
148
Dilisi S 93.1 149 [[image:add-downlink-data-converter.png||height="529" width="500"]]
Dilisi S 21.1 150
151
Dilisi S 93.1 152 You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
Dilisi S 21.1 153
Dilisi S 11.1 154
Xiaoling 64.2 155
Dilisi S 93.1 156 [[image:data-converters-list.png]]
157
158 = 3. Add Integration =
159
160
Dilisi S 21.1 161 In the left navigation, click **Integrations center**, and then click **Integrations**.
Dilisi S 11.1 162
Dilisi S 21.1 163 On the **Integrations** page, click on the '**+**' button.
Dilisi S 11.1 164
Dilisi S 49.1 165 [[image:data-converter-list-page.png]]
Dilisi S 11.1 166
167
Dilisi S 21.1 168 The **Add integration** window appears.
Dilisi S 11.1 169
Dilisi S 24.1 170 In the **Add integration** window, configure the following settings:
Dilisi S 11.1 171
Dilisi S 21.1 172
Dilisi S 11.1 173 **Basic settings:**
174
Dilisi S 49.1 175 * **Integration type**: MQTT
176 * **Name**: MQTT integration NB/CB
Dilisi S 11.1 177
178 Click **Next** button.
179
Dilisi S 16.1 180 [[image:add-integration-basic-settings.png||height="511" width="500"]]
Dilisi S 11.1 181
182
Dilisi S 16.1 183 **Uplink data converter:**
Dilisi S 11.1 184
Dilisi S 21.1 185 * Click on the **Select existing** button.
Dilisi S 49.1 186 * **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
Dilisi S 16.1 187
188 Click **Next** button.
189
Dilisi S 49.1 190 [[image:add-integration-uplink-data-converter.png||width="500"]]
Dilisi S 16.1 191
192
193 **Downlink data converter:**
194
Dilisi S 21.1 195 * Click on the **Select existing** button.
Dilisi S 49.1 196 * **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
Dilisi S 16.1 197
198 Click **Next** button.
199
Dilisi S 49.1 200 [[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
Dilisi S 16.1 201
202
203 **Connection:**
204
Dilisi S 93.1 205 * **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
206 * **Port**: 8883
Dilisi S 49.1 207 * **Credentials**: Basic
Dilisi S 93.1 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
Dilisi S 16.1 215
Dilisi S 49.1 216 Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
Dilisi S 16.1 217
Dilisi S 49.1 218 [[image:add-integration-connection.png||width="500"]]
219
220
221 If the connection is successful, you will see the **Connected** message.
222
Dilisi S 16.1 223 Click on the **Add** button.
224
Dilisi S 49.1 225 [[image:add-connection-success.png||height="511" width="500"]]
Dilisi S 16.1 226
227
Dilisi S 59.1 228 You should see that the newly added integration is listed on the **Integrations** page.
Dilisi S 49.1 229
Dilisi S 59.1 230 Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
Dilisi S 49.1 231
Xiaoling 64.2 232 [[image:integrations-list-added-pending.png]]
Dilisi S 49.1 233
234
Xiaoling 64.2 235 = 5. Verifying the receipt of data from the device =
Dilisi S 49.1 236
Dilisi S 16.1 237
Dilisi S 64.1 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.
Xiaoling 64.2 245