NDS01 - NB-IoT Door Sensor User Manual

The Dragino NDS01 is a (% style="color:blue" %)**NB-IOT Door Sensor**(%%) for Internet of Things solution. It is used to (% style="color:blue" %)**detect the open/close event for door and uplink the event** (%%)to IoT server via NB-IoT network.

21

)))

22

23

(((

24

Besides open/close event, NDS01 also has an internal temperature and humidity sensor which can detect the temperature and humidity inside the sensor.

)))

(((

(% style="color:blue" %)**NarrowBand-Internet of Things (NB-IoT)**(%%) is a standards-based low power wide area (LPWA) technology developed to enable a wide range of new IoT devices and services. NB-IoT significantly improves the power consumption of user devices, system capacity and spectrum efficiency, especially in deep coverage.

)))

(((

NDS01 is powered by (% style="color:blue" %)**2 x AAA batteries**(%%) for long term use.

)))

(((

*The measured temperature is 2~~3 degree higher than the actually environment temperature out of NDS01.

)))

[[image:1668224602353-769.png]]

41

42

43

== 1.2 Specifications ==

44

45

46

(% style="color:blue" %)**Common DC Characteristics:**

47

48

* Supply Voltage: 2.1v ~~ 3.6v

49

* Operating Temperature: -10 ~~ 50°C

50

51

(% style="color:blue" %)**NB-IoT Spec:**

52

53

* - B1 @H-FDD: 2100MHz

54

* - B3 @H-FDD: 1800MHz

55

* - B8 @H-FDD: 900MHz

56

* - B5 @H-FDD: 850MHz

57

* - B20 @H-FDD: 800MHz

58

* - B28 @H-FDD: 700MHz

59

60

(% style="color:blue" %)**Power Consumption**

61

62

* IDEL Mode: 10uA @ 3.3v

63

* Max transmit power: <500mA@3.3v

== 1.3 Features ==

* NB-IoT Bands: B1/B3/B5/B8/B20/B28 @H-FDD

72

* Ultra low power consumption

73

* Door Open / Close Detect

74

* Device remove alarm

75

* Uplink Protocol: TCP or UDP

76

* Uplink on periodically

77

* Micro SIM card slot for NB-IoT SIM

78

* 2 x AAA LR03 Batteries

79

80

81

== 1.4 Applications ==

82

83

84

* Smart Buildings & Home Automation

85

* Logistics and Supply Chain Management

* Smart Cities

* Smart Factory

= 2. Use NDS01 to communicate with IoT Server =

91

92

== 2.1 How it works ==

93

94

95

The NDS01 is equipped with a NB-IoT module, the pre-loaded firmware in NDS01 will get environment data from sensors and send the value to local NB-IoT network via the NB-IoT module. The NB-IoT network will forward this value to IoT server via the protocol defined by NDS01.

96

97

The diagram below shows the working flow in default firmware of NDS01:

98

99

[[image:1671503828297-252.png||height="1120" width="554"]]

100

101

102

== 2.2 Configure the NDS01 ==

103

104

=== 2.2.1 Test Requirement ===

105

106

107

To use NDS01 in your city, make sure meet below requirements:

108

109

* Your local operator has already distributed a NB-IoT Network there.

110

* The local NB-IoT network used the band that NDS01 supports.

111

* Your operator is able to distribute the data received in their NB-IoT network to your IoT server.

112

113

Below figure shows our testing structure.Here we have NB-IoT network coverage by China Mobile, the band they use is B8. The NDS01 will use (% style="color:red" %)**UDP(120.24.4.116:5601)** (%%)or (% style="color:red" %)**TCP(120.24.4.116:5600) **(%%)protocol to send data to IoT server.

114

115

116

[[image:1668224789474-811.png]]

117

118

119

=== 2.2.2 Insert SIM card ===

120

121

122

Insert the NB-IoT Card get from your provider.

123

124

User need to take out the NB-IoT module and insert the SIM card like below:

125

126

127

[[image:1668224846067-276.png]]

128

129

130

=== 2.2.3 Configure NDS01 ===

131

132

133

User need to configure NDS01 via serial port to set the **Server Address** / **Uplink Topic** to define where and how-to uplink packets. NDS01 support AT Commands, user can use a USB to TTL adapter to connect to NDS01 and use AT Commands to configure it, NDS01 needs to be in the wake-up state when using AT commands,as below.

134

135

136

[[image:1668224930349-417.png]]

137

138

139

(% style="color:blue" %)**Connection:**

140

141

**~ (% style="background-color:yellow" %)USB TTL GND <~-~-~-~-> GND(%%)**

142

143

**~ (% style="background-color:yellow" %)USB TTL TXD <~-~-~-~-> UART_RXD(%%)**

144

145

**~ (% style="background-color:yellow" %)USB TTL RXD <~-~-~-~-> UART_TXD(%%)**

146

147

148

In the PC, use below serial tool settings:

149

150

* Baud: (% style="color:green" %)**115200**

151

152

* Data bits:** (% style="color:green" %)8(%%)**

153

154

* Stop bits: (% style="color:green" %)**1**

155

156

* Parity: (% style="color:green" %)**None**

157

158

* Flow Control: (% style="color:green" %)**None**

159

160

//**If you are using Mac OS, please download the serial port assistant for Mac OS. The settings and operation are the same as Windows**//

161

162

[[image:/xwiki/bin/get/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/NDS01%20-%20NB-IoT%20Door%20Sensor%20User%20Manual/?sheet=CKEditor.ResourceDispatcher&outputSyntax=plain&language=en&type=attach&reference=%E5%BE%AE%E4%BF%A1%E5%9B%BE%E7%89%87_20230214103254.png&typed=||height="550" width="862"]]//**[[image:微信图片_20230214103254.png]]**//

163

164

After powering on the NDS01, the following information will be printed

165

166

[[image:1668225099789-919.png]]

167

168

169

(% style="color:blue" %)**AT command set**

170

171

(% style="color:#037691" %)**1. Set and query the communication protocol**

172

173

**Send: ** AT+PRO=<val> Val: 0:TCP 1:UDP

**Reply: **OK

**Send: ** AT+PRO? ~/~/ Inquire

**Reply:** +PRO:0

OK

(% style="color:#037691" %)**2. Set and query the server address**

185

186

**Send:** AT+SERVADDR=<server>,<port>

**Reply:** OK

**Send:** AT+SERVADDR? ~/~/ Inquire

191

192

**Reply: **+SERVADDR:<server>,<port>

OK

(% style="color:#037691" %)**3. Set and query the TDC**

198

199

**Send:** AT+TDC=<value> ~/~/ Heartbeat time, in seconds, the default is 86400s,which is 24 hours

**Reply:** OK

**Send:** AT+TDC? ~/~/ Inquire

204

205

**Reply:** +TDC:<value>

OK

(% style="color:#037691" %)**4. Query parameters**

**Send:** AT+CFG?

**Reply:** +PRO:0

+SERVADDR:120.27.12.119,2023

+TDC:86400

+CSQ:31

+IMEI:868163049937383

223

224

+ICCID:898604611619C0854626

225

226

+IMSI:460048118204626

OK

(% style="color:#037691" %)**5. Set and query the APN**

232

233

**Send:** AT+APN="<apn>" ~/~/ Set APN

**Reply:** OK

**Send:** AT+APN? ~/~/ Inquire

238

239

**Reply:** +APN:"cmiot"

OK

(% style="color:#037691" %)**6. Alarm and Silencer**

245

246

**Send: **AT+ALARM=<value> ~/~/ 0~~1,0: mute 1: buzzer alarm (note that no data will be reported, only the buzzer and the red light are on, if it is in silent mode, only the red light is on)

**Reply:** OK

=== 2.2.4 Use UDP protocol to uplink data (Default protocol) ===

252

253

254

* (% style="color:blue" %)**AT+PRO=1 **(%%) ~/~/ Set to use UDP protocol to uplink

255

256

* (% style="color:blue" %)**AT+SERVADDR=119.91.62.30,1999 ** (%%) ~/~/ to set UDP server address and port

257

258

[[image:1668231759500-524.png]]

259

260

261

=== 2.2.5 Use TCP protocol to uplink data ===

262

263

264

* (% style="color:blue" %)**AT+PRO=0 ** (%%) ~/~/ Set to use TCP protocol to uplink

265

266

* (% style="color:blue" %)**AT+SERVADDR=119.91.62.30,2002 **(%%) ~/~/ to set TCP server address and port

267

268

[[image:1668231789502-211.png]]

269

270

271

=== 2.2.6 Change Update Interval ===

272

273

274

User can use below command to change the (% style="color:blue" %)**uplink interval**.

275

276

* (% style="color:blue" %)**AT+TDC=86400 ** (%%)~/~/ Set Update Interval to 86400s

277

278

(% style="color:red" %)**NOTE:**

279

280

~1. By default, the device will send an uplink message every 24 hour (86400s).

281

282

283

[[image:1668231824288-204.png]]

284

285

286

== 2.3 Uplink Payload ==

287

288

289

registration package, uplink payload includes in total 61 bytes

290

291

292

(% border="1" cellspacing="5" style="background-color:#ffffcc; color:green; width:500px" %)

293

|(% style="width:60px" %)(((

**Size(bytes)**

The payload is ASCII string, representative same HEX: **0x (% style="color:red" %)4B57 (% style="color:blue" %)10 (% style="color:green" %)01 (% style="color:#00b0f0" %)34 (% style="color:#7030a0" %) 01 (% style="color:#d60093" %)383639393735303334343431303832 (% style="color:#0020b0" %)3839383631313230323234303134333938373632 (% style="color:#420042" %)1E (% style="color:#663300" %)15 (% style="color:#660066" %)494F54(%%)**

**where:**

* (% style="color:#037691" %)**Head:** (%%)0x4B57(fixed)

303

304

* (% style="color:#037691" %)**Version:** (%%)0x10=”V1.0”

305

306

* (% style="color:#037691" %)**Data type:** (%%)0x01=1(1:register,2:data sending)

307

308

* (% style="color:#037691" %)**Data length:** (%%)0x34=52(Valid data is 52 bytes)

309

310

* (% style="color:#037691" %)**Device type:**(%%) 0x01 = 1(Representative NDS01)

311

312

* (% style="color:#037691" %)**Device ID:** (%%)0x383639393735303334343431303832=869975034441082(ASCII)

313

314

* (% style="color:#037691" %)**IMSI:**(%%) 0x343630313133313138373433373332 = 460113118743732(ASCII)

315

316

* (% style="color:#037691" %)**ICCID:**(%%) 0x3839383631313230323234303134333938373632=89861120224014398762(ASCII)

317

318

* (% style="color:#037691" %)**Bat: **(%%)0x1E = 30/10=3.0V

319

320

* (% style="color:#037691" %)**Signal:**(%%) 0x15=21

321

322

(% style="color:red" %)** 0**(%%) -113dBm or less

323

324

(% style="color:red" %)** 1** (%%)-111dBm

325

326

(% style="color:red" %)** 2...30**(%%) -109dBm... -53dBm

327

328

(% style="color:red" %)** 31** (%%)-51dBm or greater

329

330

(% style="color:red" %)** 99** (%%)Not known or not detectable

331

332

* (% style="color:#037691" %)**Tail: **(%%)0x494F54(fixed)

333

334

data upload, uplink payload includes in total 32 bytes

335

336

(% border="1" cellspacing="5" style="background-color:#ffffcc; color:green; width:430px" %)

337

|(% style="width:60px" %)(((

**Size(bytes)**

(% border="1" cellspacing="5" style="background-color:#ffffcc; color:green; width:430px" %)

343

344

|(% style="width:78px" %)Door magnetic state|(% style="width:42px" %)BAT|(% style="width:58px" %)Signal|(% style="width:67px" %)(((

345

Temp integer

346

)))|(% style="width:72px" %)(((

347

Temp decimal

348

)))|(% style="width:67px" %)(((

349

Hum integer

350

)))|(% style="width:69px" %)(((

351

Hum decimal

352

)))|(% style="width:38px" %)tail

353

354

The payload is ASCII string, representative same HEX: **0x (% style="color:red" %)4B57 (% style="color:blue" %)10 (% style="color:green" %)02 (% style="color:#00b0f0" %)14 (% style="color:#7030a0" %)01 (% style="color:#d60093" %)383639393735303334343431303832 (% style="color:#a14d07" %)01 (% style="color:#0020b0" %)00 (% style="color:#420042" %)20 (% style="color:#663300" %)15 (% style="color:#660066" %)1c (% style="color:#aaaa40" %)55 (% style="color:#abaa70" %)23 (% style="color:#ba5a70" %)12 (% style="color:purple" %)454F54 (%%)**

**where:**

* (% style="color:#037691" %)**Head:** (%%)0x4B57(fixed)

359

360

* (% style="color:#037691" %)**Version:** (%%)0x10=”V1.0”

361

362

* (% style="color:#037691" %)**Data type:** (%%)0x02=2(1:register,2:data sending)

363

364

* (% style="color:#037691" %)**Data length:** (%%)0x14=20(Valid data is 20 bytes)

365

366

* (% style="color:#037691" %)**Device type: **(%%)0x01 = 1(Representative NDS01)

367

368

* (% style="color:#037691" %)**Device ID:** (%%)0x383639393735303334343431303832=869975034441082(ASCII)

369

370

* (% style="color:#037691" %)**Event type:** (%%)0x01

371

372

(% style="color:red" %)** 01:**(%%) TDC

373

374

(% style="color:red" %)** 02:**(%%)** **alarm

375

376

(% style="color:red" %)** 03:**(%%) remove alarm

377

378

(% style="color:red" %)**04: **(%%)dismantling alarm

379

380

(% style="color:red" %)**05:** (%%)remove demolition alarm

381

382

(% style="color:red" %)**06:** (%%)low voltage

383

384

**~ (% style="color:red" %)07: (%%)**remove low voltage

385

386

* (% style="color:#037691" %)**Door magnetic state:** (%%)0x00

387

388

(% style="color:red" %)**00:**(%%) Door sensor is close

389

390

(% style="color:red" %)**01:** (%%)Door sensor is open

391

392

* (% style="color:#037691" %)**Bat:**(%%)** **0x20 = 32/10=3.2V

393

394

* (% style="color:#037691" %)**Signal:**(%%)** **0x15=21

395

396

(% style="color:red" %)** 0** (%%)-113dBm or less

397

398

(% style="color:red" %)** 1** (%%)-111dBm

399

400

(% style="color:red" %)** 2...30**(%%) -109dBm... -53dBm

401

402

(% style="color:red" %)** 31** (%%)-51dBm or greater

403

404

(% style="color:red" %)** 99** (%%)Not known or not detectable

405

406

* (% style="color:#037691" %)**Temp integer:**(%%) 0x1c=28

407

408

* (% style="color:#037691" %)**Temp decimal:** (%%)0x55=85

409

410

Temp =Temp integer+(Temp decimal)/100=28+85/100=28.85℃

411

412

* (% style="color:#037691" %)**Hum integer: **(%%)0x23=35

413

414

* (% style="color:#037691" %)**Hum decimal:** (%%)0x12=18

415

416

Hum =Hum integer+(Hum decimal)/100=35+18/100=35.18**%**rh

417

418

* (% style="color:#037691" %)**Tail:** (%%)0x494F54(fixed)

419

420

421

== 2.4 Node-Red Example ==

422

423

424

Please refer to this link for the use of Node-RED:

425

426

[[http:~~/~~/wiki.dragino.com/xwiki/bin/view/Main/Node-RED/>>http://wiki.dragino.com/xwiki/bin/view/Main/Node-RED/]]

427

428

Please visit this link to download the Node-RED process:

429

430

[[https:~~/~~/github.com/dragino/dragino-end-node-decoder/tree/main/Node-RED>>url:https://github.com/dragino/dragino-end-node-decoder/tree/main/Node-RED]]

431

432

[[image:1668234343252-612.png]]

433

434

435

== 2.5 Buttons and LED and Mode ==

436

437

438

(% style="color:blue" %)**Operating mode**

439

440

(1) In the self-check mode (the default is the self-check mode when power on for the first time), the state change of the tamper switch does not trigger an alarm;

441

442

(2) In normal working mode, the state change of the tamper switch triggers an alarm;

443

444

(3) In silent mode (the default is non-silent mode when power on for the first time), the buzzer is silent.

445

446

447

(% style="color:blue" %)**led lights**

448

449

(1) After the device is powered on, the green light flashes once;

450

451

(2) The device does not set server parameters or cannot connect to the server, and the green light flashes quickly;

452

453

(3) SIM card recognition fails, the green light is always on for 20s;

454

455

(4) The equipment signal is poor, and the green light flashes once every 3 seconds;

456

457

(5) When the device sends data, the green light flashes twice;

458

459

(6) The communication of the equipment is normal, and the green light flashes 3 times continuously;

460

461

(7) Trigger the tamper switch, the red light is always on for 30s, and goes out when the alarm is canceled;

462

463

(8) Trigger the door magnetic alarm, the red light is always on for 30s, and goes out when the alarm is canceled;

464

465

466

(% style="color:blue" %)**buzzer**

467

468

(1) When the door magnetic alarm is triggered, the buzzer will sound for 30s; after the alarm is restored, the buzzer will be silenced;

469

470

(2) Enter the normal working mode (the tamper switch is closed for more than 5s or the door sensor is locked for more than 5s), the buzzer will sound for 1500ms;

471

472

(3) After entering the normal working mode, the tamper switch does not close, the buzzer sounds for 30s, the tamper switch is closed, and the buzzer sounds 1 time;

473

474

(4) When the door sensor does not alarm, press the button to trigger the alarm, and the buzzer will sound for 30s; when the door sensor alarms, press it once to cancel the alarm, and the buzzer will be silenced.

475

476

477

(% style="color:blue" %)**button**

478

479

(1) When there is no alarm, press it once to trigger the alarm, and the buzzer will sound; when it alarms, press the buzzer to silence the sound.

480

481

(2) Press twice to silence the buzzer;

482

483

(3) Press the button three times or more, when the mute function is turned off, the mute function is turned on, and the green light flashes once; when the mute function is turned on, the mute function is turned off, and the green light flashes once.

484

485

486

(% style="color:blue" %)**data pack**

487

488

(1) The device needs to send a registration packet and a heartbeat packet every time it is powered on and registered;

489

490

(2) The heartbeat time is reported once every 24 hours by default.

= 3. FAQ =

== 3.1 How to Upgrade Firmware ==

496

497

498

User can upgrade the firmware for 1) bug fix, 2) new feature release.

499

500

Burning software please go to this link to download: [[https:~~/~~/www.dropbox.com/sh/floxy4qsf2rgnrc/AAAJXz_rex37dPHwqVMBaqI_a?dl=0>>https://www.dropbox.com/sh/floxy4qsf2rgnrc/AAAJXz_rex37dPHwqVMBaqI_a?dl=0]]

501

502

(% style="color:red" %)**Note:**

503

504

Disconnect one battery before starting the upgrade

505

506

Please use 1.8V USB TO TTL serial port

507

508

(% style="color:blue" %)**Connection:**