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

Version 48.4 by Xiaoling on 2022/10/13 17:18

version	line-number	content
2.2	1	(% style="text-align:center" %)
48.2	2	[[image:image-20220927133941-2.png]]
1.1	3
	4
	5
36.1	6
	7
	8
	9
	10
33.4	11	Table of Contents:
1.1	12
17.3	13	{{toc/}}
1.1	14
	15
	16
17.3	17
	18
36.2	19
	20
	21
	22
2.2	23	= 1. Introduction =
1.1	24
40.2	25
2.2	26	== 1.1 What is LWL02 LoRaWAN Water Leak Sensor ==
1.1	27
	28
3.2	29	(((
2.2	30	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	31	)))
1.1	32
3.2	33	(((
2.2	34	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	35	)))
1.2	36
3.2	37	(((
2.2	38	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	39	)))
1.2	40
3.2	41	(((
	42	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.
41.2	43
	44
3.2	45	)))
1.2	46
44.2	47	[[image:image-20220927113420-3.png]]
1.2	48
	49
	50
3.3	51	== 1.2 Features ==
1.2	52
40.2	53
1.2	54	* LoRaWAN Class A v1.0.3
	55	* Frequency Bands: CN470/EU433/KR920/US915/EU868/AS923/AU915/IN865/RU864
	56	* SX1262 LoRa Core
	57	* Water Leak detect
	58	* 2 x AAA LR03 Batteries
	59	* AT Commands to change parameters
	60	* Uplink on periodically and open/close action
	61	* Remote configure parameters via LoRa Downlink
	62	* Firmware upgradable via program port
	63
40.2	64
41.2	65
3.4	66	== 1.3 Applications ==
	67
40.2	68
1.2	69	* Smart Buildings & Home Automation
	70	* Logistics and Supply Chain Management
	71	* Smart Metering
	72	* Smart Agriculture
	73	* Smart Cities
	74	* Smart Factory
	75
40.2	76
41.2	77
5.2	78	== 1.4 Dimension ==
1.2	79
40.2	80
5.2	81	[[image:image-20220608143952-2.png]]
1.2	82
41.2	83
5.2	84	[[image:1654670405145-346.png]]
1.2	85
5.2	86
	87
	88	== 1.5 Firmware Change log ==
	89
40.2	90
26.8	91	(((
40.2	92	LWL02 use the same firmware as LDS01: [[https:~~/~~/www.dropbox.com/sh/6ls5i0zsvujvbc8/AABe3V5aQXdy7zSxEdEA3DHOa?dl=0>>https://www.dropbox.com/sh/6ls5i0zsvujvbc8/AABe3V5aQXdy7zSxEdEA3DHOa?dl=0]]
26.8	93	)))
1.2	94
26.8	95	(((
40.2	96
26.8	97	)))
1.2	98
	99
5.2	100	= 2. Power ON LWL02 =
1.2	101
40.2	102
5.3	103	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	104
	105
40.2	106
7.2	107	= 3. How to install LWL02 =
1.2	108
40.2	109
7.4	110	(((
37.5	111	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.
40.2	112
	113
7.4	114	)))
1.2	115
7.2	116	[[image:image-20220608144447-4.png]]
1.2	117
	118
	119
7.2	120	= 4. Operation Mode =
1.2	121
40.2	122
7.2	123	== 4.1 How it works? ==
1.2	124
40.2	125
26.5	126	(((
7.3	127	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.
26.5	128	)))
1.2	129
26.5	130	(((
37.5	131	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.
26.5	132	)))
1.2	133
	134
40.2	135
7.3	136	== 4.2 Example to join LoRaWAN network ==
7.2	137
40.2	138
1.6	139	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	140
44.2	141	[[image:image-20220927113401-2.png]]
1.2	142
	143
9.6	144	(((
1.2	145	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	146	)))
1.2	147
9.6	148	* (((
	149	A keep-alive message which send once per day.
	150	)))
	151	* (((
24.9	152	An emergency event message when detect a water leak. ([[Alarm event can be disabled>>\|\|anchor="H7.3CanIdisableuplinkforeacheventtosavebatterylife3F"]])
9.6	153	)))
	154	* (((
	155	A periodically update at every 10 minutes when in water leak.
	156	)))
	157	* (((
17.5	158	A message when switch from water leak to none water leak. ([[Alarm event can be disabled>>\|\|anchor="H7.3CanIdisableuplinkforeacheventtosavebatterylife3F"]])
9.6	159	)))
1.2	160
9.6	161	(((
29.2	162
	163
1.2	164	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	165	)))
1.2	166
9.6	167	(((
9.5	168	(% style="color:blue" %)Step 1(%%): Create a device in TTN V3 with the OTAA keys from LWL02.
9.6	169	)))
1.2	170
9.6	171	(((
1.2	172	Each LWL02 is shipped with a sticker with unique device EUI:
9.6	173	)))
1.2	174
9.2	175	[[image:1654671040430-368.png]]
1.2	176
	177
	178	User can enter this key in their LoRaWAN Server portal. Below is TTN V3 screen shot:
	179
40.2	180
14.3	181	Add APP EUI in the application
1.2	182
11.2	183	[[image:1654671794691-956.png]]
1.2	184
	185
11.2	186	[[image:1654671809850-574.png]]
1.2	187
12.2	188	[[image:1654671820156-640.png]]
1.2	189
	190
13.2	191	[[image:1654671832011-696.png]]
1.2	192
	193
14.2	194	Add APP KEY and DEV EUI
1.2	195
32.7	196	[[image:1654671889112-678.png]]
1.2	197
32.7	198
40.2	199
24.10	200	(% 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	201
	202
33.2	203	[[image:1654681465260-713.png]]
1.2	204
32.8	205
	206
14.5	207	== 4.3 Uplink Payload ==
	208
26.11	209
1.2	210	Uplink Payload total 9 bytes.
	211
16.2	212	[[image:image-20220608150921-5.png]]
1.2	213
26.10	214
16.2	215	Example:
1.2	216
16.2	217	[[image:1654672186477-234.png]]
1.2	218
	219
16.3	220	(((
48.4	221	Example Payload Decoder in TTN V3: [[https:~~/~~/github.com/dragino/dragino-end-node-decoder>>https://github.com/dragino/dragino-end-node-decoder]]
16.3	222	)))
1.2	223
	224
40.2	225
16.4	226	== 4.4 Downlink Payload ==
1.2	227
26.9	228
16.9	229	(% border="1" cellspacing="10" style="background-color:#ffffcc; color:green; width:410px" %)
16.7	230	\|=(% style="width: 180px;" %)Downlink Control Type\|=(% style="width: 80px;" %)Type Code\|=(% style="width: 150px;" %)Downlink payload size(bytes)
	231	\|(% style="width:180px" %)TDC (Transmit Time Interval—Keep Alive Interval)\|(% style="width:80px" %)0x01\|(% style="width:150px" %)4
	232	\|(% style="width:180px" %)RESET\|(% style="width:80px" %)0x04\|(% style="width:224px" %)2
17.4	233	\|(% style="width:180px" %)[[Set confirmed mode>>\|\|anchor="HTypeCode0x05"]]\|(% style="width:80px" %)0x05\|(% style="width:150px" %)2
	234	\|(% style="width:180px" %)[[Clear Counting>>\|\|anchor="HTypeCode0xA6"]]\|(% style="width:80px" %)0xA6\|(% style="width:150px" %)2
	235	\|(% style="width:180px" %)[[Enable/Disable Alarm>>\|\|anchor="HTypeCode0xA7"]]\|(% style="width:80px" %)0xA7\|(% style="width:150px" %)2
	236	\|(% style="width:180px" %)[[Control ADR/DR>>\|\|anchor="HTypeCode0xA8"]]\|(% style="width:80px" %)0xA8\|(% style="width:150px" %)3
	237	\|(% style="width:180px" %)[[Set Alarm Timeout>>\|\|anchor="HTypeCode0xA9"]]\|(% style="width:80px" %)0xA9\|(% style="width:150px" %)4
1.2	238
48.3	239
1.2	240	Example Downlink payload setting in TTN V3:
	241
17.2	242	[[image:1654673412319-976.png]]
1.2	243
	244
17.3	245	=== (% style="color:#037691" %)Type Code 0x01(%%) ===
1.2	246
37.6	247	If the payload=0100003C, means to control the LWL02's Keep Alive interval to 0x00003C=60(S)
1.2	248
	249
17.3	250	=== (% style="color:#037691" %)Type Code 0x04(%%) ===
1.2	251
	252	If payload = 0x04FF, it will reset the LWL02.
	253
	254
17.3	255	=== (% style="color:#037691" %)Type Code 0x05(%%) ===
1.2	256
	257	0x05 00: Set uplink to LoRaWAN unconfirmed mode
	258
	259	0x05 01: Set uplink to LoRaWAN confirmed mode
	260
	261
17.3	262	=== (% style="color:#037691" %)Type Code 0xA6(%%) ===
1.2	263
	264	Example: 0xA601: Clear Counting
	265	For LWL02: reset both count number and time.
	266
	267
17.3	268	=== (% style="color:#037691" %)Type Code 0xA7(%%) ===
1.2	269
	270	0xA7 01 : Equal to AT+DISALARM=1
	271
	272	0xA7 00 : Equal to AT+DISALARM=0
	273
	274
17.3	275	=== (% style="color:#037691" %)Type Code 0xA8(%%) ===
1.2	276
	277	Format: 0xA8 aa bb
	278
	279	aa: 1: Enable ADR; 0: Disable ADR (Same as AT+CADR command)
	280
	281	bb: set DR (Same as AT+CDATARATE ,only valid after ADR=0)
	282
	283	Example: 0x A8 00 02 : Set ADR=0 and DR=1
	284
	285
17.3	286	=== (% style="color:#037691" %)Type Code 0xA9(%%) ===
1.2	287
17.7	288	See [[Alarm Base Timeout>>\|\|anchor="H4.6AlarmBaseonTimeout"]] for detail.
1.2	289
	290
40.2	291
17.8	292	== 4.5 Integrate with Datacake ==
1.2	293
40.2	294
21.5	295	(((
1.2	296	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	297	)))
1.2	298
	299
19.2	300	(% style="color:blue" %)Step 1(%%): Be sure that your device is programmed and properly connected to the network at this time.
1.2	301
19.2	302	(% 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	303
	304
19.2	305	[[image:1654674520913-519.png]]
1.2	306
	307
19.2	308	[[image:1654674530910-914.png]]
1.2	309
	310
21.2	311	[[image:1654674543078-401.png]]
1.2	312
	313
21.3	314	(% style="color:blue" %)Step 3(%%): Create an account or log in Datacake.
1.2	315
21.3	316	(% style="color:blue" %)Step 4(%%): Search LWL02 and add DevEUI.
1.2	317
21.2	318	[[image:1654674556510-911.png]]
1.2	319
	320
40.2	321
17.8	322	== 4.6 Alarm Base on Timeout ==
1.2	323
40.2	324
23.4	325	(((
39.1	326	LWL02 can monitor the timeout for a status change, this feature can be used to monitor some event such as monitoring water leakage duration etc.
41.1	327
	328	(% style="color:red" %)(This command is only applicable to LDS02.In lwl02, this command can only open the alarm, but the alarm time is fixed to 10 minutes）
23.4	329	)))
1.2	330
23.4	331	(((
1.2	332	User configure this feature by using:
23.4	333	)))
1.2	334
23.4	335	(((
	336
	337	)))
1.2	338
23.4	339	(((
21.5	340	(% style="color:blue" %)AT Command(%%) to configure:
23.4	341	)))
1.2	342
23.4	343	* (((
40.2	344	(% style="color:red" %)AT+TTRIG=1,30 (%%) ~-~-> When status change from close to open, and device keep in open
23.4	345	)))
1.2	346
23.4	347	(((
1.2	348	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.
23.4	349	)))
1.2	350
23.4	351	* (((
40.2	352	(% style="color:red" %)AT+TTRIG=0,0 (%%) ~-~-> Default Value, disable timeout Alarm.
	353
	354
	355
23.4	356	)))
1.2	357
23.4	358	(((
21.5	359	(% style="color:blue" %)Downlink Command(%%) to configure:
23.4	360	)))
1.2	361
23.4	362	(((
21.6	363	Command: 0xA9 aa bb cc
23.4	364	)))
1.2	365
23.4	366	(((
1.2	367	A9: Command Type Code
23.4	368	)))
1.2	369
23.4	370	(((
1.2	371	aa: status to be monitor
23.4	372	)))
1.2	373
23.4	374	(((
1.2	375	bb cc: timeout.
23.4	376	)))
1.2	377
23.4	378	(((
	379
	380	)))
1.2	381
23.4	382	(((
1.2	383	If user send 0xA9 01 00 1E: equal to AT+TTRIG=1,30
23.4	384	)))
1.2	385
23.4	386	(((
1.2	387	Or
23.4	388	)))
1.2	389
23.4	390	(((
1.2	391	0xA9 00 00 00: Equal to AT+TTRIG=0,0. Disable timeout Alarm.
40.2	392
	393
	394
23.4	395	)))
1.2	396
17.8	397	== 4.7 LEDs ==
1.2	398
25.9	399
21.7	400	(% border="1" cellspacing="10" style="background-color:#ffffcc; width:463px" %)
	401	\|=(% style="width: 184px;" %)Action\|=(% style="width: 275px;" %)LED behavior
	402	\|(% 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(%%)
	403	\|(% style="width:184px" %)Joined successful\|(% style="width:275px" %)(% style="color:green" %)GRENN LED (%%)on 5s
	404	\|(% style="width:184px" %)Send an uplink message\|(% style="width:275px" %)(% style="color:green" %)GREEN LED(%%) blinks once
	405	\|(% style="width:184px" %)Got a downlink message\|(% style="width:275px" %)(% style="color:blue" %)BLUE LED(%%) blinks once
1.2	406
40.2	407
41.2	408
21.8	409	= 5. Battery & How to replace =
	410
40.2	411
21.8	412	== 5.1 Battery Type and replace ==
	413
40.2	414
22.3	415	(((
1.2	416	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	417	)))
1.2	418
22.3	419	1. (((
37.6	420	The LWL02 doesn't have any screw, use can use nail to open it by the middle.
22.3	421	)))
	422	1. (((
	423	Make sure the direction is correct when install the AAA batteries.
	424	)))
1.2	425
22.3	426	(((
37.7	427	(% style="color:red" %)Important Notice: Make sure use new AAA LR03 battery and the battery doesn't have broken surface.
22.3	428	)))
1.2	429
22.3	430	(((
	431
	432	)))
1.2	433
22.3	434	(((
1.2	435	Example of AAA LR03 batter:
22.3	436	)))
1.2	437
22.2	438	[[image:1654675278044-307.png]]
1.2	439
	440
40.2	441
22.4	442	== 5.2 Power Consumption Analyze ==
	443
40.2	444
26.6	445	(((
1.2	446	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:
26.6	447	)))
1.2	448
26.6	449	(((
1.2	450	[[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]]
26.6	451	)))
1.2	452
	453
40.2	454
22.4	455	= 6. Use AT Command =
1.2	456
40.2	457
22.4	458	== 6.1 Access AT Command ==
	459
40.2	460
1.2	461	LWL02 supports AT Command set. User can use a USB to TTL adapter to configure LWL02 via use AT command, as below.
	462
40.2	463
23.2	464	[[image:image-20220608160336-1.png]]
1.2	465
	466
23.7	467	(% style="background-color:yellow" %)USB to TTL <- -> LWL02
1.2	468
23.7	469	(% style="background-color:yellow" %)RX <- -> TX
1.2	470
23.7	471	(% style="background-color:yellow" %)TX <- -> RX
	472
	473	(% style="background-color:yellow" %)GND <- -> GND
	474
24.3	475
	476	(((
24.2	477	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:
24.3	478	)))
1.2	479
24.3	480	(((
24.2	481	The AT Access password is (% style="color:red" %)123456.
24.3	482	)))
1.2	483
24.2	484	[[image:1654675618022-630.png]]
1.2	485
40.2	486
26.7	487	(((
24.4	488	Each AT Command need to (% style="color:red" %)add an ENTER(%%) at the end before send.
26.7	489	)))
1.2	490
26.7	491	(((
40.2	492	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.
26.7	493	)))
1.2	494
26.7	495	(((
1.2	496	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/]]
26.7	497	)))
1.2	498
	499
40.2	500
1.5	501	= 7. FAQ =
	502
40.2	503
1.5	504	== 7.1 How to upgrade the image? ==
	505
40.2	506
25.12	507	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]]
1.2	508
	509
40.2	510
1.5	511	== 7.2 How to change the LoRa Frequency Bands/Region? ==
1.2	512
40.2	513
24.7	514	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.
1.2	515
	516
40.2	517
1.5	518	== 7.3 Can I disable uplink for each event to save battery life? ==
	519
40.2	520
1.2	521	Yes, User can use below method to disable this:
	522
	523
40.2	524	(% style="color:blue" %)via AT Command:
1.2	525
40.3	526	(% style="color:red" %)AT+DISALARM=1(%%), End node will only send packet in TDC time.
1.2	527
40.3	528	(% style="color:red" %)AT+DISALARM=0(%%), End node will send packet in TDC time or status change for door sensor.
33.9	529
1.2	530
40.2	531	(% style="color:blue" %)via LoRaWAN downlink Command:
1.2	532
40.3	533	(% style="color:red" %)0xA701 (%%): Equal to AT+DISALARM=1
1.2	534
40.3	535	(% style="color:red" %)0xA700 (%%): Equal to AT+DISALARM=0
1.2	536
40.2	537
	538
1.5	539	= 8. Order Info =
1.2	540
40.2	541
1.6	542	Part Number: (% style="color:blue" %)LWL02-XXX(%%)
1.2	543
1.6	544	(% style="color:blue" %)XXX:
1.2	545
1.10	546	* (% style="color:red" %)EU433(%%): frequency bands EU433
	547	* (% style="color:red" %)EU868(%%): frequency bands EU868
	548	* (% style="color:red" %)KR920(%%): frequency bands KR920
1.6	549	* (% style="color:red" %)CN470(%%): frequency bands CN470
1.10	550	* (% style="color:red" %)AS923(%%): frequency bands AS923
1.6	551	* (% style="color:red" %)AU915(%%): frequency bands AU915
1.10	552	* (% style="color:red" %)US915(%%): frequency bands US915
	553	* (% style="color:red" %)IN865(%%): frequency bands IN865
1.6	554	* (% style="color:red" %)CN779(%%): frequency bands CN779
1.2	555
40.2	556
41.3	557
1.4	558	= 9. Packing Info =
	559
40.2	560
1.2	561	Package Includes:
	562
	563	* LWL02 x 1
	564
40.2	565
41.3	566
31.2	567	= 10. Support =
1.2	568
40.2	569
1.2	570	* 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.
	571	* 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]].
	572
48.2	573

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

Applications

Navigation