Show last authors
1 (% style="text-align:center" %)
2 [[image:image-20240915231842-1.png]]
3
4
5
6
7
8
9
10 (% _mstvisible="1" %)
11 (% _msthash="315238" _msttexthash="18964465" _mstvisible="3" %)**Table of Contents:**
12
13 {{toc/}}
14
15
16
17
18
19
20
21
22 = 1.  Introduction =
23
24 == 1.1  What is LTS5 LoRa HMI touch screen ==
25
26
27 LTS5 is a (% style="color:blue" %)LoRa / LoRaWAN HMI Touch Screen(%%) designed for display purpose of IoT project. It have a 5.0" HMI touch screen, and support WiFi, Bluetooch, LoRa wireless protocol.
28
29 LTS5 is an Open Source software project. The MCU is ESP32 and Dragino LA66 LoRa module. There are lots of development source for ESP32 which can greatly reduce the development time.
30
31 The HMI touch screen of LTS5 supports drap & drop design. Developer can use SquareLine to easily customize the display UI for different application.
32
33 LTS5 use LA66 LoRa module, this module can be program to support private LoRa protocol or LoRaWAN protocol.
34
35
36 == 1.2  Features ==
37
38 * ESP32-WROOM MCU: 8MB RAM & 16MB ROM
39 * Dragino LA66 LoRa Module
40 * Support Private LoRa protocol or LoRaWAN protocol
41 * Support WiFi & BLE wireless protocol
42 * 5.0" HMI touch screen
43 * Support LVGL case. SquareLine program.
44 * Support RS485 Interface
45 * Open Source Project
46 * Wall Attachable.
47 * 5V DC power
48 * IP Rating: IP52
49
50 == 1.3  Specification ==
51
52
53 **LoRa**:
54
55 * Frequency Range: 870 MHz ~~ 960 MHz
56 * TCXO crystal to ensure RF performance on low temperature
57 * Maximum Power +22 dBm constant RF output
58 * High sensitivity: -148 dBm
59 * LoRa Tx Current: <90 mA at +17 dBm, 108 mA at +22 dBm
60 * LoRa Rx current: <9 mA
61
62 **WiFi:**
63
64 * 802.11b/g/n
65 * Up to 150 Mbps data rate in 802.11n mode
66 * Support A-MPDU and A-MSDU aggregation
67 * zero point four μ S protection interval
68 * Working channel center frequency range: 2412~~2484 MHz
69
70 **Bluetooth:**
71
72 * Bluetooth V4.2 BR/EDR and Bluetooth LE standard
73 * Class-1, Class-2, and Class-3 transmitters.
74 * AFH
75 * CVSD and SBC
76
77 **Display:**
78
79 * 5.0 Inch , 800 x 480
80 * IPS Capacitive Touch SCreen
81 * RGB color.
82 * Display Area: 120.7*75.80 mm
83
84 == 1.4  Power Consumption ==
85
86
87 * External 5V DC power adapter
88
89 == 1.5  Storage & Operation Temperature ==
90
91
92 * Operation Temperature: -20 ~~ 70°C  (No Dew)
93 * Storage Temperature: -30 ~~ 70°C  (No Dew)
94
95 == 1.6  Applications ==
96
97
98 * Smart Buildings & Home Automation
99 * Logistics and Supply Chain Management
100 * Smart Metering
101 * Smart Agriculture
102 * Smart Cities
103 * Smart Factory
104
105 = 2.  Getting Started with Hello World =
106
107 == 2.1  About this demo ==
108
109
110 In this Getting Started Example, we will show how to design a simple Display UI and upload it to LTS5. This UI has  a button , when user click the button. The Web UI will jump to a new page.
111
112
113 == 2.2  Install Software Running Environment ==
114
115 The ESP MCU can be developed using ESP-IDF, Arduino, or MicroPython. For this project, we utilize ESP-IDF for compilation and Visual Studio Code (VSCode) for editing.
116
117 === 2.2.1 Install VSCode and ESP-IDF extension ===
118
119
120 Firstly, download and install VSCode for your computer's operating system from the official website: [[Download Visual Studio Code - Mac, Linux, Windows>>url:https://code.visualstudio.com/download]].
121
122 Next, you need to install the ESP-IDF extension within VSCode. The detailed operation steps are illustrated in image 1.
123
124 [[image:image-20240928110211-5.png||height="508" width="866"]]
125
126 image 1 ESP-IDF extension install
127
128 Links for reference: [[Install ESP32 ESP-IDF on Windows and Integrate with VS code (esp32tutorials.com)>>url:https://esp32tutorials.com/install-esp32-esp-idf-windows-integrate-vs-code/#:~~:text=In%20this%20tutorial,%20we%20will%20show%20you%20how%20to%20install]]
129
130
131 === 2.2.2 Install SquareLine Studio ===
132
133
134 The version we are utilizing for this software is 1.4.2. You can download it from the official link: [[SquareLine Studio - Download the current version of SquareLine Studio>>url:https://squareline.io/downloads#lastRelease]].
135
136 Please note that this software necessitates the registration of a license prior to usage, and various licenses come with distinct limitations. For instance, the free version imposes restrictions such as a limit of 1 component, 150 widgets, and 10 screens. However, for first-time downloads, you are granted unrestricted access for a period of 30 days without the need for immediate registration.
137
138
139 == 2.3 Simple usage of SquareLine Studio and export UI code ==
140
141
142 After launching and logging in to this software, create a project as shown in the following image 2. The version of LVGL is 8.3.11.
143
144 [[image:image-20240928103357-2.png||height="680" width="708"]]
145
146 image 2 create a SquareLine project
147
148 Next, we need to make some settings for this project. By clicking in the specified order on image 3, we can see the page as shown in image 4.
149
150 [[image:1727229582471-566.png]]
151
152 image 3 project settings
153
154 [[image:image-20240928105309-4.png||height="526" width="556"]]
155
156 image 4 modify project settings
157
158 Now we can start to use this software. Here are some usage information for this software.
159
160 **~1. add widget**
161
162 To add a widget, you should click a widget you want to add at the area entitled “Widgets”. In image , demonstrate a add process of label, button, and image 5.
163
164 [[image:image-20240928111412-6.png||height="526" width="864"]]
165
166 image 5 add widgets
167
168 **2. modify widget**
169
170 The area for modifying widgets is called "Inspector". There are four parts in the "Inspector" tab. We use three of them more frequently, excluding "COMPONENT". The second part is aimed at adjusting the layout, size, position, alignment, flags, and states, etc. of widgets. The name of the second part indicates the type of widget it is representing, and in image 6, it is "BUTTON".
171
172 [[image:1727485118799-984.png]]
173
174 image 6 the button widget's "Inspector" tab
175
176 Second part: "Layout" means a auto position-management for widgets contained in the parent widget. "Transform" includes size, position and align modification.
177
178 [[image:1727485251053-655.png]]
179
180 image 7 the button widget's "BUTTON" tab
181
182 Third part: It is an area of style setting.
183
184 Fourth part: It is an area for adding events. In image 8, it is adding a click event to a button. If the button is clicked after the click event is added as shown in image 8, the current screen will fade into another specified screen, and the switching process will last 500ms.
185
186 [[image:1727485480434-713.png||height="395" width="290"]]
187
188 image 8 add event for button
189
190 **3. change label widget content**
191
192 Modify the content in text as shown in image 9, the text content of label widget will be changed accordingly.
193
194 [[image:image-20240928090825-1.png||height="327" width="391"]]
195
196 image 9 modify text content of label widget
197
198 **4. Add image into project**
199
200 To use the image widget, you should first add an image to your project. The image format must be PNG, and its resolution should not exceed 800x480 pixels. There are two ways to add an image file. One way is to move your image into the folder "…/squareline project/assets/", as shown in image 10. The other way is to click the "ADD FILE INTO ASSETS" button, then select an image from your computer to import. After adding, you can see the image in the "assets" area in SquareLine Studio, as demonstrated in image 11.
201
202 [[image:image-20240928113424-9.png||height="355" width="505"]]
203
204 image 10 add image file into SquareLine Studio project
205
206 [[image:image-20240928114139-10.png||height="559" width="810"]]
207
208 image 11 use image widget in SquareLine Studio
209
210 **5. The relationship between widgets**
211
212 There are two common relationships between widgets: one is parallel, the other is parent-child. The parallel relationship means that widgets' relative position is based on a collective object of reference. In parent-child relationship, the parts of the child object that are outside the boundaries of the parent object are not visible by default. Therefore, we need to adjust the position of the child object so that it falls within the range of the parent object, allowing it to be seen as illustrated in image 13.
213
214 [[image:1727486567182-334.png||height="318" width="278"]]
215
216 image 12 move label1 to make label1 widget be a child of button1 widget(1)
217
218 [[image:image-20240928112001-8.png||height="431" width="796"]]
219
220 image 13 move label1 to make label1 widget be a child of button1 widget(2)
221
222 **6. Preview the final effect**
223
224 An advantage of this kind of software is that you can edit the UI with quick previews. In other words, it provides a way of combining graphical programming with simulation immediately.
225
226 [[image:1727487368023-281.png]]
227
228 image 14 click on the triangle icon to start or end the simulation
229
230 For more detailed usage, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
231
232
233 == 2.4 Integrate UI Code to ESP-IDF Project ==
234
235
236 To achieve the integrating, we first need to export the UI code, then make some modifications, and finally relocate the UI code to a specific position within the project.
237
238 [[image:1727229798126-306.png]]
239
240 image 15 export UI file
241
242 [[image:1727229821582-258.png||height="333" width="662"]]
243
244 image 16 exported UI file
245
246 Create a empty directory entitled "ui" in path "basic_prj/app_components/ui/", and then copy all UI code exported to this directory.
247
248 [[image:image-20240928144830-11.png]]
249
250 image 17 open CMakeLists.txt
251
252 [[image:1727229892636-154.png||height="521" width="407"]]
253
254 image 18 modify CMakeLists.txt
255
256 The last step of integrating is adding two lines of code in main.c file.
257
258 [[image:1727229926561-300.png]]
259
260 image 19 add "ui.h"
261
262 [[image:1727229955611-607.png]]
263
264 image 20 add "ui_init()"
265
266
267 == 2.5 Brief introduction of hello world project ==
268
269
270 The project consists of two screens. The first screen displays the company's logo, the project name, and a button to navigate to the next screen. The second screen presents some information about this HMI screen product through an image and includes a button to return to the previous screen.
271
272
273 == 2.6 Test Result ==
274
275
276 By pressing the button lying bottom right, the screen can switch to another as expected. This indicates that the UI file has been successfully integrated into the project and is now effective.
277
278 [[image:1727488067077-684.png||height="402" width="574"]]
279
280 image 21 screen1
281
282 [[image:1727488157579-949.png||height="397" width="572"]]
283
284 image 22 screen2
285
286
287 = 3. Example Project 1: LoRa Central Display =
288
289 [[image:image-20240916101737-1.png||height="468" width="683"]]
290
291
292 = 4. Example Project 2: LoRaWAN RS485 Alarm =
293
294 = 5.  The way to add a new panel to project =
295
296 **~1. Design a panel in SquareLine Studio, using image 5.1 below as a reference.**
297
298 [[image:image-20241121113445-1.png||height="584" width="934"]]
299
300 image 5.1 a panel about water_leak
301
302 **2. Export the ui file.** You need  to adjust the export path first, then click "Export->Export UI Files". This step had been introduced before. Then you can get the ui files as shown in image 5.2.
303
304 [[image:image-20241121141120-4.png||height="383" width="795"]]
305
306 image 5.2 ui files exported
307
308 **3. Delete or rename some file.** Here are the steps:
309
310 Step1 Delete the 'components' directory.
311 Step2 Delete 'filelist.txt'.
312 Step3 Delete 'ui_helpers.c' and 'ui_helpers.h'.
313 Step4 Rename 'ui_ScreenMain.c' in the 'screens' directory to 'ui_water_leak_style.c'.
314 Step5 Rename the 'screens' directory to 'styles'.
315
316 [[image:image-20241121151934-10.png||height="303" width="792"]]
317
318 image 5.3 rest file (1)
319
320 [[image:image-20241121142925-7.png||height="141" width="793"]]
321
322 image 5.4 rest file (2)
323
324 **4. Open this project in vscode.**
325
326 5. Add file include path about water_leak in extra_lib/CMakeLists.txt as shown in image 5.5, 5.6, and its format is similar to the tem_hum or door.
327
328 [[image:image-20241121181957-17.png||height="438" width="516"]]
329
330 image 5.5 extra_lib/CMakeLists.txt before add
331
332 [[image:image-20241121182239-18.png||height="520" width="518"]]
333
334 image 5.6 extra_lib/CMakeLists.txt after add
335
336 **6. Modify header file include in fonts and images directory.** Open the fonts/ui_font_Font12.c file, as shown in image 5.7, then modify the '#include "../ui.h"' to '#include "../ui_water_leak.h"', the image 5.8 is the modified image. Other font file need to be modified in same way.
337
338 [[image:image-20241121171629-11.png]]
339
340 image 5.7 before-modified font file
341
342 [[image:image-20241121171901-12.png]]
343
344 image 5.8 modified font file
345
346 Open the images/ui_img_battery_empty_png.c file, as shown in image 5.9, then modify the '#include "../ui.h"' to '#include "../ui_water_leak.h"', the image 5.10 is the modified image. Other image file need to be modified in same way.
347
348 [[image:image-20241121172714-13.png]]
349
350 image 5.9 before-modified image file
351
352 [[image:image-20241121172908-14.png]]
353
354 image 5.10 modified image file
355
356 **7. Modify the ui_water_leak/CMakeLists.txt.** Open this file, and modify it from image 5.11 to image 5.12.
357
358 [[image:image-20241121180030-15.png]]
359
360 image 5.11 ui_water_leak/CMakeLists.txt before modification
361
362 [[image:image-20241121180517-16.png]]
363
364 image 5.12 ui_water_leak/CMakeLists.txt after modification
365
366 **8. Modify ui_water_leak.h file.** The image 5.13, 5.14 show the code before modification, and the image 5.15, 5.16 show the code after modification.
367
368 [[image:image-20241122094200-23.png]]
369
370 image 5.13 ui_water_leak.h (1) before modification
371
372 [[image:image-20241122094320-24.png||height="852" width="554"]]
373
374 image 5.14 ui_water_leak.h (2) before modification
375
376 [[image:image-20241122094600-25.png||height="1078" width="554"]]
377
378 image 5.15 ui_water_leak.h (1) after modification
379
380 [[image:image-20241122094719-26.png||height="941" width="583"]]
381
382 image 5.16 ui_water_leak.h (2) before modification
383
384 **9. Modify ui_water_leak.c file.** The image 5.17, 5.18, 5.19 show the code before modification, and the image 5.20, 5.21, 5.22 show the code after modification.
385
386 _ui_flag_modify( ((lv_obj_t *)(e->user_data)), LV_OBJ_FLAG_HIDDEN, _UI_MODIFY_FLAG_TOGGLE);  This code replaces 4 lines of code in ui_water_leak.c, so it is pasted here for convenience.
387
388 [[image:image-20241122102929-27.png||height="619" width="426"]]
389
390 image 5.17 ui_water_leak.c (1) before modification
391
392 [[image:image-20241122112838-30.png||height="551" width="628"]]
393
394 image 5.18 ui_water_leak.c (2) before modification
395
396 [[image:image-20241122110815-29.png||height="725" width="712"]]
397
398 image 5.19 ui_water_leak.c (3) before modification
399
400 [[image:image-20241122113158-31.png||height="872" width="677"]]
401
402 image 5.20 ui_water_leak.c (1) after modification
403
404 [[image:image-20241122113259-33.png||height="874" width="724"]]
405
406 image 5.21 ui_water_leak.c (2) after modification
407
408 [[image:image-20241122113359-34.png||height="804" width="746"]]
409
410 image 5.22 ui_water_leak.c (3) after modification
411
412 **10. Modify ui_water_leak_events.h file.** The image 5.23 show the code before modification, and the image 5.24 show the code after modification.
413
414 [[image:image-20241122134113-35.png||height="380" width="421"]]
415
416 image 5.23 ui_water_leak_events_.h before modification
417
418 [[image:image-20241122134420-37.png||height="201" width="283"]]
419
420 image 5.24 ui_water_leak_events_.h after modification
421
422 **11. Modify ui_water_leak_events.c file.** The image 5.25 show the code before modification, and the image 5.26 show the code after modification.
423
424 Step1. '#include "ui.h"'~-~->'#include "ui_water_leak.h"'
425
426 Step2. add code  below in delete_object() function definition.
427
428 panel_all * panel = find_upper_by_SensorPanel(&arr,((lv_obj_t *)(e->user_data~)~)~);
429
430 size_t index = panel->panel_obj_index;
431
432 deleteElement(&arr, index);
433
434 [[image:image-20241122135023-38.png||height="358" width="372"]]
435
436 image 5.25 ui_water_leak_events_.c before modification
437
438 [[image:image-20241122135258-39.png||height="403" width="559"]]
439
440 image 5.26 ui_water_leak_events_.c after modification
441
442 **12. Modify ui_water_leak_style.c file.**
443
444 Step1. '#include "../ui.h"'~-~->#include '"../ui_water_leak.h"'
445
446 add '#include "../../sort.h"'
447
448 add '#include "ui.h"'
449
450 [[image:image-20241122141536-41.png||height="361" width="612"]]
451
452 image 5.27 ui_water_leak_style.c (1) before modification
453
454 [[image:image-20241122142129-42.png||height="386" width="613"]]
455
456 image 5.28 ui_water_leak_style.c (1) after modification
457
458 Step2. modify 'void ui_ScreenMain_screen_init(void)'~-~->'panel_with_type create_water_leak(uint8_t index)'
459
460 delete code as shown in image 5.29
461
462 [[image:image-20241122145620-44.png||height="757" width="671"]]
463
464 image 5.29 ui_water_leak_style.c (2)
465
466 Step3. The image 5.30, 5.31 show the change.
467
468 [[image:image-20241122152026-45.png||height="277" width="828"]]
469
470 image 5.30 ui_water_leak_style.c (3) before modification
471
472 [[image:image-20241122152542-46.png||height="293" width="830"]]
473
474 image 5.31 ui_water_leak_style.c (3) after modification
475
476 Step4. Copy partly the code in ui_water_leak.c, paste at extra_lib/sort.h(The process is shown in image 5.32, 5.33).
477
478 [[image:image-20241122153958-47.png]]
479
480 image 5.32 ui_water_leak_style.c (4)
481
482 [[image:image-20241122154755-49.png||height="864" width="513"]]
483
484 image 5.33 ui_water_leak_style.c (4)
485
486 Step5. Delete event function in code which was just pasted in extra_lib/sort.h(The process is shown in image 5.34).
487
488 [[image:image-20241122155650-50.png||height="922" width="513"]]
489
490 image 5.34 ui_water_leak_style.c (5)
491
492 Step6. Add some lines of code in extra_lib/sort.h as shown in image 5.35.
493
494 [[image:image-20241122161934-51.png]]
495
496 image 5.35
497
498 Step7. Add a line of code in extra_lib/sort.h as shown in image 5.36.
499
500 [[image:image-20241122162852-53.png||height="330" width="529"]]
501
502 image 5.37
503
504 Step8. Add some code in ui_water_leak_style.c as shown in image 5.38 from line534 to line 576 in detail.
505
506 panel_with_type union_sensor;
507
508 union_sensor.panel_type = WATER_LEAK_TYPE;
509
510 ......
511
512 lv_obj_set_x(union_sensor.panel_union.door.ui_PanelSensorDoor, x_by_index(index));
513
514 lv_obj_set_y(union_sensor.panel_union.door.ui_PanelSensorDoor, y_by_index(index));
515
516 return union_sensor;
517
518 [[image:image-20241122171211-54.png||height="635" width="792"]]
519
520 image 5.38
521
522 **13. Modify sort.c file.**
523
524 Add a line of code ~-~-'#include "ui_water_leak.h"' as shown in image 5.39 line 16.
525
526 [[image:image-20241122173718-56.png||height="378" width="579"]]
527
528 image 5.39 sort.c (1)
529
530 There are still some changes need to be done in sort.c, and omit here for the moment.
531
532
533
534
535
536 = 6. FAQ =
537
538 == 6.1 ==
539
540
541 = 7. Order Info =
542
543 == 7.1  Part Number ==
544
545
546 Part Number: (% style="color:#4472c4" %)LTS5
547
548
549 == 7.2  Packing Info ==
550
551
552 **Package Includes**:
553
554 * LTS5 HMI Touch Screen
555 * 5V,2A DC Power Adapter.
556 * USB Type C Program Cable
557
558 = 8. Support =
559
560
561 * 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.
562 * Provide as much information as possible regarding your enquiry (product models, accurately describe your problem and steps to replicate it etc) and send a mail to [[support@dragino.com>>url:file:///D:/市场资料/说明书/LoRa/LT系列/support@dragino.com]].
563
564 = 9.  Reference material =
565
566
567 * Datasheet
568 * Source Code
569 * Mechinical
570
571 = 10. FCC Warning =
572
573
574 This device complies with part 15 of the FCC Rules.Operation is subject to the following two conditions:
575
576 (1) This device may not cause harmful interference;
577
578 (2) this device must accept any interference received,including interference that may cause undesired operation.
579
Copyright ©2010-2024 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0