Last modified by Dilisi S on 2025/02/26 19:24
<
From version < 122.1 >
edited by Dilisi S
on 2024/12/23 04:44
To version < 131.1 >
edited by Dilisi S
on 2024/12/24 21:45
>
Change comment: Dec 24 edits - part 2

Summary

Details

Page properties
Content
... ... @@ -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.4.2.
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 144  
145 145  [[image:squareline.io_downloads.png]]
146 146  
... ... @@ -156,129 +156,147 @@
156 156  == 2.3 Simple usage of SquareLine Studio and exporting UI code ==
157 157  
158 158  
159 -After launching and logging into the software, create a new project as shown in Image 2.
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 160  
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.
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.
166 166  
167 -[[image:image-20240928103357-2.png||height="680" width="708"]]
168 168  
169 - Image 2: Creating a new SquareLine project
165 +[[image:squareline-studio-launcher-screen.png]]
170 170  
171 171  
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 173  
174 -* Select** File  -> Project Settings**
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.
175 175  
176 176  [[image:1727229582471-566.png]]
177 177  
178 - Image 3 accessing project settings
179 179  
174 +In the **PROJECT SETTINGS** dialog box, configure/modify the project settings as shown in the image below.
180 180  
181 -In the PROJECT SETTINGS dialog box, configure/modify the project settings:
182 -
183 183  * **UI Files Export Root**: Select a folder on your computer to store the UI files.
184 184  * **LVGL Include Path**: Set this to **lvgl.h**
185 -* **Click on the APPLY CHANGES button.**
178 +* Click on the **APPLY CHANGES** button.
186 186  
187 187  [[image:image-20240928105309-4.png||height="526" width="556"]]
188 188  
189 - Image 4 Configure/modify project settings
190 190  
183 +Now you can start building the user interface. Follow the steps below:
191 191  
192 -Now you can start building the sample UI. Follow the steps below:
193 193  
186 +=== **Add widgets** ===
194 194  
195 -=== Add widgets ===
196 196  
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.
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.
198 198  
199 -Add a Label, Button, and Image to the screen as shown in **Image 5**.
200 -
201 201  [[image:image-20240928111412-6.png||height="526" width="864"]]
202 202  
203 - Image 5: Add widgets
204 204  
205 -=== Modify widget properties ===
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**.
206 206  
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.
196 +[[image:Screenshot 2024-12-24 140459.png||height="278" width="290"]]
208 208  
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.
198 +=== **Modify widget properties** ===
210 210  
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 +
211 211  [[image:1727485118799-984.png]]
212 212  
213 - Image 6: The button widget's "Inspector" tab
214 214  
206 +==== **Changing the Button properties** ====
215 215  
216 -==== Changing the Button properties ====
217 217  
218 -Click the Button. Under the **Label** section, type "Click for details..." in the **Text** textbox.
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:
219 219  
220 -Under the "Layout" you can
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
221 221  
222 222  [[image:1727485251053-655.png]]
223 223  
224 -image 7 the button widget's "BUTTON" tab
225 225  
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.
226 226  
227 -Third part: It is an area of style setting.
224 +* Click **ADD EVENT** button. A new section will appear to configure this event.
228 228  
229 -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.
226 +[[image:Screenshot 2024-12-24 134937.png||height="80" width="290"]]
230 230  
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 +
231 231  [[image:1727485480434-713.png||height="395" width="290"]]
232 232  
233 - image 8 add event for button
237 + Image 8: Add an event for the button
234 234  
235 235  
236 -==== Changing the label properties ====
240 +==== **Changing the label properties** ====
237 237  
238 -Click the label. Under the **Label** section, type "Hello World!" in the **Text** textbox.
239 239  
243 +Click the Label you have added to the screen. Under the **Label** section, type "**Click for Detail**" in the **Text** textbox.
240 240  
241 241  [[image:image-20240928090825-1.png||height="327" width="391"]]
242 242  
243 - Image 9:  Modify text of label widget
244 244  
248 +Once you enter the text, it will immediately appear on the label.
245 245  
246 -==== 4. Changing image properties ====
247 247  
248 -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.
251 +==== **Changing image properties** ====
249 249  
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 +
250 250  [[image:image-20240928113424-9.png||height="355" width="505"]]
251 251  
252 - image 10 add image file into SquareLine Studio project
253 253  
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 +
254 254  [[image:image-20240928114139-10.png||height="559" width="810"]]
255 255  
256 - image 11 use image widget in SquareLine Studio
257 257  
258 -**5. The relationship between widgets**
266 +==== **The relationship between widgets** ====
259 259  
260 -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.
261 261  
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 +
262 262  [[image:1727486567182-334.png||height="318" width="278"]]
263 263  
264 -image 12 move label1 to make label1 widget be a child of button1 widget(1)
265 265  
277 +Move the label, **Label1** to make it a child of **Button1** as shown in the image below.
278 +
266 266  [[image:image-20240928112001-8.png||height="431" width="796"]]
267 267  
268 - image 13 move label1 to make label1 widget be a child of button1 widget(2)
269 269  
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.
270 270  
271 -**6. Preview the screen**
284 +[[image:Screenshot 2024-12-24 144005.png||height="360" width="290"]]
272 272  
273 -You can test the result by clicking on the **PLAY** button. The screen will change into play mode.
274 274  
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 +
275 275  [[image:1727487368023-281.png]]
276 276  
277 - image 14 click on the triangle icon to start or end the simulation
294 + Image 14: Simulating the project
278 278  
279 -For more detailed usage, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
280 280  
297 +For more information, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
281 281  
299 +
282 282  == 2.4 Integrate UI Code to ESP-IDF Project ==
283 283  
284 284  
... ... @@ -340,8 +340,9 @@
340 340  
341 341  = 4. Example Project 2: LoRaWAN RS485 Alarm =
342 342  
343 -= 5.  The way to add a new panel to project =
361 += 5. The way to add a new panel to project =
344 344  
363 +
345 345  **~1. Design a panel in SquareLine Studio, using image 5.1 below as a reference.**
346 346  
347 347  [[image:image-20241121113445-1.png||height="584" width="934"]]
... ... @@ -348,6 +348,7 @@
348 348  
349 349   image 5.1 a panel about water_leak
350 350  
370 +
351 351  **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.
352 352  
353 353  [[image:image-20241121141120-4.png||height="383" width="795"]]
... ... @@ -354,6 +354,7 @@
354 354  
355 355   image 5.2 ui files exported
356 356  
377 +
357 357  **3. Delete or rename some file.** Here are the steps:
358 358  
359 359   Step1 Delete the 'components' directory.
... ... @@ -488,6 +488,7 @@
488 488  
489 489   image 5.26 ui_water_leak_events_.c after modification
490 490  
512 +
491 491  **12. Modify ui_water_leak_style.c file.**
492 492  
493 493  Step1. '#include "../ui.h"'~-~->#include '"../ui_water_leak.h"'
... ... @@ -504,6 +504,7 @@
504 504  
505 505   image 5.28 ui_water_leak_style.c (1) after modification
506 506  
529 +
507 507  Step2. modify 'void ui_ScreenMain_screen_init(void)'~-~->'panel_with_type create_water_leak(uint8_t index)'
508 508  
509 509   delete code as shown in image 5.29
... ... @@ -512,6 +512,7 @@
512 512  
513 513   image 5.29 ui_water_leak_style.c (2)
514 514  
538 +
515 515  Step3. The image 5.30, 5.31 show the change.
516 516  
517 517  [[image:image-20241122152026-45.png||height="277" width="828"]]
... ... @@ -522,6 +522,7 @@
522 522  
523 523   image 5.31 ui_water_leak_style.c (3) after modification
524 524  
549 +
525 525  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).
526 526  
527 527  [[image:image-20241122153958-47.png]]
... ... @@ -532,6 +532,7 @@
532 532  
533 533   image 5.33 ui_water_leak_style.c (4)
534 534  
560 +
535 535  Step5. Delete event function in code which was just pasted in extra_lib/sort.h(The process is shown in image 5.34).
536 536  
537 537  [[image:image-20241122155650-50.png||height="922" width="513"]]
... ... @@ -538,6 +538,7 @@
538 538  
539 539   image 5.34 ui_water_leak_style.c (5)
540 540  
567 +
541 541  Step6. Add some lines of code in extra_lib/sort.h as shown in image 5.35.
542 542  
543 543  [[image:image-20241122161934-51.png]]
... ... @@ -544,6 +544,7 @@
544 544  
545 545   image 5.35
546 546  
574 +
547 547  Step7. Add a line of code in extra_lib/sort.h as shown in image 5.36.
548 548  
549 549  [[image:image-20241122162852-53.png||height="330" width="529"]]
... ... @@ -550,6 +550,7 @@
550 550  
551 551   image 5.37
552 552  
581 +
553 553  Step8. Add some code in ui_water_leak_style.c as shown in image 5.38 from line534 to line 576 in detail.
554 554  
555 555  panel_with_type union_sensor;
... ... @@ -568,6 +568,7 @@
568 568  
569 569   image 5.38
570 570  
600 +
571 571  **13. Modify sort.c file.**
572 572  
573 573  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
squareline-studio-launcher-screen.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +203.4 KB
Content

Applications

Navigation

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