Changes for page LTS5 LoRa HMI Touch Screen

Last modified by Dilisi S on 2025/02/26 19:24

From version < 116.1 >

edited by Dilisi S
on 2024/12/17 21:42

To version < 123.2 >

edited by Xiaoling
on 2024/12/24 11:04

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Author

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

Content

@@ -102,30 +102,37 @@
  * Smart Cities
  * Smart Factory
--= 2.  Getting Started with Hello World =
++= 2.  Getting Started with 'Hello World' =
  == 2.1  About this demo ==
--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.
++This getting started example demonstrates how to design and deploy a simple display UI for the LTS5 device. The example includes:
++* Creating a basic UI with a single button.
++* Implementing functionality to navigate the Web UI to a new page when the button is clicked.
++* Uploading the UI to the LTS5 device.
++By completing this demo, you will gain foundational knowledge for customizing the LTS5 interface and building more advanced IoT applications.
++
++
  == 2.2  Install Software Running Environment ==
--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.
++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.
--=== 2.2.1 Install VSCode and ESP-IDF extension ===
++=== 2.2.1 Install VS Code and ESP-IDF extension ===
--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]].
++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]].
--Next, you need to install the ESP-IDF extension within VSCode. The detailed operation steps are illustrated in image 1.
++Next, install the **ESP-IDF** extension within **VS Code**. Detailed steps for this process are shown in Image 1.
++
  [[image:image-20240928110211-5.png||height="508" width="866"]]
--                                                                               image 1 ESP-IDF extension install
++                                                                               Image 1: ESP-IDF extension install
  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]]
@@ -133,72 +133,121 @@
  === 2.2.2 Install SquareLine Studio ===
--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]].
++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.
--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.
++[[image:squareline.io_downloads.png]]
--== 2.3 Simple usage of SquareLine Studio and export UI code ==
++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:
++* Max. 10 screens
++* Max. 150 widgets
++* Max. 5 global colors
++* Max. 2 themes
++* Max. 1 component
--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.
++== 2.3 Simple usage of SquareLine Studio and exporting UI code ==
++
++After launching and logging into the software, create a new project as shown in Image 2.
++
++* Select the major **LVGL** version as **8.3**.
++* Select the **Desktop** tab.
++* Select  **Eclipse with  SDL for  development on PC**:
++* In the **PROJECT SETTINGS**, select **LVGL version** **8.3.11**
++* Select the **CREATE **button.
++
  [[image:image-20240928103357-2.png||height="680" width="708"]]
--                                                            image 2 create a SquareLine project
++                                                            Image 2: Creating a new SquareLine project
--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.
++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.
++
++* Select** File  -> Project Settings**
++
  [[image:1727229582471-566.png]]
--                                  image 3 project settings
++                                  Image 3 accessing project settings
++
++In the PROJECT SETTINGS dialog box, configure/modify the project settings:
++
++* **UI Files Export Root**: Select a folder on your computer to store the UI files.
++* **LVGL Include Path**: Set this to **lvgl.h**
++* **Click on the APPLY CHANGES button.**
++
  [[image:image-20240928105309-4.png||height="526" width="556"]]
--                                              image 4 modify project settings
++                                              Image 4 Configure/modify project settings
--Now we can start to use this software. Here are some usage information for this software.
--**~1. add widget**
++Now you can start building the sample UI. Follow the steps below:
--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.
++=== **Add widgets** ===
++
++
++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.
++
++Add a Label, Button, and Image to the screen as shown in **Image 5**.
++
  [[image:image-20240928111412-6.png||height="526" width="864"]]
--                                                                                       image 5 add widgets
++                                                                                       Image 5: Add widgets
--**2. modify widget**
--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".
++=== **Modify widget properties** ===
++
++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.
++
++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.
++
  [[image:1727485118799-984.png]]
-- image 6 the button widget's "Inspector" tab
++ Image 6: The button widget's "Inspector" tab
--Second part: "Layout" means a auto position-management for widgets contained in the parent widget. "Transform" includes size, position and align modification.
++==== **Changing the Button properties** ====
++
++
++Click the Button.
++
++Under the "Layout" you can change the button's position and size.
++
  [[image:1727485251053-655.png]]
--image 7 the button widget's "BUTTON" tab
++Image 7: The button widget's "BUTTON" tab
--Third part: It is an area of style setting.
--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.
++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.
++* Click **ADD EVENT** button.
++* Select **CLICKED** under the Trigger.
++* Select **Screen2** from **Screen to**.
++* Select **FADE ON** from **Fade mode**.
++* Enter **500** in the **Speed** text box.
++* Finally, click **ADD** button.
++
  [[image:1727485480434-713.png||height="395" width="290"]]
--           image 8 add event for button
++    Image 8: Add an event for the button
--**3. change label widget content**
--Modify the content in text as shown in image 9, the text content of label widget will be changed accordingly.
++==== **Changing the label properties** ====
++
++Click the label. Under the **Label** section, type "Click For Detail" in the **Text** textbox.
++
  [[image:image-20240928090825-1.png||height="327" width="391"]]
--             image 9 modify text content of label widget
++             Image 9:  Modify text of label widget
--**4. Add image into project**
++==== **Changing image properties** ====
++
++
  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.
  [[image:image-20240928113424-9.png||height="355" width="505"]]
@@ -209,29 +209,38 @@
                                                              image 11 use image widget in SquareLine Studio
--**5. The relationship between widgets**
--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.
++==== **The relationship between widgets** ====
++
++Widgets commonly have two types of relationships: **parallel** and **parent-child**.
++
++* In a **parallel relationship**, widgets' positions are determined relative to a shared reference object.
++* 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.
++
  [[image:1727486567182-334.png||height="318" width="278"]]
--image 12 move label1 to make label1 widget be a child of button1 widget(1)
++Move **Label1** to make it a child of **Button1**. See Image 13.
++
  [[image:image-20240928112001-8.png||height="431" width="796"]]
--                                image 13 move label1 to make label1 widget be a child of button1 widget(2)
++                                Image 13: Move Label1 to make it a child of Button1.
--**6. Preview the final effect**
--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.
++==== **Preview the screen** ====
++
++You can test the result by clicking on the **PLAY** button. The screen will change into play mode. See Image 14.
++
  [[image:1727487368023-281.png]]
--            image 14 click on the triangle icon to start or end the simulation
++            Image 14: Simulating the project
--For more detailed usage, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
++For more information, please visit the official link: [[SquareLine Studio 1.4.2 Documentation ~| SquareLine Studio>>url:https://docs.squareline.io/docs/squareline/]].
++
  == 2.4 Integrate UI Code to ESP-IDF Project ==
@@ -293,8 +293,9 @@
  = 4. Example Project 2: LoRaWAN RS485 Alarm =
--= 5.  The way to add a new panel to project =
++= 5. The way to add a new panel to project =
++
  **~1. Design a panel in SquareLine Studio, using image 5.1 below as a reference.**
  [[image:image-20241121113445-1.png||height="584" width="934"]]
@@ -301,6 +301,7 @@
                                                                                    image 5.1 a panel about water_leak
++
  **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.
  [[image:image-20241121141120-4.png||height="383" width="795"]]
@@ -307,6 +307,7 @@
                                                                                image 5.2 ui files exported
++
  **3. Delete or rename some file.** Here are the steps:
      Step1 Delete the 'components' directory.
@@ -441,6 +441,7 @@
                          image 5.26 ui_water_leak_events_.c after modification
++
  **12. Modify ui_water_leak_style.c file.**
  Step1. '#include "../ui.h"'~-~->#include '"../ui_water_leak.h"'
@@ -457,6 +457,7 @@
                             image 5.28 ui_water_leak_style.c (1) after modification
++
  Step2. modify 'void ui_ScreenMain_screen_init(void)'~-~->'panel_with_type create_water_leak(uint8_t index)'
             delete code as shown in image 5.29
@@ -465,6 +465,7 @@
                                                 image 5.29 ui_water_leak_style.c (2)
++
  Step3. The image 5.30, 5.31 show the change.
  [[image:image-20241122152026-45.png||height="277" width="828"]]
@@ -475,6 +475,7 @@
                                                           image 5.31 ui_water_leak_style.c (3) after modification
++
  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).
  [[image:image-20241122153958-47.png]]
@@ -485,6 +485,7 @@
                             image 5.33 ui_water_leak_style.c (4)
++
  Step5. Delete event function in code which was just pasted in extra_lib/sort.h(The process is shown in image 5.34).
  [[image:image-20241122155650-50.png||height="922" width="513"]]
@@ -491,6 +491,7 @@
                image 5.34 ui_water_leak_style.c (5)
++
  Step6. Add some lines of code in extra_lib/sort.h as shown in image 5.35.
  [[image:image-20241122161934-51.png]]
@@ -497,6 +497,7 @@
                             image 5.35
++
  Step7. Add a line of code in extra_lib/sort.h as shown in image 5.36.
  [[image:image-20241122162852-53.png||height="330" width="529"]]
@@ -503,6 +503,7 @@
                                           image 5.37
++
  Step8. Add some code in ui_water_leak_style.c as shown in image 5.38 from line534 to line 576 in detail.
  panel_with_type union_sensor;
@@ -521,6 +521,7 @@
                                                                         image 5.38
++
  **13. Modify sort.c file.**
  Add a line of code ~-~-'#include "ui_water_leak.h"' as shown in image 5.39 line 16.

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

Changes for page LTS5 LoRa HMI Touch Screen

Summary

Details

Applications

Navigation