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

Version 36.2 by Xiaoling on 2022/06/25 17:33

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

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

Applications

Navigation