Wiki source code of LDS02 - LoRaWAN Door Sensor User Manual

Version 38.3 by Xiaoling on 2022/06/08 17:32

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

Wiki source code of LDS02 - LoRaWAN Door Sensor User Manual

Applications

Navigation