NDS01 - NB-IoT Door Sensor User Manual

1

(% style="text-align:center" %)

2

[[image:image-20221112113258-1.jpeg]]

= 1. Introduction =

== 1.1 What is NDS01 NB-IoT Door Sensor ==

17

18

19

The Dragino NDS01 is a NB-IOT Door Sensor for Internet of Things solution. It is used to detect the open/close event for door and uplink the event to IoT server via NB-IoT network.

20

21

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

22

23

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

24

25

NDS01 is powered by 2 x AAA batteries for long term use.

26

27

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

28

29

30

[[image:1668224602353-769.png]]

== 1.2 Specifications ==

35

36

37

**Common DC Characteristics:**

38

39

* Supply Voltage: 2.1v ~~ 3.6v

40

* Operating Temperature: -10 ~~ 50°C

**NB-IoT Spec:**

* - B1 @H-FDD: 2100MHz

45

* - B3 @H-FDD: 1800MHz

46

* - B8 @H-FDD: 900MHz

47

* - B5 @H-FDD: 850MHz

48

* - B20 @H-FDD: 800MHz

49

* - B28 @H-FDD: 700MHz

50

51

**Power Consumption**

52

53

* IDEL Mode: 10uA @ 3.3v

54

* Max transmit power: <500mA@3.3v

== 1.3 Features ==

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

63

* Ultra low power consumption

64

* Door Open / Close Detect

65

* Device remove alarm

66

* Uplink Protocol: TCP or UDP

67

* Uplink on periodically

68

* Micro SIM card slot for NB-IoT SIM

69

* 2 x AAA LR03 Batteries

70

71

== 1.4 Applications ==

72

73

74

* Smart Buildings & Home Automation

75

* Logistics and Supply Chain Management

* Smart Cities

* Smart Factory

= 2. Use NDS01 to communicate with IoT Server =

80

81

== 2.1 How it works ==

82

83

84

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.

85

86

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

87

88

89

== 2.2 Configure the NDS01 ==

90

91

=== 2.2.1 Test Requirement ===

92

93

94

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

95

96

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

97

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

98

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

99

100

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 UDP(120.24.4.116:5601) or TCP(120.24.4.116:5600)protocol to send data to IoT server.

101

102

103

[[image:1668224789474-811.png]]

104

105

106

=== 2.2.1 Insert SIM card ===

107

108

109

Insert the NB-IoT Card get from your provider.

110

111

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

112

113

114

[[image:1668224846067-276.png]]

115

116

117

=== 2.2.3 Configure NDS01 ===

118

119

120

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.

121

122

123

[[image:1668224930349-417.png]]

124

125

126

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

127

128

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

129

130

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

131

132

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

133

134

135

In the PC, use below serial tool settings:

136

137

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

138

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

139

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

140

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

141

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

142

143

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

144

145

[[image:1668225099789-919.png]]

146

147

148

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

149

150

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

151

152

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

164

165

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

**Reply:** OK

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

170

171

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

OK

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

177

178

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

**Reply:** OK

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

183

184

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

202

203

+ICCID:898604611619C0854626

204

205

+IMSI:460048118204626

OK

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

211

212

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

**Reply:** OK

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

217

218

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

OK

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

224

225

**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) ===

232

233

234

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

235

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

236

237

[[image:1668231759500-524.png]]

238

239

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

240

241

242

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

243

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

244

245

[[image:1668231789502-211.png]]

=== 2.2.6 Change Update Interval ===

250

251

252

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

253

254

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

255

256

257

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

258

259

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

260

261

262

[[image:1668231824288-204.png]]

== 2.3 Uplink Payload ==

267

268

269

registration package, uplink payload includes in total 61 bytes

270

271

272

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

273

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

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

283

284

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

285

286

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

287

288

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

289

290

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

291

292

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

293

294

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

295

296

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

297

298

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

299

300

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

301

302

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

303

304

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

305

306

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

307

308

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

309

310

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

311

312

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

313

314

data upload, uplink payload includes in total 32 bytes

|(((

**Size(bytes)**

)))|**2**|**1**|**1**|**1**|**1**|**15**|**1**|**1**|**1**|**1**|**1**|**1**|**1**|**1**|**3**

Temp

integer

)))|(((

Temp

decimal

)))|(((

Hum

integer

)))|(((

Hum

decimal

)))|tail

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:#acaab0" %)494F54

**where:**

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

342

343

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

344

345

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

346

347

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

348

349

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

350

351

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

352

353

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

354

355

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

356

357

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

358

359

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

360

361

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

362

363

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

364

365

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

366

367

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

368

369

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

370

371

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

372

373

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

374

375

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

376

377

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

378

379

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

380

381

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

382

383

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

384

385

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

386

387

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

388

389

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

390

391

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

392

393

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

394

395

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

396

397

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

398

399

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

400

401

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

402

403

== 2.4 Node-Red Example ==

404

405

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

406

407

[[http:~~/~~/8.211.40.43:8080/xwiki/bin/view/Main/Node-RED/>>url:http://8.211.40.43:8080/xwiki/bin/view/Main/Node-RED/]]

408

409

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

410

411

[[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]]

412

413

[[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image009.png]]

== 2.5 Buttons and LED and Mode ==

Operating mode

(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;

423

424

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

425

426

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

led lights

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

432

433

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

434

435

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

436

437

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

438

439

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

440

441

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

442

443

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

444

445

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

buzzer

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

451

452

(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;

453

454

(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;

455

456

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

button

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

462

463

(2) Press twice to silence the buzzer;

464

465

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

data pack

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

471

472

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

473

474