Last modified by Dilisi S on 2025/02/26 19:24
<
From version < 116.1 >
edited by Dilisi S
on 2024/12/17 21:42
To version < 133.1 >
edited by Xiaoling
on 2024/12/26 13:55
>
Change comment: Uploaded new attachment "image-20241226135550-1.png", version {1}

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.pradeeka
1 +XWiki.Xiaoling
Content
... ... @@ -102,30 +102,37 @@
102 102  * Smart Cities
103 103  * Smart Factory
104 104  
105 -= 2.  Getting Started with Hello World =
105 += 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.
110 +This getting started example demonstrates how to design and deploy a simple display UI for the LTS5 device. The example includes:
111 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.
112 112  
116 +By completing this demo, you will gain foundational knowledge for customizing the LTS5 interface and building more advanced IoT applications.
117 +
118 +
113 113  == 2.2  Install Software Running Environment ==
114 114  
115 115  
116 -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.
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.
117 117  
118 118  
119 -=== 2.2.1 Install VSCode and ESP-IDF extension ===
125 +=== 2.2.1 Install VS Code and ESP-IDF extension ===
120 120  
121 121  
122 -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]].
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]].
123 123  
124 -Next, you need to install the ESP-IDF extension within VSCode. The detailed operation steps are illustrated in image 1.
130 +Next, install the **ESP-IDF** extension within **VS Code**. Detailed steps for this process are shown in Image 1.
125 125  
132 +
126 126  [[image:image-20240928110211-5.png||height="508" width="866"]]
127 127  
128 - image 1 ESP-IDF extension install
135 + Image 1: ESP-IDF extension install
129 129  
130 130  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]]
131 131  
... ... @@ -133,109 +133,164 @@
133 133  === 2.2.2 Install SquareLine Studio ===
134 134  
135 135  
136 -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]].
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.
137 137  
138 -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.
145 +[[image:squareline.io_downloads.png]]
139 139  
140 140  
141 -== 2.3 Simple usage of SquareLine Studio and export UI code ==
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:
142 142  
150 +* Max. 10 screens
151 +* Max. 150 widgets
152 +* Max. 5 global colors
153 +* Max. 2 themes
154 +* Max. 1 component
143 143  
144 -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.
156 +== 2.3 Simple usage of SquareLine Studio and exporting UI code ==
145 145  
146 -[[image:image-20240928103357-2.png||height="680" width="708"]]
147 147  
148 - image 2 create a SquareLine project
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**.
149 149  
150 -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.
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.
151 151  
164 +[[image:squareline-studio-launcher-screen.png]]
165 +
166 +
167 +
168 +Next, you need to configure some additional settings for this project. To do so, select** File  -> Project Settings** as shown in the image below.
169 +
152 152  [[image:1727229582471-566.png]]
153 153  
154 - image 3 project settings
155 155  
173 +In the **PROJECT SETTINGS** dialog box, configure/modify the project settings as shown in the image below.
174 +
175 +* **UI Files Export Root**: Select a folder on your computer to store the UI files.
176 +* **LVGL Include Path**: Set this to **lvgl.h**
177 +* Click on the **APPLY CHANGES** button.
178 +
156 156  [[image:image-20240928105309-4.png||height="526" width="556"]]
157 157  
158 - image 4 modify project settings
159 159  
160 -Now we can start to use this software. Here are some usage information for this software.
182 +Now you can start building the user interface. Follow the steps below:
161 161  
162 -**~1. add widget**
163 163  
164 -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.
185 +=== **Add widgets** ===
165 165  
187 +
188 +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.
189 +
166 166  [[image:image-20240928111412-6.png||height="526" width="864"]]
167 167  
168 - image 5 add widgets
169 169  
170 -**2. modify widget**
193 +Then click the **Screen **widget to add the second screen. After adding the second screen, it will appear in the Screens panel as **Screen2**.
171 171  
172 -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".
195 +[[image:Screenshot 2024-12-24 140459.png||height="278" width="290"]]
173 173  
197 +=== **Modify widget properties** ===
198 +
199 +
200 +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.
201 +
174 174  [[image:1727485118799-984.png]]
175 175  
176 - image 6 the button widget's "Inspector" tab
177 177  
178 -Second part: "Layout" means a auto position-management for widgets contained in the parent widget. "Transform" includes size, position and align modification.
205 +==== **Changing the Button properties** ====
179 179  
207 +
208 +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:
209 +
210 +* **Flex Flow**: No Layout
211 +* **Transform**:
212 +** **X**: 331 px
213 +** **Y**: 203 px
214 +** **Width**: 100 px
215 +** **Height**: 50 px
216 +** **Align**: CENTER
217 +
180 180  [[image:1727485251053-655.png]]
181 181  
182 -image 7 the button widget's "BUTTON" tab
183 183  
184 -Third part: It is an area of style setting.
221 +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.
185 185  
186 -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.
223 +* Click **ADD EVENT** button. A new section will appear to configure this event.
187 187  
225 +[[image:Screenshot 2024-12-24 134937.png||height="80" width="290"]]
226 +
227 +* 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.
228 +
229 +[[image:Screenshot 2024-12-24 134818.png||height="222" width="290"]]
230 +
231 +* 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.
232 +* Finally, click the **ADD** button.
233 +
188 188  [[image:1727485480434-713.png||height="395" width="290"]]
189 189  
190 - image 8 add event for button
236 + Image 8: Add an event for the button
191 191  
192 -**3. change label widget content**
193 193  
194 -Modify the content in text as shown in image 9, the text content of label widget will be changed accordingly.
239 +==== **Changing the label properties** ====
195 195  
241 +
242 +Click the Label you have added to the screen. Under the **Label** section, type "**Click for Detail**" in the **Text** textbox.
243 +
196 196  [[image:image-20240928090825-1.png||height="327" width="391"]]
197 197  
198 - image 9 modify text content of label widget
199 199  
200 -**4. Add image into project**
247 +Once you enter the text, it will immediately appear on the label.
201 201  
202 -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.
203 203  
250 +==== **Changing image properties** ====
251 +
252 +
253 +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.
254 +
255 +One way is to move your image into the folder "…/squareline project/assets/", as shown in the image below.
256 +
204 204  [[image:image-20240928113424-9.png||height="355" width="505"]]
205 205  
206 - image 10 add image file into SquareLine Studio project
207 207  
260 +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.
261 +
208 208  [[image:image-20240928114139-10.png||height="559" width="810"]]
209 209  
210 - image 11 use image widget in SquareLine Studio
211 211  
212 -**5. The relationship between widgets**
265 +==== **The relationship between widgets** ====
213 213  
214 -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.
215 215  
268 +Widgets commonly have two types of relationships: **parallel** and **parent-child**.
269 +
270 +* In a **parallel relationship**, widgets' positions are determined relative to a shared reference object.
271 +* 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.
272 +
216 216  [[image:1727486567182-334.png||height="318" width="278"]]
217 217  
218 -image 12 move label1 to make label1 widget be a child of button1 widget(1)
219 219  
276 +Move the label, **Label1** to make it a child of **Button1** as shown in the image below.
277 +
220 220  [[image:image-20240928112001-8.png||height="431" width="796"]]
221 221  
222 - image 13 move label1 to make label1 widget be a child of button1 widget(2)
223 223  
224 -**6. Preview the final effect**
281 +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.
225 225  
226 -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.
283 +[[image:Screenshot 2024-12-24 144005.png||height="360" width="290"]]
227 227  
285 +
286 +==== **Preview the screen** ====
287 +
288 +
289 +You can test the result by clicking on the **PLAY** button as shown in the image below. The screen will change into play mode.
290 +
228 228  [[image:1727487368023-281.png]]
229 229  
230 - image 14 click on the triangle icon to start or end the simulation
231 231  
232 -For more detailed usage, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
294 +For more information, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
233 233  
234 234  
235 235  == 2.4 Integrate UI Code to ESP-IDF Project ==
236 236  
237 237  
238 -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.
300 +To integrate, first export the UI code, then make some modifications, and finally relocate the UI code to a specific position within the project.
239 239  
240 240  [[image:1727229798126-306.png]]
241 241  
... ... @@ -255,6 +255,7 @@
255 255  
256 256   image 18 modify CMakeLists.txt
257 257  
320 +
258 258  The last step of integrating is adding two lines of code in main.c file.
259 259  
260 260  [[image:1727229926561-300.png]]
... ... @@ -293,8 +293,9 @@
293 293  
294 294  = 4. Example Project 2: LoRaWAN RS485 Alarm =
295 295  
296 -= 5.  The way to add a new panel to project =
359 += 5. The way to add a new panel to project =
297 297  
361 +
298 298  **~1. Design a panel in SquareLine Studio, using image 5.1 below as a reference.**
299 299  
300 300  [[image:image-20241121113445-1.png||height="584" width="934"]]
... ... @@ -301,6 +301,7 @@
301 301  
302 302   image 5.1 a panel about water_leak
303 303  
368 +
304 304  **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.
305 305  
306 306  [[image:image-20241121141120-4.png||height="383" width="795"]]
... ... @@ -307,6 +307,7 @@
307 307  
308 308   image 5.2 ui files exported
309 309  
375 +
310 310  **3. Delete or rename some file.** Here are the steps:
311 311  
312 312   Step1 Delete the 'components' directory.
... ... @@ -441,6 +441,7 @@
441 441  
442 442   image 5.26 ui_water_leak_events_.c after modification
443 443  
510 +
444 444  **12. Modify ui_water_leak_style.c file.**
445 445  
446 446  Step1. '#include "../ui.h"'~-~->#include '"../ui_water_leak.h"'
... ... @@ -457,6 +457,7 @@
457 457  
458 458   image 5.28 ui_water_leak_style.c (1) after modification
459 459  
527 +
460 460  Step2. modify 'void ui_ScreenMain_screen_init(void)'~-~->'panel_with_type create_water_leak(uint8_t index)'
461 461  
462 462   delete code as shown in image 5.29
... ... @@ -465,6 +465,7 @@
465 465  
466 466   image 5.29 ui_water_leak_style.c (2)
467 467  
536 +
468 468  Step3. The image 5.30, 5.31 show the change.
469 469  
470 470  [[image:image-20241122152026-45.png||height="277" width="828"]]
... ... @@ -475,6 +475,7 @@
475 475  
476 476   image 5.31 ui_water_leak_style.c (3) after modification
477 477  
547 +
478 478  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).
479 479  
480 480  [[image:image-20241122153958-47.png]]
... ... @@ -485,6 +485,7 @@
485 485  
486 486   image 5.33 ui_water_leak_style.c (4)
487 487  
558 +
488 488  Step5. Delete event function in code which was just pasted in extra_lib/sort.h(The process is shown in image 5.34).
489 489  
490 490  [[image:image-20241122155650-50.png||height="922" width="513"]]
... ... @@ -491,6 +491,7 @@
491 491  
492 492   image 5.34 ui_water_leak_style.c (5)
493 493  
565 +
494 494  Step6. Add some lines of code in extra_lib/sort.h as shown in image 5.35.
495 495  
496 496  [[image:image-20241122161934-51.png]]
... ... @@ -497,6 +497,7 @@
497 497  
498 498   image 5.35
499 499  
572 +
500 500  Step7. Add a line of code in extra_lib/sort.h as shown in image 5.36.
501 501  
502 502  [[image:image-20241122162852-53.png||height="330" width="529"]]
... ... @@ -503,6 +503,7 @@
503 503  
504 504   image 5.37
505 505  
579 +
506 506  Step8. Add some code in ui_water_leak_style.c as shown in image 5.38 from line534 to line 576 in detail.
507 507  
508 508  panel_with_type union_sensor;
... ... @@ -521,6 +521,7 @@
521 521  
522 522   image 5.38
523 523  
598 +
524 524  **13. Modify sort.c file.**
525 525  
526 526  Add a line of code ~-~-'#include "ui_water_leak.h"' as shown in image 5.39 line 16.
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