Wiki source code of DS20L -- LoRaWAN Smart Distance Detector User Manual
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | (% style="text-align:center" %) | ||
2 | [[image:image-20231110085342-2.png||height="481" width="481"]] | ||
3 | |||
4 | |||
5 | |||
6 | |||
7 | |||
8 | |||
9 | |||
10 | |||
11 | **Table of Contents:** | ||
12 | |||
13 | {{toc/}} | ||
14 | |||
15 | |||
16 | |||
17 | |||
18 | |||
19 | |||
20 | = 1. Introduction = | ||
21 | |||
22 | == 1.1 What is LoRaWAN Smart Distance Detector == | ||
23 | |||
24 | |||
25 | The Dragino (% style="color:blue" %)**DS20L is a smart distance detector**(%%) base on long-range wireless LoRaWAN technology. It uses (% style="color:blue" %)**LiDAR sensor**(%%) to detect the distance between DS20L and object, then DS20L will send the distance data to the IoT Platform via LoRaWAN. | ||
26 | |||
27 | DS20L allows users to send data and reach extremely long ranges via LoRaWAN. It provides ultra-long range spread spectrum communication and high interference immunity whilst minimizing current | ||
28 | consumption. It targets professional wireless sensor network applications such smart cities, building automation, and so on. | ||
29 | |||
30 | DS20L has a (% style="color:blue" %)**built-in 2400mAh non-chargeable battery**(%%) for long-term use up to several years*. Users can also power DS20L with an external power source for (% style="color:blue" %)**continuous measuring and distance alarm / counting purposes.** | ||
31 | |||
32 | DS20L is fully compatible with (% style="color:blue" %)**LoRaWAN v1.0.3 Class A protocol**(%%), it can work with a standard LoRaWAN gateway. | ||
33 | |||
34 | DS20L supports (% style="color:blue" %)**Datalog feature**(%%). It will record the data when there is no network coverage and users can retrieve the sensor value later to ensure no miss for every sensor reading. | ||
35 | |||
36 | [[image:image-20231110102635-5.png||height="402" width="807"]] | ||
37 | |||
38 | |||
39 | == 1.2 Features == | ||
40 | |||
41 | |||
42 | * LoRaWAN Class A protocol | ||
43 | * LiDAR distance detector, range 3 ~~ 200cm | ||
44 | * Periodically detect or continuously detect mode | ||
45 | * AT Commands to change parameters | ||
46 | * Remotely configure parameters via LoRaWAN Downlink | ||
47 | * Alarm & Counting mode | ||
48 | * Datalog Feature | ||
49 | * Firmware upgradable via program port or LoRa protocol | ||
50 | * Built-in 2400mAh battery or power by external power source | ||
51 | |||
52 | |||
53 | |||
54 | == 1.3 Specification == | ||
55 | |||
56 | |||
57 | (% style="color:#037691" %)**LiDAR Sensor:** | ||
58 | |||
59 | * Operation Temperature: -40 ~~ 80 °C | ||
60 | * Operation Humidity: 0~~99.9%RH (no Dew) | ||
61 | * Storage Temperature: -10 ~~ 45°C | ||
62 | * Measure Range: 3cm~~200cm @ 90% reflectivity | ||
63 | * Accuracy: ±2cm @ (3cm~~100cm); ±5% @ (100~~200cm) | ||
64 | * ToF FoV: ±9°, Total 18° | ||
65 | * Light source: VCSEL | ||
66 | |||
67 | (% style="display:none" %) | ||
68 | |||
69 | |||
70 | |||
71 | = 2. Configure DS20L to connect to LoRaWAN network = | ||
72 | |||
73 | == 2.1 How it works == | ||
74 | |||
75 | |||
76 | The DS20L 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 DS20L. It will automatically join the network via OTAA and start to send the sensor value. The default uplink interval is 20 minutes. | ||
77 | |||
78 | (% style="display:none" %) (%%) | ||
79 | |||
80 | == 2.2 Quick guide to connect to LoRaWAN server (OTAA) == | ||
81 | |||
82 | |||
83 | 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. | ||
84 | |||
85 | 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.(% style="display:none" %) | ||
86 | |||
87 | [[image:image-20231110102635-5.png||height="402" width="807"]](% style="display:none" %) | ||
88 | |||
89 | (% style="color:blue" %)**Step 1:**(%%) Create a device in TTN with the OTAA keys from DS20L. | ||
90 | |||
91 | Each DS20L is shipped with a sticker with the default device EUI as below: | ||
92 | |||
93 | [[image:image-20230426084152-1.png||alt="图片-20230426084152-1.png" height="233" width="502"]] | ||
94 | |||
95 | |||
96 | You can enter this key in the LoRaWAN Server portal. Below is TTN screen shot: | ||
97 | |||
98 | |||
99 | (% style="color:blue" %)**Register the device** | ||
100 | |||
101 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LSN50v2-S31-S31B%20LoRaWAN%20Temperature%20%26%20Humidity%20Sensor%20User%20Manual/WebHome/1654935135620-998.png?rev=1.1||alt="1654935135620-998.png"]] | ||
102 | |||
103 | |||
104 | (% style="color:blue" %)**Add APP EUI and DEV EUI** | ||
105 | |||
106 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LSN50v2-S31-S31B%20LoRaWAN%20Temperature%20%26%20Humidity%20Sensor%20User%20Manual/WebHome/image-20220611161308-4.png?width=753&height=551&rev=1.1||alt="图片-20220611161308-4.png"]] | ||
107 | |||
108 | |||
109 | (% style="color:blue" %)**Add APP EUI in the application** | ||
110 | |||
111 | |||
112 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LSN50v2-S31-S31B%20LoRaWAN%20Temperature%20%26%20Humidity%20Sensor%20User%20Manual/WebHome/image-20220611161308-5.png?width=742&height=601&rev=1.1||alt="图片-20220611161308-5.png"]] | ||
113 | |||
114 | |||
115 | (% style="color:blue" %)**Add APP KEY** | ||
116 | |||
117 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LSN50v2-S31-S31B%20LoRaWAN%20Temperature%20%26%20Humidity%20Sensor%20User%20Manual/WebHome/image-20220611161308-6.png?width=744&height=485&rev=1.1||alt="图片-20220611161308-6.png"]] | ||
118 | |||
119 | |||
120 | (% style="color:blue" %)**Step 2:**(%%) Activate on DS20L | ||
121 | |||
122 | |||
123 | Press the button for 5 seconds to activate the DS20L. | ||
124 | |||
125 | (% 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. | ||
126 | |||
127 | After join success, it will start to upload messages to TTN and you can see the messages in the panel. | ||
128 | |||
129 | |||
130 | == 2.3 Uplink Payload == | ||
131 | |||
132 | === 2.3.1 Device Status, FPORT~=5 === | ||
133 | |||
134 | |||
135 | Users can use the downlink command(**0x26 01**) to ask DS20L to send device configure detail, include device configure status. DS20L will uplink a payload via FPort=5 to server. | ||
136 | |||
137 | The Payload format is as below. | ||
138 | |||
139 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
140 | |=(% style="width: 60px;background-color:#4F81BD;color:white" %)((( | ||
141 | **Size(bytes)** | ||
142 | )))|=(% style="width: 100px; background-color: #4F81BD;color:white;" %)**1**|=(% style="width: 100px; background-color: #4F81BD;color:white;" %)**2**|=(% style="background-color: #4F81BD;color:white; width: 100px;" %)**1**|=(% style="background-color: #4F81BD;color:white; width: 100px;" %)**1**|=(% style="background-color: #4F81BD;color:white; width: 50px;" %)**2** | ||
143 | |(% style="width:62.5px" %)Value|(% style="width:110px" %)Sensor Model|(% style="width:48px" %)Firmware Version|(% style="width:94px" %)Frequency Band|(% style="width:91px" %)Sub-band|(% style="width:60px" %)BAT | ||
144 | |||
145 | Example parse in TTNv3 | ||
146 | |||
147 | [[image:image-20230805103904-1.png||height="131" width="711"]] | ||
148 | |||
149 | (% style="color:blue" %)**Sensor Model**(%%): For DS20L, this value is 0x24 | ||
150 | |||
151 | (% style="color:blue" %)**Firmware Version**(%%): 0x0100, Means: v1.0.0 version | ||
152 | |||
153 | (% style="color:blue" %)**Frequency Band**: | ||
154 | |||
155 | 0x01: EU868 | ||
156 | |||
157 | 0x02: US915 | ||
158 | |||
159 | 0x03: IN865 | ||
160 | |||
161 | 0x04: AU915 | ||
162 | |||
163 | 0x05: KZ865 | ||
164 | |||
165 | 0x06: RU864 | ||
166 | |||
167 | 0x07: AS923 | ||
168 | |||
169 | 0x08: AS923-1 | ||
170 | |||
171 | 0x09: AS923-2 | ||
172 | |||
173 | 0x0a: AS923-3 | ||
174 | |||
175 | 0x0b: CN470 | ||
176 | |||
177 | 0x0c: EU433 | ||
178 | |||
179 | 0x0d: KR920 | ||
180 | |||
181 | 0x0e: MA869 | ||
182 | |||
183 | (% style="color:blue" %)**Sub-Band**: | ||
184 | |||
185 | AU915 and US915:value 0x00 ~~ 0x08 | ||
186 | |||
187 | CN470: value 0x0B ~~ 0x0C | ||
188 | |||
189 | Other Bands: Always 0x00 | ||
190 | |||
191 | (% style="color:blue" %)**Battery Info**: | ||
192 | |||
193 | Check the battery voltage. | ||
194 | |||
195 | Ex1: 0x0B45 = 2885mV | ||
196 | |||
197 | Ex2: 0x0B49 = 2889mV | ||
198 | |||
199 | |||
200 | === 2.3.2 Uplink Payload, FPORT~=2 === | ||
201 | |||
202 | |||
203 | ((( | ||
204 | DS20L will send this uplink **after** Device Status once join the LoRaWAN network successfully. And DS20L will: | ||
205 | |||
206 | periodically send this uplink every 20 minutes, this interval [[can be changed>>||anchor="H3.3.1SetTransmitIntervalTime"]]. | ||
207 | |||
208 | Uplink Payload totals 11 bytes. | ||
209 | ))) | ||
210 | |||
211 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
212 | |=(% style="width: 60px;background-color:#4F81BD;color:white" %)((( | ||
213 | **Size(bytes)** | ||
214 | )))|=(% style="width: 30px;background-color:#4F81BD;color:white" %)**2**|=(% style="width: 80px;background-color:#4F81BD;color:white" %)**2**|=(% style="width: 50px;background-color:#4F81BD;color:white" %)**2**|=(% style="width: 70px;background-color:#4F81BD;color:white" %)**2**|=(% style="background-color:#4F81BD;color:white; width: 80px;" %)**1**|=(% style="background-color: #4F81BD;color:white; width: 70px;" %)**1**|=(% style="background-color: #4F81BD;color:white; width: 70px;" %)**1** | ||
215 | |(% style="width:62.5px" %)Value|(% style="width:62.5px" %)[[BAT>>||anchor="HBatteryInfo"]]|(% style="width:62.5px" %)((( | ||
216 | [[Temperature DS18B20>>||anchor="HDS18B20Temperaturesensor"]] | ||
217 | )))|[[Distance>>||anchor="HDistance"]]|[[Distance signal strength>>||anchor="HDistancesignalstrength"]]|(% style="width:122px" %)((( | ||
218 | [[Interrupt flag & Interrupt_level>>||anchor="HInterruptPin26A0InterruptLevel"]] | ||
219 | )))|(% style="width:54px" %)[[LiDAR temp>>||anchor="HLiDARtemp"]]|(% style="width:96px" %)((( | ||
220 | [[Message Type>>||anchor="HMessageType"]] | ||
221 | ))) | ||
222 | |||
223 | [[image:image-20230805104104-2.png||height="136" width="754"]] | ||
224 | |||
225 | |||
226 | ==== (% style="color:blue" %)**Battery Info**(%%) ==== | ||
227 | |||
228 | |||
229 | Check the battery voltage for DS20L. | ||
230 | |||
231 | Ex1: 0x0B45 = 2885mV | ||
232 | |||
233 | Ex2: 0x0B49 = 2889mV | ||
234 | |||
235 | |||
236 | ==== (% style="color:blue" %)**DS18B20 Temperature sensor**(%%) ==== | ||
237 | |||
238 | |||
239 | This is optional, user can connect external DS18B20 sensor to the +3.3v, 1-wire and GND pin . and this field will report temperature. | ||
240 | |||
241 | |||
242 | **Example**: | ||
243 | |||
244 | If payload is: 0105H: (0105 & FC00 == 0), temp = 0105H /10 = 26.1 degree | ||
245 | |||
246 | If payload is: FF3FH : (FF3F & FC00 == 1) , temp = (FF3FH - 65536)/10 = -19.3 degrees. | ||
247 | |||
248 | |||
249 | ==== (% style="color:blue" %)**Distance**(%%) ==== | ||
250 | |||
251 | |||
252 | Represents the distance value of the measurement output, the default unit is cm, and the value range parsed as a decimal number is 0-1200. In actual use, when the signal strength value Strength. | ||
253 | |||
254 | |||
255 | **Example**: | ||
256 | |||
257 | If the data you get from the register is 0x0B 0xEA, the distance between the sensor and the measured object is 0BEA(H) = 3050 (D)/10 = 305cm. | ||
258 | |||
259 | |||
260 | ==== (% style="color:blue" %)**Distance signal strength**(%%) ==== | ||
261 | |||
262 | |||
263 | Refers to the signal strength, the default output value will be between 0-65535. When the distance measurement gear is fixed, the farther the distance measurement is, the lower the signal strength; the lower the target reflectivity, the lower the signal strength. When Strength is greater than 100 and not equal to 65535, the measured value of Dist is considered credible. | ||
264 | |||
265 | |||
266 | **Example**: | ||
267 | |||
268 | If payload is: 01D7(H)=471(D), distance signal strength=471, 471>100,471≠65535, the measured value of Dist is considered credible. | ||
269 | |||
270 | Customers can judge whether they need to adjust the environment based on the signal strength. | ||
271 | |||
272 | |||
273 | **1) When the sensor detects valid data:** | ||
274 | |||
275 | [[image:image-20230805155335-1.png||height="145" width="724"]] | ||
276 | |||
277 | |||
278 | **2) When the sensor detects invalid data:** | ||
279 | |||
280 | [[image:image-20230805155428-2.png||height="139" width="726"]] | ||
281 | |||
282 | |||
283 | **3) When the sensor is not connected:** | ||
284 | |||
285 | [[image:image-20230805155515-3.png||height="143" width="725"]] | ||
286 | |||
287 | |||
288 | ==== (% style="color:blue" %)**Interrupt Pin & Interrupt Level**(%%) ==== | ||
289 | |||
290 | |||
291 | This data field shows if this packet is generated by interrupt or not. [[Click here>>||anchor="H3.3.2SetInterruptMode"]] for the hardware and software set up. | ||
292 | |||
293 | Note: The Internet Pin is a separate pin in the screw terminal. See pin mapping of GPIO_EXTI . | ||
294 | |||
295 | **Example:** | ||
296 | |||
297 | If byte[0]&0x01=0x00 : Normal uplink packet. | ||
298 | |||
299 | If byte[0]&0x01=0x01 : Interrupt Uplink Packet. | ||
300 | |||
301 | |||
302 | ==== (% style="color:blue" %)**LiDAR temp**(%%) ==== | ||
303 | |||
304 | |||
305 | Characterize the internal temperature value of the sensor. | ||
306 | |||
307 | **Example: ** | ||
308 | If payload is: 1C(H) <<24>>24=28(D),LiDAR temp=28℃. | ||
309 | If payload is: F2(H) <<24>>24=-14(D),LiDAR temp=-14℃. | ||
310 | |||
311 | |||
312 | ==== (% style="color:blue" %)**Message Type**(%%) ==== | ||
313 | |||
314 | |||
315 | ((( | ||
316 | For a normal uplink payload, the message type is always 0x01. | ||
317 | ))) | ||
318 | |||
319 | ((( | ||
320 | Valid Message Type: | ||
321 | ))) | ||
322 | |||
323 | (% border="1" cellspacing="5" style="background-color:#f2f2f2; width:499px" %) | ||
324 | |=(% style="width: 161px;background-color:#4F81BD;color:white" %)**Message Type Code**|=(% style="width: 164px;background-color:#4F81BD;color:white" %)**Description**|=(% style="width: 174px;background-color:#4F81BD;color:white" %)**Payload** | ||
325 | |(% style="width:160px" %)0x01|(% style="width:163px" %)Normal Uplink|(% style="width:173px" %)Normal Uplink Payload | ||
326 | |(% style="width:160px" %)0x02|(% style="width:163px" %)Reply configures info|(% style="width:173px" %)Configure Info Payload | ||
327 | |||
328 | [[image:image-20230805150315-4.png||height="233" width="723"]] | ||
329 | |||
330 | |||
331 | === 2.3.3 Historical measuring distance, FPORT~=3 === | ||
332 | |||
333 | |||
334 | DS20L stores sensor values and users can retrieve these history values via the [[downlink command>>||anchor="H2.5.4Pollsensorvalue"]]. | ||
335 | |||
336 | The historical payload includes one or multiplies entries and every entry has the same payload as Real-Time measuring distance. | ||
337 | |||
338 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
339 | |=(% style="width: 60px;background-color:#4F81BD;color:white" %)((( | ||
340 | **Size(bytes)** | ||
341 | )))|=(% style="width: 80px;background-color:#4F81BD;color:white" %)1|=(% style="width: 80px;background-color:#4F81BD;color:white" %)**1**|=(% style="width: 50px;background-color:#4F81BD;color:white" %)**2**|=(% style="width: 70px;background-color:#4F81BD;color:white" %)**2**|=(% style="background-color:#4F81BD; color: white; width: 85px;" %)**1**|=(% style="background-color: #4F81BD; color: white; width: 85px;" %)4 | ||
342 | |(% style="width:62.5px" %)Value|(% style="width:62.5px" %)Interrupt flag & Interrupt_level|(% style="width:62.5px" %)((( | ||
343 | Reserve(0xFF) | ||
344 | )))|Distance|Distance signal strength|(% style="width:88px" %)((( | ||
345 | LiDAR temp | ||
346 | )))|(% style="width:85px" %)Unix TimeStamp | ||
347 | |||
348 | **Interrupt flag & Interrupt level:** | ||
349 | |||
350 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:480px" %) | ||
351 | |=(% style="width: 60px;background-color:#4F81BD;color:white" %)((( | ||
352 | **Size(bit)** | ||
353 | )))|=(% style="width: 90px;background-color:#4F81BD;color:white" %)**bit7**|=(% style="width: 90px;background-color:#4F81BD;color:white" %)**bit6**|=(% style="width: 60px;background-color:#4F81BD;color:white" %)**[bit5:bit2]**|=(% style="width: 90px; background-color: #4F81BD; color: white;" %)**bit1**|=(% style="background-color: #4F81BD; color: white; width: 90px;" %)**bit0** | ||
354 | |(% style="width:62.5px" %)Value|(% style="width:62.5px" %)No ACK message|(% style="width:62.5px" %)Poll Message Flag|Reserve|(% style="width:91px" %)Interrupt level|(% style="width:88px" %)((( | ||
355 | Interrupt flag | ||
356 | ))) | ||
357 | |||
358 | * ((( | ||
359 | Each data entry is 11 bytes and has the same structure as [[Uplink Payload>>||anchor="H2.3.2UplinkPayload2CFPORT3D2"]], to save airtime and battery, DS20L will send max bytes according to the current DR and Frequency bands. | ||
360 | ))) | ||
361 | |||
362 | For example, in the US915 band, the max payload for different DR is: | ||
363 | |||
364 | **a) DR0:** max is 11 bytes so one entry of data | ||
365 | |||
366 | **b) DR1:** max is 53 bytes so devices will upload 4 entries of data (total 44 bytes) | ||
367 | |||
368 | **c) DR2:** total payload includes 11 entries of data | ||
369 | |||
370 | **d) DR3:** total payload includes 22 entries of data. | ||
371 | |||
372 | If DS20L doesn't have any data in the polling time. It will uplink 11 bytes of 0 | ||
373 | |||
374 | |||
375 | **Downlink:** | ||
376 | |||
377 | 0x31 64 CC 68 0C 64 CC 69 74 05 | ||
378 | |||
379 | [[image:image-20230805144936-2.png||height="113" width="746"]] | ||
380 | |||
381 | **Uplink:** | ||
382 | |||
383 | 43 FF 0E 10 00 B0 1E 64 CC 68 0C 40 FF 0D DE 00 A8 1E 64 CC 68 29 40 FF 09 92 00 D3 1E 64 CC 68 65 40 FF 02 3A 02 BC 1E 64 CC 68 A1 41 FF 0E 1A 00 A4 1E 64 CC 68 C0 40 FF 0D 2A 00 B8 1E 64 CC 68 E8 40 FF 00 C8 11 6A 1E 64 CC 69 24 40 FF 0E 24 00 AD 1E 64 CC 69 6D | ||
384 | |||
385 | |||
386 | **Parsed Value:** | ||
387 | |||
388 | [DISTANCE , DISTANCE_SIGNAL_STRENGTH,LIDAR_TEMP,EXTI_STATUS , EXTI_FLAG , TIME] | ||
389 | |||
390 | |||
391 | [360,176,30,High,True,2023-08-04 02:53:00], | ||
392 | |||
393 | [355,168,30,Low,False,2023-08-04 02:53:29], | ||
394 | |||
395 | [245,211,30,Low,False,2023-08-04 02:54:29], | ||
396 | |||
397 | [57,700,30,Low,False,2023-08-04 02:55:29], | ||
398 | |||
399 | [361,164,30,Low,True,2023-08-04 02:56:00], | ||
400 | |||
401 | [337,184,30,Low,False,2023-08-04 02:56:40], | ||
402 | |||
403 | [20,4458,30,Low,False,2023-08-04 02:57:40], | ||
404 | |||
405 | [362,173,30,Low,False,2023-08-04 02:58:53], | ||
406 | |||
407 | |||
408 | **History read from serial port:** | ||
409 | |||
410 | [[image:image-20230805145056-3.png]] | ||
411 | |||
412 | |||
413 | === 2.3.4 Decode payload in The Things Network === | ||
414 | |||
415 | |||
416 | While using TTN network, you can add the payload format to decode the payload. | ||
417 | |||
418 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LLDS12-LoRaWAN%20LiDAR%20ToF%20Distance%20Sensor%20User%20Manual/WebHome/1654592762713-715.png?rev=1.1||alt="1654592762713-715.png"]] | ||
419 | |||
420 | |||
421 | ((( | ||
422 | The payload decoder function for TTN is here: | ||
423 | ))) | ||
424 | |||
425 | ((( | ||
426 | DS20L TTN Payload Decoder: [[https:~~/~~/github.com/dragino/dragino-end-node-decoder>>https://github.com/dragino/dragino-end-node-decoder]] | ||
427 | ))) | ||
428 | |||
429 | |||
430 | == 2.4 Show Data in DataCake IoT Server == | ||
431 | |||
432 | |||
433 | ((( | ||
434 | [[DATACAKE>>url:https://datacake.co/]] provides a human friendly interface to show the sensor data, once we have data in TTN, we can use [[DATACAKE>>url:https://datacake.co/]] to connect to TTN and see the data in DATACAKE. Below are the steps: | ||
435 | ))) | ||
436 | |||
437 | |||
438 | ((( | ||
439 | (% style="color:blue" %)**Step 1**(%%)**: Be sure that your device is programmed and properly connected to the network at this time.** | ||
440 | ))) | ||
441 | |||
442 | ((( | ||
443 | (% 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:** | ||
444 | ))) | ||
445 | |||
446 | |||
447 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDDS75%20-%20LoRaWAN%20Distance%20Detection%20Sensor%20User%20Manual/WebHome/1654592790040-760.png?rev=1.1||alt="1654592790040-760.png"]] | ||
448 | |||
449 | |||
450 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDDS75%20-%20LoRaWAN%20Distance%20Detection%20Sensor%20User%20Manual/WebHome/1654592800389-571.png?rev=1.1||alt="1654592800389-571.png"]] | ||
451 | |||
452 | |||
453 | (% style="color:blue" %)**Step 3**(%%)**: Create an account or log in Datacake.** | ||
454 | |||
455 | (% style="color:blue" %)**Step 4**(%%)**: Search the DS20L and add DevEUI.** | ||
456 | |||
457 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDDS75%20-%20LoRaWAN%20Distance%20Detection%20Sensor%20User%20Manual/WebHome/1654851029373-510.png?rev=1.1||alt="1654851029373-510.png"]] | ||
458 | |||
459 | |||
460 | After added, the sensor data arrive TTN V3, it will also arrive and show in Datacake. | ||
461 | |||
462 | [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/LDDS75%20-%20LoRaWAN%20Distance%20Detection%20Sensor%20User%20Manual/WebHome/image-20220610165129-11.png?width=1088&height=595&rev=1.1||alt="image-20220610165129-11.png"]] | ||
463 | |||
464 | |||
465 | == 2.5 Datalog Feature == | ||
466 | |||
467 | |||
468 | Datalog Feature is to ensure IoT Server can get all sampling data from Sensor even if the LoRaWAN network is down. For each sampling, DS20L will store the reading for future retrieving purposes. | ||
469 | |||
470 | |||
471 | === 2.5.1 Ways to get datalog via LoRaWAN === | ||
472 | |||
473 | |||
474 | Set PNACKMD=1, DS20L will wait for ACK for every uplink, when there is no LoRaWAN network, DS20L 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. | ||
475 | |||
476 | * ((( | ||
477 | a) DS20L will do an ACK check for data records sending to make sure every data arrive server. | ||
478 | ))) | ||
479 | * ((( | ||
480 | b) DS20L will send data in **CONFIRMED Mode** when PNACKMD=1, but DS20L 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 DS20L gets a ACK, DS20L will consider there is a network connection and resend all NONE-ACK messages. | ||
481 | ))) | ||
482 | |||
483 | |||
484 | === 2.5.2 Unix TimeStamp === | ||
485 | |||
486 | |||
487 | DS20L uses Unix TimeStamp format based on | ||
488 | |||
489 | [[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="图片-20220523001219-11.png" height="97" width="627"]] | ||
490 | |||
491 | User can get this time from link: [[https:~~/~~/www.epochconverter.com/>>url:https://www.epochconverter.com/]] : | ||
492 | |||
493 | Below is the converter example | ||
494 | |||
495 | [[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="图片-20220523001219-12.png" height="298" width="720"]] | ||
496 | |||
497 | |||
498 | So, we can use AT+TIMESTAMP=1611889405 or downlink 3060137afd00 to set the current time 2021 – Jan ~-~- 29 Friday 03:03:25 | ||
499 | |||
500 | |||
501 | === 2.5.3 Set Device Time === | ||
502 | |||
503 | |||
504 | User need to set (% style="color:blue" %)**SYNCMOD=1**(%%) to enable sync time via MAC command. | ||
505 | |||
506 | Once DS20L Joined LoRaWAN network, it will send the MAC command (DeviceTimeReq) and the server will reply with (DeviceTimeAns) to send the current time to DS20L. If DS20L fails to get the time from the server, DS20L will use the internal time and wait for next time request (AT+SYNCTDC to set the time request period, default is 10 days). | ||
507 | |||
508 | (% 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 v3 and loriot support but TTN V3 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 V3 v2 if SYNCMOD=1.** | ||
509 | |||
510 | |||
511 | === 2.5.4 Poll sensor value === | ||
512 | |||
513 | |||
514 | Users can poll sensor values based on timestamps. Below is the downlink command. | ||
515 | |||
516 | (% border="1" cellspacing="5" style="background-color:#f2f2f2; width:425.818px" %) | ||
517 | |(% colspan="4" style="background-color:#4f81bd; color:white; width:423px" %)**Downlink Command to poll Open/Close status (0x31)** | ||
518 | |(% style="width:58px" %)**1byte**|(% style="width:127px" %)**4bytes**|(% style="width:124px" %)**4bytes**|(% style="width:114px" %)**1byte** | ||
519 | |(% style="width:58px" %)31|(% style="width:127px" %)Timestamp start|(% style="width:124px" %)Timestamp end|(% style="width:114px" %)Uplink Interval | ||
520 | |||
521 | ((( | ||
522 | Timestamp start and Timestamp end-use Unix TimeStamp format as mentioned above. Devices will reply with all data logs during this period, using the uplink interval. | ||
523 | ))) | ||
524 | |||
525 | ((( | ||
526 | For example, downlink command [[image:http://wiki.dragino.com/xwiki/bin/download/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/CPL01%20LoRaWAN%20Outdoor%20PulseContact%20%20Sensor%20Manual/WebHome/image-20220518162852-1.png?rev=1.1||alt="image-20220518162852-1.png"]] | ||
527 | ))) | ||
528 | |||
529 | ((( | ||
530 | Is to check 2021/11/12 12:00:00 to 2021/11/12 15:00:00's data | ||
531 | ))) | ||
532 | |||
533 | ((( | ||
534 | Uplink Internal =5s,means DS20L will send one packet every 5s. range 5~~255s. | ||
535 | ))) | ||
536 | |||
537 | |||
538 | == 2.6 Frequency Plans == | ||
539 | |||
540 | |||
541 | The DS20L uses OTAA mode and below frequency plans by default. If user want to use it with different frequency plan, please refer the AT command sets. | ||
542 | |||
543 | [[http:~~/~~/wiki.dragino.com/xwiki/bin/view/Main/End%20Device%20Frequency%20Band/>>http://wiki.dragino.com/xwiki/bin/view/Main/End%20Device%20Frequency%20Band/]] | ||
544 | |||
545 | |||
546 | 3. Configure DS20L | ||
547 | |||
548 | == 3.1 Configure Methods == | ||
549 | |||
550 | |||
551 | DS20L supports below configure method: | ||
552 | |||
553 | * AT Command via Bluetooth Connection (**Recommended**): [[BLE Configure Instruction>>http://wiki.dragino.com/xwiki/bin/view/Main/BLE%20Bluetooth%20Remote%20Configure/]]. | ||
554 | |||
555 | * AT Command via UART Connection : See [[UART Connection>>http://wiki.dragino.com/xwiki/bin/view/Main/UART%20Access%20for%20LoRa%20ST%20v4%20base%20model/#H2.3UARTConnectionforSN50v3basemotherboard]]. | ||
556 | |||
557 | * LoRaWAN Downlink. Instruction for different platforms: See [[IoT LoRaWAN Server>>http://wiki.dragino.com/xwiki/bin/view/Main/]] section. | ||
558 | |||
559 | |||
560 | |||
561 | == 3.2 General Commands == | ||
562 | |||
563 | |||
564 | These commands are to configure: | ||
565 | |||
566 | * General system settings like: uplink interval. | ||
567 | |||
568 | * LoRaWAN protocol & radio related command. | ||
569 | |||
570 | They are same for all Dragino Devices which support DLWS-005 LoRaWAN Stack. These commands can be found on the wiki: | ||
571 | |||
572 | [[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/]] | ||
573 | |||
574 | |||
575 | == 3.3 Commands special design for DS20L == | ||
576 | |||
577 | |||
578 | These commands only valid for DS20L, as below: | ||
579 | |||
580 | |||
581 | === 3.3.1 Set Transmit Interval Time === | ||
582 | |||
583 | |||
584 | ((( | ||
585 | Feature: Change LoRaWAN End Node Transmit Interval. | ||
586 | ))) | ||
587 | |||
588 | ((( | ||
589 | (% style="color:blue" %)**AT Command: AT+TDC** | ||
590 | ))) | ||
591 | |||
592 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
593 | |=(% 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** | ||
594 | |(% style="width:156px" %)AT+TDC=?|(% style="width:137px" %)Show current transmit Interval|((( | ||
595 | 30000 | ||
596 | OK | ||
597 | the interval is 30000ms = 30s | ||
598 | ))) | ||
599 | |(% style="width:156px" %)AT+TDC=60000|(% style="width:137px" %)Set Transmit Interval|((( | ||
600 | OK | ||
601 | Set transmit interval to 60000ms = 60 seconds | ||
602 | ))) | ||
603 | |||
604 | ((( | ||
605 | (% style="color:blue" %)**Downlink Command: 0x01** | ||
606 | ))) | ||
607 | |||
608 | ((( | ||
609 | Format: Command Code (0x01) followed by 3 bytes time value. | ||
610 | ))) | ||
611 | |||
612 | ((( | ||
613 | If the downlink payload=0100003C, it means set the END Node's Transmit Interval to 0x00003C=60(S), while type code is 01. | ||
614 | ))) | ||
615 | |||
616 | * ((( | ||
617 | Example 1: Downlink Payload: 0100001E ~/~/ Set Transmit Interval (TDC) = 30 seconds | ||
618 | ))) | ||
619 | * ((( | ||
620 | Example 2: Downlink Payload: 0100003C ~/~/ Set Transmit Interval (TDC) = 60 seconds | ||
621 | |||
622 | |||
623 | |||
624 | ))) | ||
625 | |||
626 | === 3.3.2 Set Interrupt Mode === | ||
627 | |||
628 | |||
629 | Feature, Set Interrupt mode for pin of GPIO_EXTI. | ||
630 | |||
631 | When AT+INTMOD=0 is set, GPIO_EXTI is used as a digital input port. | ||
632 | |||
633 | (% style="color:blue" %)**AT Command: AT+INTMOD** | ||
634 | |||
635 | (% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %) | ||
636 | |=(% style="width: 155px;background-color:#4F81BD;color:white" %)**Command Example**|=(% style="width: 197px;background-color:#4F81BD;color:white" %)**Function**|=(% style="width: 158px;background-color:#4F81BD;color:white" %)**Response** | ||
637 | |(% style="width:154px" %)AT+INTMOD=?|(% style="width:196px" %)Show current interrupt mode|(% style="width:157px" %)((( | ||
638 | 0 | ||
639 | OK | ||
640 | the mode is 0 =Disable Interrupt | ||
641 | ))) | ||
642 | |(% style="width:154px" %)((( | ||
643 | AT+INTMOD=2 | ||
644 | |||
645 | (default) | ||
646 | )))|(% style="width:196px" %)((( | ||
647 | Set Transmit Interval | ||
648 | 0. (Disable Interrupt), | ||
649 | ~1. (Trigger by rising and falling edge) | ||
650 | 2. (Trigger by falling edge) | ||
651 | 3. (Trigger by rising edge) | ||
652 | )))|(% style="width:157px" %)OK | ||
653 | |||
654 | (% style="color:blue" %)**Downlink Command: 0x06** | ||
655 | |||
656 | Format: Command Code (0x06) followed by 3 bytes. | ||
657 | |||
658 | This means that the interrupt mode of the end node is set to 0x000003=3 (rising edge trigger), and the type code is 06. | ||
659 | |||
660 | * Example 1: Downlink Payload: 06000000 ~/~/ Turn off interrupt mode | ||
661 | |||
662 | * Example 2: Downlink Payload: 06000003 ~/~/ Set the interrupt mode to rising edge trigger | ||
663 | |||
664 | |||
665 | |||
666 | = 4. Battery & Power Consumption = | ||
667 | |||
668 | |||
669 | DS20L use built-in 2400mAh non-chargeable battery for long-term use up to several years*. See below link for detail information about the battery info and how to replace. | ||
670 | |||
671 | [[**Battery Info & Power Consumption Analyze**>>http://wiki.dragino.com/xwiki/bin/view/Main/How%20to%20calculate%20the%20battery%20life%20of%20Dragino%20sensors%3F/]] . | ||
672 | |||
673 | |||
674 | = 5. OTA Firmware update = | ||
675 | |||
676 | |||
677 | (% class="wikigeneratedid" %) | ||
678 | User can change firmware DS20L to: | ||
679 | |||
680 | * Change Frequency band/ region. | ||
681 | |||
682 | * Update with new features. | ||
683 | |||
684 | * Fix bugs. | ||
685 | |||
686 | Firmware and changelog can be downloaded from : **[[Firmware download link>>https://www.dropbox.com/sh/zqv1vt3komgp4tu/AAC33PnXIcWOVl_UXBEAeT_xa?dl=0]]** | ||
687 | |||
688 | Methods to Update Firmware: | ||
689 | |||
690 | * (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/]]** | ||
691 | |||
692 | * 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]]**. | ||
693 | |||
694 | |||
695 | |||
696 | = 6. FAQ = | ||
697 | |||
698 | == 6.1 What is the frequency plan for DS20L? == | ||
699 | |||
700 | |||
701 | DS20L use the same frequency as other Dragino products. User can see the detail from this link: [[Introduction>>doc:Main.End Device Frequency Band.WebHome||anchor="H1.Introduction"]] | ||
702 | |||
703 | |||
704 | = 7. Trouble Shooting = | ||
705 | |||
706 | == 7.1 AT Command input doesn't work == | ||
707 | |||
708 | |||
709 | In the case if user can see the console output but can't type input to the device. Please check if you already include the (% style="color:blue" %)**ENTER**(%%) while sending out the command. Some serial tool doesn't send (% style="color:blue" %)**ENTER**(%%) while press the send key, user need to add ENTER in their string. | ||
710 | |||
711 | |||
712 | == 7.2 Significant error between the output distant value of LiDAR and actual distance == | ||
713 | |||
714 | |||
715 | ((( | ||
716 | (% style="color:blue" %)**Cause ①**(%%)**:**Due to the physical principles of The LiDAR probe, the above phenomenon is likely to occur if the detection object is the material with high reflectivity (such as mirror, smooth floor tile, etc.) or transparent substance. (such as glass and water, etc.) | ||
717 | ))) | ||
718 | |||
719 | ((( | ||
720 | (% style="color:red" %)**Troubleshooting**(%%): Please avoid use of this product under such circumstance in practice. | ||
721 | ))) | ||
722 | |||
723 | |||
724 | ((( | ||
725 | (% style="color:blue" %)**Cause ②**(%%)**: **The IR-pass filters are blocked. | ||
726 | ))) | ||
727 | |||
728 | ((( | ||
729 | (% style="color:red" %)**Troubleshooting**(%%): please use dry dust-free cloth to gently remove the foreign matter. | ||
730 | ))) | ||
731 | |||
732 | |||
733 | = 8. Order Info = | ||
734 | |||
735 | |||
736 | Part Number: (% style="color:blue" %)**DS20L-XXX** | ||
737 | |||
738 | (% style="color:red" %)**XXX**(%%): **The default frequency band** | ||
739 | |||
740 | * (% style="color:red" %)**AS923**(%%): LoRaWAN AS923 band | ||
741 | |||
742 | * (% style="color:red" %)**AU915**(%%): LoRaWAN AU915 band | ||
743 | |||
744 | * (% style="color:red" %)**EU433**(%%): LoRaWAN EU433 band | ||
745 | |||
746 | * (% style="color:red" %)**EU868**(%%): LoRaWAN EU868 band | ||
747 | |||
748 | * (% style="color:red" %)**KR920**(%%): LoRaWAN KR920 band | ||
749 | |||
750 | * (% style="color:red" %)**US915**(%%): LoRaWAN US915 band | ||
751 | |||
752 | * (% style="color:red" %)**IN865**(%%): LoRaWAN IN865 band | ||
753 | |||
754 | * (% style="color:red" %)**CN470**(%%): LoRaWAN CN470 band | ||
755 | |||
756 | |||
757 | |||
758 | = 9. Packing Info = | ||
759 | |||
760 | |||
761 | (% style="color:#037691" %)**Package Includes**: | ||
762 | |||
763 | * DS20L LoRaWAN Smart Distance Detector x 1 | ||
764 | |||
765 | (% style="color:#037691" %)**Dimension and weight**: | ||
766 | |||
767 | * Device Size: cm | ||
768 | |||
769 | * Device Weight: g | ||
770 | |||
771 | * Package Size / pcs : cm | ||
772 | |||
773 | * Weight / pcs : g | ||
774 | |||
775 | |||
776 | |||
777 | = 10. Support = | ||
778 | |||
779 | |||
780 | * 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. | ||
781 | |||
782 | * 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]]. |