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

Version 23.3 by Xiaoling on 2022/06/08 16:03

version	line-number	content
2.2	1	(% style="text-align:center" %)
	2	[[image:1654669760488-506.png\|\|height="510" width="769"]]
1.1	3
	4
	5
17.3	6	Contents:
1.1	7
17.3	8	{{toc/}}
1.1	9
	10
	11
17.3	12
	13
2.2	14	= 1. Introduction =
1.1	15
2.2	16	== 1.1 What is LWL02 LoRaWAN Water Leak Sensor ==
1.1	17
	18
3.2	19	(((
2.2	20	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.
3.2	21	)))
1.1	22
3.2	23	(((
2.2	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.
3.2	25	)))
1.2	26
3.2	27	(((
2.2	28	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.
3.2	29	)))
1.2	30
3.2	31	(((
	32	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	)))
1.2	34
3.2	35	[[image:image-20220608143744-1.png]]
1.2	36
	37
	38
3.3	39	== 1.2 Features ==
1.2	40
	41	* 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
3.4	51	== 1.3 Applications ==
	52
1.2	53	* Smart Buildings & Home Automation
	54	* Logistics and Supply Chain Management
	55	* Smart Metering
	56	* Smart Agriculture
	57	* Smart Cities
	58	* Smart Factory
	59
5.2	60	== 1.4 Dimension ==
1.2	61
5.2	62	[[image:image-20220608143952-2.png]]
1.2	63
5.2	64	[[image:1654670405145-346.png]]
1.2	65
5.2	66
	67
	68	== 1.5 Firmware Change log ==
	69
1.2	70	LWL02 use the same firmware as LDS01.
	71
	72	[[LWL02 Image files – Download link>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_End_Node/LDS01/Firmware/]]
	73
	74
	75
5.2	76	= 2. Power ON LWL02 =
1.2	77
5.3	78	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.
1.2	79
	80
	81
7.2	82	= 3. How to install LWL02 =
1.2	83
7.4	84	(((
1.2	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.
7.4	86	)))
1.2	87
7.2	88	[[image:image-20220608144447-4.png]]
1.2	89
	90
	91
7.2	92	= 4. Operation Mode =
1.2	93
7.2	94	== 4.1 How it works? ==
1.2	95
7.3	96	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.
1.2	97
7.3	98	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.
1.2	99
	100
	101
7.3	102	== 4.2 Example to join LoRaWAN network ==
7.2	103
1.6	104	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.
1.2	105
8.2	106	[[image:1654671007127-335.png]]
1.2	107
	108
9.6	109	(((
1.2	110	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.
9.6	111	)))
1.2	112
9.6	113	* (((
	114	A keep-alive message which send once per day.
	115	)))
	116	* (((
	117	An emergency event message when detect a water leak. ([[Alarm event can be disabled>>\|\|anchor="H7.3CanIdisableuplinkforeacheventtosavebatterylife?"]])
	118	)))
	119	* (((
	120	A periodically update at every 10 minutes when in water leak.
	121	)))
	122	* (((
17.5	123	A message when switch from water leak to none water leak. ([[Alarm event can be disabled>>\|\|anchor="H7.3CanIdisableuplinkforeacheventtosavebatterylife3F"]])
9.6	124	)))
1.2	125
9.6	126	(((
1.2	127	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:
9.6	128	)))
1.2	129
9.6	130	(((
9.5	131	(% style="color:blue" %)Step 1(%%): Create a device in TTN V3 with the OTAA keys from LWL02.
9.6	132	)))
1.2	133
9.6	134	(((
1.2	135	Each LWL02 is shipped with a sticker with unique device EUI:
9.6	136	)))
1.2	137
9.2	138	[[image:1654671040430-368.png]]
1.2	139
	140
	141	User can enter this key in their LoRaWAN Server portal. Below is TTN V3 screen shot:
	142
14.3	143	Add APP EUI in the application
1.2	144
11.2	145	[[image:1654671794691-956.png]]
1.2	146
	147
11.2	148	[[image:1654671809850-574.png]]
1.2	149
12.2	150	[[image:1654671820156-640.png]]
1.2	151
	152
13.2	153	[[image:1654671832011-696.png]]
1.2	154
	155
14.2	156	Add APP KEY and DEV EUI
1.2	157
	158
14.4	159	(% 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.
1.2	160
14.2	161	[[image:1654671889112-678.png]]
1.2	162
	163
	164
14.5	165	== 4.3 Uplink Payload ==
	166
1.2	167	Uplink Payload total 9 bytes.
	168
16.2	169	[[image:image-20220608150921-5.png]]
1.2	170
16.2	171	Example:
1.2	172
16.2	173	[[image:1654672186477-234.png]]
1.2	174
	175
16.3	176	(((
	177	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/]]
	178	)))
1.2	179
	180
	181
16.4	182	== 4.4 Downlink Payload ==
1.2	183
16.9	184	(% border="1" cellspacing="10" style="background-color:#ffffcc; color:green; width:410px" %)
16.7	185	\|=(% style="width: 180px;" %)Downlink Control Type\|=(% style="width: 80px;" %)Type Code\|=(% style="width: 150px;" %)Downlink payload size(bytes)
	186	\|(% style="width:180px" %)TDC (Transmit Time Interval—Keep Alive Interval)\|(% style="width:80px" %)0x01\|(% style="width:150px" %)4
	187	\|(% style="width:180px" %)RESET\|(% style="width:80px" %)0x04\|(% style="width:224px" %)2
17.4	188	\|(% style="width:180px" %)[[Set confirmed mode>>\|\|anchor="HTypeCode0x05"]]\|(% style="width:80px" %)0x05\|(% style="width:150px" %)2
	189	\|(% style="width:180px" %)[[Clear Counting>>\|\|anchor="HTypeCode0xA6"]]\|(% style="width:80px" %)0xA6\|(% style="width:150px" %)2
	190	\|(% style="width:180px" %)[[Enable/Disable Alarm>>\|\|anchor="HTypeCode0xA7"]]\|(% style="width:80px" %)0xA7\|(% style="width:150px" %)2
	191	\|(% style="width:180px" %)[[Control ADR/DR>>\|\|anchor="HTypeCode0xA8"]]\|(% style="width:80px" %)0xA8\|(% style="width:150px" %)3
	192	\|(% style="width:180px" %)[[Set Alarm Timeout>>\|\|anchor="HTypeCode0xA9"]]\|(% style="width:80px" %)0xA9\|(% style="width:150px" %)4
1.2	193
	194	Example Downlink payload setting in TTN V3:
	195
17.2	196	[[image:1654673412319-976.png]]
1.2	197
	198
17.3	199	=== (% style="color:#037691" %)Type Code 0x01(%%) ===
1.2	200
	201	If the payload=0100003C, means to control the LWL02’s Keep Alive interval to 0x00003C=60(S)
	202
	203
17.3	204	=== (% style="color:#037691" %)Type Code 0x04(%%) ===
1.2	205
	206	If payload = 0x04FF, it will reset the LWL02.
	207
	208
17.3	209	=== (% style="color:#037691" %)Type Code 0x05(%%) ===
1.2	210
	211	0x05 00: Set uplink to LoRaWAN unconfirmed mode
	212
	213	0x05 01: Set uplink to LoRaWAN confirmed mode
	214
	215
17.3	216	=== (% style="color:#037691" %)Type Code 0xA6(%%) ===
1.2	217
	218	Example: 0xA601: Clear Counting
	219	For LWL02: reset both count number and time.
	220
	221
17.3	222	=== (% style="color:#037691" %)Type Code 0xA7(%%) ===
1.2	223
	224	0xA7 01 : Equal to AT+DISALARM=1
	225
	226	0xA7 00 : Equal to AT+DISALARM=0
	227
	228
17.3	229	=== (% style="color:#037691" %)Type Code 0xA8(%%) ===
1.2	230
	231	Format: 0xA8 aa bb
	232
	233	aa: 1: Enable ADR; 0: Disable ADR (Same as AT+CADR command)
	234
	235	bb: set DR (Same as AT+CDATARATE ,only valid after ADR=0)
	236
	237	Example: 0x A8 00 02 : Set ADR=0 and DR=1
	238
	239
17.3	240	=== (% style="color:#037691" %)Type Code 0xA9(%%) ===
1.2	241
17.7	242	See [[Alarm Base Timeout>>\|\|anchor="H4.6AlarmBaseonTimeout"]] for detail.
1.2	243
	244
	245
17.8	246	== 4.5 Integrate with Datacake ==
1.2	247
21.5	248	(((
1.2	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:
21.5	250	)))
1.2	251
	252
19.2	253	(% style="color:blue" %)Step 1(%%): Be sure that your device is programmed and properly connected to the network at this time.
1.2	254
19.2	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:
1.2	256
	257
19.2	258	[[image:1654674520913-519.png]]
1.2	259
	260
19.2	261	[[image:1654674530910-914.png]]
1.2	262
	263
21.2	264	[[image:1654674543078-401.png]]
1.2	265
	266
21.3	267	(% style="color:blue" %)Step 3(%%): Create an account or log in Datacake.
1.2	268
21.3	269	(% style="color:blue" %)Step 4(%%): Search LWL02 and add DevEUI.
1.2	270
21.2	271	[[image:1654674556510-911.png]]
1.2	272
	273
17.8	274	== 4.6 Alarm Base on Timeout ==
1.2	275
	276	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.
	277
	278
	279	User configure this feature by using:
	280
	281
21.5	282	(% style="color:blue" %)AT Command(%%) to configure:
1.2	283
21.6	284	* AT+TTRIG=1,30 ~-~-> When status change from close to open, and device keep in open
1.2	285
	286	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.
	287
21.6	288	* AT+TTIG=0,0 ~-~-> Default Value, disable timeout Alarm.
1.2	289
21.5	290	(% style="color:blue" %)Downlink Command(%%) to configure:
1.2	291
21.6	292	Command: 0xA9 aa bb cc
1.2	293
	294	A9: Command Type Code
	295
	296	aa: status to be monitor
	297
	298	bb cc: timeout.
	299
	300
	301	If user send 0xA9 01 00 1E: equal to AT+TTRIG=1,30
	302
	303	Or
	304
	305	0xA9 00 00 00: Equal to AT+TTRIG=0,0. Disable timeout Alarm.
	306
	307
	308
17.8	309	== 4.7 LEDs ==
1.2	310
21.7	311	(% border="1" cellspacing="10" style="background-color:#ffffcc; width:463px" %)
	312	\|=(% style="width: 184px;" %)Action\|=(% style="width: 275px;" %)LED behavior
	313	\|(% 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(%%)
	314	\|(% style="width:184px" %)Joined successful\|(% style="width:275px" %)(% style="color:green" %)GRENN LED (%%)on 5s
	315	\|(% style="width:184px" %)Send an uplink message\|(% style="width:275px" %)(% style="color:green" %)GREEN LED(%%) blinks once
	316	\|(% style="width:184px" %)Got a downlink message\|(% style="width:275px" %)(% style="color:blue" %)BLUE LED(%%) blinks once
1.2	317
	318
21.8	319	= 5. Battery & How to replace =
	320
	321	== 5.1 Battery Type and replace ==
	322
22.3	323	(((
1.2	324	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:
22.3	325	)))
1.2	326
22.3	327	1. (((
	328	The LWL02 doesn’t have any screw, use can use nail to open it by the middle.
	329	)))
	330	1. (((
	331	Make sure the direction is correct when install the AAA batteries.
	332	)))
1.2	333
22.3	334	(((
22.2	335	(% style="color:red" %)Important Notice: Make sure use new AAA LR03 battery and the battery doesn’t have broken surface.
22.3	336	)))
1.2	337
22.3	338	(((
	339
	340	)))
1.2	341
22.3	342	(((
1.2	343	Example of AAA LR03 batter:
22.3	344	)))
1.2	345
22.2	346	[[image:1654675278044-307.png]]
1.2	347
	348
	349
	350
	351
22.4	352	== 5.2 Power Consumption Analyze ==
	353
1.2	354	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:
	355
	356	[[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]]
	357
	358
	359
22.4	360	= 6. Use AT Command =
1.2	361
22.4	362	== 6.1 Access AT Command ==
	363
1.2	364	LWL02 supports AT Command set. User can use a USB to TTL adapter to configure LWL02 via use AT command, as below.
	365
23.2	366	[[image:image-20220608160336-1.png]]
1.2	367
	368	USB to TTL <- -> LWL02
	369
	370	RX <- -> TX
	371
	372	TX <- -> RX
	373
	374	GND <- -> GND
	375
	376
	377	In PC, User needs to set serial tool(such as [[putty>>url:https://www.chiark.greenend.org.uk/~~sgtatham/putty/latest.html]], SecureCRT) baud rate to 115200 to access to access serial console of LWL02. Below is the output for reference:
	378
	379	The AT Access password is 123456.
	380
	381	[[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image022.png]]
	382
	383	Each AT Command need to add an ENTER at the end before send.
	384
	385
	386	When entering the first command, the 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 RED LED will be off.
	387
	388
	389	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/]]
	390
	391
	392
1.5	393
	394	= 7. FAQ =
	395
	396	== 7.1 How to upgrade the image? ==
	397
1.7	398	User can upgrade the of LWL02 for bug fix, new features, or change working region. The upgrade instruction is here: [[Firmware Upgrade Instruction>>Firmware Upgrade Instruction for STM32 base products]]
1.2	399
	400
	401
	402
1.5	403	== 7.2 How to change the LoRa Frequency Bands/Region? ==
1.2	404
1.6	405	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.1Howtoupgradetheimage"]]. When download the images, choose the required image file for download.
1.2	406
	407
	408
1.5	409
	410	== 7.3 Can I disable uplink for each event to save battery life? ==
	411
1.2	412	Yes, User can use below method to disable this:
	413
1.6	414	(% style="color:#4f81bd" %)via AT Command:
1.2	415
	416	AT+DISALARM=1, End node will only send packet in TDC time.
	417
1.6	418	AT+DISALARM=0, End node will send packet in TDC time or status change for door sensor.
1.2	419
1.6	420	(% style="color:#4f81bd" %)via LoRaWAN downlink Command:
1.2	421
	422	0xA701 : Equal to AT+DISALARM=1
	423
	424	0xA700 : Equal to AT+DISALARM=0
	425
	426
	427
	428
1.5	429	= 8. Order Info =
1.2	430
1.6	431	Part Number: (% style="color:blue" %)LWL02-XXX(%%)
1.2	432
1.6	433	(% style="color:blue" %)XXX:
1.2	434
1.10	435	* (% style="color:red" %)EU433(%%): frequency bands EU433
	436	* (% style="color:red" %)EU868(%%): frequency bands EU868
	437	* (% style="color:red" %)KR920(%%): frequency bands KR920
1.6	438	* (% style="color:red" %)CN470(%%): frequency bands CN470
1.10	439	* (% style="color:red" %)AS923(%%): frequency bands AS923
1.6	440	* (% style="color:red" %)AU915(%%): frequency bands AU915
1.10	441	* (% style="color:red" %)US915(%%): frequency bands US915
	442	* (% style="color:red" %)IN865(%%): frequency bands IN865
1.6	443	* (% style="color:red" %)CN779(%%): frequency bands CN779
1.2	444
1.4	445	= 9. Packing Info =
	446
	447
1.2	448	Package Includes:
	449
	450	* LWL02 x 1
	451
	452	= 10.Support =
	453
	454	* 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.
	455	* 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]].
	456

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

Applications

Navigation