Wiki source code of DS03A-LB/LS -- Outdoor LoRaWAN Door Sensor User Manual
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | (% style="display:none" %) (%%) | ||
2 | |||
3 | (% style="text-align:center" %) | ||
4 | [[image:image-20240108161155-2.png]] | ||
5 | |||
6 | |||
7 | |||
8 | |||
9 | |||
10 | |||
11 | |||
12 | |||
13 | |||
14 | **Table of Contents:** | ||
15 | |||
16 | {{toc/}} | ||
17 | |||
18 | |||
19 | |||
20 | |||
21 | |||
22 | |||
23 | = 1. Introduction = | ||
24 | |||
25 | == 1.1 What is LoRaWAN Door Sensor == | ||
26 | |||
27 | |||
28 | ((( | ||
29 | The Dragino DS03A-LB/LS is a (% style="color:blue" %)**LoRaWAN Door Sensor**(%%) for Internet of Things solution. It detects door open/close status and uplinks to IoT server via LoRaWAN network. user can see the door status, open duration, open counts in the IoT Server. | ||
30 | ))) | ||
31 | |||
32 | ((( | ||
33 | The LoRa wireless technology used in DS03A-LB/LS allows device to send data and reach extremely long ranges at low data-rates. It provides ultra-long range spread spectrum communication and high interference immunity whilst minimizing current consumption. | ||
34 | ))) | ||
35 | |||
36 | ((( | ||
37 | The DS03A-LB/LS will send periodically data every 2 hours as well as for each door open/close action. It also counts the door open times and calculates the last door open duration. Users can also disable the uplink for each open/close event, instead, DS03A-LB/LS can count each open event and uplink periodically. | ||
38 | ))) | ||
39 | |||
40 | ((( | ||
41 | DS03A-LB/LS supports (% style="color:blue" %)**Datalog Feature,**(%%) it can save the data when there is no LoRaWAN network and uplink when network recover. | ||
42 | ))) | ||
43 | |||
44 | ((( | ||
45 | DS03A-LB/LS has the (% style="color:blue" %)**Open Alarm Feature**(%%), user can set this feature so the device will send an alarm if the door has been open for a certain time. | ||
46 | |||
47 | DS03A-LB/LS is designed for outdoor use. It has a weatherproof enclosure and industrial level battery to work in low to high temperatures | ||
48 | ))) | ||
49 | |||
50 | ((( | ||
51 | DS03A-LB/LS (% style="color:blue" %)**supports BLE configure**(%%) and (% style="color:blue" %)**wireless OTA update**(%%) which make user easy to use. | ||
52 | ))) | ||
53 | |||
54 | ((( | ||
55 | DS03A-LB/LS is powered by (% style="color:blue" %)**8500mAh Li-SOCI2 battery **(%%)or (% style="color:blue" %)**solar powered + Li-ion battery**(%%), it is designed for long term use up to 5 years. | ||
56 | ))) | ||
57 | |||
58 | ((( | ||
59 | Each DS03A-LB/LS is pre-load with a set of unique keys for LoRaWAN registrations, register these keys to local LoRaWAN server and it will auto connect after power on. | ||
60 | ))) | ||
61 | |||
62 | |||
63 | [[image:image-20230522092934-2.png||height="346" width="774"]] | ||
64 | |||
65 | |||
66 | == 1.2 Features == | ||
67 | |||
68 | |||
69 | * LoRaWAN 1.0.3 Class A | ||
70 | * Ultra-low power consumption | ||
71 | * Bands: CN470/EU433/KR920/US915/EU868/AS923/AU915/IN865 | ||
72 | * Door Open/Close detect | ||
73 | * Door open/close statistics | ||
74 | * Datalog Feature, Open Alarm Feature | ||
75 | * Probe length: 40cm | ||
76 | * Support Bluetooth v5.1 and LoRaWAN remote configure | ||
77 | * Support wireless OTA update firmware | ||
78 | * Uplink on periodically | ||
79 | * Downlink to change configure | ||
80 | * Wall Mountable | ||
81 | * Outdoor Use | ||
82 | * 8500mAh Li/SOCl2 Battery (DS03A-LB) | ||
83 | * Solar panel + 3000mAh Li-ion battery (DS03A-LS) | ||
84 | |||
85 | == 1.3 Specification == | ||
86 | |||
87 | |||
88 | (% style="color:#037691" %)**Common DC Characteristics:** | ||
89 | |||
90 | * Supply Voltage: Built-in Battery , 2.5v ~~ 3.6v | ||
91 | * Operating Temperature: -40 ~~ 85°C | ||
92 | |||
93 | (% style="color:#037691" %)**LoRa Spec:** | ||
94 | |||
95 | * Frequency Range, Band 1 (HF): 862 ~~ 1020 Mhz | ||
96 | * Max +22 dBm constant RF output vs. | ||
97 | * RX sensitivity: down to -139 dBm. | ||
98 | * Excellent blocking immunity | ||
99 | |||
100 | (% style="color:#037691" %)**Battery:** | ||
101 | |||
102 | * Li/SOCI2 un-chargeable battery | ||
103 | * Capacity: 8500mAh | ||
104 | * Self-Discharge: <1% / Year @ 25°C | ||
105 | * Max continuously current: 130mA | ||
106 | * Max boost current: 2A, 1 second | ||
107 | |||
108 | (% style="color:#037691" %)**Power Consumption** | ||
109 | |||
110 | * Sleep Mode: 5uA @ 3.3v | ||
111 | * LoRa Transmit Mode: 125mA @ 20dBm, 82mA @ 14dBm | ||
112 | |||
113 | == 1.4 Applications == | ||
114 | |||
115 | |||
116 | [[image:Main.User Manual for LoRaWAN End Nodes.LDS03A - Outdoor LoRaWAN OpenClose Door Sensor Manual.WebHome@1654741400370-813.png]] | ||
117 | |||
118 | |||
119 | == 1.5 Sleep mode and working mode == | ||
120 | |||
121 | |||
122 | (% style="color:blue" %)**Deep Sleep Mode: **(%%)Sensor doesn't have any LoRaWAN activate. This mode is used for storage and shipping to save battery life. | ||
123 | |||
124 | (% style="color:blue" %)**Working Mode:** (%%)In this mode, Sensor will work as LoRaWAN Sensor to Join LoRaWAN network and send out sensor data to server. Between each sampling/tx/rx periodically, sensor will be in IDLE mode), in IDLE mode, sensor has the same power consumption as Deep Sleep mode. | ||
125 | |||
126 | |||
127 | == 1.6 Button & LEDs == | ||
128 | |||
129 | |||
130 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/RS485-LB_Waterproof_RS485UART_to_LoRaWAN_Converter/WebHome/image-20240103160425-4.png?rev=1.1||alt="image-20240103160425-4.png"]] | ||
131 | |||
132 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
133 | |=(% style="width: 167px;background-color:#4F81BD;color:white" %)**Behavior on ACT**|=(% style="width: 117px;background-color:#4F81BD;color:white" %)**Function**|=(% style="width: 226px;background-color:#4F81BD;color:white" %)**Action** | ||
134 | |(% style="width:167px" %)Pressing ACT between 1s < time < 3s|(% style="width:117px" %)Send an uplink|(% style="width:225px" %)((( | ||
135 | If sensor is already Joined to LoRaWAN network, sensor will send an uplink packet, (% style="color:blue" %)**blue led** (%%)will blink once. | ||
136 | Meanwhile, BLE module will be active and user can connect via BLE to configure device. | ||
137 | ))) | ||
138 | |(% style="width:167px" %)Pressing ACT for more than 3s|(% style="width:117px" %)Active Device|(% style="width:225px" %)((( | ||
139 | (% style="color:green" %)**Green led**(%%) will fast blink 5 times, device will enter (% style="color:#037691" %)**OTA mode**(%%) for 3 seconds. And then start to JOIN LoRaWAN network. | ||
140 | (% style="color:green" %)**Green led**(%%) will solidly turn on for 5 seconds after joined in network. | ||
141 | Once sensor is active, BLE module will be active and user can connect via BLE to configure device, no matter if device join or not join LoRaWAN network. | ||
142 | ))) | ||
143 | |(% style="width:167px" %)Fast press ACT 5 times.|(% style="width:117px" %)Deactivate Device|(% style="width:225px" %)(% style="color:red" %)**Red led**(%%) will solid on for 5 seconds. Means Device is in Deep Sleep Mode. | ||
144 | |||
145 | == 1.7 BLE connection == | ||
146 | |||
147 | |||
148 | DS03A-LB/LS support BLE remote configure. | ||
149 | |||
150 | |||
151 | BLE can be used to configure the parameter of sensor or see the console output from sensor. BLE will be only activate on below case: | ||
152 | |||
153 | * Press button to send an uplink | ||
154 | * Press button to active device. | ||
155 | * Device Power on or reset. | ||
156 | |||
157 | If there is no activity connection on BLE in 60 seconds, sensor will shut down BLE module to enter low power mode. | ||
158 | |||
159 | |||
160 | == 1.8 Pin Definitions == | ||
161 | |||
162 | [[image:image-20230630160843-7.png]] | ||
163 | |||
164 | |||
165 | == 1.9 Mechanical == | ||
166 | |||
167 | === 1.9.1 for LB version === | ||
168 | |||
169 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/DDS75-LB_LoRaWAN_Distance_Detection_Sensor_User_Manual/WebHome/image-20240105152536-3.png?rev=1.1||alt="image-20240105152536-3.png"]] | ||
170 | |||
171 | |||
172 | (% style="color:blue" %)**Probe Mechanical:** | ||
173 | |||
174 | [[image:Main.User Manual for LoRaWAN End Nodes.LDS03A - Outdoor LoRaWAN OpenClose Door Sensor Manual.WebHome@1654741444887-479.png||height="399" width="513"]] | ||
175 | |||
176 | |||
177 | |||
178 | === 1.9.2 for LS version === | ||
179 | |||
180 | |||
181 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/SN50v3-LB/WebHome/image-20231231203439-3.png?width=886&height=385&rev=1.1||alt="image-20231231203439-3.png"]] | ||
182 | |||
183 | |||
184 | |||
185 | |||
186 | == 1.10 Magnet Distance == | ||
187 | |||
188 | |||
189 | * Wood Door: 10mm ~~ 30mm | ||
190 | * Iron Door: 30 ~~ 45mm | ||
191 | |||
192 | = 2. Configure DS03A-LB/LS to connect to LoRaWAN network = | ||
193 | |||
194 | == 2.1 How it works == | ||
195 | |||
196 | |||
197 | The DS03A-LB/LS is configured as (% style="color:#037691" %)**LoRaWAN OTAA Class A**(%%) mode by default. It has OTAA keys to join LoRaWAN network. To connect a local LoRaWAN network, you need to input the OTAA keys in the LoRaWAN IoT server and press the button to activate the DS03A-LB/LS. It will automatically join the network via OTAA and start to send the sensor value. The default uplink interval is 2 hours. | ||
198 | |||
199 | |||
200 | == 2.2 Quick guide to connect to LoRaWAN server (OTAA) == | ||
201 | |||
202 | |||
203 | Following is an example for how to join the [[TTN v3 LoRaWAN Network>>url:https://console.cloud.thethings.network/]]. Below is the network structure; we use the [[LPS8v2>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/228-lps8v2.html]] as a LoRaWAN gateway in this example. (% style="display:none" %) | ||
204 | |||
205 | The LPS8v2 is already set to connected to [[TTN network >>url:https://console.cloud.thethings.network/]], so what we need to now is configure the TTN server. | ||
206 | |||
207 | [[image:image-20230522092858-1.png||height="391" width="874"]] | ||
208 | |||
209 | |||
210 | (% style="color:blue" %)**Step 1:**(%%) Create a device in TTN with the OTAA keys from DS03A-LB/LS. | ||
211 | |||
212 | Each DS03A-LB/LS is shipped with a sticker with the default device EUI as below: | ||
213 | |||
214 | [[image:image-20230426085205-1.png||height="238" width="512"]] | ||
215 | |||
216 | |||
217 | You can enter this key in the LoRaWAN Server portal. Below is TTN screen shot: | ||
218 | |||
219 | (% style="display:none" %) (%%) | ||
220 | |||
221 | (% style="color:blue" %)**Register the device** | ||
222 | |||
223 | |||
224 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/D20-LBD22-LBD23-LB_LoRaWAN_Temperature_Sensor_User_Manual/WebHome/1675144099263-405.png?rev=1.1||alt="1675144099263-405.png"]](% style="display:none" %) | ||
225 | |||
226 | |||
227 | (% style="color:blue" %)**Add APP EUI and DEV EUI** | ||
228 | |||
229 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/D20-LBD22-LBD23-LB_LoRaWAN_Temperature_Sensor_User_Manual/WebHome/1675144117571-832.png?rev=1.1||alt="1675144117571-832.png"]] | ||
230 | |||
231 | |||
232 | (% style="color:blue" %)**Add APP EUI in the application** | ||
233 | |||
234 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/D20-LBD22-LBD23-LB_LoRaWAN_Temperature_Sensor_User_Manual/WebHome/1675144143021-195.png?rev=1.1||alt="1675144143021-195.png"]] | ||
235 | |||
236 | |||
237 | (% style="color:blue" %)**Add APP KEY** | ||
238 | |||
239 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/D20-LBD22-LBD23-LB_LoRaWAN_Temperature_Sensor_User_Manual/WebHome/1675144157838-392.png?rev=1.1||alt="1675144157838-392.png"]] | ||
240 | |||
241 | |||
242 | (% style="color:blue" %)**Step 2:**(%%) Activate on DS03A-LB/LS | ||
243 | |||
244 | |||
245 | Press the button for 5 seconds to activate the DS03A-LB/LS. | ||
246 | |||
247 | (% style="color:green" %)**Green led**(%%) will fast blink 5 times, device will enter (% style="color:blue" %)**OTA mode**(%%) for 3 seconds. And then start to Join LoRaWAN network. (% style="color:green" %)**Green led**(%%) will solidly turn on for 5 seconds after joined in network. | ||
248 | |||
249 | After join success, it will start to upload messages to TTN and you can see the messages in the panel. | ||
250 | |||
251 | |||
252 | == 2.3 Uplink Payload == | ||
253 | |||
254 | === 2.3.1 Device Status, FPORT~=5 === | ||
255 | |||
256 | |||
257 | Include device configure status. Once DS03A-LB/LS Joined the network, it will uplink this message to the server. After that, DS03A-LB/LS will uplink Device Status every 12 hours. | ||
258 | |||
259 | Users can also use the downlink command**(0x26 01)** to ask DS03A-LB/LS to resend this uplink. This uplink payload also includes the DeviceTimeReq to get time. | ||
260 | |||
261 | |||
262 | The Payload format is as below. | ||
263 | |||
264 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
265 | |(% colspan="6" style="background-color:#4f81bd; color:white" %)**Device Status (FPORT=5)** | ||
266 | |(% style="width:103px" %)**Size (bytes)**|(% style="width:72px" %)**1**|**2**|(% style="width:91px" %)**1**|(% style="width:86px" %)**1**|(% style="width:44px" %)**2** | ||
267 | |(% style="width:103px" %)Value|(% style="width:72px" %)Sensor Model|Firmware Version|(% style="width:91px" %)Frequency Band|(% style="width:86px" %)Sub-band|(% style="width:44px" %)BAT | ||
268 | |||
269 | Example parse in TTNv3 | ||
270 | |||
271 | [[image:image-20230630155406-1.png||height="190" width="873"]] | ||
272 | |||
273 | |||
274 | (% style="color:#037691" %)**Sensor Model**(%%): For DS03A-LB/LS, this value is 0x1B | ||
275 | |||
276 | (% style="color:#037691" %)**Firmware Version**(%%): 0x0100, Means: v1.0.0 version | ||
277 | |||
278 | (% style="color:#037691" %)**Frequency Band**: | ||
279 | |||
280 | 0x01: EU868 | ||
281 | |||
282 | 0x02: US915 | ||
283 | |||
284 | 0x03: IN865 | ||
285 | |||
286 | 0x04: AU915 | ||
287 | |||
288 | 0x05: KZ865 | ||
289 | |||
290 | 0x06: RU864 | ||
291 | |||
292 | 0x07: AS923 | ||
293 | |||
294 | 0x08: AS923-1 | ||
295 | |||
296 | 0x09: AS923-2 | ||
297 | |||
298 | 0x0a: AS923-3 | ||
299 | |||
300 | 0x0b: CN470 | ||
301 | |||
302 | 0x0c: EU433 | ||
303 | |||
304 | 0x0d: KR920 | ||
305 | |||
306 | 0x0e: MA869 | ||
307 | |||
308 | |||
309 | (% style="color:#037691" %)**Sub-Band**: | ||
310 | |||
311 | AU915 and US915:value 0x00 ~~ 0x08 | ||
312 | |||
313 | CN470: value 0x0B ~~ 0x0C | ||
314 | |||
315 | Other Bands: Always 0x00 | ||
316 | |||
317 | |||
318 | (% style="color:#037691" %)**Battery Info**: | ||
319 | |||
320 | Check the battery voltage. | ||
321 | |||
322 | Ex1: 0x0B45 = 2885mV | ||
323 | |||
324 | Ex2: 0x0B49 = 2889mV | ||
325 | |||
326 | |||
327 | === 2.3.2 Sensor Configuration, FPORT~=4 === | ||
328 | |||
329 | |||
330 | DS03A-LB/LS will only send this command after getting the downlink command **(0x26 02)** from the server. | ||
331 | |||
332 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:515px" %) | ||
333 | |(% colspan="8" style="background-color:#4f81bd; color:white; width:515px" %)**Sensor Configuration FPORT=4** | ||
334 | |**Size(bytes)**|(% style="width:75px" %)**3**|(% style="width:50px" %)**1**|(% style="width:100px" %)**1**|(% style="width:90px" %)**2**|(% style="width:100px" %)**1**|(% style="width:100px" %)**2**|(% style="width:98px" %)**1** | ||
335 | |Value|(% style="width:75px" %)TDC (unit:sec)|(% style="width:77px" %)Disalarm|(% style="width:96px" %)((( | ||
336 | Keep status1 | ||
337 | )))|(% style="width:99px" %)((( | ||
338 | Keep time1(unit: sec) | ||
339 | )))|(% style="width:87px" %)Keep status2|(% style="width:97px" %)((( | ||
340 | Keep time2(unit: sec) | ||
341 | )))|(% style="width:98px" %)((( | ||
342 | Alarm interval(unit: min) | ||
343 | ))) | ||
344 | |||
345 | Example parse in TTNv3 | ||
346 | |||
347 | [[image:image-20230630155527-3.png||height="146" width="902"]] | ||
348 | |||
349 | |||
350 | * ((( | ||
351 | (% style="color:blue" %)**TDC: (default: 0x001C20)** | ||
352 | ))) | ||
353 | |||
354 | Uplink interval for the Open/Close Event, default value is 0x001C20 which is 7200 seconds = 2 hours. | ||
355 | |||
356 | |||
357 | * ((( | ||
358 | (% style="color:blue" %)**Disalarm: (default: 0)** | ||
359 | ))) | ||
360 | |||
361 | **If Disalarm = 1**, DS03A-LB/LS will only send uplink at every TDC periodically. This is normally use for pulse meter application, in this application, there are many open/close event, and platform only care about the total number of pulse. | ||
362 | |||
363 | **If Disalarm = 0**, DS03A-LB/LS will send uplink at every TDC periodically and send data on each open/close event. This is useful for the application user need to monitor the open/close event in real-time. | ||
364 | |||
365 | |||
366 | (% style="color:red" %)** Note: When Disalarm=0, a high frequently open/close event will cause lots of uplink and drain battery very fast. ** | ||
367 | |||
368 | |||
369 | * ((( | ||
370 | (% style="color:blue" %)**Keep Status1 & Keep Time1 & Keep Status2 & Keep Time2** | ||
371 | ))) | ||
372 | |||
373 | Shows the configure value of [[Alarm Base on Timeout Feature>>||anchor="H3.3.3A0AlarmBaseonTimeout"]] | ||
374 | |||
375 | |||
376 | |||
377 | * ((( | ||
378 | (% style="color:blue" %)**Alarm interval(default: 0)** | ||
379 | ))) | ||
380 | |||
381 | When the state of the door sensor has not been changed after the timeout alarm, the device will send a uplink every alarm interval. It will stop the alarm until the state of the door sensor is changed after the timeout alarm. | ||
382 | |||
383 | |||
384 | === 2.3.3 Real-Time Open/Close Status, Uplink FPORT~=2 === | ||
385 | |||
386 | |||
387 | DS03A-LB/LS will send this uplink **after** Device Status once join the LoRaWAN network successfully. And DS03A-LB/LS will send uplinks when: | ||
388 | |||
389 | * Every 2 hours, this interval [[can be changed>>||anchor="H3.3.1A0SetTransmitIntervalTime"]]. | ||
390 | * There is an Open/Close event. (This info can be disabled by AT+DISALARM=1) | ||
391 | |||
392 | **1) When (% style="color:blue" %)AT+TTRCHANNEL=1(%%), Uplink Payload totals (% style="color:blue" %)11 bytes. (Default mode)(%%)** | ||
393 | |||
394 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:515px" %) | ||
395 | |=(% colspan="5" style="background-color:#4F81BD;color:white;width:515px" %)**Real-Time Open/Close Status, FPORT=2** | ||
396 | |(% style="width:94px" %)**Size(bytes)**|(% style="width:97px" %)**1**|(% style="width:95px" %)**3**|(% style="width:119px" %)**3**|(% style="width:107px" %)**4** | ||
397 | |(% style="width:95px" %)Value|(% style="width:97px" %)((( | ||
398 | Status & [[Alarm>>||anchor="H3.3.4A0TTRIG126TTRIG2timeoutstatusalarm"]] | ||
399 | )))|(% style="width:95px" %)Total open door events|(% style="width:119px" %)((( | ||
400 | The last door open duration (unit: sec) | ||
401 | )))|(% style="width:108px" %)[[Unix TimeStamp>>||anchor="H2.5.2UnixTimeStamp"]] | ||
402 | |||
403 | **Status & Alarm:** | ||
404 | |||
405 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:515px" %) | ||
406 | |(% style="background-color:#4f81bd; color:white; width:50px" %)**Size(bit)**|(% style="background-color:#4f81bd; color:white; width:60px" %)**[bit7:bit4]**|(% style="background-color:#4f81bd; color:white; width:80px" %)**bit3**|(% style="background-color:#4f81bd; color:white; width:100px" %)**bit2**|(% style="background-color:#4f81bd; color:white; width:120px" %)**bit1**|(% style="background-color:#4f81bd; color:white; width:105px" %)**bit0** | ||
407 | |(% style="width:76px" %)Value|(% style="width:96px" %)Reserve|(% style="width:110px" %)((( | ||
408 | Count mod | ||
409 | )))|(% style="width:106px" %)TDC flag 0:No;1:Yes|(% style="width:148px" %)((( | ||
410 | Alarm 0: No Alarm; 1: Alarm | ||
411 | )))|(% style="width:131px" %)((( | ||
412 | Status 0: Close; 1: Open | ||
413 | ))) | ||
414 | |||
415 | [[image:image-20230630155451-2.png||height="246" width="928"]] | ||
416 | |||
417 | |||
418 | * ((( | ||
419 | (% style="color:blue" %)**Count mod:Default=0** | ||
420 | ))) | ||
421 | |||
422 | 0: Uplink total open door times since factory | ||
423 | |||
424 | 1: Uplink total open door times since last FPORT=2 uplink. | ||
425 | |||
426 | |||
427 | * (% style="color:blue" %)**TDC flag** | ||
428 | |||
429 | When the flag is 1, it means sending packets at normal time intervals. | ||
430 | |||
431 | Otherwise, it is a packet sent at non-TDC time. | ||
432 | |||
433 | |||
434 | * ((( | ||
435 | (% style="color:#0000ff" %)**Alarm** | ||
436 | ))) | ||
437 | |||
438 | See [[Alarm Base on Timeout>>||anchor="H3.3.3A0AlarmBaseonTimeout"]] | ||
439 | |||
440 | |||
441 | * ((( | ||
442 | (% style="color:blue" %)**Status** | ||
443 | ))) | ||
444 | |||
445 | This bit is 1 when the door sensor is open and 0 when it is close. | ||
446 | |||
447 | |||
448 | * ((( | ||
449 | (% style="color:blue" %)**Total open door events** | ||
450 | ))) | ||
451 | |||
452 | Total pulse/counting base on open door. | ||
453 | |||
454 | Range (3 Bytes) : 0x000000 ~~ 0xFFFFFF . Max: 16777215 | ||
455 | |||
456 | |||
457 | * ((( | ||
458 | (% style="color:blue" %)**The last door open duration** | ||
459 | ))) | ||
460 | |||
461 | Door sensor last open duration. | ||
462 | |||
463 | Unit: sec. | ||
464 | |||
465 | [[image:image-20230701094042-1.png||height="154" width="763"]] | ||
466 | |||
467 | |||
468 | **2) When (% style="color:blue" %)AT+TTRCHANNEL=2(%%), Uplink Payload totals (% style="color:blue" %)18 bytes(%%)**(% style="color:blue" %). | ||
469 | |||
470 | (When the maximum DR of some frequencies is 11 bytes, it will cause the server to receive empty packets) | ||
471 | |||
472 | (% style="color:red" %)**Note:When using the AT+TTRCHANNEL=2 command, the Datalog function cannot be used.** | ||
473 | |||
474 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:515px" %) | ||
475 | |=(% colspan="8" style="background-color:#4F81BD;color:white; width: 515px;" %)**Real-Time Open/Close Status, FPORT=2** | ||
476 | |(% style="width:50px" %)**Size(bytes)**|(% style="width:97px" %)**1**|(% style="width:95px" %)**3**|(% style="width:125px" %)**3**|(% style="width:100px" %)**4**|(% style="width:86px" %)**1**|(% style="width:96px" %)**3**|(% style="width:126px" %)**3** | ||
477 | |(% style="width:95px" %)Value|(% style="width:97px" %)((( | ||
478 | Status1 & Alarm1 | ||
479 | )))|(% style="width:95px" %)Total open door events1|(% style="width:125px" %)((( | ||
480 | The last door open duration1 (unit: sec) | ||
481 | )))|(% style="width:100px" %)[[Unix TimeStamp>>||anchor="H2.5.2UnixTimeStamp"]]|(% style="width:86px" %)((( | ||
482 | Status2 & Alarm2 | ||
483 | )))|(% style="width:96px" %)Total open door events2|(% style="width:126px" %)The last door open duration2 (unit: sec) | ||
484 | |||
485 | **Status1 & Alarm1:** | ||
486 | |||
487 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:514px" %) | ||
488 | |(% style="background-color:#4f81bd; color:white; width:50px" %)**Size(bit)**|(% style="background-color:#4f81bd; color:white; width:60px" %)**[bit7:bit4]**|(% style="background-color:#4f81bd; color:white; width:70px" %)**bit3**|(% style="background-color:#4f81bd; color:white; width:100px" %)**bit2**|(% style="background-color:#4f81bd; color:white; width:117px" %)**bit1**|(% style="background-color:#4f81bd; color:white; width:117px" %)**bit0** | ||
489 | |(% style="width:76px" %)Value|(% style="width:96px" %)Reserve|(% style="width:99px" %)((( | ||
490 | Count mod | ||
491 | )))|(% style="width:103px" %)TDC flag 0:No;1:Yes|(% style="width:216px" %)((( | ||
492 | Alarm1 0: No Alarm; 1: Alarm (PA8 of pin) | ||
493 | )))|(% style="width:181px" %)((( | ||
494 | Status1 0: Close; 1: Open (PA8 of pin) | ||
495 | ))) | ||
496 | |||
497 | **Status2 & Alarm2:** | ||
498 | |||
499 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
500 | |(% style="background-color:#4f81bd; color:white; width:50px" %)**Size(bit)**|(% style="background-color:#4f81bd; color:white; width:60px" %)**[bit7:bit2]**|(% style="background-color:#4f81bd; color:white; width:200px" %)**bit1**|(% style="background-color:#4f81bd; color:white; width:200px" %)**bit0** | ||
501 | |(% style="width:76px" %)Value|(% style="width:113px" %)Reserve|(% style="width:219px" %)((( | ||
502 | Alarm2 0: No Alarm; 1: Alarm (PA4 of pin) | ||
503 | )))|(% style="width:181px" %)((( | ||
504 | Status2 0: Close; 1: Open (PA4 of pin) | ||
505 | ))) | ||
506 | |||
507 | [[image:image-20230630155908-6.png||height="295" width="927"]] | ||
508 | |||
509 | |||
510 | * ((( | ||
511 | (% style="color:blue" %)**Count mod:Default=0** | ||
512 | ))) | ||
513 | |||
514 | 0: Uplink total open door times since factory | ||
515 | |||
516 | 1: Uplink total open door times since last FPORT=2 uplink. | ||
517 | |||
518 | |||
519 | * (% style="color:blue" %)**TDC flag** | ||
520 | |||
521 | When the flag is 1, it means sending packets at normal time intervals. | ||
522 | |||
523 | Otherwise, it is a packet sent at non-TDC time. | ||
524 | |||
525 | |||
526 | * ((( | ||
527 | (% style="color:#0000ff" %)**Alarm1 or Alarm2** | ||
528 | ))) | ||
529 | |||
530 | See [[Alarm Base on Timeout>>||anchor="H3.3.3A0AlarmBaseonTimeout"]] | ||
531 | |||
532 | |||
533 | * ((( | ||
534 | (% style="color:blue" %)**Status1 **(% style="color:#0000ff" %)**or **(% style="color:blue" %)**Status2** | ||
535 | ))) | ||
536 | |||
537 | This bit is 1 when the door sensor is open and 0 when it is close. | ||
538 | |||
539 | |||
540 | * ((( | ||
541 | (% style="color:blue" %)**Total open door events1 **(% style="color:#0000ff" %)**or**(% style="color:blue" %)** Total open door events2** | ||
542 | ))) | ||
543 | |||
544 | Total pulse/counting base on open door. | ||
545 | |||
546 | Range (3 Bytes) : 0x000000 ~~ 0xFFFFFF . Max: 16777215 | ||
547 | |||
548 | |||
549 | * ((( | ||
550 | (% style="color:blue" %)**The last door open duration1 **(% style="color:#0000ff" %)**or**(% style="color:blue" %)** The last door open duration2** | ||
551 | ))) | ||
552 | |||
553 | Door sensor last open duration. | ||
554 | |||
555 | Unit: sec. | ||
556 | |||
557 | [[image:image-20230701094042-1.png||height="154" width="763"]] | ||
558 | |||
559 | |||
560 | === 2.3.4 Historical Door Open/Close Event, FPORT~=3 === | ||
561 | |||
562 | |||
563 | DS03A-LB/LS stores sensor values and users can retrieve these history values via the [[downlink command>>||anchor="H2.5DatalogFeature"]]. | ||
564 | |||
565 | The historical payload includes one or multiplies entries and every entry has the same payload as Real-Time open/close status. | ||
566 | |||
567 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
568 | |=(% colspan="5" style="background-color:#4F81BD;color:white;width:515px" %)**Real-Time Open/Close Status, FPORT=3** | ||
569 | |(% style="width:60px" %)**Size(bytes)**|(% style="width:80px" %)**1**|(% style="width:120px" %)**3**|(% style="width:150px" %)**3**|(% style="width:90px" %)**4** | ||
570 | |(% style="width:95px" %)Value|(% style="width:97px" %)((( | ||
571 | Status & [[Alarm>>||anchor="H3.3.3A0AlarmBaseonTimeout"]] | ||
572 | )))|(% style="width:95px" %)Total open door events|(% style="width:119px" %)((( | ||
573 | The last door open duration (unit: sec) | ||
574 | )))|(% style="width:108px" %)[[Unix TimeStamp>>||anchor="H2.5.2UnixTimeStamp"]] | ||
575 | |||
576 | **Status & Alarm:** | ||
577 | |||
578 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:515px" %) | ||
579 | |(% style="background-color:#4f81bd; color:white; width:50px" %)**Size(bit)**|(% style="background-color:#4f81bd; color:white; width:75px" %)**bit7**|(% style="background-color:#4f81bd; color:white; width:65px" %)**bit6**|(% style="background-color:#4f81bd; color:white; width:50px" %)**[bit5:bit4]**|(% style="background-color:#4f81bd; color:white; width:50px" %)**bit3**|(% style="background-color:#4f81bd; color:white; width:70px" %)**bit2**|(% style="background-color:#4f81bd; color:white; width:80px" %)**bit1**|(% style="background-color:#4f81bd; color:white; width:75px" %)**bit0** | ||
580 | |(% style="width:76px" %)Value|(% style="width:88px" %)No ACK message|(% style="width:92px" %)Poll Message Flag|(% style="width:89px" %)Reserve|(% style="width:90px" %)((( | ||
581 | Count mod | ||
582 | )))|(% style="width:95px" %)((( | ||
583 | TDC flag 0:No; 1:Yes | ||
584 | )))|(% style="width:116px" %)((( | ||
585 | Alarm 0: No Alarm; 1: Alarm | ||
586 | )))|(% style="width:112px" %)((( | ||
587 | Status 0:Close; 1: Open | ||
588 | ))) | ||
589 | |||
590 | * ((( | ||
591 | Each data entry is 11 bytes and has the same structure as [[Real-Time open/close status>>||anchor="H2.3.3A0Real-TimeOpen2FCloseStatus2CUplinkFPORT3D2"]], to save airtime and battery, DS03A-LB/LS will send max bytes according to the current DR and Frequency bands. | ||
592 | ))) | ||
593 | |||
594 | For example, in the US915 band, the max payload for different DR is: | ||
595 | |||
596 | ((( | ||
597 | **~1. DR0**: max is 11 bytes so one entry of data | ||
598 | ))) | ||
599 | |||
600 | ((( | ||
601 | **2. DR1**: max is 53 bytes so devices will upload 4 entries of data (total 44 bytes) | ||
602 | ))) | ||
603 | |||
604 | ((( | ||
605 | **3. DR2**: total payload includes 11 entries of data | ||
606 | ))) | ||
607 | |||
608 | ((( | ||
609 | **4. DR3**: total payload includes 22 entries of data. | ||
610 | ))) | ||
611 | |||
612 | If DS03A-LB doesn't have any data in the polling time. It will uplink 11 bytes of 0 | ||
613 | |||
614 | [[image:image-20230630155556-4.png||height="146" width="938"]] | ||
615 | |||
616 | **Downlink:** | ||
617 | |||
618 | 0x31 64 9E 7D 34 64 9E 7E 9C 05 | ||
619 | |||
620 | |||
621 | **Uplink:** | ||
622 | |||
623 | 45 00 00 00 00 00 00 64 9E 7D 48 40 00 00 00 00 00 63 64 9E 7D 9C 41 00 00 01 00 00 63 64 9E 7D A4 40 00 00 01 00 00 8D 64 9E 7E 31 43 00 00 02 00 00 8D 64 9E 7E 44 48 00 00 02 00 00 1F 64 9E 7E 59 4B 00 00 03 00 00 1F 64 9E 7E 6B | ||
624 | |||
625 | |||
626 | **Parsed Value:** | ||
627 | |||
628 | [COUNTMOD, TDC_FLAG, ALARM, DOOR_STATUS, OPEN_DOOR_TIMES, LAST_DOOR_OPEN_DURATION, TIME] | ||
629 | |||
630 | |||
631 | [SUM,YES,FALSE,OPEN,0,0,2023-06-30 06:59:20], | ||
632 | |||
633 | [SUM,NO,FALSE,CLOSE,0,99,2023-06-30 07:00:44], | ||
634 | |||
635 | [SUM,NO,FALSE,OPEN, 1,99,2023-06-30 07:00:52], | ||
636 | |||
637 | [SUM,NO,FALSE,CLOSE,1,141,2023-06-30 07:03:13], | ||
638 | |||
639 | [SUM,NO,TRUE,OPEN, 2,141,2023-06-30 07:03:32], | ||
640 | |||
641 | [PART,NO,FALSE,CLOSE,2,31,2023-06-30 07:03:53], | ||
642 | |||
643 | [PART,NO,TRUE,OPEN, 3,31,2023-06-30 07:04:11], | ||
644 | |||
645 | [[image:image-20230630172740-1.png||height="199" width="868"]] | ||
646 | |||
647 | |||
648 | == 2.4 Payload Decoder file == | ||
649 | |||
650 | |||
651 | ((( | ||
652 | In TTN, use can add a custom payload so it shows friendly. | ||
653 | ))) | ||
654 | |||
655 | ((( | ||
656 | In the page **Applications ~-~-> Payload Formats ~-~-> Custom ~-~-> decoder** to add the decoder from: [[https:~~/~~/github.com/dragino/dragino-end-node-decoder>>https://github.com/dragino/dragino-end-node-decoder]] | ||
657 | ))) | ||
658 | |||
659 | |||
660 | == 2.5 Datalog Feature == | ||
661 | |||
662 | |||
663 | (% style="color:blue" %)**Datalog Feature** (%%)is to ensure IoT Server can get all sampling data from Sensor even if the LoRaWAN network is down. For each sampling, DS03A-LB/LS will store the reading for future retrieving purposes. | ||
664 | |||
665 | (% style="color:red" %)**Note:After the device is reset,in cumulative counting mode,the last stored count value will be read as the initial value.** | ||
666 | |||
667 | |||
668 | === 2.5.1 Ways to get datalog via LoRaWAN === | ||
669 | |||
670 | |||
671 | Set PNACKMD=1, DS03A-LB/LS will wait for ACK for every uplink, when there is no LoRaWAN network, DS03A-LB/LS will mark these records with non-ack messages and store the sensor data, and it will send all messages (10s interval) after the network recovery. | ||
672 | |||
673 | * a) DS03A-LB/LS will do an ACK check for data records sending to make sure every data arrive server. | ||
674 | * b) DS03A-LB/LS will send data in **CONFIRMED Mode** when PNACKMD=1, but DS03A-LB/LS won't re-transmit the packet if it doesn't get ACK, it will just mark it as a NONE-ACK message. In a future uplink if DS03A-LB/LS gets a ACK, DS03A-LB/LS will consider there is a network connection and resend all NONE-ACK Message. | ||
675 | |||
676 | === 2.5.2 Unix TimeStamp === | ||
677 | |||
678 | |||
679 | DS03A-LB/LS uses Unix TimeStamp format based on | ||
680 | |||
681 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LHT65N%20LoRaWAN%20Temperature%20%26%20Humidity%20Sensor%20Manual/WebHome/image-20220523001219-11.png?width=627&height=97&rev=1.1||alt="image-20220523001219-11.png" height="97" width="627"]] | ||
682 | |||
683 | User can get this time from link: [[https:~~/~~/www.epochconverter.com/>>url:https://www.epochconverter.com/]] : | ||
684 | |||
685 | Below is the converter example | ||
686 | |||
687 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LHT65N%20LoRaWAN%20Temperature%20%26%20Humidity%20Sensor%20Manual/WebHome/image-20220523001219-12.png?width=720&height=298&rev=1.1||alt="image-20220523001219-12.png" height="298" width="720"]] | ||
688 | |||
689 | So, we can use AT+TIMESTAMP=1611889405 or downlink 3060137afd00 to set the current time 2021 – Jan ~-~- 29 Friday 03:03:25 | ||
690 | |||
691 | |||
692 | === 2.5.3 Set Device Time === | ||
693 | |||
694 | |||
695 | User need to set (% style="color:blue" %)**SYNCMOD=1**(%%) to enable sync time via MAC command. | ||
696 | |||
697 | Once DS03A-LB/LS Joined LoRaWAN network, it will send the MAC command (DeviceTimeReq) and the server will reply with (DeviceTimeAns) to send the current time to DS03A-LB/LS. If DS03A-LB/LS fails to get the time from the server, DS03A-LB/LS will use the internal time and wait for next time request (AT+SYNCTDC to set the time request period, default is 10 days). | ||
698 | |||
699 | (% style="color:red" %)**Note: LoRaWAN Server need to support LoRaWAN v1.0.3(MAC v1.0.3) or higher to support this MAC command feature, Chirpstack,TTN v3 and loriot support but TTN v2 doesn't support. If server doesn't support this command, it will through away uplink packet with this command, so user will lose the packet with time request for TTN v2 if SYNCMOD=1.** | ||
700 | |||
701 | |||
702 | == 2.6 Show Data in DataCake IoT Server == | ||
703 | |||
704 | |||
705 | Datacake IoT platform provides a human-friendly interface to show the sensor data, once we have sensor data in TTN V3, we can use Datacake to connect to TTN V3 and see the data in Datacake. Below are the steps: | ||
706 | |||
707 | |||
708 | (% style="color:blue" %)**Step 1:**(%%)** Link TTNv3 to Datacake.**[[https:~~/~~/docs.datacake.de/lorawan/lns/thethingsindustries#create-integration-on-tti>>url:https://docs.datacake.de/lorawan/lns/thethingsindustries#create-integration-on-tti]] | ||
709 | |||
710 | (% style="color:blue" %)**Step 2:**(%%)** Configure DS03A-LB/LS in Datacake.** | ||
711 | |||
712 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDS03A%20-%20Outdoor%20LoRaWAN%20OpenClose%20Door%20Sensor%20Manual/WebHome/1654746350207-427.png?rev=1.1||alt="1654746350207-427.png"]] | ||
713 | |||
714 | |||
715 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDS03A%20-%20Outdoor%20LoRaWAN%20OpenClose%20Door%20Sensor%20Manual/WebHome/1654747162439-840.png?rev=1.1||alt="1654747162439-840.png"]] | ||
716 | |||
717 | |||
718 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDS03A%20-%20Outdoor%20LoRaWAN%20OpenClose%20Door%20Sensor%20Manual/WebHome/1654746405400-203.png?rev=1.1||alt="1654746405400-203.png"]] | ||
719 | |||
720 | |||
721 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDS03A%20-%20Outdoor%20LoRaWAN%20OpenClose%20Door%20Sensor%20Manual/WebHome/1654746763908-732.png?rev=1.1||alt="1654746763908-732.png"]] | ||
722 | |||
723 | |||
724 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDS03A%20-%20Outdoor%20LoRaWAN%20OpenClose%20Door%20Sensor%20Manual/WebHome/1654746716087-684.png?rev=1.1||alt="1654746716087-684.png"]] | ||
725 | |||
726 | |||
727 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDS03A%20-%20Outdoor%20LoRaWAN%20OpenClose%20Door%20Sensor%20Manual/WebHome/1654746693868-718.png?rev=1.1||alt="1654746693868-718.png"]] | ||
728 | |||
729 | |||
730 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDS03A%20-%20Outdoor%20LoRaWAN%20OpenClose%20Door%20Sensor%20Manual/WebHome/1654746674738-826.png?rev=1.1||alt="1654746674738-826.png"]] | ||
731 | |||
732 | |||
733 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDS03A%20-%20Outdoor%20LoRaWAN%20OpenClose%20Door%20Sensor%20Manual/WebHome/1654746646379-591.png?rev=1.1||alt="1654746646379-591.png"]] | ||
734 | |||
735 | |||
736 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDS03A%20-%20Outdoor%20LoRaWAN%20OpenClose%20Door%20Sensor%20Manual/WebHome/1654746549277-209.png?rev=1.1||alt="1654746549277-209.png"]] | ||
737 | |||
738 | |||
739 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDS03A%20-%20Outdoor%20LoRaWAN%20OpenClose%20Door%20Sensor%20Manual/WebHome/1654746593411-887.png?rev=1.1||alt="1654746593411-887.png"]] | ||
740 | |||
741 | |||
742 | == 2.7 Frequency Plans == | ||
743 | |||
744 | |||
745 | The DS03A-LB/LS uses OTAA mode and below frequency plans by default. Each frequency band use different firmware, user update the firmware to the corresponding band for their country. | ||
746 | |||
747 | [[http:~~/~~/wiki.dragino.com/xwiki/bin/view/Main/End%20Device%20Frequency%20Band/>>http://wiki.dragino.com/xwiki/bin/view/Main/End%20Device%20Frequency%20Band/]] | ||
748 | |||
749 | |||
750 | == 2.8 Firmware Change Log == | ||
751 | |||
752 | |||
753 | **Firmware download link: **[[https:~~/~~/www.dropbox.com/sh/b0uwyzjs4px4eao/AADvI7fPRwsFKTglEmaRRuaaa?dl=0>>https://www.dropbox.com/sh/b0uwyzjs4px4eao/AADvI7fPRwsFKTglEmaRRuaaa?dl=0]] | ||
754 | |||
755 | |||
756 | = 3. Configure DS03A-LB/LS = | ||
757 | |||
758 | == 3.1 Configure Methods: == | ||
759 | |||
760 | |||
761 | DS03A-LB/LS supports below configure method: | ||
762 | |||
763 | * AT Command via Bluetooth Connection (**Recommended**): [[BLE Configure Instruction>>http://wiki.dragino.com/xwiki/bin/view/Main/BLE%20Bluetooth%20Remote%20Configure/]]. | ||
764 | * AT Command via UART Connection : See [[Connection>>http://wiki.dragino.com/xwiki/bin/view/Main/UART%20Access%20for%20LoRa%20ST%20v4%20base%20model/#H2.3UARTConnectionforSN50v3basemotherboard]]. | ||
765 | * LoRaWAN Downlink. Instruction for different platforms: See [[IoT LoRaWAN Server>>http://wiki.dragino.com/xwiki/bin/view/Main/]] section. | ||
766 | |||
767 | == 3.2 General Commands == | ||
768 | |||
769 | |||
770 | These commands are to configure: | ||
771 | |||
772 | * General system settings like: uplink interval. | ||
773 | * LoRaWAN protocol & radio related command. | ||
774 | |||
775 | They are same for all Dragino Devices which support DLWS-005 LoRaWAN Stack. These commands can be found on the wiki: | ||
776 | |||
777 | [[http:~~/~~/wiki.dragino.com/xwiki/bin/view/Main/End%20Device%20AT%20Commands%20and%20Downlink%20Command/>>http://wiki.dragino.com/xwiki/bin/view/Main/End%20Device%20AT%20Commands%20and%20Downlink%20Command/]] | ||
778 | |||
779 | |||
780 | == 3.3 Commands special design for DS03A-LB/LS == | ||
781 | |||
782 | |||
783 | These commands only valid for DS03A-LB/LS, as below: | ||
784 | |||
785 | |||
786 | === 3.3.1 Set Transmit Interval Time === | ||
787 | |||
788 | |||
789 | Feature: Change LoRaWAN End Node Transmit Interval. | ||
790 | |||
791 | (% style="color:blue" %)**AT Command: AT+TDC** | ||
792 | |||
793 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
794 | |=(% style="width: 156px;background-color:#4F81BD;color:white" %)**Command Example**|=(% style="width: 137px;background-color:#4F81BD;color:white" %)**Function**|=(% style="background-color:#4F81BD;color:white" %)**Response** | ||
795 | |(% style="width:156px" %)AT+TDC=?|(% style="width:137px" %)Show current transmit Interval|((( | ||
796 | 30000 | ||
797 | OK | ||
798 | the interval is 30000ms = 30s | ||
799 | ))) | ||
800 | |(% style="width:156px" %)AT+TDC=60000|(% style="width:137px" %)Set Transmit Interval|((( | ||
801 | OK | ||
802 | Set transmit interval to 60000ms = 60 seconds | ||
803 | ))) | ||
804 | |||
805 | (% style="color:blue" %)**Downlink Command: 0x01** | ||
806 | |||
807 | Format: Command Code (0x01) followed by 3 bytes time value. | ||
808 | |||
809 | If the downlink payload=0100003C, it means set the END Node's Transmit Interval to 0x00003C=60(S), while type code is 01. | ||
810 | |||
811 | * Example 1: Downlink Payload: 0100001E ~/~/ Set Transmit Interval (TDC) = 30 seconds | ||
812 | * Example 2: Downlink Payload: 0100003C ~/~/ Set Transmit Interval (TDC) = 60 seconds | ||
813 | |||
814 | === 3.3.2 Set Power Output Duration === | ||
815 | |||
816 | |||
817 | Control the output duration 5V . Before each sampling, device will | ||
818 | |||
819 | ~1. first enable the power output to external sensor, | ||
820 | |||
821 | 2. keep it on as per duration, read sensor value and construct uplink payload | ||
822 | |||
823 | 3. final, close the power output. | ||
824 | |||
825 | (% style="color:blue" %)**AT Command: AT+5VT** | ||
826 | |||
827 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
828 | |=(% style="width: 156px;background-color:#4F81BD;color:white" %)**Command Example**|=(% style="width: 204px; background-color:#4F81BD;color:white" %)**Function**|=(% style="background-color: #4F81BD;color:white; width: 149px;" %)**Response** | ||
829 | |(% style="width:156px" %)AT+5VT=?|(% style="width:204px" %)Show 5V open time.|(% style="width:149px" %)0 (default) | ||
830 | OK | ||
831 | |(% style="width:156px" %)AT+5VT=500|(% style="width:204px" %)Close after a delay of 500 milliseconds.|(% style="width:149px" %)((( | ||
832 | OK | ||
833 | |||
834 | ))) | ||
835 | |||
836 | (% style="color:blue" %)**Downlink Command: 0x07**(%%) | ||
837 | Format: Command Code (0x07) followed by 2 bytes. | ||
838 | |||
839 | The first and second bytes are the time to turn on. | ||
840 | |||
841 | * Example 1: Downlink Payload: 070000 **~-~-->** AT+5VT=0 | ||
842 | * Example 2: Downlink Payload: 0701F4 **~-~-->** AT+5VT=500 | ||
843 | |||
844 | === 3.3.3 Enable / Disable Alarm === | ||
845 | |||
846 | |||
847 | Feature: Enable/Disable Alarm for open/close event. Default value 0. | ||
848 | |||
849 | (% style="color:blue" %)**AT Command: ** | ||
850 | |||
851 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:515px" %) | ||
852 | |(% style="background-color:#4f81bd; color:white; width:153px" %)**Command Example**|(% style="background-color:#4f81bd; color:white; width:276px" %)**Function**|(% style="background-color:#4f81bd; color:white; width:86px" %)**Response** | ||
853 | |(% style="width:154px" %)AT+DISALARM=1|(% style="width:278px" %)End node will only send packets in TDC time.|OK | ||
854 | |(% style="width:154px" %)AT+DISALARM=0|(% style="width:278px" %)End node will send packets in TDC time or status change for door sensor|OK | ||
855 | |||
856 | (% style="color:blue" %)**Downlink Command: ** | ||
857 | |||
858 | 0xA7 01 ~/~/ Same As AT+DISALARM=1 | ||
859 | |||
860 | 0xA7 00 ~/~/ Same As AT+DISALARM=0 | ||
861 | |||
862 | |||
863 | === 3.3.4 Alarm Base on Timeout === | ||
864 | |||
865 | |||
866 | DS03A-LB/LS can monitor the timeout for a status change, this feature can be used to monitor some events such as door opening too long etc. Related Parameters are: | ||
867 | |||
868 | * ((( | ||
869 | (% style="color:blue" %)**Keep Status: Status to be monitor** | ||
870 | ))) | ||
871 | |||
872 | (% style="color:#037691" %)**Keep Status = 1**(%%): Monitor Close to Open event | ||
873 | |||
874 | (% style="color:#037691" %)**Keep Status = 0**(%%): Monitor Open to Close event | ||
875 | |||
876 | |||
877 | * ((( | ||
878 | (% style="color:blue" %)**Keep Time: Timeout to send an Alarm** | ||
879 | ))) | ||
880 | |||
881 | Range 0 ~~ 65535(0xFFFF) seconds. | ||
882 | |||
883 | If (% style="color:#037691" %)**keep time = 0**(%%), Disable Alarm Base on Timeout feature. | ||
884 | |||
885 | If (% style="color:#037691" %)**keep time > 0**(%%), device will monitor the keep status event and send an alarm when status doesn't change after timeout. | ||
886 | |||
887 | |||
888 | * ((( | ||
889 | (% style="color:blue" %)**Downlink Command** | ||
890 | ))) | ||
891 | |||
892 | (% style="color:#037691" %)**Command: 0xA9 aa bb cc dd** | ||
893 | |||
894 | **A9:** Command Type Code | ||
895 | |||
896 | **aa: **01:TTRIG1; 02:TTRIG2 | ||
897 | |||
898 | **bb:** status to be monitored | ||
899 | |||
900 | **cc dd:** timeout. | ||
901 | |||
902 | |||
903 | **1) AT+TTRIG1 : (PA8 of pin)** | ||
904 | |||
905 | (% style="color:blue" %)**AT Command to configure:** | ||
906 | |||
907 | * ((( | ||
908 | (% style="color:#037691" %)**AT+TTRIG1=1,30** (%%) **~-~->** When the **Keep Status** change from close to open, and device remains in open status for more than 30 seconds. DS03A-LB/LS will send an uplink packet, the Alarm1 bit(the second bit of 1^^st^^ byte of payload) on this uplink packet is set to 1. | ||
909 | |||
910 | (% style="color:#037691" %)**AT+TTRIG1=0,30** (%%) **~-~->** When the **Keep Status** change from open to close, and device remains in open status for more than 30 seconds. DS03A-LB/LS will send an uplink packet, the Alarm1 bit (the second bit of 1^^st^^ byte of payload) on this uplink packet is set to 1. | ||
911 | ))) | ||
912 | |||
913 | * ((( | ||
914 | (% style="color:#037691" %)**AT+TTRIG1=0,0** (%%) **~-~-> ** Default Value, disable timeout Alarm. | ||
915 | |||
916 | |||
917 | |||
918 | ))) | ||
919 | |||
920 | (% style="color:blue" %)**Downlink Command to configure:** | ||
921 | |||
922 | If user send 0xA9 01 01 00 1E: equal to AT+TTRIG1=1,30 **or** 0xA9 01 00 00 00: Equal to AT+TTRIG1=0,0. | ||
923 | |||
924 | |||
925 | **2) AT+TTRIG2 : (PA4 of pin,need to use AT+TTRCHANNEL=2)** | ||
926 | |||
927 | (% style="color:blue" %)**AT Command to configure:** | ||
928 | |||
929 | * ((( | ||
930 | (% style="color:#037691" %)**AT+TTRIG2=1,30** (%%) **~-~->** When the **Keep Status** change from close to open, and device remains in open status for more than 30 seconds. DS03A-LB/LS will send an uplink packet, the Alarm2 bit (the second bit of 12^^st^^ byte of payload) on this uplink packet is set to 1. | ||
931 | |||
932 | (% style="color:#037691" %)**AT+TTRIG2=0,30** (%%) **~-~->** When the **Keep Status** change from open to close, and device remains in open status for more than 30 seconds. DS03A-LB/LS will send an uplink packet, the Alarm2 bit (the second bit of 12^^st^^ byte of payload) on this uplink packet is set to 1. | ||
933 | ))) | ||
934 | |||
935 | * ((( | ||
936 | (% style="color:#037691" %)**AT+TTRIG2=0,0** (%%) **~-~-> ** Default Value, disable timeout Alarm. | ||
937 | |||
938 | |||
939 | |||
940 | ))) | ||
941 | |||
942 | (% style="color:blue" %)**Downlink Command to configure:** | ||
943 | |||
944 | If user send 0xA9 02 00 00 1E: equal to AT+TTRIG2=0,30 **or** 0xA9 02 00 00 00: Equal to AT+TTRIG2=0,0. | ||
945 | |||
946 | |||
947 | === 3.3.5 TTRIG1 & TTRIG2 timeout status alarm === | ||
948 | |||
949 | |||
950 | It needs to be used with AT+TTRIG1 or AT+TTRIG2. When TTRIG1 or TTRIG2 times out and causes an alarm, and the status does not change subsequently, an alarm packet will be sent at the alarm interval. | ||
951 | |||
952 | (% style="color:blue" %)**AT Command:** | ||
953 | |||
954 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
955 | |=(% style="width: 155px;background-color:#4F81BD;color:white" %)**Command Example**|=(% style="width: 279px;background-color:#4F81BD;color:white" %)**Function**|=(% style="width: 76px;background-color:#4F81BD;color:white" %)**Response** | ||
956 | |(% style="width:155px" %)((( | ||
957 | AT+TTRALARM=0 | ||
958 | )))|(% style="width:279px" %)((( | ||
959 | disable continuous alarm | ||
960 | )))|(% style="width:84px" %)((( | ||
961 | OK | ||
962 | ))) | ||
963 | |(% style="width:155px" %)((( | ||
964 | AT+TTRALARM=60 | ||
965 | )))|(% style="width:279px" %)((( | ||
966 | The alarm interval is 60 minutes (unit: minutes) | ||
967 | )))|(% style="width:84px" %)((( | ||
968 | OK | ||
969 | ))) | ||
970 | |||
971 | (% style="color:blue" %)**Downlink Command:** | ||
972 | |||
973 | Example: 0C aa => AT+TTRALARM= aa | ||
974 | |||
975 | |||
976 | === 3.3.6 Count Mod === | ||
977 | |||
978 | |||
979 | Feature: Manually set the count mode. | ||
980 | |||
981 | (% style="color:blue" %)**AT Command:** | ||
982 | |||
983 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:515px" %) | ||
984 | |=(% style="width: 154px;background-color:#4F81BD;color:white" %)**Command Example**|=(% style="width: 275px;background-color:#4F81BD;color:white" %)**Function**|=(% style="width: 86px;background-color:#4F81BD;color:white" %)**Response** | ||
985 | |(% style="width:155px" %)((( | ||
986 | AT+COUNTMOD=0 | ||
987 | )))|(% style="width:277px" %)((( | ||
988 | the count value keeps accumulating mode | ||
989 | )))|(% style="width:86px" %)((( | ||
990 | OK | ||
991 | ))) | ||
992 | |(% style="width:155px" %)((( | ||
993 | AT+COUNTMOD=1 | ||
994 | )))|(% style="width:277px" %)((( | ||
995 | the count value will be reset after each TDC time(Last Close Duration Reset after each uplink) | ||
996 | )))|(% style="width:86px" %)((( | ||
997 | OK | ||
998 | ))) | ||
999 | |||
1000 | (% style="color:blue" %)**Downlink Command:** | ||
1001 | |||
1002 | Example: 0B aa => AT+COUNTMOD = second byte | ||
1003 | |||
1004 | |||
1005 | === 3.3.7 Number of channel of door sensors === | ||
1006 | |||
1007 | |||
1008 | Feature: Set the number of door sensor channels. | ||
1009 | |||
1010 | (% style="color:blue" %)**AT Command:** | ||
1011 | |||
1012 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:500px" %) | ||
1013 | |=(% style="width: 155px;background-color:#4F81BD;color:white" %)**Command Example**|=(% style="width: 288px; background-color:#4F81BD;color:white" %)**Function**|=(% style="width: 57px;background-color:#4F81BD;color:white" %)**Response** | ||
1014 | |(% style="width:155px" %)((( | ||
1015 | AT+TTRCHANNEL=1 | ||
1016 | )))|(% style="width:259px" %)((( | ||
1017 | Set as single channel, only use PA8 pin as interrupt pin. | ||
1018 | )))|(% style="width:44px" %)((( | ||
1019 | OK | ||
1020 | ))) | ||
1021 | |(% style="width:155px" %)((( | ||
1022 | AT+TTRCHANNEL=2 | ||
1023 | )))|(% style="width:259px" %)((( | ||
1024 | Set as dual channel, use PA8 pin and PA4 pin as interrupt pin. | ||
1025 | )))|(% style="width:44px" %)((( | ||
1026 | OK | ||
1027 | ))) | ||
1028 | |||
1029 | (% style="color:blue" %)**Downlink Command:** | ||
1030 | |||
1031 | Example: 0D aa => AT+TTRCHANNEL = second byte | ||
1032 | |||
1033 | |||
1034 | === 3.3.8 Set Time Sync Mode === | ||
1035 | |||
1036 | |||
1037 | Feature: Enable/Disable Sync system time via LoRaWAN MAC Command (DeviceTimeReq), LoRaWAN server must support v1.0.3 protocol to reply to this command. | ||
1038 | |||
1039 | SYNCMOD is set to 1 by default. If user wants to set a different time from the LoRaWAN server, the user needs to set this to 0. | ||
1040 | |||
1041 | (% style="color:blue" %)**AT Command:** | ||
1042 | |||
1043 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:500px" %) | ||
1044 | |=(% style="width: 155px;background-color:#4F81BD;color:white" %)**Command Example**|=(% style="width: 288px; background-color:#4F81BD;color:white" %)**Function**|=(% style="width: 57px;background-color:#4F81BD;color:white" %)**Response** | ||
1045 | |(% style="width:155px" %)((( | ||
1046 | AT+SYNCMOD=1 | ||
1047 | )))|(% style="width:259px" %)((( | ||
1048 | Enable Sync system time via LoRaWAN MAC Command (DeviceTimeReq) The default is zero time zone. | ||
1049 | )))|(% style="width:44px" %)((( | ||
1050 | OK | ||
1051 | ))) | ||
1052 | |(% style="width:155px" %)((( | ||
1053 | AT+SYNCMOD=1,8 | ||
1054 | )))|(% style="width:259px" %)((( | ||
1055 | Enable Sync system time via LoRaWAN MAC Command (DeviceTimeReq) Set to East eight time zone. | ||
1056 | )))|(% style="width:44px" %)((( | ||
1057 | OK | ||
1058 | ))) | ||
1059 | |(% style="width:155px" %)AT+SYNCMOD=1,-12|(% style="width:259px" %)Enable Sync system time via LoRaWAN MAC Command (DeviceTimeReq) Set to West Twelve Time Zone.|(% style="width:44px" %)OK | ||
1060 | |||
1061 | (% style="color:blue" %)**Downlink Command:** | ||
1062 | |||
1063 | 0x28 01 ~/~/ Same As AT+SYNCMOD=1 | ||
1064 | |||
1065 | 0x28 01 08 ~/~/ Same As AT+SYNCMOD=1,8 | ||
1066 | |||
1067 | 0x28 01 F4 ~/~/ Same As AT+SYNCMOD=1,-12 | ||
1068 | |||
1069 | 0x28 00 ~/~/ Same As AT+SYNCMOD=0 | ||
1070 | |||
1071 | |||
1072 | === 3.3.9 Clear the open door times and the duration of the last open door === | ||
1073 | |||
1074 | |||
1075 | (% style="color:blue" %)**AT Command:** | ||
1076 | |||
1077 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
1078 | |=(% style="width: 163px;background-color:#4F81BD;color:white" %)**Command Example**|=(% style="width: 290px; background-color:#4F81BD;color:white" %)**Function**|=(% style="width: 57px;background-color:#4F81BD;color:white" %)**Response** | ||
1079 | |(% style="width:155px" %)AT+CLRC|(% style="width:259px" %)clear the open door times and the duration of the last open door.|(% style="width:44px" %)((( | ||
1080 | OK | ||
1081 | ))) | ||
1082 | |||
1083 | (% style="color:blue" %)**Downlink Command:**(%%)0xA6 01 | ||
1084 | |||
1085 | The sensor will clear the open door times and the duration of the last open door. | ||
1086 | |||
1087 | |||
1088 | === 3.3.10 Set the count value of the number of open door === | ||
1089 | |||
1090 | |||
1091 | (% style="color:blue" %)**AT Command:** | ||
1092 | |||
1093 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:500px" %) | ||
1094 | |=(% style="width: 155px;background-color:#4F81BD;color:white" %)**Command Example**|=(% style="width: 288px; background-color:#4F81BD;color:white" %)**Function**|=(% style="width: 57px;background-color:#4F81BD;color:white" %)**Response** | ||
1095 | |(% style="width:155px" %)((( | ||
1096 | AT+SETCNT=1,100 | ||
1097 | )))|(% style="width:259px" %)((( | ||
1098 | Set the open door times of PA8 pin to 100 times. | ||
1099 | )))|(% style="width:44px" %)((( | ||
1100 | OK | ||
1101 | ))) | ||
1102 | |(% style="width:155px" %)AT+SETCNT=1,0|(% style="width:259px" %)Clear the open door times of PA8 pin.|(% style="width:44px" %)OK | ||
1103 | |(% style="width:155px" %)((( | ||
1104 | AT+SETCNT=2,50 | ||
1105 | )))|(% style="width:259px" %)((( | ||
1106 | Set the open door times of PA4 pin to 100 times. | ||
1107 | )))|(% style="width:44px" %)((( | ||
1108 | OK | ||
1109 | ))) | ||
1110 | |||
1111 | (% style="color:blue" %)**Downlink Command:** | ||
1112 | |||
1113 | 0xA6 01 00 00 64 ==> AT+SETCNT=1,100 | ||
1114 | |||
1115 | 0xA6 01 00 00 00 ==> AT+SETCNT=1,0 | ||
1116 | |||
1117 | 0xA6 02 00 00 32 ==> AT+SETCNT=2,50 | ||
1118 | |||
1119 | |||
1120 | = 4. Battery & Power Consumption = | ||
1121 | |||
1122 | |||
1123 | DS03A-LB use ER26500 + SPC1520 battery pack and DS03A-LS use 3000mAh Recharable Battery with Solar Panel. See below link for detail information about the battery info and how to replace. | ||
1124 | |||
1125 | [[**Battery Info & Power Consumption Analyze**>>http://wiki.dragino.com/xwiki/bin/view/Main/How%20to%20calculate%20the%20battery%20life%20of%20Dragino%20sensors%3F/]] . | ||
1126 | |||
1127 | |||
1128 | = 5. OTA firmware update = | ||
1129 | |||
1130 | |||
1131 | User can change firmware DS03A-LB/LS to: | ||
1132 | |||
1133 | * Change Frequency band/ region. | ||
1134 | * Update with new features. | ||
1135 | * Fix bugs. | ||
1136 | |||
1137 | Firmware and changelog can be downloaded from : **[[Firmware download link>>http://wiki.dragino.com/xwiki/bin/view/Main/Firmware%20OTA%20Update%20for%20Sensors/]]** | ||
1138 | |||
1139 | Methods to Update Firmware: | ||
1140 | |||
1141 | * (Recommanded way) OTA firmware update via wireless:** [[http:~~/~~/wiki.dragino.com/xwiki/bin/view/Main/Firmware%20OTA%20Update%20for%20Sensors/>>url:http://wiki.dragino.com/xwiki/bin/view/Main/Firmware%20OTA%20Update%20for%20Sensors/]]** | ||
1142 | * Update through UART TTL interface: **[[Instruction>>url:http://wiki.dragino.com/xwiki/bin/view/Main/UART%20Access%20for%20LoRa%20ST%20v4%20base%20model/#H1.LoRaSTv4baseHardware]]**. | ||
1143 | |||
1144 | = 6. FAQ = | ||
1145 | |||
1146 | |||
1147 | |||
1148 | = 7. Order Info = | ||
1149 | |||
1150 | |||
1151 | **Part Number: (% style="color:blue" %)DS03A-LB-XX (%%)or (% style="color:blue" %)DS03A-LS-XX(%%)** | ||
1152 | |||
1153 | (% style="color:red" %)**XX**(%%): The default frequency band | ||
1154 | |||
1155 | * (% style="color:red" %)**AS923**(%%): LoRaWAN AS923 band | ||
1156 | |||
1157 | * (% style="color:red" %)**AU915**(%%): LoRaWAN AU915 band | ||
1158 | |||
1159 | * (% style="color:red" %)**EU433**(%%): LoRaWAN EU433 band | ||
1160 | |||
1161 | * (% style="color:red" %)**EU868**(%%): LoRaWAN EU868 band | ||
1162 | |||
1163 | * (% style="color:red" %)**KR920**(%%): LoRaWAN KR920 band | ||
1164 | |||
1165 | * (% style="color:red" %)**US915**(%%): LoRaWAN US915 band | ||
1166 | |||
1167 | * (% style="color:red" %)**IN865**(%%): LoRaWAN IN865 band | ||
1168 | |||
1169 | * (% style="color:red" %)**CN470**(%%): LoRaWAN CN470 band | ||
1170 | |||
1171 | = 8. Packing Info = | ||
1172 | |||
1173 | |||
1174 | (% style="color:#037691" %)**Package Includes**: | ||
1175 | |||
1176 | * DS03A-LB or DS03A-LS LoRaWAN Temperature Sensor | ||
1177 | |||
1178 | (% style="color:#037691" %)**Dimension and weight**: | ||
1179 | |||
1180 | * Device Size: cm | ||
1181 | |||
1182 | * Device Weight: g | ||
1183 | |||
1184 | * Package Size / pcs : cm | ||
1185 | |||
1186 | * Weight / pcs : g | ||
1187 | |||
1188 | = 9. Support = | ||
1189 | |||
1190 | |||
1191 | * 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. | ||
1192 | |||
1193 | * 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.cc>>mailto:Support@dragino.cc]]. |