Summary

• Page properties (1 modified, 0 added, 0 removed)
• Attachments (0 modified, 2 added, 0 removed)
  • squalreline-trial.png
  • squareline.io_downloads.png

Details

Page properties

Content

...	...	@@ -102,30 +102,37 @@
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
109	109
110		-In this Getting Started Example, we will show how to design a simple Display UI and upload it to LTS5. This UI has  a button , when user click the button. The Web UI will jump to a new page.
	110	+This getting started example demonstrates how to design and deploy a simple display UI for the LTS5 device. The example includes:
111	111
	112	+* Creating a basic UI with a single button.
	113	+* Implementing functionality to navigate the Web UI to a new page when the button is clicked.
	114	+* Uploading the UI to the LTS5 device.
112	112
	116	+By completing this demo, you will gain foundational knowledge for customizing the LTS5 interface and building more advanced IoT applications.
	117	+
	118	+
113	113	== 2.2  Install Software Running Environment ==
114	114
115	115
116		-The ESP MCU can be developed using ESP-IDF, Arduino, or MicroPython. For this project, we utilize ESP-IDF for compilation and Visual Studio Code (VSCode) for editing.
	122	+The **ESP MCU** supports development with **ESP-IDF**, **Arduino**, or **MicroPython**. We use **ESP-IDF** for compilation and **Visual Studio Code (VS Code)** as the development environment for this project.
117	117
118	118
119		-=== 2.2.1 Install VSCode and ESP-IDF extension ===
	125	+=== 2.2.1 Install VS Code and ESP-IDF extension ===
120	120
121	121
122		-Firstly, download and install VSCode for your computer's operating system from the official website: [[Download Visual Studio Code - Mac, Linux, Windows>>url:https://code.visualstudio.com/download]].
	128	+First, download and install **VS Code** for your operating system from the Visual Studio Code website: [[Visual Studio Code - Mac, Linux, Windows>>https://code.visualstudio.com/download]].
123	123
124		-Next, you need to install the ESP-IDF extension within VSCode. The detailed operation steps are illustrated in image 1.
	130	+Next, install the **ESP-IDF** extension within **VS Code**. Detailed steps for this process are shown in Image 1.
125	125
	132	+
126	126	[[image:image-20240928110211-5.png||height="508" width="866"]]
127	127
128		- image 1 ESP-IDF extension install
	135	+ Image 1: ESP-IDF extension install
129	129
130	130	Links for reference: [[Install ESP32 ESP-IDF on Windows and Integrate with VS code (esp32tutorials.com)>>url:https://esp32tutorials.com/install-esp32-esp-idf-windows-integrate-vs-code/#:~~:text=In%20this%20tutorial,%20we%20will%20show%20you%20how%20to%20install]]
131	131
...	...	@@ -133,72 +133,116 @@
133	133	=== 2.2.2 Install SquareLine Studio ===
134	134
135	135
136		-The version we are utilizing for this software is 1.4.2. You can download it from the official link: [[SquareLine Studio - Download the current version of SquareLine Studio>>url:https://squareline.io/downloads#lastRelease]].
	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.
137	137
138		-Please note that this software necessitates the registration of a license prior to usage, and various licenses come with distinct limitations. For instance, the free version imposes restrictions such as a limit of 1 component, 150 widgets, and 10 screens. However, for first-time downloads, you are granted unrestricted access for a period of 30 days without the need for immediate registration.
	145	+[[image:squareline.io_downloads.png]]
139	139
140	140
141		-== 2.3 Simple usage of SquareLine Studio and export UI code ==
	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:
142	142
	150	+* Max. 10 screens
	151	+* Max. 150 widgets
	152	+* Max. 5 global colors
	153	+* Max. 2 themes
	154	+* Max. 1 component
143	143
144		-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.
	156	+== 2.3 Simple usage of SquareLine Studio and exporting UI code ==
145	145
	158	+
	159	+After launching and logging into the software, create a new project as shown in Image 2.
	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.
	166	+
146	146	[[image:image-20240928103357-2.png||height="680" width="708"]]
147	147
148		- image 2 create a SquareLine project
	169	+ Image 2: Creating a new SquareLine project
149	149
150		-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.
151	151
	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	+
152	152	[[image:1727229582471-566.png]]
153	153
154		- image 3 project settings
	178	+ Image 3 accessing project settings
155	155
	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	+
156	156	[[image:image-20240928105309-4.png||height="526" width="556"]]
157	157
158		- image 4 modify project settings
	189	+ Image 4 Configure/modify project settings
159	159
160		-Now we can start to use this software. Here are some usage information for this software.
161	161
162		-**~1. add widget**
	192	+Now you can start building the sample UI. Follow the steps below:
163	163
164		-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.
165	165
	195	+=== Add widgets ===
	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.
	198	+
	199	+Add a Label, Button, and Image to the screen as shown in **Image 5**.
	200	+
166	166	[[image:image-20240928111412-6.png||height="526" width="864"]]
167	167
168		- image 5 add widgets
	203	+ Image 5: Add widgets
169	169
170		-**2. modify widget**
	205	+=== Modify widget properties ===
171	171
172		-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	+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.
173	173
	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.
	210	+
174	174	[[image:1727485118799-984.png]]
175	175
176		- image 6 the button widget's "Inspector" tab
	213	+ Image 6: The button widget's "Inspector" tab
177	177
178		-Second part: "Layout" means a auto position-management for widgets contained in the parent widget. "Transform" includes size, position and align modification.
179	179
	216	+==== Changing the Button properties ====
	217	+
	218	+Click the Button.
	219	+
	220	+Under the "Layout" you can change the button's position and size.
	221	+
180	180	[[image:1727485251053-655.png]]
181	181
182		-image 7 the button widget's "BUTTON" tab
	224	+Image 7: The button widget's "BUTTON" tab
183	183
184		-Third part: It is an area of style setting.
185	185
186		-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.
	227	+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.
187	187
	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.
	235	+
188	188	[[image:1727485480434-713.png||height="395" width="290"]]
189	189
190		- image 8 add event for button
	238	+ Image 8: Add an event for the button
191	191
192		-**3. change label widget content**
193	193
194		-Modify the content in text as shown in image 9, the text content of label widget will be changed accordingly.
	241	+==== Changing the label properties ====
195	195
	243	+Click the label. Under the **Label** section, type "Click For Detail" in the **Text** textbox.
	244	+
	245	+
196	196	[[image:image-20240928090825-1.png||height="327" width="391"]]
197	197
198		- image 9 modify text content of label widget
	248	+ Image 9:  Modify text of label widget
199	199
200		-**4. Add image into project**
201	201
	251	+==== 4. Changing image properties ====
	252	+
202	202	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.
203	203
204	204	[[image:image-20240928113424-9.png||height="355" width="505"]]
...	...	@@ -209,29 +209,36 @@
209	209
210	210	image 11 use image widget in SquareLine Studio
211	211
212		-**5. The relationship between widgets**
213	213
214		-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	+==== 5. The relationship between widgets ====
215	215
	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	+
216	216	[[image:1727486567182-334.png||height="318" width="278"]]
217	217
218		-image 12 move label1 to make label1 widget be a child of button1 widget(1)
219	219
	274	+Move **Label1** to make it a child of **Button1**. See Image 13.
	275	+
220	220	[[image:image-20240928112001-8.png||height="431" width="796"]]
221	221
222		- image 13 move label1 to make label1 widget be a child of button1 widget(2)
	278	+ Image 13: Move Label1 to make it a child of Button1.
223	223
224		-**6. Preview the final effect**
225	225
226		-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.
	281	+**6. Preview the screen**
227	227
	283	+You can test the result by clicking on the **PLAY** button. The screen will change into play mode. See Image 14.
	284	+
228	228	[[image:1727487368023-281.png]]
229	229
230		- image 14 click on the triangle icon to start or end the simulation
	287	+ Image 14: Simulating the project
231	231
232		-For more detailed usage, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
233	233
	290	+For more information, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
234	234
	292	+
235	235	== 2.4 Integrate UI Code to ESP-IDF Project ==
236	236
237	237

squalreline-trial.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+60.4 KB

Content

squareline.io_downloads.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+1.5 MB

Content