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 the LTS5 LoRa HMI Touch Screen? ==
25
26
27 The LTS5 is a (% style="color:blue" %)**LoRa / LoRaWAN HMI Touch Screen**(%%) designed for displaying information in IoT projects. It features a **5.0-inch HMI touch screen** and supports **Wi-Fi**, **Bluetooth**, and **LoRa** wireless protocols.
28
29 The LTS5 is an open-source software project powered by an **ESP32 MCU** and a **Dragino LA66 LoRa** module. The extensive development resources available for ESP32 can significantly reduce development time.
30
31 The LTS5's HMI touch screen supports **drag-and-drop** design, allowing developers to use SquareLine to easily customize the display UI for various applications.
32
33 The LA66 LoRa module can be programmed to support either private LoRa protocols or the LoRaWAN protocol.
34
35 == 1.2  Features ==
36
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  Specifications ==
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 This getting started example demonstrates how to design and deploy a simple display UI for the LTS5 device. The example includes:
111
112 * Creating a basic UI with a single button.
113 * Implementing functionality to navigate the Web UI to a new page when the button is clicked.
114 * Uploading the UI to the LTS5 device.
115
116 By completing this demo, you will gain foundational knowledge for customizing the LTS5 interface and building more advanced IoT applications.
117
118
119 == 2.2  Install Software Running Environment ==
120
121
122 The **ESP MCU** supports development with **ESP-IDF**, **Arduino**, or **MicroPython**. We use **ESP-IDF** for compilation and **Visual Studio Code (VS Code)** as the development environment for this project.
123
124
125 === 2.2.1 Install VS Code and ESP-IDF extension ===
126
127
128 First, download and install **VS Code** for your operating system from the Visual Studio Code website: [[Visual Studio Code - Mac, Linux, Windows>>https://code.visualstudio.com/download]].
129
130 Next, install the **ESP-IDF** extension within **VS Code**. Detailed steps for this process are shown in Image 1.
131
132
133 [[image:image-20240928110211-5.png||height="508" width="866"]]
134
135 Image 1: ESP-IDF extension install
136
137 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]]
138
139
140 === 2.2.2 Install SquareLine Studio ===
141
142
143 Download and install the latest version of [[SquareLine Studio>>https://squareline.io/downloads#lastRelease]] on your computer. It supports Windows, Linux, and Mac OS. The software version we are using here is 1.5.0. See the image below.
144
145 [[image:squareline.io_downloads.png]]
146
147
148 After installation, you can use SquareLine Studio with a **PERSONAL license plan**. Click **LOG IN** and create a free account using your email address. Then activate your PERSONAL license plan for free. You don’t need to provide any credit card information. However, the PERSONAL license plan has the following limitations:
149
150 * Max. 10 screens
151 * Max. 150 widgets
152 * Max. 5 global colors
153 * Max. 2 themes
154 * Max. 1 component
155
156 == 2.3 Simple usage of SquareLine Studio and exporting UI code ==
157
158
159 Start the SquareLine Studio. The **launcher screen** appears as shown in the below image. You can create a new project by clicking **Create** in the top menu. Then select the **Desktop** tab. Select the development platform, **Eclipse with  SDL for development on PC**.
160
161 * In the **PROJECT SETTINGS**, select **LVGL version **as **8.3.11** and **Resolution** as **800** x **480**.
162 * Select the **CREATE **button to create the new project with the selected settings.
163
164
165 [[image:squareline-studio-launcher-screen.png]]
166
167
168
169 Next, you need to configure some additional settings for this project. To do so, select** File  -> Project Settings** as shown in the image below.
170
171 [[image:1727229582471-566.png]]
172
173
174 In the **PROJECT SETTINGS** dialog box, configure/modify the project settings as shown in the image below.
175
176 * **UI Files Export Root**: Select a folder on your computer to store the UI files.
177 * **LVGL Include Path**: Set this to **lvgl.h**
178 * Click on the **APPLY CHANGES** button.
179
180 [[image:image-20240928105309-4.png||height="526" width="556"]]
181
182
183 Now you can start building the user interface. Follow the steps below:
184
185
186 === **Add widgets** ===
187
188
189 To add a widget, navigate to the **Widgets** panel, and then click on the widget you want to add to the screen. You can reposition the widgets in the screen area by clicking and dragging them. Now add a **Label**, **Button**, and **Image** as shown in the image below. The added widgets are also displayed in the **Hierarchy **panel.
190
191 [[image:image-20240928111412-6.png||height="526" width="864"]]
192
193
194 Then click the **Screen **widget to add the second screen. After adding the second screen, it will appear in the Screens panel as **Screen2**.
195
196 [[image:Screenshot 2024-12-24 140459.png||height="278" width="290"]]
197
198 === **Modify widget properties** ===
199
200
201 The area for modifying widgets is called the **Inspector** panel. The Inspector panel consists of four sections: **COMPONENT**, **<WIDGET>**, **STYLE SETTINGS**, and **EVENTS**, as shown in the image below. The second section allows you to adjust a widget's layout, size, position, alignment, flags, states, and more. When you select a widget on the screen, the name of this section changes to match the name of the selected widget.
202
203 [[image:1727485118799-984.png]]
204
205
206 ==== **Changing the Button properties** ====
207
208
209 Click the **Button **you have added to the screen. Under the **Layout** you can change the button's position and size. Use the following settings:
210
211 * **Flex Flow**: No Layout
212 * **Transform**:
213 ** **X**: 331 px
214 ** **Y**: 203 px
215 ** **Width**: 100 px
216 ** **Height**: 50 px
217 ** **Align**: CENTER
218
219 [[image:1727485251053-655.png]]
220
221
222 Next, add a click event to the button. When the button is clicked, an event should trigger to change the current screen (Screen1) to a new screen (Screen2) with a fade effect and the transition from Screen1 to Screen2 should take 500ms.
223
224 * Click **ADD EVENT** button. A new section will appear to configure this event.
225
226 [[image:Screenshot 2024-12-24 134937.png||height="80" width="290"]]
227
228 * Select **CLICKED** from the dropdown under **Trigger**. Choose **CHANGE SCREEN** under **Action**, then click the **ADD** button. A new section will appear to configure the action.
229
230 [[image:Screenshot 2024-12-24 134818.png||height="222" width="290"]]
231
232 * Select **Screen2** under **Screen to**. Select **FADE ON** from **Fade mode**. The default value **500** means the transition takes 500 milliseconds to appear the Screen2.
233 * Finally, click the **ADD** button.
234
235 [[image:1727485480434-713.png||height="395" width="290"]]
236
237 Image 8: Add an event for the button
238
239
240 ==== **Changing the label properties** ====
241
242
243 Click the Label you have added to the screen. Under the **Label** section, type "**Click for Detail**" in the **Text** textbox.
244
245 [[image:image-20240928090825-1.png||height="327" width="391"]]
246
247
248 Once you enter the text, it will immediately appear on the label.
249
250
251 ==== **Changing image properties** ====
252
253
254 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.
255
256 One way is to move your image into the folder "…/squareline project/assets/", as shown in the image below.
257
258 [[image:image-20240928113424-9.png||height="355" width="505"]]
259
260
261 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**" panel in SquareLine Studio, as shown in the image below.
262
263 [[image:image-20240928114139-10.png||height="559" width="810"]]
264
265
266 ==== **The relationship between widgets** ====
267
268
269 Widgets commonly have two types of relationships: **parallel** and **parent-child**.
270
271 * In a **parallel relationship**, widgets' positions are determined relative to a shared reference object.
272 * In a **parent-child relationship**, any part of the child object outside the parent's boundaries is hidden by default. To make the child object fully visible, you must adjust its position to fit within the parent's range, as shown in Image 13.
273
274 [[image:1727486567182-334.png||height="318" width="278"]]
275
276
277 Move the label, **Label1** to make it a child of **Button1** as shown in the image below.
278
279 [[image:image-20240928112001-8.png||height="431" width="796"]]
280
281
282 Then set the **X** and **Y** position of the label to **0** as shown in the image below. The label will appear on the button. If you move the button on the screen, the label will move along with it as part of the button.
283
284 [[image:Screenshot 2024-12-24 144005.png||height="360" width="290"]]
285
286
287 ==== **Preview the screen** ====
288
289
290 You can test the result by clicking on the **PLAY** button. The screen will change into play mode. See Image 14.
291
292 [[image:1727487368023-281.png]]
293
294 Image 14: Simulating the project
295
296
297 For more information, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
298
299
300 == 2.4 Integrate UI Code to ESP-IDF Project ==
301
302
303 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.
304
305 [[image:1727229798126-306.png]]
306
307 image 15 export UI file
308
309 [[image:1727229821582-258.png||height="333" width="662"]]
310
311 image 16 exported UI file
312
313 Create a empty directory entitled "ui" in path "basic_prj/app_components/ui/", and then copy all UI code exported to this directory.
314
315 [[image:image-20240928144830-11.png]]
316
317 image 17 open CMakeLists.txt
318
319 [[image:1727229892636-154.png||height="521" width="407"]]
320
321 image 18 modify CMakeLists.txt
322
323 The last step of integrating is adding two lines of code in main.c file.
324
325 [[image:1727229926561-300.png]]
326
327 image 19 add "ui.h"
328
329 [[image:1727229955611-607.png]]
330
331 image 20 add "ui_init()"
332
333
334 == 2.5 Brief introduction of hello world project ==
335
336
337 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.
338
339
340 == 2.6 Test Result ==
341
342
343 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.
344
345 [[image:1727488067077-684.png||height="402" width="574"]]
346
347 image 21 screen1
348
349 [[image:1727488157579-949.png||height="397" width="572"]]
350
351 image 22 screen2
352
353
354 = 3. Example Project 1: LoRa Central Display =
355
356 [[image:image-20240916101737-1.png||height="468" width="683"]]
357
358
359 = 4. Example Project 2: LoRaWAN RS485 Alarm =
360
361 = 5. The way to add a new panel to project =
362
363
364 **~1. Design a panel in SquareLine Studio, using image 5.1 below as a reference.**
365
366 [[image:image-20241121113445-1.png||height="584" width="934"]]
367
368 image 5.1 a panel about water_leak
369
370
371 **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.
372
373 [[image:image-20241121141120-4.png||height="383" width="795"]]
374
375 image 5.2 ui files exported
376
377
378 **3. Delete or rename some file.** Here are the steps:
379
380 Step1 Delete the 'components' directory.
381 Step2 Delete 'filelist.txt'.
382 Step3 Delete 'ui_helpers.c' and 'ui_helpers.h'.
383 Step4 Rename 'ui_ScreenMain.c' in the 'screens' directory to 'ui_water_leak_style.c'.
384 Step5 Rename the 'screens' directory to 'styles'.
385
386 [[image:image-20241121151934-10.png||height="303" width="792"]]
387
388 image 5.3 rest file (1)
389
390 [[image:image-20241121142925-7.png||height="141" width="793"]]
391
392 image 5.4 rest file (2)
393
394 **4. Open this project in vscode.**
395
396 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.
397
398 [[image:image-20241121181957-17.png||height="438" width="516"]]
399
400 image 5.5 extra_lib/CMakeLists.txt before add
401
402 [[image:image-20241121182239-18.png||height="520" width="518"]]
403
404 image 5.6 extra_lib/CMakeLists.txt after add
405
406 **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.
407
408 [[image:image-20241121171629-11.png]]
409
410 image 5.7 before-modified font file
411
412 [[image:image-20241121171901-12.png]]
413
414 image 5.8 modified font file
415
416 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.
417
418 [[image:image-20241121172714-13.png]]
419
420 image 5.9 before-modified image file
421
422 [[image:image-20241121172908-14.png]]
423
424 image 5.10 modified image file
425
426 **7. Modify the ui_water_leak/CMakeLists.txt.** Open this file, and modify it from image 5.11 to image 5.12.
427
428 [[image:image-20241121180030-15.png]]
429
430 image 5.11 ui_water_leak/CMakeLists.txt before modification
431
432 [[image:image-20241121180517-16.png]]
433
434 image 5.12 ui_water_leak/CMakeLists.txt after modification
435
436 **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.
437
438 [[image:image-20241122094200-23.png]]
439
440 image 5.13 ui_water_leak.h (1) before modification
441
442 [[image:image-20241122094320-24.png||height="852" width="554"]]
443
444 image 5.14 ui_water_leak.h (2) before modification
445
446 [[image:image-20241122094600-25.png||height="1078" width="554"]]
447
448 image 5.15 ui_water_leak.h (1) after modification
449
450 [[image:image-20241122094719-26.png||height="941" width="583"]]
451
452 image 5.16 ui_water_leak.h (2) before modification
453
454 **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.
455
456 _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.
457
458 [[image:image-20241122102929-27.png||height="619" width="426"]]
459
460 image 5.17 ui_water_leak.c (1) before modification
461
462 [[image:image-20241122112838-30.png||height="551" width="628"]]
463
464 image 5.18 ui_water_leak.c (2) before modification
465
466 [[image:image-20241122110815-29.png||height="725" width="712"]]
467
468 image 5.19 ui_water_leak.c (3) before modification
469
470 [[image:image-20241122113158-31.png||height="872" width="677"]]
471
472 image 5.20 ui_water_leak.c (1) after modification
473
474 [[image:image-20241122113259-33.png||height="874" width="724"]]
475
476 image 5.21 ui_water_leak.c (2) after modification
477
478 [[image:image-20241122113359-34.png||height="804" width="746"]]
479
480 image 5.22 ui_water_leak.c (3) after modification
481
482 **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.
483
484 [[image:image-20241122134113-35.png||height="380" width="421"]]
485
486 image 5.23 ui_water_leak_events_.h before modification
487
488 [[image:image-20241122134420-37.png||height="201" width="283"]]
489
490 image 5.24 ui_water_leak_events_.h after modification
491
492 **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.
493
494 Step1. '#include "ui.h"'~-~->'#include "ui_water_leak.h"'
495
496 Step2. add code  below in delete_object() function definition.
497
498 panel_all * panel = find_upper_by_SensorPanel(&arr,((lv_obj_t *)(e->user_data~)~)~);
499
500 size_t index = panel->panel_obj_index;
501
502 deleteElement(&arr, index);
503
504 [[image:image-20241122135023-38.png||height="358" width="372"]]
505
506 image 5.25 ui_water_leak_events_.c before modification
507
508 [[image:image-20241122135258-39.png||height="403" width="559"]]
509
510 image 5.26 ui_water_leak_events_.c after modification
511
512
513 **12. Modify ui_water_leak_style.c file.**
514
515 Step1. '#include "../ui.h"'~-~->#include '"../ui_water_leak.h"'
516
517 add '#include "../../sort.h"'
518
519 add '#include "ui.h"'
520
521 [[image:image-20241122141536-41.png||height="361" width="612"]]
522
523 image 5.27 ui_water_leak_style.c (1) before modification
524
525 [[image:image-20241122142129-42.png||height="386" width="613"]]
526
527 image 5.28 ui_water_leak_style.c (1) after modification
528
529
530 Step2. modify 'void ui_ScreenMain_screen_init(void)'~-~->'panel_with_type create_water_leak(uint8_t index)'
531
532 delete code as shown in image 5.29
533
534 [[image:image-20241122145620-44.png||height="757" width="671"]]
535
536 image 5.29 ui_water_leak_style.c (2)
537
538
539 Step3. The image 5.30, 5.31 show the change.
540
541 [[image:image-20241122152026-45.png||height="277" width="828"]]
542
543 image 5.30 ui_water_leak_style.c (3) before modification
544
545 [[image:image-20241122152542-46.png||height="293" width="830"]]
546
547 image 5.31 ui_water_leak_style.c (3) after modification
548
549
550 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).
551
552 [[image:image-20241122153958-47.png]]
553
554 image 5.32 ui_water_leak_style.c (4)
555
556 [[image:image-20241122154755-49.png||height="864" width="513"]]
557
558 image 5.33 ui_water_leak_style.c (4)
559
560
561 Step5. Delete event function in code which was just pasted in extra_lib/sort.h(The process is shown in image 5.34).
562
563 [[image:image-20241122155650-50.png||height="922" width="513"]]
564
565 image 5.34 ui_water_leak_style.c (5)
566
567
568 Step6. Add some lines of code in extra_lib/sort.h as shown in image 5.35.
569
570 [[image:image-20241122161934-51.png]]
571
572 image 5.35
573
574
575 Step7. Add a line of code in extra_lib/sort.h as shown in image 5.36.
576
577 [[image:image-20241122162852-53.png||height="330" width="529"]]
578
579 image 5.37
580
581
582 Step8. Add some code in ui_water_leak_style.c as shown in image 5.38 from line534 to line 576 in detail.
583
584 panel_with_type union_sensor;
585
586 union_sensor.panel_type = WATER_LEAK_TYPE;
587
588 ......
589
590 lv_obj_set_x(union_sensor.panel_union.door.ui_PanelSensorDoor, x_by_index(index));
591
592 lv_obj_set_y(union_sensor.panel_union.door.ui_PanelSensorDoor, y_by_index(index));
593
594 return union_sensor;
595
596 [[image:image-20241122171211-54.png||height="635" width="792"]]
597
598 image 5.38
599
600
601 **13. Modify sort.c file.**
602
603 Add a line of code ~-~-'#include "ui_water_leak.h"' as shown in image 5.39 line 16.
604
605 [[image:image-20241122173718-56.png||height="378" width="579"]]
606
607 image 5.39 sort.c (1)
608
609 There are still some changes need to be done in sort.c, and omit here for the moment.
610
611
612 = 6. FAQ =
613
614 == 6.1 ==
615
616
617 = 7. Order Info =
618
619 == 7.1  Part Number ==
620
621
622 Part Number: (% style="color:#4472c4" %)LTS5
623
624
625 == 7.2  Packing Info ==
626
627
628 **Package Includes**:
629
630 * LTS5 HMI Touch Screen
631 * 5V,2A DC Power Adapter.
632 * USB Type C Program Cable
633
634 = 8. Support =
635
636
637 * 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.
638 * 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]].
639
640 = 9.  Reference material =
641
642
643 * Datasheet
644 * Source Code
645 * Mechinical
646
647 = 10. FCC Warning =
648
649
650 This device complies with part 15 of the FCC Rules.Operation is subject to the following two conditions:
651
652 (1) This device may not cause harmful interference;
653
654 (2) this device must accept any interference received,including interference that may cause undesired operation.
655
Copyright ©2010-2024 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0