Skip to Content
Last modified by Xiaoling on 2025/06/10 18:03
From version 131.1
edited by Dilisi S
on 2024/12/24 21:45
Change comment: Dec 24 edits - part 2
To version 121.1
edited by Dilisi S
on 2024/12/22 21:12
Change comment: Dec 22 edits - part 2

Summary

Details

Page properties
Content
... ... @@ -102,7 +102,7 @@
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  
... ... @@ -140,7 +140,7 @@
140 140  === 2.2.2 Install SquareLine Studio ===
141 141  
142 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.
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.4.2.
144 144  
145 145  [[image:squareline.io_downloads.png]]
146 146  
... ... @@ -153,150 +153,120 @@
153 153  * Max. 2 themes
154 154  * Max. 1 component
155 155  
156 +
156 156  == 2.3 Simple usage of SquareLine Studio and exporting UI code ==
157 157  
158 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 +After launching and logging into the software, create a new project as shown in Image 2.
160 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.
162 +* Select the major **LVGL** version as **8.3**.
163 +* Select the **Desktop** tab.
164 +* Select  **Eclipse with  SDL for  development on PC**:
165 +* In the **PROJECT SETTINGS**, select **LVGL version** **8.3.11**
166 +* Select the **CREATE **button.
163 163  
164 164  
165 -[[image:squareline-studio-launcher-screen.png]]
169 +[[image:image-20240928103357-2.png||height="680" width="708"]]
166 166  
171 + Image 2: Creating a new SquareLine project
167 167  
168 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.
174 +Next, you need to configure some settings for this project. By clicking in the specified order shown in Image 3, you will be directed to the page displayed in Image 4.
170 170  
176 +* Select File  -> Project Settings
177 +
171 171  [[image:1727229582471-566.png]]
172 172  
180 + Image 3 accessing project settings
173 173  
174 -In the **PROJECT SETTINGS** dialog box, configure/modify the project settings as shown in the image below.
175 175  
183 +In the PROJECT SETTINGS dialog box, configure/modify the project settings:
184 +
176 176  * **UI Files Export Root**: Select a folder on your computer to store the UI files.
177 177  * **LVGL Include Path**: Set this to **lvgl.h**
178 -* Click on the **APPLY CHANGES** button.
187 +* **Click on the APPLY CHANGES button.**
179 179  
180 180  [[image:image-20240928105309-4.png||height="526" width="556"]]
181 181  
191 + Image 4 Configure/modify project settings
182 182  
183 -Now you can start building the user interface. Follow the steps below:
184 184  
194 +Now you can start building the UI. Follow the steps below:
185 185  
186 -=== **Add widgets** ===
187 187  
197 +**~1. add widget**
188 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.
199 +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.
190 190  
191 191  [[image:image-20240928111412-6.png||height="526" width="864"]]
192 192  
203 + image 5 add widgets
193 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**.
205 +**2. modify widget**
195 195  
196 -[[image:Screenshot 2024-12-24 140459.png||height="278" width="290"]]
207 +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".
197 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 203  [[image:1727485118799-984.png]]
204 204  
211 + image 6 the button widget's "Inspector" tab
205 205  
206 -==== **Changing the Button properties** ====
213 +Second part: "Layout" means a auto position-management for widgets contained in the parent widget. "Transform" includes size, position and align modification.
207 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 219  [[image:1727485251053-655.png]]
220 220  
217 +image 7 the button widget's "BUTTON" tab
221 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.
219 +Third part: It is an area of style setting.
223 223  
224 -* Click **ADD EVENT** button. A new section will appear to configure this event.
221 +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.
225 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 235  [[image:1727485480434-713.png||height="395" width="290"]]
236 236  
237 - Image 8: Add an event for the button
225 + image 8 add event for button
238 238  
227 +**3. change label widget content**
239 239  
240 -==== **Changing the label properties** ====
229 +Modify the content in text as shown in image 9, the text content of label widget will be changed accordingly.
241 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 245  [[image:image-20240928090825-1.png||height="327" width="391"]]
246 246  
233 + image 9 modify text content of label widget
247 247  
248 -Once you enter the text, it will immediately appear on the label.
235 +**4. Add image into project**
249 249  
237 +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.
250 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 258  [[image:image-20240928113424-9.png||height="355" width="505"]]
259 259  
241 + image 10 add image file into SquareLine Studio project
260 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 263  [[image:image-20240928114139-10.png||height="559" width="810"]]
264 264  
245 + image 11 use image widget in SquareLine Studio
265 265  
266 -==== **The relationship between widgets** ====
247 +**5. The relationship between widgets**
267 267  
249 +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.
268 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 274  [[image:1727486567182-334.png||height="318" width="278"]]
275 275  
253 +image 12 move label1 to make label1 widget be a child of button1 widget(1)
276 276  
277 -Move the label, **Label1** to make it a child of **Button1** as shown in the image below.
278 -
279 279  [[image:image-20240928112001-8.png||height="431" width="796"]]
280 280  
257 + image 13 move label1 to make label1 widget be a child of button1 widget(2)
281 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.
259 +**6. Preview the final effect**
283 283  
284 -[[image:Screenshot 2024-12-24 144005.png||height="360" width="290"]]
261 +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.
285 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 292  [[image:1727487368023-281.png]]
293 293  
294 - Image 14: Simulating the project
265 + image 14 click on the triangle icon to start or end the simulation
295 295  
267 +For more detailed usage, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
296 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 298  
299 -
300 300  == 2.4 Integrate UI Code to ESP-IDF Project ==
301 301  
302 302  
... ... @@ -358,9 +358,8 @@
358 358  
359 359  = 4. Example Project 2: LoRaWAN RS485 Alarm =
360 360  
361 -= 5. The way to add a new panel to project =
331 += 5.  The way to add a new panel to project =
362 362  
363 -
364 364  **~1. Design a panel in SquareLine Studio, using image 5.1 below as a reference.**
365 365  
366 366  [[image:image-20241121113445-1.png||height="584" width="934"]]
... ... @@ -367,7 +367,6 @@
367 367  
368 368   image 5.1 a panel about water_leak
369 369  
370 -
371 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 372  
373 373  [[image:image-20241121141120-4.png||height="383" width="795"]]
... ... @@ -374,7 +374,6 @@
374 374  
375 375   image 5.2 ui files exported
376 376  
377 -
378 378  **3. Delete or rename some file.** Here are the steps:
379 379  
380 380   Step1 Delete the 'components' directory.
... ... @@ -509,7 +509,6 @@
509 509  
510 510   image 5.26 ui_water_leak_events_.c after modification
511 511  
512 -
513 513  **12. Modify ui_water_leak_style.c file.**
514 514  
515 515  Step1. '#include "../ui.h"'~-~->#include '"../ui_water_leak.h"'
... ... @@ -526,7 +526,6 @@
526 526  
527 527   image 5.28 ui_water_leak_style.c (1) after modification
528 528  
529 -
530 530  Step2. modify 'void ui_ScreenMain_screen_init(void)'~-~->'panel_with_type create_water_leak(uint8_t index)'
531 531  
532 532   delete code as shown in image 5.29
... ... @@ -535,7 +535,6 @@
535 535  
536 536   image 5.29 ui_water_leak_style.c (2)
537 537  
538 -
539 539  Step3. The image 5.30, 5.31 show the change.
540 540  
541 541  [[image:image-20241122152026-45.png||height="277" width="828"]]
... ... @@ -546,7 +546,6 @@
546 546  
547 547   image 5.31 ui_water_leak_style.c (3) after modification
548 548  
549 -
550 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 551  
552 552  [[image:image-20241122153958-47.png]]
... ... @@ -557,7 +557,6 @@
557 557  
558 558   image 5.33 ui_water_leak_style.c (4)
559 559  
560 -
561 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 562  
563 563  [[image:image-20241122155650-50.png||height="922" width="513"]]
... ... @@ -564,7 +564,6 @@
564 564  
565 565   image 5.34 ui_water_leak_style.c (5)
566 566  
567 -
568 568  Step6. Add some lines of code in extra_lib/sort.h as shown in image 5.35.
569 569  
570 570  [[image:image-20241122161934-51.png]]
... ... @@ -571,7 +571,6 @@
571 571  
572 572   image 5.35
573 573  
574 -
575 575  Step7. Add a line of code in extra_lib/sort.h as shown in image 5.36.
576 576  
577 577  [[image:image-20241122162852-53.png||height="330" width="529"]]
... ... @@ -578,7 +578,6 @@
578 578  
579 579   image 5.37
580 580  
581 -
582 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 583  
584 584  panel_with_type union_sensor;
... ... @@ -597,7 +597,6 @@
597 597  
598 598   image 5.38
599 599  
600 -
601 601  **13. Modify sort.c file.**
602 602  
603 603  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,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -15.0 KB
Content
Screenshot 2024-12-24 134937.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -3.6 KB
Content
Screenshot 2024-12-24 140459.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -12.0 KB
Content
Screenshot 2024-12-24 144005.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -28.0 KB
Content
squareline-studio-launcher-screen.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -203.4 KB
Content