Wiki source code of LDS02 - LoRaWAN Door Sensor User Manual

Version 43.10 by Xiaoling on 2022/06/08 18:05

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

Wiki source code of LDS02 - LoRaWAN Door Sensor User Manual

Applications

Navigation