ThingsBoard - DRAGINO

1

**Table of Contents:**

2

Draft Document

= 1. Introduction =

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**.

= 2. Prerequisites =

To complete this tutorial, you need to have the following:

23

24

* ThingsBoard cloud account

25

* MQTT Broker (public or private) such as,

26

** **[[HiveMQ Cloud>>https://www.hivemq.com]] - You can create a free account to try it or subscribe for a paid account. - We use HiveMQ Cloud as the MQTT broker to build example in this tutorial.**

27

** [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] - The public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.

28

** [[lns1.thingseye.io>>http://lns1.thingseye.io/]] - This is Dragino's MQTT broker, which requires a CA certificate to use.

29

30

== 2.1 ThingsBoard Cloud ==

31

32

33

Go to [[https:~~/~~/thingsboard.io/>>https://thingsboard.io/]]

34

35

Click on the **Try it now**.

36

37

38

[[image:thingsboard-1.png]]

39

40

41

Select either the **North America** or **Europe** region. Here, we use the Europe region.

42

43

[[image:thingsboard-2.png]]

44

45

46

You can sign up with your **Google**, **GitHub**, **Facebook**, or **Apple** account. If not you can create an account with providing your **name**, **email address** and a **password**.

47

48

Click on the **Sign up** button.

49

50

[[image:thingsboard-3.png||height="651" width="500"]]

51

52

53

You will be navigated to the following page.

54

55

[[image:thingsboard-5.png||height="109" width="500"]]

56

57

58

simultaneously, you will receive an email to confirm your email address. Click on the **Activate Your Account** button.

59

60

61

[[image:thingsboard-4.png||height="249" width="500"]]

62

63

64

Now losing to the account using your credentials:

65

66

67

[[image:thingsboard-6.png||height="244" width="500"]]

68

69

70

== 2.2 HiveMQ Cloud ==

71

72

=== 2.2.1 HiveMQ Cloud ===

73

74

75

Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]

76

77

Click on the **Start Free** button.

78

79

[[image:hivwmq-1.png]]

80

81

82

Click on the **Sign Up FREE Now** button in the **HIVEMQ CLOUD** section.

83

84

[[image:hivemq-2.png]]

85

86

87

Click on the **Sign Up** button.

88

89

You can sign up with HiveMQ using your **GitHub**, **Google**, or **LinkedIn** account.

90

91

If not, provide your **email address** and a **password** to create an account by clicking on the **Sign Up** button.

92

93

94

[[image:hivemq-3.png]]

95

96

97

You will receive an email to verify your email address. Click on the **Confirm my account** button.

98

99

100

[[image:hivemq-4.jpg||height="889" width="400"]]

101

102

103

You will be redirected to a page asking you to complete your profile. Once done, click the **Continue** button.

104

105

106

[[image:hivemq-5.png||height="655" width="700"]]

107

108

109

Select the CloudMQ Cloud plan you need. For testing purposes, select the **Serverless FREE** plan by clicking on the **Create Serverless Cluster** button.

110

111

112

[[image:hivemq-6.png]]

113

114

115

You will be navigated to the **Your Clusters** page. Click on the **Manage Cluster** button.

116

117

[[image:hivemq-7.png]]

118

119

120

In your cluster page, you can find some useful parameters you need to create a MQTT connection.

121

122

**URL**: This is the host name. Click on the copy button to copy it.

**Port**: 8883

Click on the **Getting Started** tab to setup the username and the password as the connection credentials.

128

129

130

[[image:hivemq-8.png]]

131

132

133

In the '**Create Connection Credentials**' section, provide a **username** and **password**, then click the **Add** button.

134

135

136

[[image:hivemq-9.png]]

If everything is successful, you will see the following message.

141

142

143

[[image:hivemq-10.png||height="206" width="500"]]

144

145

146

You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.

=== 2.2.2 emqx ===

The [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.

153

154

155

[[image:emqx.png||height="420" width="500"]]

156

157

158

=== 2.2.3 Ins1.thingseye.io ===

159

160

[[lns1.thingseye.io>>http://lns1.thingseye.io/]] is the Dragino's MQTT broker, which requires a CA certificate file, Certificate file, and the Private key file to use.

161

162

If customers need to use this MQTT connection with ThingsBoard, they need to contact the TE team to obtain three license files.

163

164

[[image:ins1.png||height="310" width="500"]]

165

166

167

= 3. Data Converters =

168

169

170

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.

== 3.1 Uplink ==

In the left navigation, click **Integrations center**, and then click **Data converters**.

177

178

179

[[image:data-converters-list-empty.png]]

180

181

182

On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.

[[image:create-new-converter-menu.png||height="259" width="500"]]

187

188

189

The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.

190

191

Click on the **JavaScript** button.

192

193

Delete the default decoder function in the code editor. Now copy and paste the following decoder function written in **JavaScript** in to the **code editor**. This decoder function is compatible for both NB and CB series devices.

//Version: 0.1

// decode payload to string

199

var payloadStr = decodeToString(payload);

200

201

// decode payload to JSON

202

var objdata = {};

203

var obj1 = {};

204

var data = decodeToJson(payload);

205

var deviceName = data.IMEI;

206

delete data.IMEI;

207

var modelname = "Dragino " + data.Model;

//var mod = data.mod

delete data.Model;

//delete data.mod

var timestamp = new Date().getTime();

212

213

for (var key in data) {

214

215

if (Number(key)) {

216

obj1[key] = data[key];

217

obj1[key][obj1[key].length - 1] = Number(new Date(

218

obj1[key][obj1[key].length - 1]));

219

220

}

221

//Alec submitted25/02/25

222

//turn old key into new

223

else if (key === "Reading") {

224

objdata["reading"] = data[key];

225

} else if (key === "work mode") {

226

objdata["work_mode"] = data[key];

227

} else if (key === "hum") {

228

objdata["humidity"] = data[key];

229

}else if (key === "hum2") {

230

objdata["humidity2"] = data[key];

231

} else if (key === "hum3") {

232

objdata["humidity3"] = data[key];

233

} else if (key === "tem") {

234

objdata["temperature"] = data[key];

235

} else if (key === "tem2") {

236

objdata["temperature2"] = data[key];

237

} else if (key === "tem3") {

238

objdata["temperature3"] = data[key];

239

} else if (key === "DS18B20_Temp") {

240

objdata["temperature_pro"] = data[key];

241

} else if (key === "ds18b20_temperature") {

242

objdata["temperature_pro"] = data[key];

243

} else if (key === "DS18B20_temperature_pro") {

244

objdata["temperature_pro"] = data[key];

245

} else if (key === "tdc send flag") {

246

objdata["tdc_send_flag"] = data[key];

247

} else if (key === "trigger mode") {

248

objdata["trigger_mode"] = data[key];

249

} else if (key === "soil dielectric constant") {

250

objdata["soil_dielectric_constant"] = data[key];

251

} else if (key === "door open num") {

252

objdata["door_open_num"] = data[key];

253

} else if (key === "door duration") {

254

objdata["door_duration"] = data[key];

255

} else if (key === "count time") {

256

objdata["count_time"] = data[key];

257

} else if (key === "last open time2") {

258

objdata["last_open_time2"] = data[key];

259

} else if (key === "last open time3") {

260

objdata["last_open_time3"] = data[key];

261

}

262

//Alec submitted25/02/25

263

else {

264

objdata[key] = data[key]

}

}

var listdata = [{

"ts": timestamp,

"values": objdata

}]

for (var key1 in obj1) {

272

if (modelname == "Dragino RS485-NB") {

273

listdata.push({

274

"ts": obj1[key1][obj1[key1].length - 1],

275

"values": {

276

"Payload": obj1[key1][0],

}

})

} else {

listdata.push({

"ts": obj1[key1][obj1[key1].length - 1],

"values": {

"values": obj1[key1]

},

})

}

}

var result = {

deviceName: deviceName,

291

deviceType: modelname,

292

attributes: {

293

model: modelname,

294

//customerName: "NB-CB",

295

//groupName: "NB-CB",

296

//integrationName: metadata['integrationName']

},

telemetry: listdata

}

function decodeToString(payload) {

303

return String.fromCharCode.apply(String, payload);

304

}

305

306

function decodeToJson(payload) {

307

// covert payload to string.

308

var str = decodeToString(payload);

309

310

// parse string to JSON

311

var data = JSON.parse(str);

return data;

}

return result;

Click on the **Add** button.

320

321

322

[[image:mqtt-uplink.png||width="500"]]

You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.

327

328

329

[[image:data-converter-list-showing-uplink-dc.png]]

== 3.2 Downlink ==

On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.

336

337

338

[[image:create-new-converter-menu.png||width="500"]]

The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.

343

344

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.

// Encode downlink data from incoming Rule Engine message

349

350

// msg - JSON message payload downlink message json

351

// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.

352

// metadata - list of key-value pairs with additional data about the message

353

// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter

/** Encoder **/

var data = {};

// Process data from incoming message and metadata

360

361

data.tempFreq = msg.temperatureUploadFrequency;

362

data.humFreq = msg.humidityUploadFrequency;

363

364

data.devSerialNumber = metadata['ss_serialNumber'];

365

366

// Result object with encoded downlink payload

367

var result = {

368

369

// downlink data content type: JSON, TEXT or BINARY (base64 format)

contentType: "JSON",

// downlink data

data: JSON.stringify(data),

374

375

// Optional metadata object presented in key/value format

376

metadata: {

377

topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'

}

};

return result;

Click on the **Add** button.

387

388

389

[[image:add-downlink-data-converter.png||height="529" width="500"]]

390

391

392

You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.

393

394

395

[[image:data-converters-list.png]]

396

397

398

= 4. Add Integration =

399

400

401

In the left navigation, click **Integrations center**, and then click **Integrations**.

402

403

404

[[image:integrations-list-empty.png]]

405

406

407

On the **Integrations** page, click on the '**+**' button.

408

409

410

The **Add integration** window appears.

411

412

In the **Add integration** window, configure the following settings:

**Basic settings:**

* **Integration type**: MQTT

418

* **Name**: MQTT integration NB/CB

419

* **Enable integration**: YES

420

* **Allows create devices or assets**: YES

421

422

Click **Next** button.

423

424

425

[[image:add-integration-basic-settings.png||height="511" width="500"]]

426

427

428

**Uplink data converter:**

429

430

* Click on the **Select existing** button.

431

* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.

432

433

Click **Next** button.

434

435

436

[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]

437

438

439

**Downlink data converter:**

440

441

* Click on the **Select existing** button.

442

* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.

443

444

Click **Next** button.

445

446

447

[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]

**Connection:**

* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)

453

* **Port**: 8883

454

* **Credentials**: Basic

455

* **Enable SSL**: YES

456

* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)

457

* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)

458

* **Topic: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)

459

* **QoS:** 0-At most once

460

461

[[image:add-integration-connection.png||height="511" width="500"]]

462

463

464

Click on the **Advanced settings** button.

465

466

* **Clean session:** YES

467

* **Retained**: YES

468

469

[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]

470

471

472

Click on the **Check connection** button to verify the MQTT connection using the provided parameters.

473

474

475

[[image:check-connection.png||height="83" width="300"]]

476

477

478

If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.

479

480

481

[[image:connection-success.png||height="511" width="500"]]

482

483

484

Click on the **Add** button.

485

486

You should see that the newly added integration is listed on the **Integrations** page.

487

488

Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**

[[image:new-integration-pending.png]]

493

494

495

= 5. Verifying the receipt of data from virtual devices =

496

497

498

== 5.1 How does it work? ==

499

500

501

We use the Mosquitto MQTT client to simulate MQTT messages, acting as a virtual device. First, install the Mosquitto client on your computer from [[this link>>url:https://mosquitto.org/download/]]. The Mosquitto client publishes messages to the MQTT broker (HiveMQ) on a specified MQTT topic. ThingsBoard subscribes to these messages using the same topic.

502

503

The Mosquitto client publishes messages on the topic v1/devices/[device_name]/telemetry. The [device_name]placeholder can be replaced with any device name, for example, 'S31B-NB'. Then, the MQTT topic would be v1/devices/S31B-NB/telemetry.

504

505

On the ThingsBoard side, we configure the MQTT topic subscription as v1/devices/+/telemetry. The + wildcard represents any device name and allows ThingsBoard to automatically create (provision) a device with that name, such as S31B-NB, for example.

506

507

508

**The new device is created the first time the MQTT topic is received. For subsequent MQTT topics with the same device name, no duplicate devices will be created.**

509

510

511

For example, if you send two MQTT messages with different device names in the topic:

512

513

1. v1/devices/**S31B-NB**/telemetry

514

1. v1/devices/**LDS25-NB**/telemetry

515

516

ThingsBoard will create two devices named **S31B-NB** and **LDS25-NB** in the **//Devices//** section.

517

518

519

The MQTT payload format is as follows, which is common for all ~-~-NB and ~-~-CB series devices:

520

521

522

{"temperature":10.4, "humidity":85}

== 5.2 Sending messages ==

527

528

529

On the terminal, issue the following MQTT command which simulates the device S31B-NB. The message payload contains the fields temperature and humidity, which hold the values 10.4 and 85, respectively. This payload is also (technically) known as telemetry.

530

531

532

mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":10.4, "humidity":85}'

533

534

535

If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.

536

537

538

[[image:integration-active.png]]

539

540

541

Also, a new device named **S31B-NB** will appear under **//Entities -> Devices -> All//**. This means the first MQTT message triggers ThingsBoard to provision a device named **S31B-NB**.

542

543

544

[[image:device-provision-1.png]]

545

546

547

Click on the device S31B-NB on the devices list to see its details.

548

549

Then go to the **Latest telemetry** tab.

550

551

You can see the fields temperature and humidity with the values you previously sent using the MQTT message.

552

553

554

[[image:telemetry-1.png]]

555

556

557

Now, change the values of the fields and send the MQTT message again. For example, set temperature to 20 and humidity to 70. Observe how the values update in //Latest Telemetry//.

558

559

560

[[image:telemetry-2.png]]

561

562

563

Let's provision the second device named **LDS25-NB **with initial telemetry. Use the following MQTT message.

mosquitto_pub -d -q 1 -h 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/LDS25-NB/telemetry" -u "pradeeka" -P "Kalpani123@" -m '{"temperature":11, "humidity":87}'

568

569

570

Now, refresh the **Devices** page, and you will see the second device, **LDS25-NB**, which was recently provisioned.

571

572

573

[[image:device-provision-2.png]]

574

575

576

= 6. Creating a Dashboard =

577

578

ThingsBoard **Dashboards** provide a powerful way to visualize and monitor real-time and historical data from connected devices. They allow users to create interactive, customizable panels displaying telemetry data, device status, and other key metrics. With a variety of widgets, including charts, maps, and tables, dashboards help users gain insights, track trends, and manage IoT deployments efficiently.

579

580

581

This section guides you on how to create a dashboard to display temperature and humidity data from the device on a time-series chart. You may also use other widgets in ThingsBoard to display data according to your requirements.

582

583

584

In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.

585

586

587

[[image:dashboard-1.png]]

588

589

590

In the **Title** text box, enter **NB/CB Test Dashboard** as the title of the dashboard.

591

592

Click on the **Add** button.

593

594

595

[[image:dashboard-2.png||height="526" width="500"]]

596

597

598

Click on the **Add widget / Add new widget** button.

599

600

601

[[image:dashboard-3.png]]

602

603

604

In the **Select widgets bundle** window, click **Charts**.

605

606

607

[[image:dashboard-4.png||height="537" width="700"]]

In the **Charts: select widget** window, click **Time series chart**.

612

613

614

[[image:dashboard-5.png||height="525" width="700"]]

615

616

617

Configure the **Time series chart** widget as follows:

618

619

* **Datasource** - select S31B-NB device you provisioned.

620

* **Series**:

621

** **temperature** - you can see this key by default.

622

** **humidity** - Click **Add series** button. Then add the **humidity** for the key and then type **%** as its unit.

623

* Click on the **Add** button.

624

625

[[image:timeseries-1.png||height="491" width="700"]]

626

627

628

The time-series chart will appear in edit mode. Resize it by clicking and dragging the lower-right corner.

629

630

Click the **Save** button to add the widget to the dashboard.

631

632

633

[[image:timeseries-3.png||height="347" width="700"]]

634

635

636

Now send the following MQTT messages from the terminal to simulate the data.

mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":20, "humidity":70}'

641

642

mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":22, "humidity":71}'

643

644

mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":18, "humidity":79}'

The chart will update with the values in realtime, as shown in the below image.

649

650

651

[[image:timeseries-4.png||height="316" width="700"]]

652

653

654