DS03A-NB -- NB-IoT Door Sensor User Manual

The Dragino DS03A-NB is a (% style="color:blue" %) **NB-IoT Door Sensor**(%%) for Internet of Things solution. It (% style="color:blue" %)**detects door open/close status**(%%) and uplinks to IoT server via NB-IoT network. user can see the door status, open duration, open counts in the IoT Server.

22

23

The DS03A-NB will send periodically data every 2 hours as well as for each door open/close action. It also counts the door open times and calculates the last door open duration. Users can also disable the uplink for each open/close event, instead, DS03A-NB can count each open event and uplink periodically.

24

25

DS03A-LB supports (% style="color:blue" %)**Datalog Feature,** (%%)it can save the data when there is no NB-IoT network and uplink when network recover.

26

27

DS03A-LB has the (% style="color:blue" %)**Open Alarm Feature**,(%%) user can set this feature so the device will send an alarm if the door has been open for a certain time.

28

29

DS03A-LB is designed for outdoor use. It has a weatherproof enclosure and industrial level battery to work in low to high temperatures

30

31

SW3L-NB supports different uplink methods including (% style="color:blue" %)**MQTT, MQTTs, UDP & TCP**(%%) for different application requirement, and support uplinks to various IoT Servers.

32

33

SW3L-NB (% style="color:blue" %)**supports BLE configure **(%%)and(% style="color:blue" %)** OTA update**(%%) which make user easy to use.

34

35

SW3L-NB is powered by (% style="color:blue" %)**8500mAh Li-SOCI2 battery**(%%), it is designed for long-term use up to several years.

36

37

SW3L-NB has optional built-in SIM card and default IoT server connection version. Which makes it works with simple configuration.

38

39

[[image:image-20231011093807-6.png||height="278" width="879"]]

== 1.2 Features ==

* NB-IoT Bands: B1/B2/B3/B4/B5/B8/B12/B13/B17/B18/B19/B20/B25/B28/B66/B70/B85 @H-FDD

46

* Ultra-low power consumption

47

* Upload water flow volume

48

* Door Open/Close detect

49

* Door open/close statistics

50

* Datalog Feature

51

* Open Alarm Feature

52

* Multiply Sampling and one uplink

53

* Support Bluetooth v5.1 remote configure and update firmware

54

* Uplink on periodically

55

* Downlink to change configure

56

* 8500mAh Battery for long term use

57

* Nano SIM card slot for NB-IoT SIM

58

59

== 1.3 Specification ==

60

61

62

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

63

64

* Supply Voltage: 2.5v ~~ 3.6v

65

* Operating Temperature: -40 ~~ 85°C

66

67

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

68

69

(% style="color:#037691" %)**NB-IoT Module: BC660K-GL**

70

71

(% style="color:#037691" %)**Support Bands:**

* B1 @H-FDD: 2100MHz

* B2 @H-FDD: 1900MHz

* B3 @H-FDD: 1800MHz

* B4 @H-FDD: 2100MHz

* B5 @H-FDD: 860MHz

* B8 @H-FDD: 900MHz

* B12 @H-FDD: 720MHz

* B13 @H-FDD: 740MHz

* B17 @H-FDD: 730MHz

* B18 @H-FDD: 870MHz

* B19 @H-FDD: 870MHz

* B20 @H-FDD: 790MHz

* B25 @H-FDD: 1900MHz

86

* B28 @H-FDD: 750MHz

87

* B66 @H-FDD: 2000MHz

88

* B70 @H-FDD: 2000MHz

89

* B85 @H-FDD: 700MHz

90

91

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

92

93

* Li/SOCI2 un-chargeable battery

94

* Capacity: 8500mAh

95

* Self Discharge: <1% / Year @ 25°C

96

* Max continuously current: 130mA

97

* Max boost current: 2A, 1 second

98

99

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

100

101

* STOP Mode: 10uA @ 3.3v

102

* Max transmit power: 350mA@3.3v

103

104

(% class="wikigeneratedid" id="H1.4Ratedenvironmentalconditions" %)

105

(% style="display:none" %) (%%)

106

107

108

== 1.4 Applications ==

109

110

111

[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDS03A%20-%20Outdoor%20LoRaWAN%20OpenClose%20Door%20Sensor%20Manual/WebHome/1654741400370-813.png?rev=1.1||alt="1654741400370-813.png"]]

112

113

114

== 1.5 Sleep mode and working mode ==

115

116

117

(% style="color:blue" %)**Deep Sleep Mode: **(%%)Sensor doesn't have any NB-IoT activate. This mode is used for storage and shipping to save battery life.

118

119

(% style="color:blue" %)**Working Mode:** (%%)In this mode, Sensor will work as NB-IoT Sensor to Join NB-IoT network and send out sensor data to server. Between each sampling/tx/rx periodically, sensor will be in IDLE mode), in IDLE mode, sensor has the same power consumption as Deep Sleep mode.

120

121

122

== 1.6 Button & LEDs ==

123

124

125

[[image:Main.User Manual for LoRaWAN End Nodes.D20-LBD22-LBD23-LB_LoRaWAN_Temperature_Sensor_User_Manual.WebHome@1675071855856-879.png]]

126

127

128

(% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %)

129

|=(% style="width: 167px;background-color:#4F81BD;color:white" %)**Behavior on ACT**|=(% style="width: 117px;background-color:#4F81BD;color:white" %)**Function**|=(% style="width:225px;background-color:#4F81BD;color:white" %)**Action**

130

|(% style="width:167px" %)Pressing ACT between 1s < time < 3s|(% style="width:117px" %)Send an uplink|(% style="width:225px" %)(((

131

If sensor has already attached to NB-IoT network, sensor will send an uplink packet, (% style="color:blue" %)**blue led** (%%)will blink once.

132

Meanwhile, BLE module will be active and user can connect via BLE to configure device.

133

)))

134

|(% style="width:167px" %)Pressing ACT for more than 3s|(% style="width:117px" %)Active Device|(% style="width:225px" %)(((

135

(% style="color:green" %)**Green led**(%%) will fast blink 5 times, device will enter (% style="color:#037691" %)**OTA mode**(%%) for 3 seconds. And then start to attach NB-IoT network.

136

(% style="color:green" %)**Green led**(%%) will solidly turn on for 5 seconds after joined in network.

137

Once sensor is active, BLE module will be active and user can connect via BLE to configure device, no matter if device attach NB-IoT network or not.

138

)))

139

|(% style="width:167px" %)Fast press ACT 5 times.|(% style="width:117px" %)Deactivate Device|(% style="width:225px" %)(% style="color:red" %)**Red led**(%%) will solid on for 5 seconds. Means device is in Deep Sleep Mode.

140

141

== 1.7 BLE connection ==

142

143

144

SW3L-NB support BLE remote configure and firmware update.

145

146

147

BLE can be used to configure the parameter of sensor or see the console output from sensor. BLE will be only activate on below case:

148

149

* Press button to send an uplink

150

* Press button to active device.

151

* Device Power on or reset.

152

153

If there is no activity connection on BLE in 60 seconds, sensor will shut down BLE module to enter low power mode.

154

155

156

== 1.8 Pin Definitions & Switch ==

157

158

159

[[image:image-20230819104805-5.png]]

160

161

162

=== 1.8.1 Jumper JP2 ===

163

164

165

Power on Device when put this jumper.

166

167

168

=== 1.8.2 BOOT MODE / SW1 ===

169

170

171

**1)** (% style="color:blue" %)**ISP**(%%): upgrade mode, device won't have any signal in this mode. but ready for upgrade firmware. LED won't work. Firmware won't run.

172

173

**2)** (% style="color:blue" %)**Flash**(%%): work mode, device starts to work and send out console output for further debug

174

175

176

=== 1.8.3 Reset Button ===

177

178

179

Press to reboot the device.

180

181

(% style="display:none" %)

== 1.9 Mechanical ==

[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/D20-LBD22-LBD23-LB_LoRaWAN_Temperature_Sensor_User_Manual/WebHome/1675143884058-338.png?rev=1.1||alt="1675143884058-338.png"]]

187

188

[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/D20-LBD22-LBD23-LB_LoRaWAN_Temperature_Sensor_User_Manual/WebHome/1675143899218-599.png?rev=1.1||alt="1675143899218-599.png"]]

189

190

[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/D20-LBD22-LBD23-LB_LoRaWAN_Temperature_Sensor_User_Manual/WebHome/1675143909447-639.png?rev=1.1||alt="1675143909447-639.png"]]

**Probe Mechanical:**

195

196

197

[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDS03A%20-%20Outdoor%20LoRaWAN%20OpenClose%20Door%20Sensor%20Manual/WebHome/1654741444887-479.png?width=513&height=399&rev=1.1||alt="1654741444887-479.png"]]

== 1.10 Magnet Distance ==

202

203

204

* Wood Door: 10mm ~~ 30mm

205

* Iron Door: 30 ~~ 45mm

= 2. Use SW3L-NB to communicate with IoT Server =

210

211

== 2.1 Send data to IoT server via NB-IoT network ==

212

213

214

The SW3L-NB is equipped with a NB-IoT module, the pre-loaded firmware in SW3L-NB 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 SW3L-NB.

215

216

217

Below shows the network structure:

218

219

[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/SW3L-NB_NB-IoT_Flow_Sensor_User_Manual/WebHome/image-20231010091546-2.png?width=909&height=348&rev=1.1||alt="image-20231010091546-2.png"]]

220

221

222

There are two version: (% style="color:blue" %)**-GE**(%%) and (% style="color:blue" %)**-1D**(%%) version of SW3L-NB.

223

224

225

(% style="color:blue" %)**GE Version**(%%): This version doesn't include SIM card or point to any IoT server. User needs to use AT Commands to configure below two steps to set SW3L-NB send data to IoT server.

226

227

* Install NB-IoT SIM card and configure APN. See instruction of [[Attach Network>>url:http://wiki.dragino.com/xwiki/bin/view/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/#H2.AttachNetwork]].

228

229

* Set up sensor to point to IoT Server. See instruction of [[Configure to Connect Different Servers>>url:http://wiki.dragino.com/xwiki/bin/view/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/#H3.Configuretoconnecttodifferentservers]].

230

231

Below shows result of different server as a glance.

232

233

(% border="1" cellspacing="4" style="width:515px" %)

234

|(% style="background-color:#4f81bd; color:white; width:100px" %)**Servers**|(% style="background-color:#4f81bd; color:white; width:300px" %)**Dash Board**|(% style="background-color:#4f81bd; color:white; width:115px" %)**Comments**

235

|(% style="width:127px" %)[[Node-Red>>url:http://wiki.dragino.com/xwiki/bin/view/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/#H3.5A0Node-RedA028viaA0MQTT29]]|(% style="width:385px" %)(((

236

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

237

[[image:image-20230819113244-8.png||height="183" width="367"]]

238

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

239

|(% style="width:127px" %)[[DataCake>>url:http://wiki.dragino.com/xwiki/bin/view/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/#H3.4Datacake]]|(% style="width:385px" %)(((

240

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

241

[[image:image-20230819113244-9.png||height="119" width="367"]]

242

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

243

|(% style="width:127px" %)[[Tago.IO>>url:http://wiki.dragino.com/xwiki/bin/view/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/#H3.7A0Tago.ioA028viaA0MQTT29]]|(% style="width:385px" %) |(% style="width:170px" %)

244

|(% style="width:127px" %)[[General UDP>>url:http://wiki.dragino.com/xwiki/bin/view/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/#H3.1GeneralA0UDPA0Connection]]|(% style="width:385px" %)Raw Payload. Need Developer to design Dash Board|(% style="width:170px" %)

245

|(% style="width:127px" %)[[General MQTT>>url:http://wiki.dragino.com/xwiki/bin/view/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/#H3.2GeneralA0MQTTA0Connection]]|(% style="width:385px" %)Raw Payload. Need Developer to design Dash Board|(% style="width:170px" %)

246

|(% style="width:127px" %)[[ThingSpeak>>url:http://wiki.dragino.com/xwiki/bin/view/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/#H3.3A0ThingSpeakA028viaA0MQTT29]]|(% style="width:385px" %)(((

247

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

248

[[image:image-20230819113244-10.png||height="104" width="367"]]

249

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

250

|(% style="width:127px" %)[[ThingsBoard>>url:http://wiki.dragino.com/xwiki/bin/view/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/#H3.6A0ThingsBoard.CloudA028viaA0MQTT29]]|(% style="width:385px" %)(((

251

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

252

[[image:image-20230819113244-11.png||height="141" width="367"]]

253

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

254

255

(% style="color:blue" %)**1D Version**(%%): This version has 1NCE SIM card pre-installed and configure to send value to DataCake. User Just need to select the sensor type in DataCake and Activate SW3L-NB and user will be able to see data in DataCake. See here for [[DataCake Config Instruction>>url:http://wiki.dragino.com/xwiki/bin/view/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/#H3.4Datacake]].

256

257

258

== 2.2 Payload Types ==

259

260

261

To meet different server requirement, SW3L-NB supports different payload type.

**Includes:**

* [[General JSON format payload>>||anchor="H2.2.1GeneralJsonFormat28Type3D529"]]. (Type=5)

266

267

* [[HEX format Payload>>||anchor="H2.2.2HEXformatPayload28Type3D029"]]. (Type=0)

268

269

* [[ThingSpeak Format>>||anchor="H2.2.4ThingSpeakPayload28Type3D129"]]. (Type=1)

270

271

* [[ThingsBoard Format>>||anchor="H2.2.3ThingsBoardPayload28Type3D329"]]. (Type=3)

272

273

User can specify the payload type when choose the connection protocol. Example:

274

275

(% style="color:#037691" %)**AT+PRO=2,0** (%%) ~/~/ Use UDP Connection & hex Payload

276

277

(% style="color:#037691" %)**AT+PRO=2,5** (%%) ~/~/ Use UDP Connection & Json Payload

278

279

(% style="color:#037691" %)**AT+PRO=3,5 ** (%%) ~/~/ Use MQTT Connection & Json Payload

280

281

282

=== 2.2.1 General Json Format(Type~=5) ===

283

284

285

This is the General Json Format. As below:

286

287

(% style="color:#4472c4" %)**{"IMEI":"866207058378443","Model":"SW3L-NB","flow":217,"battery":3.54,"signal":24,"1":{221,2023/09/20 09:47:01},"2":{0,2023/09/20 09:15:04},"3":{0,2023/09/20 09:00:04},"4":{0,2023/09/20 08:45:03},"5":{0,2023/09/20 08:30:03},"6":{0,2023/09/20 08:15:03},"7":{0,2023/09/20 08:00:04},"8":{0,2023/09/20 07:45:04}}**

288

289

290

[[image:image-20230920175015-3.png||height="613" width="890"]]

291

292

293

(% style="color:red" %)**Notice, from above payload:**

294

295

* Distance , Battery & Signal are the value at uplink time.

296

297

* Json entry 1 ~~ 8 are the last 1 ~~ 8 sampling data as specify by (% style="color:#037691" %)**AT+NOUD=8 ** (%%)Command. Each entry includes (from left to right): Water Flow, Sampling time.

298

299

=== 2.2.2 HEX format Payload(Type~=0) ===

300

301

302

This is the HEX Format. As below:

303

304

(% style="color:#4472c4" %)**f8662070583784430b640dda15010003a4650abc400000650ab8180000650ab4940000650ab10f0000650aad8b0000650aaa070000650aa6840000650aa3000000650a9308**

305

306

[[image:image-20230920172200-1.png||height="191" width="1047"]]

307

308

309

If we use the MQTT client to subscribe to this MQTT topic, we can see the following information when the NB sensor uplink data.

310

311

[[image:image-20230920173352-2.png||height="636" width="919"]]

312

313

314

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

315

316

These bytes include the hardware and software version.

317

318

(% style="color:#037691" %)**Higher byte:**(%%) Specify Sensor Model: 0x11 for SW3L-NB

319

320

(% style="color:#037691" %)**Lower byte:**(%%) Specify the software version: 0x64=100, means firmware version 1.0.0

321

322

323

(% style="color:blue" %)**BAT (Battery Info):**

Ex1: 0x0dda = 3546mV

(% style="color:blue" %)**Signal Strength:**

329

330

NB-IoT Network signal Strength.

**Ex1: 0x15 = 21**

**0** -113dBm or less

**1** -111dBm

**2...30** -109dBm... -53dBm

339

340

**31** -51dBm or greater

341

342

**99** Not known or not detectable

343

344

345

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

346

347

Unit Timestamp Example: 650abc40(H) = 1695202368(D)

348

349

Put the decimal value into this link([[https:~~/~~/www.epochconverter.com)>>https://www.epochconverter.com]]) to get the time.

350

351

352

=== 2.2.3 ThingsBoard Payload(Type~=3) ===

353

354

355

Type3 payload special design for ThingsBoard, it will also configure other default server to ThingsBoard.

356

357

(% style="color:#4472c4" %)** {"IMEI": "866207058378443","Model": "SW3L","flow": 502,"battery": 3.57,"signal": 23}**

358

359

[[image:image-20230922094043-2.png||height="558" width="851"]]

=== 2.2.4 ThingSpeak Payload(Type~=1) ===

364

365

366

This payload meets ThingSpeak platform requirement. It includes only four fields. Form 1~~3 are:

367

368

Distance, Battery & Signal. This payload type only valid for ThingsSpeak Platform

As below:

(% style="color:#4472c4" %)**field1=Flow value&field2=Battery value&field3=Singal value**

373

374

[[image:image-20230921104741-1.png||height="565" width="826"]]

375

376

377

== 2.3 Uplink Payload ==

378

379

=== 2.3.1 Sensor Configuration, FPORT~=4 ===

380

381

382

SW3L-NB will only send this command after getting the downlink command **(0x26 02)** from the server.

383

384

(% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %)

385

|(% style="background-color:#4f81bd; color:white; width:70px" %) **Size(bytes)**|(% style="background-color:#4f81bd; color:white; width:105px" %)**3**|(% style="background-color:#4f81bd; color:white; width:60px" %)**1**|(% style="background-color:#4f81bd; color:white; width:96px" %)**1**|(% style="background-color:#4f81bd; color:white; width:105px" %)**2**|(% style="background-color:#4f81bd; color:white; width:74px" %)**1**

386

387

388

Example parse in TTNv3

389

390

[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/SW3L-LB_LoRaWAN_Flow_Sensor_User_Manual/WebHome/image-20230614172555-4.png?width=853&height=151&rev=1.1||alt="image-20230614172555-4.png"]]

391

392

393

* (% style="color:blue" %)**TDC: (default: 0x0004B0)**

394

395

Uplink interval for the total pulse count, default value is 0x0004B0 which is 1200 seconds = 20 minutes.

396

397

398

* (% style="color:blue" %)**STOP Duration & Alarm Timer**

399

400

Shows the configure value of [[Alarm for continuously water flow>>||anchor="H2.7Alarmforcontinuouslywaterflow"]]

401

402

403

=== 2.3.2 Water Flow Value, Uplink FPORT~=2 ===

(((

SW3L-NB will send this uplink **after** Device Status once join the NB-IoT network successfully. And SW3L-NB will:

)))

(((

periodically send this uplink every 20 minutes, this interval [[can be changed>>||anchor="H2.10SetTransmitIntervalTime"]].

)))

(((

Uplink Payload totals 11 bytes.

416

)))

417

418

(% border="1" cellspacing="4" style="background-color:#f2f2f2; width:515px" %)

419

|=(% colspan="6" style="width: 515px; background-color:#4F81BD;color:white" %)**Water Flow Value, FPORT=2**

420

421

|(% style="width:110px" %)**Value**|(% style="width:81px" %)Calculate Flag & [[Alarm>>||anchor="H2.7Alarmforcontinuouslywaterflow"]]|(% style="width:95px" %)(((

422

Total pulse Or Last Pulse

423

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

424

MOD & PA4_status & PB15_status

425

)))|(% style="width:92px" %)Reserve(0x01)|(% style="width:134px" %)Unix TimeStamp

426

427

**Calculate Flag & Alarm:**

428

429

(% border="1" cellspacing="4" style="background-color:#f2f2f2; width:500px" %)

430

|(% style="background-color:#4f81bd; color:white; width:70px" %)**Size(bit)**|(% style="background-color:#4f81bd; color:white; width:70px" %)**[bit7:bit6]**|(% style="background-color:#4f81bd; color:white; width:90px" %)**[bit5:bit2]**|(% style="background-color:#4f81bd; color:white; width:140px" %)**bit1**|(% style="background-color:#4f81bd; color:white; width:130px" %)**bit0**

431

432

433

**MOD & PA4_status & PB15_status:**

434

435

(% border="1" cellspacing="4" style="background-color:#f2f2f2; width:230px" %)

436

|(% style="background-color:#4f81bd; color:white; width:50px" %)**Size(bit)**|(% style="background-color:#4f81bd; color:white; width:60px" %)**bit7**|(% style="background-color:#4f81bd; color:white; width:60px" %)**bit6**|(% style="background-color:#4f81bd; color:white; width:60px" %)**[bit5:bit0]**

437

|(% style="width:88px" %)**Value**|(% style="width:117px" %)PA4_status|(% style="width:117px" %)PB15_status|(% style="width:118px" %)MOD

438

439

(% style="color:#037691" %)** **[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/SW3L-LB_LoRaWAN_Flow_Sensor_User_Manual/WebHome/image-20230626093242-1.png?width=892&height=276&rev=1.1||alt="image-20230626093242-1.png"]]

* (((

(% style="color:blue" %)**Calculate Flag**

)))

(((

The calculate flag is a user defined field, IoT server can use this flag to handle different meters with different pulse factors. For example, if there are 100 Flow Sensors, meters 1 ~~50 are 1 liter/pulse and meters 51 ~~ 100 has 1.5 liter/pulse.

)))

(((

**Example: in the default payload:**

)))

* (((

calculate flag=0: for SW3L-004 Flow Sensor: 450 pulse = 1 L

456

)))

457

* (((

458

calculate flag=1: for SW3L-006 Flow Sensor: 390 pulse = 1 L

459

)))

460

* (((

461

calculate flag=2: for SW3L-010 Flow Sensor: 64 pulse = 1 L

)))

(((

Default value: 0.

)))

(((

Range (4 bits): (b)0000 ~~ (b) 1111

470

471

If user use with a meter for example is 0.02L/pulse. To proper decode the correct value in server,

472

473

1) User can set the Calculate Flag of this sensor to 3.

474

475

2) In server side, when a sensor data arrive, the decoder will check the value of Calculate Flag, It the value is 3, the total volume = 0.02 x Pulse Count.

)))

(((

(% style="color:red" %)**NOTE: User need to set Calculate Flag to proper value before use Flow Sensor. Downlink or AT Command see: **(%%)Refer: [[Set Calculate Flag>>||anchor="H2.8Setthecalculateflag"]]

(((

)))

)))

* (((

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

)))

(((

See [[Alarm for continuously water flow>>||anchor="H2.7Alarmforcontinuouslywaterflow"]]

493

)))

494

495

[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/SW3L%20LoRaWAN%20Outdoor%20Flow%20Sensor/WebHome/image-20220519095946-4.png?width=724&height=65&rev=1.1||alt="image-20220519095946-4.png"]]

(((

* (% style="color:blue" %)**TDC flag**

500

501

When the flag is 1, it means sending packets at normal time intervals.

502

503

Otherwise, it is a packet sent at non-TDC time.

)))

* (((

(% style="color:blue" %)**Total pulse**

)))

(((

Total pulse/counting since factory

)))

(((

Range (4 Bytes) : 0x00000000~~ 0xFFFFFFFF .

)))

* (((

(% style="color:blue" %)**Last Pulse**

)))

(((

Total pulse since last FPORT=2 uplink. (Default 20 minutes)

)))

(((

Range (4 Bytes) : 0x00000000~~ 0xFFFFFFFF .

* (((

(% style="color:blue" %)**PA4_status: Support digital level input below 3.3V**

)))

(((

0 ~-~-> PA4 is at low level.

)))

(((

1 ~-~-> PA4 is at high level.

* (((

(% style="color:blue" %)**PB15_status: Support digital level input below 3.3V**

)))

(((

0 ~-~-> PB15 is at low level.

)))

(((

1 ~-~-> PB15 is at high level..

)))

)))

)))

* (((

(% style="color:blue" %)**MOD: Default =0**

)))

(((

MOD=0 ~-~-> Uplink Total Pulse since factory

)))

(((

MOD=1 ~-~-> Uplink total pulse since last FPORT=2 uplink.

)))

* (((

(% style="color:blue" %)**Water Flow Value**

)))

(((

**Total Water Flow Volume = (Calculate Flag) x (Total Pulse)=9597/450=21.3L**

578

)))

579

580

[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/SW3L%20LoRaWAN%20Outdoor%20Flow%20Sensor/WebHome/image-20220519095946-5.png?width=727&height=50&rev=1.1||alt="image-20220519095946-5.png"]]

(((

**Total Water Flow for TDC timer = (Calculate Flag) x (Last Pulse)=79/450=0.2L**

585

)))

586

587

[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/SW3L%20LoRaWAN%20Outdoor%20Flow%20Sensor/WebHome/image-20220519095946-6.png?width=733&height=43&rev=1.1||alt="image-20220519095946-6.png"]] ** **

588

589

590

=== 2.3.3 Historical Water Flow Status, FPORT~=3 ===

(((

SW3L-NB stores sensor values and users can retrieve these history values via the downlink command.

)))

(((

The historical payload includes one or multiplies entries and every entry has the same payload as Real-Time water flow status.

599

600

(% border="1" cellspacing="4" style="background-color:#f2f2f2; width:515px" %)

601

|=(% colspan="6" style="width: 515px; background-color:#4F81BD;color:white" %)**Water Flow Value, FPORT=3**

602

603

|(% style="width:110px" %)**Value**|(% style="width:81px" %)Calculate Flag & [[Alarm>>||anchor="H2.7Alarmforcontinuouslywaterflow"]]|(% style="width:95px" %)(((

604

Total pulse Or Last Pulse

605

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

606

MOD & PA4_status & PB15_status

607

)))|(% style="width:92px" %)Reserve(0x01)|(% style="width:134px" %)Unix TimeStamp

608

609

**Calculate Flag & Alarm:**

610

611

(% border="1" cellspacing="4" style="background-color:#f2f2f2; width:515px" %)

612

|(% style="background-color:#4f81bd; color:white; width:50px" %)**Size(bit)**|(% style="background-color:#4f81bd; color:white; width:89px" %)**bit7**|(% style="background-color:#4f81bd; color:white; width:89px" %)**bit6**|(% style="background-color:#4f81bd; color:white; width:69px" %)**[bit5:bit2]**|(% style="background-color:#4f81bd; color:white; width:129px" %)**bit1**|(% style="background-color:#4f81bd; color:white; width:89px" %)**bit0**

613

|(% style="width:88px" %)**Value**|(% style="width:96px" %)(((

614

No ACK message

615

)))|(% style="width:94px" %)Poll Message Flag|(% style="width:115px" %)Calculate Flag|(% style="width:136px" %)Alarm: 0: No Alarm; 1: Alarm|(% style="width:120px" %)TDC flag 0:No;1:Yes

616

617

**MOD & PA4_status & PB15_status:**

618

619

(% border="1" cellspacing="4" style="background-color:#f2f2f2; width:240px" %)

620

|(% style="background-color:#4f81bd; color:white; width:60px" %)**Size(bit)**|(% style="background-color:#4f81bd; color:white; width:60px" %)**bit7**|(% style="background-color:#4f81bd; color:white; width:60px" %)**bit6**|(% style="background-color:#4f81bd; color:white; width:60px" %)**[bit5:bit0]**

621

|(% style="width:88px" %)**Value**|(% style="width:117px" %)PA4_status|(% style="width:117px" %)PB15_status|(% style="width:118px" %)MOD

)))

* (((

Each data entry is 11 bytes and has the same structure as [[real time water flow status>>||anchor="H2.3.2A0WaterFlowValue2CUplinkFPORT3D2"]], to save airtime and battery, SW3L will send max bytes according to the current DR and Frequency bands.

)))

(((

For example, in the US915 band, the max payload for different DR is:

)))

(((

(% style="color:blue" %)**a) DR0:**(%%) max is 11 bytes so one entry of data

)))

(((

(% style="color:blue" %)**b) DR1:**(%%) max is 53 bytes so devices will upload 4 entries of data (total 44 bytes)

)))

(((

(% style="color:blue" %)**c) DR2:**(%%) total payload includes 11 entries of data

)))

(((

(% style="color:blue" %)**d) DR3:**(%%) total payload includes 22 entries of data.

)))

(((

If SW3L-NB doesn't have any data in the polling time. It will uplink 11 bytes of 0

)))

(((

(% style="color:#037691" %)**Downlink:**

)))

(((

0x31 64 92 C5 AC 64 92 C7 8C 05

660

)))

661

662

[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/SW3L-LB_LoRaWAN_Flow_Sensor_User_Manual/WebHome/image-20230626093440-2.png?width=890&height=160&rev=1.1||alt="image-20230626093440-2.png"]]

(((

(% style="color:#037691" %)**Uplink:**

)))

(((

41 00 01 00 00 00 08 64 92 C5 E4 40 00 01 00 00 00 08 64 92 C6 06 49 41 01 00 00 00 00 64 92 C6 8B 49 81 01 00 00 00 00 64 92 C7 34 4A 01 01 00 00 00 2D 64 92 C7 7C

)))

(((

(% style="color:#037691" %)**Parsed Value:**

)))

(((

[TDC_flag, Alarm, Calculate Flag, PA4_status, PB15_status, MOD, Total pulse or Last Pulse,** **Water Flow Value, TIME]

)))

(((

[YES,FALSE,0,L,L, 0,8, 0.0,2023-06-21 09:41:56],

686

687

[NO,FALSE,0,L,L, 0,8, 0.0,2023-06-21 09:42:30],

688

689

[YES,FALSE,2,L,H,1,0, 0.0,2023-06-21 09:44:43],

690

691

[YES,FALSE,2,H,L,1,0, 0.0,2023-06-21 09:47:32],

692

693

[NO,TRUE ,2, L,L,1,45,0.7,2023-06-21 09:48:44],

694

)))

695

696

[[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/SW3L-LB_LoRaWAN_Flow_Sensor_User_Manual/WebHome/image-20230626093703-3.png?width=894&height=156&rev=1.1||alt="image-20230626093703-3.png"]]

697

698

699

== 2.4 Test Uplink and Change Update Interval ==

700

701

702

By default, Sensor will send uplinks (% style="color:blue" %)**every 2 hours**(%%) & AT+NOUD=8

703

704

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

705

706

(% style="color:#037691" %)**AT+TDC=600 ** (%%) ~/~/ Set Update Interval to 600s

707

708

User can also push the button for more than 1 seconds to activate an uplink.

709

710

711

== 2.5 Multi-Samplings and One uplink ==

712

713

714

To save battery life, SW3L-NB will sample Water Flow data every 15 minutes and send one uplink every 2 hours. So each uplink it will include 8 stored data + 1 real-time data. They are defined by:

715

716

* (% style="color:#037691" %)**AT+TR=900** (%%) ~/~/ The unit is seconds, and the default is to record data once every 900 seconds (15 minutes, the minimum can be set to 180 seconds)

717

718

* (% style="color:#037691" %)**AT+NOUD=8** (%%)~/~/ The device uploads 8 sets of recorded data by default. Up to 32 sets of record data can be uploaded.

719

720

The diagram below explains the relationship between TR, NOUD, and TDC more clearly:

721

722

[[image:1692424376354-959.png]]

723

724

725

== 2.6 Trggier an uplink by external interrupt ==

726

727

728

SW3L-NB has an external trigger interrupt function. Users can use the PB15 pin to trigger the upload of data packets.

729

730

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

731

732

* (% style="color:#037691" %)**AT+INTMOD **(%%) ~/~/ Set the trigger interrupt mode

733

734

* (% style="color:#037691" %)**AT+INTMOD=0 **(%%) ~/~/ Disable Interrupt

735

736

* (% style="color:#037691" %)**AT+INTMOD=1 **(%%) ~/~/ Trigger by rising and falling edge

737

738

* (% style="color:#037691" %)**AT+INTMOD=2 **(%%) ~/~/ Trigger by falling edge

739

740

* (% style="color:#037691" %)**AT+INTMOD=3 **(%%) ~/~/ Trigger by rising edge

741

742

== 2.7 Alarm for continuously water flow ==

(((

This feature is to monitor and send Alarm for continuously water flow.

)))

(((

Example case is for Toilet water monitoring, if some one push toilet button, the toilet will have water flow. If the toilet button has broken and can't returned to original state, the water flow will keep for hours or days which cause huge waste for water.

)))

(((

To monitor this faulty and send alarm, there are two settings:

)))

* (((

(% style="color:blue" %)**Stop Duration: Unit: Second**

)))

(((

Default: 15s, If SW3L-NB didn't see any water flow in 15s, SW3L-NB will consider stop of water flow event.

)))

* (((

(% style="color:blue" %)**Alarm Timer: Units: Minute; Default 0 minutes (means Alarm disable)**

)))

(((

**Example:** 3 minutes, if SW3L-NB detect a start of water flow event and didn't detect a stop event within Alarm timer, SW3L-NB will send an Alarm to indicate a water flow abnormal alarm.

)))

(((

So for example, If we set stop duration=15s and Alarm Timer=3minutes. If the toilet water flow continuously for more than 3 minutes, Sensor will send an alarm (in Confirmed MODE) to platform.

)))

(((

(% style="color:red" %)**Note:** **After this alarm is send, sensor will consider a stop of water flow and count for another new event. So if water flow waste last for 1 hour, Sensor will keep sending alarm every 3 minutes.**

)))

(((

(% style="color:blue" %)**AT Command to configure:**

)))

* (((

AT+PTRIG=15,3 ~-~-> Set Stop duration: 15s, Alarm Timer: 3 minutes.

)))

* (((

AT+ PTRIG=15,0 ~-~-> Default Value, disable water waste Alarm.

)))

(((

(% style="color:blue" %)**Downlink Command to configure:**

)))

(((

Command: **0xAA aa bb cc**

)))

(((

AA: Command Type Code

)))

(((

aa: Stop duration

)))

(((

bb cc: Alarm Timer

)))

(((

If user send 0xAA 0F 00 03: equal to AT+PTRIG=15,3

)))

== 2.8 Set the calculate flag ==

819

820

821

Feature: Set the calculate flag

822

823

(% style="color:blue" %)**AT Command: AT+CALCFLAG**

824

825

(% border="1" cellspacing="5" style="background-color:#f2f2f2; width:461px" %)

826

|=(% style="width: 158px;background-color:#4F81BD;color:white" %)**Command Example**|=(% style="width: 193px;background-color:#4F81BD;color:white" %)**Function**|=(% style="width: 110px;background-color:#4F81BD;color:white" %)**Response**

827

|(% style="width:158px" %)AT+CALCFLAG =1|(% style="width:192px" %)Set the calculate flag to 1.|(% style="width:109px" %)OK

828

|(% style="width:158px" %)AT+CALCFLAG =2|(% style="width:192px" %)Set the calculate flag to 2.|(% style="width:109px" %)OK

829

830

(% style="color:blue" %)**Downlink Command:**

831

832

* **Example**: 0XA501 ~/~/ Same as AT+CALCFLAG =1

833

834

== 2.9 Set count number ==

835

836

837

Feature: Manually set the count number

838

839

(% style="color:blue" %)**AT Command: AT+SETCNT**

840

841

(% border="1" cellspacing="5" style="background-color:#f2f2f2; width:479px" %)

842

|=(% style="width: 160px;background-color:#4F81BD;color:white" %)**Command Example**|=(% style="width: 223px;background-color:#4F81BD;color:white" %)**Function**|=(% style="width: 96px;background-color:#4F81BD;color:white" %)**Response**

843

|(% style="width:160px" %)AT+ SETCNT =0|(% style="width:221px" %)Set the count number to 0.|(% style="width:95px" %)OK

844

|(% style="width:160px" %)AT+ SETCNT =100|(% style="width:221px" %)Set the count number to 100.|(% style="width:95px" %)OK

845

846

(% style="color:blue" %)**Downlink Command:**

847

848

* **Example**: 0xA6000001 ~/~/ Same as AT+ SETCNT =1

849

850

* **Example**: 0xA6000064 ~/~/ Same as AT+ SETCNT =100

851

852

== 2.10 Set Transmit Interval Time ==

(((

Feature: Change NB-IoT End Node Transmit Interval.

)))

(((

(% style="color:blue" %)**AT Command: AT+TDC**

861

)))

862

863

(% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %)

864

|=(% style="width: 156px;background-color:#4F81BD;color:white" %)**Command Example**|=(% style="width: 137px;background-color:#4F81BD;color:white" %)**Function**|=(% style="background-color:#4F81BD;color:white" %)**Response**

865

|(% style="width:156px" %)AT+TDC=?|(% style="width:137px" %)Show current transmit Interval|(((

866

30000

867

OK

868

the interval is 30000ms = 30s

869

)))

870

|(% style="width:156px" %)AT+TDC=60000|(% style="width:137px" %)Set Transmit Interval|(((

871

OK

872

Set transmit interval to 60000ms = 60 seconds

)))

(((

(% style="color:blue" %)**Downlink Command: 0x01**

)))

(((

Format: Command Code (0x01) followed by 3 bytes time value.

)))

(((

If the downlink payload=0100003C, it means set the END Node's Transmit Interval to 0x00003C=60(S), while type code is 01.

)))

* (((

Example 1: Downlink Payload: 0100001E ~/~/ Set Transmit Interval (TDC) = 30 seconds

889

)))

890

* (((

891

Example 2: Downlink Payload: 0100003C ~/~/ Set Transmit Interval (TDC) = 60 seconds

)))

= 3. Configure SW3L-NB =

898

899

== 3.1 Configure Methods ==

900

901

902

SW3L-NB supports below configure method:

903

904

* AT Command via Bluetooth Connection (**Recommended**): [[BLE Configure Instruction>>http://wiki.dragino.com/xwiki/bin/view/Main/BLE%20Bluetooth%20Remote%20Configure/]].

905

906

* AT Command via UART Connection : See [[UART Connection>>http://wiki.dragino.com/xwiki/bin/view/Main/UART%20Access%20for%20LoRa%20ST%20v4%20base%20model/#H2.3UARTConnectionforSN50v3basemotherboard]].

907

908

== 3.2 AT Commands Set ==

909

910

911

AT+<CMD>? : Help on <CMD>

AT+<CMD> : Run <CMD>

AT+<CMD>=<value> : Set the value

916

917

AT+<CMD>=? : Get the value

918

919

920

(% style="color:blue" %)**General Commands**

AT : Attention

AT? : Short Help

ATZ : MCU Reset

AT+TDC : Application Data Transmission Interval

929

930

AT+CFG : Print all configurations

931

932

AT+CFGMOD : Working mode selection

933

934

AT+DEUI : Get or set the Device ID

935

936

AT+INTMOD : Set the trigger interrupt mode

937

938

AT+5VT : Set extend the time of 5V power

939

940

AT+PRO : Choose agreement

941

942

AT+RXDL : Extend the sending and receiving time

943

944

AT+DNSCFG : Get or Set DNS Server

945

946

AT+GETSENSORVALUE : Returns the current sensor measurement

947

948

AT+NOUD : Get or Set the number of data to be uploaded

949

950

AT+CDP : Read or Clear cached data

951

952

AT+SHTEMP: Get or Set alarm of temp

953

954

AT+SHHUM: Get or Set alarm of moisture

955

956

AT+SERVADDR : Server Address

957

958

959

(% style="color:blue" %)**UDP Management**

960

961

AT+CFM : Upload confirmation mode (only valid for UDP)

962

963

964

(% style="color:blue" %)**MQTT Management**

965

966

AT+CLIENT : Get or Set MQTT client

967

968

AT+UNAME : Get or Set MQTT Username

969

970

AT+PWD : Get or Set MQTT password

971

972

AT+PUBTOPIC : Get or Set MQTT publish topic

973

974

AT+SUBTOPIC : Get or Set MQTT subscription topic

975

976

977

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

978

979

AT+FDR : Factory Data Reset

980

981

AT+PWORD : Serial Access Password

982

983

AT+LDATA : Get the last upload data

984

985

AT+CDP : Read or Clear cached data

986

987

988

= 4. Battery & Power Consumption =

989

990

991

SW3L-NB use ER26500 + SPC1520 battery pack. See below link for detail information about the battery info and how to replace.

992

993

[[**Battery Info & Power Consumption Analyze**>>http://wiki.dragino.com/xwiki/bin/view/Main/How%20to%20calculate%20the%20battery%20life%20of%20Dragino%20sensors%3F/]] .

994

995

996

= 5. Firmware update =

997

998

999

User can change device firmware to::

1000

1001

* Update with new features.

* Fix bugs.

Firmware and changelog can be downloaded from : **[[Firmware download link>>https://www.dropbox.com/sh/l0bszumyrmil3yv/AAAg8LYGeAgDsD_ycCnweD72a?dl=0]]**

1006

1007

Methods to Update Firmware:

1008

1009

* (Recommended way) OTA firmware update via BLE: [[**Instruction**>>url:http://wiki.dragino.com/xwiki/bin/view/Main/BLE_Firmware_Update_NB_Sensors_BC660K-GL/]].

1010

1011

* Update through UART TTL interface : **[[Instruction>>url:http://wiki.dragino.com/xwiki/bin/view/Main/UART%20Access%20for%20LoRa%20ST%20v4%20base%20model/#H1.LoRaSTv4baseHardware]]**.

= 6. FAQ =

== 6.1 How can I access t BC660K-GL AT Commands? ==

1016

1017

1018

User can access to BC660K-GL directly and send AT Commands.

1019

1020

[[See BC660K-GL AT Command set>>url:https://www.dropbox.com/sh/5f6ssda5fum8rvs/AABT68l8ZzWOvZ5eg2qwOoFda?dl=0]]

= 7. Order Info =

Part Number: (% style="color:blue" %)**SW3L-NB-XX-YY**

1027

1028

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

1029

1030

* (% style="color:#037691" %)**GE**(%%): General version ( Exclude SIM card)

1031

1032

* (% style="color:#037691" %)**1D**(%%): with 1NCE* 10 years 500MB SIM card and Pre-configure to DataCake server

1033

1034

(% style="color:#037691" %)**1NCE SIM Card NB-IoT network coverage**(%%): Austria, Belgium, Bulgaria, Croatia, Czech Republic, Denmark, Finland, Germany, Great Britain, Greece, Hungary, Ireland, Italy, Latvia, Malta, Netherlands, Norway, Puerto Rico, Russia, Slovak , Republic, Slovenia, Spain, Sweden, Switzerland, Taiwan, USA, US Virgin Islands

1035

1036

(((

1037

(% style="color:blue" %)**YY**(%%): Flow Sensor Model:

)))

(((

**004:** DW-004 Flow Sensor: diameter: G1/2” / DN15. 450 pulse = 1 L

)))

(((

**006:** DW-006 Flow Sensor: diameter: G3/4” / DN20. 390 pulse = 1 L

)))

(((

**010:** DW-010 Flow Sensor: diameter: G 1” / DN25. 64 pulse = 1 L

)))

* (((

calculate flag=0: for SW3L-004 Flow Sensor: 450 pulse = 1 L

)))

* (((

calculate flag=1: for SW3L-006 Flow Sensor: 390 pulse = 1 L

)))

* (((

calculate flag=2: for SW3L-010 Flow Sensor: 64 pulse = 1 L

)))

= 8. Packing Info =

(% style="color:#037691" %)**Package Includes**:

1071

1072

* SW3L-NB NB-IoT Distance Detection sensor x 1

1073

1074

* External antenna x 1

1075

1076

(% style="color:#037691" %)**Dimension and weight**:

1077

1078

* Device Size: 13.0 x 5 x 4.5 cm

1079

1080

* Device Weight: 150g

1081

1082

* Package Size / pcs : 14.0 x 8x 5 cm

1083

1084

* Weight / pcs : 180g

= 9. Support =

* Support is provided Monday to Friday, from 09:00 to 18:00 GMT+8. Due to different timezones we cannot offer live support. However, your questions will be answered as soon as possible in the before-mentioned schedule.

1090

1091

* Provide as much information as possible regarding your enquiry (product models, accurately describe your problem and steps to replicate it etc) and send a mail to [[Support@dragino.cc>>mailto:Support@dragino.cc]].

1092

1093

(% style="display:none" %) (%%)

Wiki source code of DS03A-NB -- NB-IoT Door Sensor User Manual

Applications

Navigation