Skip to Content
Last modified by Xiaoling on 2025/06/10 18:03
From version 134.1
edited by Xiaoling
on 2024/12/26 14:00
Change comment: There is no comment for this version
To version 123.1
edited by Dilisi S
on 2024/12/24 04:36
Change comment: Dec 23 edits - Part 1

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Xiaoling
1 +XWiki.pradeeka
Content
... ... @@ -1,11 +3,12 @@
1 -
2 -
3 3  (% style="text-align:center" %)
4 -[[image:image-20241226135550-1.png]]
2 +[[image:image-20240915231842-1.png]]
5 5  
6 6  
7 7  
8 8  
7 +
8 +
9 +
9 9  (% _mstvisible="1" %)
10 10  (% _msthash="315238" _msttexthash="18964465" _mstvisible="3" %)**Table of Contents:**
11 11  
... ... @@ -139,9 +139,9 @@
139 139  === 2.2.2 Install SquareLine Studio ===
140 140  
141 141  
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.
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.
143 143  
144 -[[image:squareline.io_downloads.png||height="888" width="1294"]]
145 +[[image:squareline.io_downloads.png]]
145 145  
146 146  
147 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:
... ... @@ -155,140 +155,137 @@
155 155  == 2.3 Simple usage of SquareLine Studio and exporting UI code ==
156 156  
157 157  
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**.
159 +After launching and logging into the software, create a new project as shown in Image 2.
159 159  
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.
161 +* Select the major **LVGL** version as **8.3**.
162 +* Select the **Desktop** tab.
163 +* Select  **Eclipse with  SDL for  development on PC**:
164 +* In the **PROJECT SETTINGS**, select **LVGL version** **8.3.11**
165 +* Select the **CREATE **button.
162 162  
163 -[[image:squareline-studio-launcher-screen.png||height="752" width="1415"]]
167 +[[image:image-20240928103357-2.png||height="680" width="708"]]
164 164  
169 + Image 2: Creating a new SquareLine project
165 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 167  
172 +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.
173 +
174 +* Select** File  -> Project Settings**
175 +
168 168  [[image:1727229582471-566.png]]
169 169  
178 + Image 3 accessing project settings
170 170  
171 -In the **PROJECT SETTINGS** dialog box, configure/modify the project settings as shown in the image below.
172 172  
181 +In the PROJECT SETTINGS dialog box, configure/modify the project settings:
182 +
173 173  * **UI Files Export Root**: Select a folder on your computer to store the UI files.
174 174  * **LVGL Include Path**: Set this to **lvgl.h**
175 -* Click on the **APPLY CHANGES** button.
185 +* **Click on the APPLY CHANGES button.**
176 176  
177 177  [[image:image-20240928105309-4.png||height="526" width="556"]]
178 178  
189 + Image 4 Configure/modify project settings
179 179  
180 -Now you can start building the user interface. Follow the steps below:
181 181  
192 +Now you can start building the sample UI. Follow the steps below:
182 182  
183 -=== **Add widgets** ===
184 184  
195 +=== Add widgets ===
185 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.
197 +To add widgets navigate to the **Widgets** area, then click on the widgets you want to add. The selected widgets will be added to the screen. You can reposition the widgets in the screen area by clicking and dragging them.
187 187  
199 +Add a Label, Button, and Image to the screen as shown in **Image 5**.
200 +
188 188  [[image:image-20240928111412-6.png||height="526" width="864"]]
189 189  
203 + Image 5: Add widgets
190 190  
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**.
205 +=== Modify widget properties ===
192 192  
193 -[[image:Screenshot 2024-12-24 140459.png||height="278" width="290"]]
207 +The area for modifying widgets is called the **Inspector** tab. The Inspector tab consists of four sections: **COMPONENT**, **<WIDGET>**, **STYLE SETTINGS**, and **EVENTS**, as shown in Image 6.
194 194  
195 -=== **Modify widget properties** ===
209 +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.
196 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 -
200 200  [[image:1727485118799-984.png]]
201 201  
213 + Image 6: The button widget's "Inspector" tab
202 202  
203 -==== **Changing the Button properties** ====
204 204  
216 +==== Changing the Button properties ====
205 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:
218 +Click the Button.
207 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
220 +Under the "Layout" you can change the button's position and size.
215 215  
216 216  [[image:1727485251053-655.png]]
217 217  
224 +Image 7: The button widget's "BUTTON" tab
218 218  
226 +
219 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.
220 220  
221 -* Click **ADD EVENT** button. A new section will appear to configure this event.
229 +* Click **ADD EVENT** button.
230 +* Select **CLICKED** under the Trigger.
231 +* Select **Screen2** from **Screen to**.
232 +* Select **FADE ON** from **Fade mode**.
233 +* Enter **500** in the **Speed** text box.
234 +* Finally, click **ADD** button.
222 222  
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 -
232 232  [[image:1727485480434-713.png||height="395" width="290"]]
233 233  
234 - Image 8: Add an event for the button
238 + Image 8: Add an event for the button
235 235  
236 236  
237 -==== **Changing the label properties** ====
241 +==== Changing the label properties ====
238 238  
243 +Click the label. Under the **Label** section, type "Click For Detail" in the **Text** textbox.
239 239  
240 -Click the Label you have added to the screen. Under the **Label** section, type "**Click for Detail**" in the **Text** textbox.
241 241  
242 242  [[image:image-20240928090825-1.png||height="327" width="391"]]
243 243  
248 + Image 9:  Modify text of label widget
244 244  
245 -Once you enter the text, it will immediately appear on the label.
246 246  
251 +==== 4. Changing image properties ====
247 247  
248 -==== **Changing image properties** ====
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. 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.
249 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 -
255 255  [[image:image-20240928113424-9.png||height="355" width="505"]]
256 256  
257 + image 10 add image file into SquareLine Studio project
257 257  
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 -
260 260  [[image:image-20240928114139-10.png||height="559" width="810"]]
261 261  
261 + image 11 use image widget in SquareLine Studio
262 262  
263 -==== **The relationship between widgets** ====
264 264  
264 +==== 5. The relationship between widgets ====
265 265  
266 266  Widgets commonly have two types of relationships: **parallel** and **parent-child**.
267 267  
268 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.
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, as shown in Image 13.
270 270  
271 271  [[image:1727486567182-334.png||height="318" width="278"]]
272 272  
273 273  
274 -Move the label, **Label1** to make it a child of **Button1** as shown in the image below.
274 +Move **Label1** to make it a child of **Button1**. See Image 13.
275 275  
276 276  [[image:image-20240928112001-8.png||height="431" width="796"]]
277 277  
278 + Image 13: Move Label1 to make it a child of Button1.
278 278  
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.
280 280  
281 -[[image:Screenshot 2024-12-24 144005.png||height="360" width="290"]]
281 +**6. Preview the screen**
282 282  
283 +You can test the result by clicking on the **PLAY** button. The screen will change into play mode. See Image 14.
283 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 -
289 289  [[image:1727487368023-281.png]]
290 290  
287 + Image 14: Simulating the project
291 291  
289 +
292 292  For more information, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
293 293  
294 294  
... ... @@ -295,7 +295,7 @@
295 295  == 2.4 Integrate UI Code to ESP-IDF Project ==
296 296  
297 297  
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.
296 +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.
299 299  
300 300  [[image:1727229798126-306.png]]
301 301  
... ... @@ -315,7 +315,6 @@
315 315  
316 316   image 18 modify CMakeLists.txt
317 317  
318 -
319 319  The last step of integrating is adding two lines of code in main.c file.
320 320  
321 321  [[image:1727229926561-300.png]]
... ... @@ -354,9 +354,8 @@
354 354  
355 355  = 4. Example Project 2: LoRaWAN RS485 Alarm =
356 356  
357 -= 5. The way to add a new panel to project =
354 += 5.  The way to add a new panel to project =
358 358  
359 -
360 360  **~1. Design a panel in SquareLine Studio, using image 5.1 below as a reference.**
361 361  
362 362  [[image:image-20241121113445-1.png||height="584" width="934"]]
... ... @@ -363,7 +363,6 @@
363 363  
364 364   image 5.1 a panel about water_leak
365 365  
366 -
367 367  **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.
368 368  
369 369  [[image:image-20241121141120-4.png||height="383" width="795"]]
... ... @@ -370,7 +370,6 @@
370 370  
371 371   image 5.2 ui files exported
372 372  
373 -
374 374  **3. Delete or rename some file.** Here are the steps:
375 375  
376 376   Step1 Delete the 'components' directory.
... ... @@ -505,7 +505,6 @@
505 505  
506 506   image 5.26 ui_water_leak_events_.c after modification
507 507  
508 -
509 509  **12. Modify ui_water_leak_style.c file.**
510 510  
511 511  Step1. '#include "../ui.h"'~-~->#include '"../ui_water_leak.h"'
... ... @@ -522,7 +522,6 @@
522 522  
523 523   image 5.28 ui_water_leak_style.c (1) after modification
524 524  
525 -
526 526  Step2. modify 'void ui_ScreenMain_screen_init(void)'~-~->'panel_with_type create_water_leak(uint8_t index)'
527 527  
528 528   delete code as shown in image 5.29
... ... @@ -531,7 +531,6 @@
531 531  
532 532   image 5.29 ui_water_leak_style.c (2)
533 533  
534 -
535 535  Step3. The image 5.30, 5.31 show the change.
536 536  
537 537  [[image:image-20241122152026-45.png||height="277" width="828"]]
... ... @@ -542,7 +542,6 @@
542 542  
543 543   image 5.31 ui_water_leak_style.c (3) after modification
544 544  
545 -
546 546  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).
547 547  
548 548  [[image:image-20241122153958-47.png]]
... ... @@ -553,7 +553,6 @@
553 553  
554 554   image 5.33 ui_water_leak_style.c (4)
555 555  
556 -
557 557  Step5. Delete event function in code which was just pasted in extra_lib/sort.h(The process is shown in image 5.34).
558 558  
559 559  [[image:image-20241122155650-50.png||height="922" width="513"]]
... ... @@ -560,7 +560,6 @@
560 560  
561 561   image 5.34 ui_water_leak_style.c (5)
562 562  
563 -
564 564  Step6. Add some lines of code in extra_lib/sort.h as shown in image 5.35.
565 565  
566 566  [[image:image-20241122161934-51.png]]
... ... @@ -567,7 +567,6 @@
567 567  
568 568   image 5.35
569 569  
570 -
571 571  Step7. Add a line of code in extra_lib/sort.h as shown in image 5.36.
572 572  
573 573  [[image:image-20241122162852-53.png||height="330" width="529"]]
... ... @@ -574,7 +574,6 @@
574 574  
575 575   image 5.37
576 576  
577 -
578 578  Step8. Add some code in ui_water_leak_style.c as shown in image 5.38 from line534 to line 576 in detail.
579 579  
580 580  panel_with_type union_sensor;
... ... @@ -593,7 +593,6 @@
593 593  
594 594   image 5.38
595 595  
596 -
597 597  **13. Modify sort.c file.**
598 598  
599 599  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
image-20241226135550-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Xiaoling
Size
... ... @@ -1,1 +1,0 @@
1 -293.3 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