Last modified by Dilisi S on 2025/02/26 19:24
<
From version < 113.3 >
edited by BoYang Xie
on 2024/11/22 18:05
To version < 133.2 >
edited by Xiaoling
on 2024/12/26 14:00
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.xieby
1 +XWiki.Xiaoling
Content
... ... @@ -1,12 +1,11 @@
1 +
2 +
1 1  (% style="text-align:center" %)
2 -[[image:image-20240915231842-1.png]]
4 +[[image:image-20241226135550-1.png]]
3 3  
4 4  
5 5  
6 6  
7 -
8 -
9 -
10 10  (% _mstvisible="1" %)
11 11  (% _msthash="315238" _msttexthash="18964465" _mstvisible="3" %)**Table of Contents:**
12 12  
... ... @@ -21,20 +21,20 @@
21 21  
22 22  = 1.  Introduction =
23 23  
24 -== 1.1  What is LTS5 LoRa HMI touch screen ==
23 +== 1.1  What is the LTS5 LoRa HMI Touch Screen? ==
25 25  
26 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.
26 +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 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.
28 +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 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.
30 +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 32  
33 -LTS5 use LA66 LoRa module, this module can be program to support private LoRa protocol or LoRaWAN protocol.
32 +The LA66 LoRa module can be programmed to support either private LoRa protocols or the LoRaWAN protocol.
34 34  
35 -
36 36  == 1.2  Features ==
37 37  
36 +
38 38  * ESP32-WROOM MCU: 8MB RAM & 16MB ROM
39 39  * Dragino LA66 LoRa Module
40 40  * Support Private LoRa protocol or LoRaWAN protocol
... ... @@ -47,7 +47,7 @@
47 47  * 5V DC power
48 48  * IP Rating: IP52
49 49  
50 -== 1.3  Specification ==
49 +== 1.3  Specifications ==
51 51  
52 52  
53 53  **LoRa**:
... ... @@ -102,28 +102,37 @@
102 102  * Smart Cities
103 103  * Smart Factory
104 104  
105 -= 2.  Getting Started with Hello World =
104 += 2.  Getting Started with 'Hello World' =
106 106  
107 107  == 2.1  About this demo ==
108 108  
109 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.
109 +This getting started example demonstrates how to design and deploy a simple display UI for the LTS5 device. The example includes:
111 111  
111 +* Creating a basic UI with a single button.
112 +* Implementing functionality to navigate the Web UI to a new page when the button is clicked.
113 +* Uploading the UI to the LTS5 device.
112 112  
115 +By completing this demo, you will gain foundational knowledge for customizing the LTS5 interface and building more advanced IoT applications.
116 +
117 +
113 113  == 2.2  Install Software Running Environment ==
114 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 116  
117 -=== 2.2.1 Install VSCode and ESP-IDF extension ===
121 +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.
118 118  
119 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]].
124 +=== 2.2.1 Install VS Code and ESP-IDF extension ===
121 121  
122 -Next, you need to install the ESP-IDF extension within VSCode. The detailed operation steps are illustrated in image 1.
123 123  
127 +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]].
128 +
129 +Next, install the **ESP-IDF** extension within **VS Code**. Detailed steps for this process are shown in Image 1.
130 +
131 +
124 124  [[image:image-20240928110211-5.png||height="508" width="866"]]
125 125  
126 - image 1 ESP-IDF extension install
134 + Image 1: ESP-IDF extension install
127 127  
128 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 129  
... ... @@ -131,109 +131,163 @@
131 131  === 2.2.2 Install SquareLine Studio ===
132 132  
133 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]].
142 +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.
135 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.
144 +[[image:squareline.io_downloads.png||height="888" width="1294"]]
137 137  
138 138  
139 -== 2.3 Simple usage of SquareLine Studio and export UI code ==
147 +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:
140 140  
149 +* Max. 10 screens
150 +* Max. 150 widgets
151 +* Max. 5 global colors
152 +* Max. 2 themes
153 +* Max. 1 component
141 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.
155 +== 2.3 Simple usage of SquareLine Studio and exporting UI code ==
143 143  
144 -[[image:image-20240928103357-2.png||height="680" width="708"]]
145 145  
146 - image 2 create a SquareLine project
158 +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**.
147 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.
160 +* In the **PROJECT SETTINGS**, select **LVGL version **as **8.3.11** and **Resolution** as **800** x **480**.
161 +* Select the **CREATE **button to create the new project with the selected settings.
149 149  
163 +[[image:squareline-studio-launcher-screen.png||height="752" width="1415"]]
164 +
165 +
166 +Next, you need to configure some additional settings for this project. To do so, select** File  -> Project Settings** as shown in the image below.
167 +
150 150  [[image:1727229582471-566.png]]
151 151  
152 - image 3 project settings
153 153  
171 +In the **PROJECT SETTINGS** dialog box, configure/modify the project settings as shown in the image below.
172 +
173 +* **UI Files Export Root**: Select a folder on your computer to store the UI files.
174 +* **LVGL Include Path**: Set this to **lvgl.h**
175 +* Click on the **APPLY CHANGES** button.
176 +
154 154  [[image:image-20240928105309-4.png||height="526" width="556"]]
155 155  
156 - image 4 modify project settings
157 157  
158 -Now we can start to use this software. Here are some usage information for this software.
180 +Now you can start building the user interface. Follow the steps below:
159 159  
160 -**~1. add widget**
161 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.
183 +=== **Add widgets** ===
163 163  
185 +
186 +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.
187 +
164 164  [[image:image-20240928111412-6.png||height="526" width="864"]]
165 165  
166 - image 5 add widgets
167 167  
168 -**2. modify widget**
191 +Then click the **Screen **widget to add the second screen. After adding the second screen, it will appear in the Screens panel as **Screen2**.
169 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".
193 +[[image:Screenshot 2024-12-24 140459.png||height="278" width="290"]]
171 171  
195 +=== **Modify widget properties** ===
196 +
197 +
198 +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.
199 +
172 172  [[image:1727485118799-984.png]]
173 173  
174 - image 6 the button widget's "Inspector" tab
175 175  
176 -Second part: "Layout" means a auto position-management for widgets contained in the parent widget. "Transform" includes size, position and align modification.
203 +==== **Changing the Button properties** ====
177 177  
205 +
206 +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:
207 +
208 +* **Flex Flow**: No Layout
209 +* **Transform**:
210 +** **X**: 331 px
211 +** **Y**: 203 px
212 +** **Width**: 100 px
213 +** **Height**: 50 px
214 +** **Align**: CENTER
215 +
178 178  [[image:1727485251053-655.png]]
179 179  
180 -image 7 the button widget's "BUTTON" tab
181 181  
182 -Third part: It is an area of style setting.
219 +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.
183 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.
221 +* Click **ADD EVENT** button. A new section will appear to configure this event.
185 185  
223 +[[image:Screenshot 2024-12-24 134937.png||height="80" width="290"]]
224 +
225 +* 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.
226 +
227 +[[image:Screenshot 2024-12-24 134818.png||height="222" width="290"]]
228 +
229 +* 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.
230 +* Finally, click the **ADD** button.
231 +
186 186  [[image:1727485480434-713.png||height="395" width="290"]]
187 187  
188 - image 8 add event for button
234 + Image 8: Add an event for the button
189 189  
190 -**3. change label widget content**
191 191  
192 -Modify the content in text as shown in image 9, the text content of label widget will be changed accordingly.
237 +==== **Changing the label properties** ====
193 193  
239 +
240 +Click the Label you have added to the screen. Under the **Label** section, type "**Click for Detail**" in the **Text** textbox.
241 +
194 194  [[image:image-20240928090825-1.png||height="327" width="391"]]
195 195  
196 - image 9 modify text content of label widget
197 197  
198 -**4. Add image into project**
245 +Once you enter the text, it will immediately appear on the label.
199 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 201  
248 +==== **Changing image properties** ====
249 +
250 +
251 +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.
252 +
253 +One way is to move your image into the folder "…/squareline project/assets/", as shown in the image below.
254 +
202 202  [[image:image-20240928113424-9.png||height="355" width="505"]]
203 203  
204 - image 10 add image file into SquareLine Studio project
205 205  
258 +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.
259 +
206 206  [[image:image-20240928114139-10.png||height="559" width="810"]]
207 207  
208 - image 11 use image widget in SquareLine Studio
209 209  
210 -**5. The relationship between widgets**
263 +==== **The relationship between widgets** ====
211 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 213  
266 +Widgets commonly have two types of relationships: **parallel** and **parent-child**.
267 +
268 +* In a **parallel relationship**, widgets' positions are determined relative to a shared reference object.
269 +* 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.
270 +
214 214  [[image:1727486567182-334.png||height="318" width="278"]]
215 215  
216 -image 12 move label1 to make label1 widget be a child of button1 widget(1)
217 217  
274 +Move the label, **Label1** to make it a child of **Button1** as shown in the image below.
275 +
218 218  [[image:image-20240928112001-8.png||height="431" width="796"]]
219 219  
220 - image 13 move label1 to make label1 widget be a child of button1 widget(2)
221 221  
222 -**6. Preview the final effect**
279 +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.
223 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.
281 +[[image:Screenshot 2024-12-24 144005.png||height="360" width="290"]]
225 225  
283 +
284 +==== **Preview the screen** ====
285 +
286 +
287 +You can test the result by clicking on the **PLAY** button as shown in the image below. The screen will change into play mode.
288 +
226 226  [[image:1727487368023-281.png]]
227 227  
228 - image 14 click on the triangle icon to start or end the simulation
229 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/]].
292 +For more information, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
231 231  
232 232  
233 233  == 2.4 Integrate UI Code to ESP-IDF Project ==
234 234  
235 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.
298 +To integrate, first export the UI code, then make some modifications, and finally relocate the UI code to a specific position within the project.
237 237  
238 238  [[image:1727229798126-306.png]]
239 239  
... ... @@ -253,6 +253,7 @@
253 253  
254 254   image 18 modify CMakeLists.txt
255 255  
318 +
256 256  The last step of integrating is adding two lines of code in main.c file.
257 257  
258 258  [[image:1727229926561-300.png]]
... ... @@ -291,8 +291,9 @@
291 291  
292 292  = 4. Example Project 2: LoRaWAN RS485 Alarm =
293 293  
294 -= 5.  The way to add a new panel to project =
357 += 5. The way to add a new panel to project =
295 295  
359 +
296 296  **~1. Design a panel in SquareLine Studio, using image 5.1 below as a reference.**
297 297  
298 298  [[image:image-20241121113445-1.png||height="584" width="934"]]
... ... @@ -299,6 +299,7 @@
299 299  
300 300   image 5.1 a panel about water_leak
301 301  
366 +
302 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 303  
304 304  [[image:image-20241121141120-4.png||height="383" width="795"]]
... ... @@ -305,6 +305,7 @@
305 305  
306 306   image 5.2 ui files exported
307 307  
373 +
308 308  **3. Delete or rename some file.** Here are the steps:
309 309  
310 310   Step1 Delete the 'components' directory.
... ... @@ -439,6 +439,7 @@
439 439  
440 440   image 5.26 ui_water_leak_events_.c after modification
441 441  
508 +
442 442  **12. Modify ui_water_leak_style.c file.**
443 443  
444 444  Step1. '#include "../ui.h"'~-~->#include '"../ui_water_leak.h"'
... ... @@ -455,6 +455,7 @@
455 455  
456 456   image 5.28 ui_water_leak_style.c (1) after modification
457 457  
525 +
458 458  Step2. modify 'void ui_ScreenMain_screen_init(void)'~-~->'panel_with_type create_water_leak(uint8_t index)'
459 459  
460 460   delete code as shown in image 5.29
... ... @@ -463,6 +463,7 @@
463 463  
464 464   image 5.29 ui_water_leak_style.c (2)
465 465  
534 +
466 466  Step3. The image 5.30, 5.31 show the change.
467 467  
468 468  [[image:image-20241122152026-45.png||height="277" width="828"]]
... ... @@ -473,6 +473,7 @@
473 473  
474 474   image 5.31 ui_water_leak_style.c (3) after modification
475 475  
545 +
476 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 477  
478 478  [[image:image-20241122153958-47.png]]
... ... @@ -483,6 +483,7 @@
483 483  
484 484   image 5.33 ui_water_leak_style.c (4)
485 485  
556 +
486 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 487  
488 488  [[image:image-20241122155650-50.png||height="922" width="513"]]
... ... @@ -489,6 +489,7 @@
489 489  
490 490   image 5.34 ui_water_leak_style.c (5)
491 491  
563 +
492 492  Step6. Add some lines of code in extra_lib/sort.h as shown in image 5.35.
493 493  
494 494  [[image:image-20241122161934-51.png]]
... ... @@ -495,6 +495,7 @@
495 495  
496 496   image 5.35
497 497  
570 +
498 498  Step7. Add a line of code in extra_lib/sort.h as shown in image 5.36.
499 499  
500 500  [[image:image-20241122162852-53.png||height="330" width="529"]]
... ... @@ -501,6 +501,7 @@
501 501  
502 502   image 5.37
503 503  
577 +
504 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 505  
506 506  panel_with_type union_sensor;
... ... @@ -519,6 +519,7 @@
519 519  
520 520   image 5.38
521 521  
596 +
522 522  **13. Modify sort.c file.**
523 523  
524 524  Add a line of code ~-~-'#include "ui_water_leak.h"' as shown in image 5.39 line 16.
... ... @@ -530,9 +530,6 @@
530 530  There are still some changes need to be done in sort.c, and omit here for the moment.
531 531  
532 532  
533 -
534 -
535 -
536 536  = 6. FAQ =
537 537  
538 538  == 6.1 ==
Screenshot 2024-12-24 134818.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +15.0 KB
Content
Screenshot 2024-12-24 134937.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +3.6 KB
Content
Screenshot 2024-12-24 140459.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +12.0 KB
Content
Screenshot 2024-12-24 144005.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +28.0 KB
Content
image-20241226135550-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Xiaoling
Size
... ... @@ -1,0 +1,1 @@
1 +293.3 KB
Content
squalreline-trial.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +60.4 KB
Content
squareline-studio-launcher-screen.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +203.4 KB
Content
squareline.io_downloads.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +1.5 MB
Content

Applications

Navigation

Copyright ©2010-2024 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0