Summary

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

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
...	...	@@ -145,73 +145,116 @@
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	+After launching and logging into the software, create a new project as shown in Image 2.
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	+* 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.
158	158
159	159	[[image:image-20240928103357-2.png||height="680" width="708"]]
160	160
161		- image 2 create a SquareLine project
	169	+ Image 2: Creating a new 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
	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	+
165	165	[[image:1727229582471-566.png]]
166	166
167		- image 3 project settings
	178	+ Image 3 accessing project settings
168	168
	180	+
	181	+In the PROJECT SETTINGS dialog box, configure/modify the project settings:
	182	+
	183	+* **UI Files Export Root**: Select a folder on your computer to store the UI files.
	184	+* **LVGL Include Path**: Set this to **lvgl.h**
	185	+* **Click on the APPLY CHANGES button.**
	186	+
169	169	[[image:image-20240928105309-4.png||height="526" width="556"]]
170	170
171		- image 4 modify project settings
	189	+ Image 4 Configure/modify project settings
172	172
173		-Now we can start to use this software. Here are some usage information for this software.
174	174
175		-**~1. add widget**
	192	+Now you can start building the sample UI. Follow the steps below:
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.
178	178
	195	+=== **Add widgets** ===
	196	+
	197	+
	198	+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.
	199	+
	200	+Add a Label, Button, and Image to the screen as shown in **Image 5**.
	201	+
179	179	[[image:image-20240928111412-6.png||height="526" width="864"]]
180	180
181		- image 5 add widgets
	204	+ Image 5: Add widgets
182	182
183		-**2. modify widget**
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".
	207	+=== **Modify widget properties** ===
186	186
	209	+
	210	+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.
	211	+
	212	+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.
	213	+
187	187	[[image:1727485118799-984.png]]
188	188
189		- image 6 the button widget's "Inspector" tab
	216	+ 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.
192	192
	219	+==== **Changing the Button properties** ====
	220	+
	221	+
	222	+Click the Button.
	223	+
	224	+Under the "Layout" you can change the button's position and size.
	225	+
193	193	[[image:1727485251053-655.png]]
194	194
195		-image 7 the button widget's "BUTTON" tab
	228	+Image 7: The button widget's "BUTTON" tab
196	196
197		-Third part: It is an area of style setting.
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.
	231	+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.
200	200
	233	+* Click **ADD EVENT** button.
	234	+* Select **CLICKED** under the Trigger.
	235	+* Select **Screen2** from **Screen to**.
	236	+* Select **FADE ON** from **Fade mode**.
	237	+* Enter **500** in the **Speed** text box.
	238	+* Finally, click **ADD** button.
	239	+
201	201	[[image:1727485480434-713.png||height="395" width="290"]]
202	202
203		- image 8 add event for button
	242	+ 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.
	245	+==== **Changing the label properties** ====
208	208
	247	+
	248	+Click the label. Under the **Label** section, type "Click For Detail" in the **Text** textbox.
	249	+
209	209	[[image:image-20240928090825-1.png||height="327" width="391"]]
210	210
211		- image 9 modify text content of label widget
	252	+ Image 9:  Modify text of label widget
212	212
213		-**4. Add image into project**
214	214
	255	+==== **Changing image properties** ====
	256	+
	257	+
215	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
217	217	[[image:image-20240928113424-9.png||height="355" width="505"]]
...	...	@@ -222,29 +222,38 @@
222	222
223	223	image 11 use image widget in SquareLine Studio
224	224
225		-**5. 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.
	269	+==== **The relationship between widgets** ====
228	228
	271	+
	272	+Widgets commonly have two types of relationships: **parallel** and **parent-child**.
	273	+
	274	+* In a **parallel relationship**, widgets' positions are determined relative to a shared reference object.
	275	+* 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.
	276	+
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
	280	+Move **Label1** to make it a child of **Button1**. See Image 13.
	281	+
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)
	284	+ Image 13: Move Label1 to make it a child of Button1.
236	236
237		-**6. Preview the final effect**
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.
	287	+==== **Preview the screen** ====
240	240
	289	+
	290	+You can test the result by clicking on the **PLAY** button. The screen will change into play mode. See Image 14.
	291	+
241	241	[[image:1727487368023-281.png]]
242	242
243		- image 14 click on the triangle icon to start or end the simulation
	294	+ Image 14: Simulating the project
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/]].
246	246
	297	+For more information, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
247	247
	299	+
248	248	== 2.4 Integrate UI Code to ESP-IDF Project ==
249	249
250	250
...	...	@@ -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 =
	361	+= 5. The way to add a new panel to project =
310	310
	363	+
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
	370	+
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
	377	+
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
	512	+
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
	529	+
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
	538	+
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
	549	+
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
	560	+
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
	567	+
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
	574	+
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
	581	+
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
	600	+
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.