<
From version < 120.1 >
edited by Dilisi S
on 2024/12/22 15:47
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,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,115 +140,164 @@
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  
147 147  
148 -After installation, you can use SquareLine Studio as a trial version for 30 days without activation. Click **CONTINUE WITH TRIAL** to use the trial version, or click **LOG IN** to activate the software with your license key.
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:
149 149  
150 -[[image:squalreline-trial.png||height="602" width="400"]]
150 +* Max. 10 screens
151 +* Max. 150 widgets
152 +* Max. 5 global colors
153 +* Max. 2 themes
154 +* Max. 1 component
151 151  
152 -The free version restricts usage to 1 component, 150 widgets, and 10 screens.
156 +== 2.3 Simple usage of SquareLine Studio and exporting UI code ==
153 153  
154 -== 2.3 Simple usage of SquareLine Studio and export UI code ==
155 155  
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**.
156 156  
157 -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.
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.
158 158  
159 -[[image:image-20240928103357-2.png||height="680" width="708"]]
164 +[[image:squareline-studio-launcher-screen.png]]
160 160  
161 - image 2 create a SquareLine project
162 162  
163 -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.
164 164  
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 +
165 165  [[image:1727229582471-566.png]]
166 166  
167 - image 3 project settings
168 168  
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 +
169 169  [[image:image-20240928105309-4.png||height="526" width="556"]]
170 170  
171 - image 4 modify project settings
172 172  
173 -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:
174 174  
175 -**~1. add widget**
176 176  
177 -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** ===
178 178  
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 +
179 179  [[image:image-20240928111412-6.png||height="526" width="864"]]
180 180  
181 - image 5 add widgets
182 182  
183 -**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**.
184 184  
185 -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"]]
186 186  
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 +
187 187  [[image:1727485118799-984.png]]
188 188  
189 - image 6 the button widget's "Inspector" tab
190 190  
191 -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** ====
192 192  
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 +
193 193  [[image:1727485251053-655.png]]
194 194  
195 -image 7 the button widget's "BUTTON" tab
196 196  
197 -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.
198 198  
199 -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.
200 200  
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 +
201 201  [[image:1727485480434-713.png||height="395" width="290"]]
202 202  
203 - image 8 add event for button
236 + Image 8: Add an event for the button
204 204  
205 -**3. change label widget content**
206 206  
207 -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** ====
208 208  
241 +
242 +Click the Label you have added to the screen. Under the **Label** section, type "**Click for Detail**" in the **Text** textbox.
243 +
209 209  [[image:image-20240928090825-1.png||height="327" width="391"]]
210 210  
211 - image 9 modify text content of label widget
212 212  
213 -**4. Add image into project**
247 +Once you enter the text, it will immediately appear on the label.
214 214  
215 -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.
216 216  
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 +
217 217  [[image:image-20240928113424-9.png||height="355" width="505"]]
218 218  
219 - image 10 add image file into SquareLine Studio project
220 220  
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 +
221 221  [[image:image-20240928114139-10.png||height="559" width="810"]]
222 222  
223 - image 11 use image widget in SquareLine Studio
224 224  
225 -**5. The relationship between widgets**
265 +==== **The relationship between widgets** ====
226 226  
227 -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.
228 228  
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 +
229 229  [[image:1727486567182-334.png||height="318" width="278"]]
230 230  
231 -image 12 move label1 to make label1 widget be a child of button1 widget(1)
232 232  
276 +Move the label, **Label1** to make it a child of **Button1** as shown in the image below.
277 +
233 233  [[image:image-20240928112001-8.png||height="431" width="796"]]
234 234  
235 - image 13 move label1 to make label1 widget be a child of button1 widget(2)
236 236  
237 -**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.
238 238  
239 -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"]]
240 240  
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 +
241 241  [[image:1727487368023-281.png]]
242 242  
243 - image 14 click on the triangle icon to start or end the simulation
244 244  
245 -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/]].
246 246  
247 247  
248 248  == 2.4 Integrate UI Code to ESP-IDF Project ==
249 249  
250 250  
251 -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.
252 252  
253 253  [[image:1727229798126-306.png]]
254 254  
... ... @@ -268,6 +268,7 @@
268 268  
269 269   image 18 modify CMakeLists.txt
270 270  
320 +
271 271  The last step of integrating is adding two lines of code in main.c file.
272 272  
273 273  [[image:1727229926561-300.png]]
... ... @@ -306,8 +306,9 @@
306 306  
307 307  = 4. Example Project 2: LoRaWAN RS485 Alarm =
308 308  
309 -= 5.  The way to add a new panel to project =
359 += 5. The way to add a new panel to project =
310 310  
361 +
311 311  **~1. Design a panel in SquareLine Studio, using image 5.1 below as a reference.**
312 312  
313 313  [[image:image-20241121113445-1.png||height="584" width="934"]]
... ... @@ -314,6 +314,7 @@
314 314  
315 315   image 5.1 a panel about water_leak
316 316  
368 +
317 317  **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.
318 318  
319 319  [[image:image-20241121141120-4.png||height="383" width="795"]]
... ... @@ -320,6 +320,7 @@
320 320  
321 321   image 5.2 ui files exported
322 322  
375 +
323 323  **3. Delete or rename some file.** Here are the steps:
324 324  
325 325   Step1 Delete the 'components' directory.
... ... @@ -454,6 +454,7 @@
454 454  
455 455   image 5.26 ui_water_leak_events_.c after modification
456 456  
510 +
457 457  **12. Modify ui_water_leak_style.c file.**
458 458  
459 459  Step1. '#include "../ui.h"'~-~->#include '"../ui_water_leak.h"'
... ... @@ -470,6 +470,7 @@
470 470  
471 471   image 5.28 ui_water_leak_style.c (1) after modification
472 472  
527 +
473 473  Step2. modify 'void ui_ScreenMain_screen_init(void)'~-~->'panel_with_type create_water_leak(uint8_t index)'
474 474  
475 475   delete code as shown in image 5.29
... ... @@ -478,6 +478,7 @@
478 478  
479 479   image 5.29 ui_water_leak_style.c (2)
480 480  
536 +
481 481  Step3. The image 5.30, 5.31 show the change.
482 482  
483 483  [[image:image-20241122152026-45.png||height="277" width="828"]]
... ... @@ -488,6 +488,7 @@
488 488  
489 489   image 5.31 ui_water_leak_style.c (3) after modification
490 490  
547 +
491 491  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).
492 492  
493 493  [[image:image-20241122153958-47.png]]
... ... @@ -498,6 +498,7 @@
498 498  
499 499   image 5.33 ui_water_leak_style.c (4)
500 500  
558 +
501 501  Step5. Delete event function in code which was just pasted in extra_lib/sort.h(The process is shown in image 5.34).
502 502  
503 503  [[image:image-20241122155650-50.png||height="922" width="513"]]
... ... @@ -504,6 +504,7 @@
504 504  
505 505   image 5.34 ui_water_leak_style.c (5)
506 506  
565 +
507 507  Step6. Add some lines of code in extra_lib/sort.h as shown in image 5.35.
508 508  
509 509  [[image:image-20241122161934-51.png]]
... ... @@ -510,6 +510,7 @@
510 510  
511 511   image 5.35
512 512  
572 +
513 513  Step7. Add a line of code in extra_lib/sort.h as shown in image 5.36.
514 514  
515 515  [[image:image-20241122162852-53.png||height="330" width="529"]]
... ... @@ -516,6 +516,7 @@
516 516  
517 517   image 5.37
518 518  
579 +
519 519  Step8. Add some code in ui_water_leak_style.c as shown in image 5.38 from line534 to line 576 in detail.
520 520  
521 521  panel_with_type union_sensor;
... ... @@ -534,6 +534,7 @@
534 534  
535 535   image 5.38
536 536  
598 +
537 537  **13. Modify sort.c file.**
538 538  
539 539  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
squareline-studio-launcher-screen.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +203.4 KB
Content
Copyright ©2010-2024 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0