Summary

• Page properties (1 modified, 0 added, 0 removed)

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,115 +140,78 @@
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
147	147
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:
	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.
149	149
150		-* Max. 10 screens
151		-* Max. 150 widgets
152		-* Max. 5 global colors
153		-* Max. 2 themes
154		-* Max. 1 component
	150	+[[image:squalreline-trial.png||height="602" width="400"]]
155	155
156		-== 2.3 Simple usage of SquareLine Studio and exporting UI code ==
	152	+The free version restricts usage to 1 component, 150 widgets, and 10 screens.
157	157
	154	+== 2.3 Simple usage of SquareLine Studio and export UI code ==
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.
160	160
161		-* Select major **LVGL** version: **8.3**.
162		-* Select the **Desktop** tab.
163		-* Select  **Eclipse with  SDL for  development on PC**:
164		-* In the **PROJECT SETTINGS**, select **LVGL version **as **8.3.11** and **Resolution** as **800** x **480**.
165		-* Select the **CREATE **button to create the new project with the selected settings.
	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.
166	166
167	167	[[image:image-20240928103357-2.png||height="680" width="708"]]
168	168
	161	+ image 2 create a SquareLine project
169	169
170		-Next, you need to configure some additional settings for this project. Select** File  -> Project Settings** as shown in the image below.
	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.
171	171
172	172	[[image:1727229582471-566.png]]
173	173
	167	+ image 3 project settings
174	174
175		-In the PROJECT SETTINGS dialog box, configure/modify the project settings:
176		-
177		-* **UI Files Export Root**: Select a folder on your computer to store the UI files.
178		-* **LVGL Include Path**: Set this to **lvgl.h**
179		-* **Click on the APPLY CHANGES button.**
180		-
181	181	[[image:image-20240928105309-4.png||height="526" width="556"]]
182	182
183		- Image 4 Configure/modify project settings
	171	+ image 4 modify project settings
184	184
	173	+Now we can start to use this software. Here are some usage information for this software.
185	185
186		-Now you can start building the sample UI. Follow the steps below:
	175	+**~1. add widget**
187	187
	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.
188	188
189		-=== **Add widgets** ===
190		-
191		-
192		-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.
193		-
194		-Add a Label, Button, and Image to the screen as shown in **Image 5**.
195		-
196	196	[[image:image-20240928111412-6.png||height="526" width="864"]]
197	197
198		- Image 5: Add widgets
	181	+ image 5 add widgets
199	199
	183	+**2. modify widget**
200	200
201		-=== **Modify widget properties** ===
	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".
202	202
203		-
204		-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.
205		-
206		-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.
207		-
208	208	[[image:1727485118799-984.png]]
209	209
210		- Image 6: The button widget's "Inspector" tab
	189	+ image 6 the button widget's "Inspector" tab
211	211
	191	+Second part: "Layout" means a auto position-management for widgets contained in the parent widget. "Transform" includes size, position and align modification.
212	212
213		-==== **Changing the Button properties** ====
214		-
215		-
216		-Click the Button.
217		-
218		-Under the "Layout" you can change the button's position and size.
219		-
220	220	[[image:1727485251053-655.png]]
221	221
222		-Image 7: The button widget's "BUTTON" tab
	195	+image 7 the button widget's "BUTTON" tab
223	223
	197	+Third part: It is an area of style setting.
224	224
225		-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.
	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.
226	226
227		-* Click **ADD EVENT** button.
228		-* Select **CLICKED** under the Trigger.
229		-* Select **Screen2** from **Screen to**.
230		-* Select **FADE ON** from **Fade mode**.
231		-* Enter **500** in the **Speed** text box.
232		-* Finally, click **ADD** button.
233		-
234	234	[[image:1727485480434-713.png||height="395" width="290"]]
235	235
236		- Image 8: Add an event for the button
	203	+ image 8 add event for button
237	237
	205	+**3. change label widget content**
238	238
239		-==== **Changing the label properties** ====
	207	+Modify the content in text as shown in image 9, the text content of label widget will be changed accordingly.
240	240
241		-
242		-Click the label. Under the **Label** section, type "Click For Detail" in the **Text** textbox.
243		-
244	244	[[image:image-20240928090825-1.png||height="327" width="391"]]
245	245
246		- Image 9:  Modify text of label widget
	211	+ image 9 modify text content of label widget
247	247
	213	+**4. Add image into project**
248	248
249		-==== **Changing image properties** ====
250		-
251		-
252	252	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.
253	253
254	254	[[image:image-20240928113424-9.png||height="355" width="505"]]
...	...	@@ -259,38 +259,29 @@
259	259
260	260	image 11 use image widget in SquareLine Studio
261	261
	225	+**5. The relationship between widgets**
262	262
263		-==== **The relationship between widgets** ====
	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.
264	264
265		-
266		-Widgets commonly have two types of relationships: **parallel** and **parent-child**.
267		-
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, as shown in Image 13.
270		-
271	271	[[image:1727486567182-334.png||height="318" width="278"]]
272	272
	231	+image 12 move label1 to make label1 widget be a child of button1 widget(1)
273	273
274		-Move **Label1** to make it a child of **Button1**. See Image 13.
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.
	235	+ image 13 move label1 to make label1 widget be a child of button1 widget(2)
279	279
	237	+**6. Preview the final effect**
280	280
281		-==== **Preview the screen** ====
	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.
282	282
283		-
284		-You can test the result by clicking on the **PLAY** button. The screen will change into play mode. See Image 14.
285		-
286	286	[[image:1727487368023-281.png]]
287	287
288		- Image 14: Simulating the project
	243	+ image 14 click on the triangle icon to start or end the simulation
289	289
	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/]].
290	290
291		-For more information, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
292	292
293		-
294	294	== 2.4 Integrate UI Code to ESP-IDF Project ==
295	295
296	296
...	...	@@ -352,9 +352,8 @@
352	352
353	353	= 4. Example Project 2: LoRaWAN RS485 Alarm =
354	354
355		-= 5. The way to add a new panel to project =
	309	+= 5.  The way to add a new panel to project =
356	356
357		-
358	358	**~1. Design a panel in SquareLine Studio, using image 5.1 below as a reference.**
359	359
360	360	[[image:image-20241121113445-1.png||height="584" width="934"]]
...	...	@@ -361,7 +361,6 @@
361	361
362	362	image 5.1 a panel about water_leak
363	363
364		-
365	365	**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.
366	366
367	367	[[image:image-20241121141120-4.png||height="383" width="795"]]
...	...	@@ -368,7 +368,6 @@
368	368
369	369	image 5.2 ui files exported
370	370
371		-
372	372	**3. Delete or rename some file.** Here are the steps:
373	373
374	374	Step1 Delete the 'components' directory.
...	...	@@ -503,7 +503,6 @@
503	503
504	504	image 5.26 ui_water_leak_events_.c after modification
505	505
506		-
507	507	**12. Modify ui_water_leak_style.c file.**
508	508
509	509	Step1. '#include "../ui.h"'~-~->#include '"../ui_water_leak.h"'
...	...	@@ -520,7 +520,6 @@
520	520
521	521	image 5.28 ui_water_leak_style.c (1) after modification
522	522
523		-
524	524	Step2. modify 'void ui_ScreenMain_screen_init(void)'~-~->'panel_with_type create_water_leak(uint8_t index)'
525	525
526	526	delete code as shown in image 5.29
...	...	@@ -529,7 +529,6 @@
529	529
530	530	image 5.29 ui_water_leak_style.c (2)
531	531
532		-
533	533	Step3. The image 5.30, 5.31 show the change.
534	534
535	535	[[image:image-20241122152026-45.png||height="277" width="828"]]
...	...	@@ -540,7 +540,6 @@
540	540
541	541	image 5.31 ui_water_leak_style.c (3) after modification
542	542
543		-
544	544	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).
545	545
546	546	[[image:image-20241122153958-47.png]]
...	...	@@ -551,7 +551,6 @@
551	551
552	552	image 5.33 ui_water_leak_style.c (4)
553	553
554		-
555	555	Step5. Delete event function in code which was just pasted in extra_lib/sort.h(The process is shown in image 5.34).
556	556
557	557	[[image:image-20241122155650-50.png||height="922" width="513"]]
...	...	@@ -558,7 +558,6 @@
558	558
559	559	image 5.34 ui_water_leak_style.c (5)
560	560
561		-
562	562	Step6. Add some lines of code in extra_lib/sort.h as shown in image 5.35.
563	563
564	564	[[image:image-20241122161934-51.png]]
...	...	@@ -565,7 +565,6 @@
565	565
566	566	image 5.35
567	567
568		-
569	569	Step7. Add a line of code in extra_lib/sort.h as shown in image 5.36.
570	570
571	571	[[image:image-20241122162852-53.png||height="330" width="529"]]
...	...	@@ -572,7 +572,6 @@
572	572
573	573	image 5.37
574	574
575		-
576	576	Step8. Add some code in ui_water_leak_style.c as shown in image 5.38 from line534 to line 576 in detail.
577	577
578	578	panel_with_type union_sensor;
...	...	@@ -591,7 +591,6 @@
591	591
592	592	image 5.38
593	593
594		-
595	595	**13. Modify sort.c file.**
596	596
597	597	Add a line of code ~-~-'#include "ui_water_leak.h"' as shown in image 5.39 line 16.