LWL02 - LoRaWAN Water Leak Sensor User Manual

The Dragino LWL02 is a (% style="color:#4f81bd" %)**LoRaWAN Water Sensor**(%%). When there is water between the two metal probes, LWL02 indicates a water leak event and uplink to IoT server via LoRaWAN network.

21

)))

22

23

(((

24

LWL02 is powered by (% style="color:#4f81bd" %)**2 x AAA batteries**(%%) and target for long time use, these two batteries can provide about 16,000 ~~ 70,000 uplink packets, which result in 2 ~~ 10 years battery life. After battery running out, user can easily open the enclosure and replace with 2 common AAA batteries.

)))

(((

The LWL02 will send periodically data every day as well as for each water leak event. It also (% style="color:#4f81bd" %)**counts the water leak times**(%%) and (% style="color:#4f81bd" %)**calculate last water leak duration**(%%). User can also disable the uplink for each water leak event, instead, device can count each event and uplink periodically.

)))

(((

Each LWL02 is (% style="color:#4f81bd" %)**pre-load with a set of unique keys**(%%) for LoRaWAN registration, register these keys to LoRaWAN server and it will auto connect after power on.

33

)))

34

35

[[image:image-20220608143744-1.png]]

== 1.2 Features ==

* LoRaWAN Class A v1.0.3

42

* Frequency Bands: CN470/EU433/KR920/US915/EU868/AS923/AU915/IN865/RU864

43

* SX1262 LoRa Core

44

* Water Leak detect

45

* 2 x AAA LR03 Batteries

46

* AT Commands to change parameters

47

* Uplink on periodically and open/close action

48

* Remote configure parameters via LoRa Downlink

49

* Firmware upgradable via program port

50

51

52

== 1.3 Applications ==

53

54

* Smart Buildings & Home Automation

55

* Logistics and Supply Chain Management

* Smart Metering

* Smart Agriculture

* Smart Cities

* Smart Factory

== 1.4 Dimension ==

[[image:image-20220608143952-2.png]]

65

66

[[image:1654670405145-346.png]]

== 1.5 Firmware Change log ==

71

72

LWL02 use the same firmware as LDS01.

73

74

[[LWL02 Image files – Download link>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_End_Node/LDS01/Firmware/]]

75

76

77

= 2. Power ON LWL02 =

78

79

When receive the LWL02, please open the enclosure and add 2 x AAA batteries to power it. The [[LED>>||anchor="H4.7LEDs"]] will blink when device is powered.

80

81

82

= 3. How to install LWL02 =

83

84

(((

85

When install the LWL02 on wall. Please install as below so the water leak probe will be soak in water for water detect purpose. The LWL02 main body is not water proof. Please don’t let water go inside the LWL02 main body.

86

)))

87

88

[[image:image-20220608144447-4.png]]

= 4. Operation Mode =

93

94

== 4.1 How it works? ==

95

96

(((

97

The LWL02 is configured as LoRaWAN OTAA Class A mode by default. It has OTAA keys to join network. To connect a local LoRaWAN network, user just need to input the OTAA keys in the network server and [[power on>>||anchor="H2.PowerONLWL02"]] the LWL02. It will auto join the network via OTAA.

)))

(((

In case user can’t set the OTAA keys in the network server and has to use the existing keys from server. User can [[use AT Command>>||anchor="H6.UseATCommand"]] to set the keys in the devices.

)))

== 4.2 Example to join LoRaWAN network ==

106

107

Here shows an example for how to join the [[TTN V3 Network>>url:https://eu1.cloud.thethings.network/]]. Below is the network structure, we use [[LG308>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/140-lg308.html]] as LoRaWAN gateway here.

108

109

[[image:1654671007127-335.png]]

(((

The LWL02 has water leak detect probe as above. When there is water between these two detect probe, they will be short and generate the water leak event. and send the status to LoRaWAN server. The LWL02 will uplink two type of messages to the server.

)))

* (((

A keep-alive message which send once per day.

118

)))

119

* (((

120

An emergency event message when detect a water leak. ([[Alarm event can be disabled>>||anchor="H7.3CanIdisableuplinkforeacheventtosavebatterylife3F"]])

121

)))

122

* (((

123

A periodically update at every 10 minutes when in water leak.

124

)))

125

* (((

126

A message when switch from water leak to none water leak. ([[Alarm event can be disabled>>||anchor="H7.3CanIdisableuplinkforeacheventtosavebatterylife3F"]])

)))

(((

The LG308 is already set to connect to [[TTN V3 network >>url:https://eu1.cloud.thethings.network/]]. What we need to now is only configure the TTN V3:

)))

(((

(% style="color:blue" %)**Step 1**(%%): Create a device in TTN V3 with the OTAA keys from LWL02.

)))

(((

Each LWL02 is shipped with a sticker with unique device EUI:

139

)))

140

141

[[image:1654671040430-368.png]]

142

143

144

User can enter this key in their LoRaWAN Server portal. Below is TTN V3 screen shot:

145

146

**Add APP EUI in the application**

147

148

[[image:1654671794691-956.png]]

149

150

151

[[image:1654671809850-574.png]]

152

153

[[image:1654671820156-640.png]]

154

155

156

[[image:1654671832011-696.png]]

157

158

159

**Add APP KEY and DEV EUI**

160

161

162

(% style="color:blue" %)**Step 2**(%%): **[[Power on>>||anchor="H2.PowerONLWL02"]]** LWL02 and it will auto join to the TTN V3 network. After join success, it will start to upload message to TTN V3 and user can see in the panel.

163

164

[[image:1654671889112-678.png]]

165

166

167

== 4.3 Uplink Payload ==

168

169

Uplink Payload total 9 bytes.

170

171

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

**Example:**

[[image:1654672186477-234.png]]

(((

Example Payload Decoder in TTN V3: [[http:~~/~~/www.dragino.com/downloads/index.php?dir=LoRa_End_Node/LDS01/Payload/>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_End_Node/LDS01/Payload/]]

)))

== 4.4 Downlink Payload ==

184

185

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

186

|=(% style="width: 180px;" %)**Downlink Control Type**|=(% style="width: 80px;" %)**Type Code**|=(% style="width: 150px;" %)**Downlink payload size(bytes)**

187

|(% style="width:180px" %)TDC (Transmit Time Interval—Keep Alive Interval)|(% style="width:80px" %)0x01|(% style="width:150px" %)4

188

|(% style="width:180px" %)RESET|(% style="width:80px" %)0x04|(% style="width:224px" %)2

189

|(% style="width:180px" %)[[Set confirmed mode>>||anchor="HTypeCode0x05"]]|(% style="width:80px" %)0x05|(% style="width:150px" %)2

190

|(% style="width:180px" %)[[Clear Counting>>||anchor="HTypeCode0xA6"]]|(% style="width:80px" %)0xA6|(% style="width:150px" %)2

191

|(% style="width:180px" %)[[Enable/Disable Alarm>>||anchor="HTypeCode0xA7"]]|(% style="width:80px" %)0xA7|(% style="width:150px" %)2

192

|(% style="width:180px" %)[[Control ADR/DR>>||anchor="HTypeCode0xA8"]]|(% style="width:80px" %)0xA8|(% style="width:150px" %)3

193

|(% style="width:180px" %)[[Set Alarm Timeout>>||anchor="HTypeCode0xA9"]]|(% style="width:80px" %)0xA9|(% style="width:150px" %)4

194

195

Example Downlink payload setting in TTN V3:

196

197

[[image:1654673412319-976.png]]

198

199

200

=== (% style="color:#037691" %)**Type Code 0x01**(%%) ===

201

202

If the payload=0100003C, means to control the LWL02’s Keep Alive interval to 0x00003C=60(S)

203

204

205

=== (% style="color:#037691" %)**Type Code 0x04**(%%) ===

206

207

If payload = 0x04FF, it will reset the LWL02.

208

209

210

=== (% style="color:#037691" %)**Type Code 0x05**(%%) ===

211

212

0x05 00: Set uplink to LoRaWAN unconfirmed mode

213

214

0x05 01: Set uplink to LoRaWAN confirmed mode

215

216

217

=== (% style="color:#037691" %)**Type Code 0xA6**(%%) ===

218

219

Example: 0xA601: Clear Counting

220

For LWL02: reset both count number and time.

221

222

223

=== (% style="color:#037691" %)**Type Code 0xA7**(%%) ===

224

225

0xA7 01 : Equal to AT+DISALARM=1

226

227

0xA7 00 : Equal to AT+DISALARM=0

228

229

230

=== (% style="color:#037691" %)**Type Code 0xA8**(%%) ===

Format: 0xA8 aa bb

aa: 1: Enable ADR; 0: Disable ADR (Same as AT+CADR command)

235

236

bb: set DR (Same as AT+CDATARATE ,only valid after ADR=0)

237

238

Example: 0x A8 00 02 : Set ADR=0 and DR=1

239

240

241

=== (% style="color:#037691" %)**Type Code 0xA9**(%%) ===

242

243

See [[Alarm Base Timeout>>||anchor="H4.6AlarmBaseonTimeout"]] for detail.

244

245

246

== 4.5 Integrate with Datacake ==

247

248

(((

249

Datacake provides a human friendly interface to show the sensor data, once we have data in TTN V3, we can use Datacake to connect to TTN V3 and see the data in Datacake. Below are the steps:

)))

(% style="color:blue" %)**Step 1**(%%): Be sure that your device is programmed and properly connected to the network at this time.

254

255

(% style="color:blue" %)**Step 2**(%%): To configure the Application to forward data to Datacake you will need to add integration. To add the Datacake integration, perform the following steps:

256

257

258

[[image:1654674520913-519.png]]

259

260

261

[[image:1654674530910-914.png]]

262

263

264

[[image:1654674543078-401.png]]

265

266

267

(% style="color:blue" %)**Step 3**(%%): Create an account or log in Datacake.

268

269

(% style="color:blue" %)**Step 4**(%%): Search LWL02 and add DevEUI.

270

271

[[image:1654674556510-911.png]]

272

273

274

== 4.6 Alarm Base on Timeout ==

275

276

(((

277

LWL02 can monitor the timeout for a status change, this feature can be used to monitor some event such as open fridge too long etc.

)))

(((

User configure this feature by using:

)))

(((

)))

(((

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

)))

* (((

**AT+TTRIG=1,30 ** **~-~->** When status change from close to open, and device keep in open

)))

(((

status for more than 30 seconds. LWL02 will send an uplink packet, the Alarm bit (the lowest bit of 10^^th^^ byte of payload) on this uplink packet is set to 1.

)))

* (((

**AT+TTIG=0,0** **~-~->** Default Value, disable timeout Alarm.

)))

(((

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

)))

(((

**Command: 0xA9 aa bb cc**

)))

(((

A9: Command Type Code

)))

(((

aa: status to be monitor

)))

(((

bb cc: timeout.

)))

(((

)))

(((

If user send 0xA9 01 00 1E: equal to AT+TTRIG=1,30

)))

(((

Or

)))

(((

0xA9 00 00 00: Equal to AT+TTRIG=0,0. Disable timeout Alarm.

)))

== 4.7 LEDs ==

(% border="1" cellspacing="10" style="background-color:#ffffcc; width:463px" %)

346

|=(% style="width: 184px;" %)**Action**|=(% style="width: 275px;" %)**LED behavior**

347

|(% style="width:184px" %)Power On|(% style="width:275px" %)(% style="color:green" %)**GREEN on 1s, **(% style="color:red" %)**RED on 1s,**(%%)** (% style="color:blue" %)BLUE on 1s(%%)**

348

|(% style="width:184px" %)Joined successful|(% style="width:275px" %)(% style="color:green" %)**GRENN LED **(%%)on 5s

349

|(% style="width:184px" %)Send an uplink message|(% style="width:275px" %)(% style="color:green" %)**GREEN LED**(%%) blinks once

350

|(% style="width:184px" %)Got a downlink message|(% style="width:275px" %)(% style="color:blue" %)**BLUE LED**(%%) blinks once

351

352

353

= 5. Battery & How to replace =

354

355

== 5.1 Battery Type and replace ==

356

357

(((

358

LWL02 is equipped with 2 x AAA LR03 batteries. If the batteries running low(see 2.1v in the platform). User can buy generic AAA battery and replace it. Note:

)))

1. (((

The LWL02 doesn’t have any screw, use can use nail to open it by the middle.

363

)))

364

1. (((

365

Make sure the direction is correct when install the AAA batteries.

)))

(((

(% style="color:red" %)**Important Notice: Make sure use new AAA LR03 battery and the battery doesn’t have broken surface.**

)))

(((

)))

(((

Example of AAA LR03 batter:

378

)))

379

380

[[image:1654675278044-307.png]]

381

382

383

== 5.2 Power Consumption Analyze ==

384

385

(((

386

Dragino battery powered products are all run in Low Power mode. User can check the guideline from this link to calculate the estimate battery life:

)))

(((

[[https:~~/~~/www.dragino.com/downloads/downloads/LoRa_End_Node/Battery_Analyze/DRAGINO_Battery_Life_Guide.pdf>>url:https://www.dragino.com/downloads/downloads/LoRa_End_Node/Battery_Analyze/DRAGINO_Battery_Life_Guide.pdf]]

)))

= 6. Use AT Command =

396

397

== 6.1 Access AT Command ==

398

399

LWL02 supports AT Command set. User can use a USB to TTL adapter to configure LWL02 via use AT command, as below.

400

401

[[image:image-20220608160336-1.png]]

402

403

404

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

405

406

(% style="background-color:yellow" %)**RX <- -> TX**

407

408

(% style="background-color:yellow" %)**TX <- -> RX**

409

410

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

(((

In PC, User needs to set (% style="color:#037691" %)**serial tool**(%%)(such as [[putty>>url:https://www.chiark.greenend.org.uk/~~sgtatham/putty/latest.html]], SecureCRT) baud rate to (% style="color:green" %)**115200**(%%) to access to access serial console of LWL02. Below is the output for reference:

)))

(((

The AT Access password is (% style="color:red" %)**123456**.

419

)))

420

421

[[image:1654675618022-630.png]]

422

423

(((

424

Each AT Command need to (% style="color:red" %)**add an ENTER**(%%) at the end before send.

)))

(((

When entering the first command, the (% style="color:red" %)**RED LED**(%%) will on and user can now input AT Commands. After input all needed AT Commands, please input AT+CLPM=1 to set the device to work in Low Power mode and (% style="color:red" %)**RED LED**(%%) will be off.

)))

(((

More detail AT Command manual can be found at [[AT Command Manual>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_End_Node/LDS01/]]

)))

= 7. FAQ =

== 7.1 How to upgrade the image? ==

440

441

User can upgrade the of LWL02 for bug fix, new features, or change working region. The upgrade instruction is here: [[Firmware Upgrade Instruction>>doc:Main.Firmware Upgrade Instruction for STM32 base products.WebHome]]

442

443

444

== 7.2 How to change the LoRa Frequency Bands/Region? ==

445

446

If user has for example US915 frequency and want to change it to AS923 frequency. User can follow the introduction for [[how to upgrade image>>||anchor="H7.1Howtoupgradetheimage3F"]]. When download the images, choose the required image file for download.

447

448

449

== 7.3 Can I disable uplink for each event to save battery life? ==

450

451

Yes, User can use below method to disable this:

452

453

(% style="color:#4f81bd" %)**via AT Command**:

454

455

AT+DISALARM=1, End node will only send packet in TDC time.

456

457

AT+DISALARM=0, End node will send packet in TDC time or status change for door sensor.

458

459

(% style="color:#4f81bd" %)**via LoRaWAN downlink Command**:

460

461

0xA701 : Equal to AT+DISALARM=1

462

463

0xA700 : Equal to AT+DISALARM=0

= 8. Order Info =

**Part Number: (% style="color:blue" %)LWL02-XXX(%%)**

469

470

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

471

472

* (% style="color:red" %)**EU433**(%%): frequency bands EU433

473

* (% style="color:red" %)**EU868**(%%): frequency bands EU868

474

* (% style="color:red" %)**KR920**(%%): frequency bands KR920

475

* (% style="color:red" %)**CN470**(%%): frequency bands CN470

476

* (% style="color:red" %)**AS923**(%%): frequency bands AS923

477

* (% style="color:red" %)**AU915**(%%): frequency bands AU915

478

* (% style="color:red" %)**US915**(%%): frequency bands US915

479

* (% style="color:red" %)**IN865**(%%): frequency bands IN865

480

* (% style="color:red" %)**CN779**(%%): frequency bands CN779

= 9. Packing Info =

**Package Includes**:

* LWL02 x 1

= 10.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.

494

* 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.com>>url:file:///D:/市场资料/说明书/LoRa/LT系列/support@dragino.com]].

495

496

Wiki source code of LWL02 - LoRaWAN Water Leak Sensor User Manual

Applications

Navigation