Changes for page LTS5 LoRa HMI Touch Screen

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

From version < 122.1 >

edited by Dilisi S
on 2024/12/23 04:44

To version < 135.1 >

edited by Dilisi S
on 2024/12/26 18:50

Change comment: Dec 26 edits - part 1

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 6 added, 0 removed)

Details

Page properties

Content

@@ -1,12 +1,11 @@
++
++
  (% style="text-align:center" %)
--[[image:image-20240915231842-1.png]]
++[[image:image-20241226135550-1.png]]
--
--
--
  (% _mstvisible="1" %)
  (% _msthash="315238" _msttexthash="18964465" _mstvisible="3" %)**Table of Contents:**
@@ -140,9 +140,9 @@
  === 2.2.2 Install SquareLine Studio ===
--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.
++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.
--[[image:squareline.io_downloads.png]]
++[[image:squareline.io_downloads.png||height="888" width="1294"]]
  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:
@@ -156,183 +156,202 @@
  == 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.
++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**.
--* 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.
++* In the **PROJECT SETTINGS**, select **LVGL version **as **8.3.11** and **Resolution** as **800** x **480**.
++* Select the **CREATE **button to create the new project with the selected settings.
--[[image:image-20240928103357-2.png||height="680" width="708"]]
++[[image:squareline-studio-launcher-screen.png||height="752" width="1415"]]
--                                                            Image 2: Creating a new SquareLine project
++Next, you need to configure some additional settings for this project. To do so, select** File  -> Project Settings** as shown in the image below.
--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 accessing project settings
++In the **PROJECT SETTINGS** dialog box, configure/modify the project settings as shown in the image below.
--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.**
++* Click on the **APPLY CHANGES** button.
  [[image:image-20240928105309-4.png||height="526" width="556"]]
--                                              Image 4 Configure/modify project settings
++Now you can start building the user interface. Follow the steps below:
--Now you can start building the sample UI. Follow the steps below:
++=== **Add widgets** ===
--=== 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.
++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.
--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
--=== Modify widget properties ===
++Then click the **Screen **widget to add the second screen. After adding the second screen, it will appear in the Screens panel as **Screen2**.
--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.
++[[image:Screenshot 2024-12-24 140459.png||height="278" width="290"]]
--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.
++=== **Modify widget properties** ===
++
++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.
++
  [[image:1727485118799-984.png]]
-- Image 6: The button widget's "Inspector" tab
++==== **Changing the Button properties** ====
--==== Changing the Button properties ====
--Click the Button. Under the **Label** section, type "Click for details..." in the **Text** textbox.
++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:
--Under the "Layout" you can
++* **Flex Flow**: No Layout
++* **Transform**:
++** **X**: 331 px
++** **Y**: 203 px
++** **Width**: 100 px
++** **Height**: 50 px
++** **Align**: CENTER
  [[image:1727485251053-655.png]]
--image 7 the button widget's "BUTTON" tab
++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.
--Third part: It is an area of style setting.
++* Click **ADD EVENT** button. A new section will appear to configure this event.
--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.
++[[image:Screenshot 2024-12-24 134937.png||height="80" width="290"]]
++* 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.
++
++[[image:Screenshot 2024-12-24 134818.png||height="222" width="290"]]
++
++* 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.
++* Finally, click the **ADD** button.
++
  [[image:1727485480434-713.png||height="395" width="290"]]
--           image 8 add event for button
++    Image 8: Add an event for the button
--==== Changing the label properties ====
++==== **Changing the label properties** ====
--Click the label. Under the **Label** section, type "Hello World!" in the **Text** textbox.
++Click the Label you have added to the screen. 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 of label widget
++Once you enter the text, it will immediately appear on the label.
--==== 4. 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.
++==== **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 the image below.
++
  [[image:image-20240928113424-9.png||height="355" width="505"]]
--               image 10 add image file into SquareLine Studio project
++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.
++
  [[image:image-20240928114139-10.png||height="559" width="810"]]
--                                                            image 11 use image widget in SquareLine Studio
--**5. The relationship between widgets**
++==== **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.
++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.
++
  [[image:1727486567182-334.png||height="318" width="278"]]
--image 12 move label1 to make label1 widget be a child of button1 widget(1)
++Move the label, **Label1** to make it a child of **Button1** as shown in the image below.
++
  [[image:image-20240928112001-8.png||height="431" width="796"]]
--                                image 13 move label1 to make label1 widget be a child of button1 widget(2)
++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.
--**6. Preview the screen**
++[[image:Screenshot 2024-12-24 144005.png||height="360" width="290"]]
--You can test the result by clicking on the **PLAY** button. The screen will change into play mode.
++==== **Preview the screen** ====
++
++
++You can test the result by clicking on the **PLAY** button as shown in the image below. The screen will change into play mode.
++
  [[image:1727487368023-281.png]]
--            image 14 click on the triangle icon to start or end the simulation
--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 ==
--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.
++To integrate, first export the UI code, then make some modifications, and finally relocate the UI code to a specific position within the project.
++On the  menubar, click **Export -> Export UI** Files as shown in the image below.
++
  [[image:1727229798126-306.png]]
--                                             image 15 export UI file
++The exported UI files can be found in your SquareLine project folder as shown in the image below.
++
++
  [[image:1727229821582-258.png||height="333" width="662"]]
--                                                               image 16 exported UI file
--Create a empty directory entitled "ui" in path "basic_prj/app_components/ui/", and then copy all UI code exported to this directory.
++Create a new folder named "**ui**" at path "**basic_prj/app_components/ui/**", and copy all the exported UI code into it as shown in the image below.
  [[image:image-20240928144830-11.png]]
--                                                image 17 open CMakeLists.txt
++Open the **CMakeLists.txt** file and edit it as ahown below.
++
  [[image:1727229892636-154.png||height="521" width="407"]]
--                         image 18 modify CMakeLists.txt
--The last step of integrating is adding two lines of code in main.c file.
++Open the main.c file and  add two lines of code as shown in the below images.
++Add **#include "ui.h"**
++
  [[image:1727229926561-300.png]]
--                                                          image 19 add "ui.h"
++Add **ui_init();**
++
  [[image:1727229955611-607.png]]
--                                                   image 20 add "ui_init()"
++== 2.5 Brief introduction to the Hello World project ==
--== 2.5 Brief introduction of hello world project ==
++The project consists of two screens. The first screen displays the company's logo, the project name, and a button to navigate to the next screen. The second screen provides information about the HMI screen product through an image and includes a button to return to the previous screen.
--The project consists of two screens. The first screen displays the company's logo, the project name, and a button to navigate to the next screen. The second screen presents some information about this HMI screen product through an image and includes a button to return to the previous screen.
--
  == 2.6 Test Result ==
--By pressing the button lying bottom right, the screen can switch to another as expected. This indicates that the UI file has been successfully integrated into the project and is now effective.
++By pressing the button located at the bottom right, the screen switches to the next one as expected. This confirms that the UI file has been successfully integrated into the project and is functioning correctly.
++Screen 1:
++
  [[image:1727488067077-684.png||height="402" width="574"]]
--                                                      image 21 screen1
++Screen 2:
++
  [[image:1727488157579-949.png||height="397" width="572"]]
--                                                       image 22 screen2
--
  = 3. Example Project 1: LoRa Central Display =
  [[image:image-20240916101737-1.png||height="468" width="683"]]
@@ -340,28 +340,31 @@
  = 4. Example Project 2: LoRaWAN RS485 Alarm =
--= 5.  The way to add a new panel to project =
++= 5. Adding new panel to the project =
--**~1. Design a panel in SquareLine Studio, using image 5.1 below as a reference.**
++**~1. **Design a panel in SquareLine Studio, as shown in Image 5.1 below for reference.
++
  [[image:image-20241121113445-1.png||height="584" width="934"]]
--                                                                                  image 5.1 a panel about water_leak
++                                                                                  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.
++**2. Export the UI file: **You need to adjust the export path first, then click '**Export -> Export UI Files**' on the menu bar. This step was introduced earlier. After that, you can get the UI files as shown in Image 5.2.
++
  [[image:image-20241121141120-4.png||height="383" width="795"]]
--                                                                              image 5.2 ui files exported
++                                                                              Image 5.2: Exported UI files
--**3. Delete or rename some file.** Here are the steps:
--    Step1 Delete the 'components' directory.
--    Step2 Delete 'filelist.txt'.
--    Step3 Delete 'ui_helpers.c' and 'ui_helpers.h'.
--    Step4 Rename 'ui_ScreenMain.c' in the 'screens' directory to 'ui_water_leak_style.c'.
--    Step5 Rename the 'screens' directory to 'styles'.
++**3. Delete and rename some file.** Here are the steps:
++    Step 1: Delete the 'components' directory.
++    Step 2: Delete 'filelist.txt'.
++    Step 3: Delete 'ui_helpers.c' and 'ui_helpers.h'.
++    Step 4: Rename 'ui_ScreenMain.c' in the 'screens' directory to 'ui_water_leak_style.c'.
++    Step 5: Rename the 'screens' directory to 'styles'.
++
  [[image:image-20241121151934-10.png||height="303" width="792"]]
                                                                                   image 5.3 rest file (1)
@@ -370,9 +370,9 @@
                                                                                   image 5.4 rest file (2)
--**4. Open this project in vscode.**
++4. Open the project in **VS Code**.
--5. Add file include path about water_leak in extra_lib/CMakeLists.txt as shown in image 5.5, 5.6, and its format is similar to the tem_hum or door.
++5. Add the file include path for **water_leak** in **extra_lib/CMakeLists.txt**, as shown in Images 5.5 and 5.6. Its format is similar to that of **tem_hum** or **door**."
  [[image:image-20241121181957-17.png||height="438" width="516"]]
@@ -382,8 +382,10 @@
                                image 5.6 extra_lib/CMakeLists.txt after add
--**6. Modify header file include in fonts and images directory.** Open the fonts/ui_font_Font12.c file, as shown in image 5.7, then modify the '#include "../ui.h"' to '#include "../ui_water_leak.h"', the image 5.8 is the modified image. Other font file need to be modified in same way.
++**6. ** **Modify the header files included in the fonts and images directories**.
++Open the **fonts/ui_font_Font12.c** file, as shown in Image 5.7, and change **#include "../ui.h"** to **#include "../ui_water_leak.h"**. The modified file is shown in Image 5.8. Other font files need to be modified in the same way.
++
  [[image:image-20241121171629-11.png]]
                                 image 5.7 before-modified font file
@@ -392,7 +392,7 @@
                                    image 5.8 modified font file
--Open the images/ui_img_battery_empty_png.c file, as shown in image 5.9, then modify the '#include "../ui.h"' to '#include "../ui_water_leak.h"', the image 5.10 is the modified image. Other image file need to be modified in same way.
++Open the **images/ui_img_battery_empty_png.c** file, as shown in Image 5.9, and change **#include "../ui.h"** to **#include "../ui_water_leak.h"**. The modified file is shown in Image 5.10. Other image files need to be modified in the same way.
  [[image:image-20241121172714-13.png]]
@@ -402,7 +402,7 @@
                                                    image 5.10 modified image file
--**7. Modify the ui_water_leak/CMakeLists.txt.** Open this file, and modify it from image 5.11 to image 5.12.
++7. Modify the **ui_water_leak/CMakeLists.txt**. Open this file, and modify it as shown in image 5.11 (before) and image 5.12 (after).
  [[image:image-20241121180030-15.png]]
@@ -412,8 +412,9 @@
    image 5.12 ui_water_leak/CMakeLists.txt after modification
--**8. Modify ui_water_leak.h file.** The image 5.13, 5.14 show the code before modification, and the image 5.15, 5.16 show the code after modification.
++**8. **Modify the **ui_water_leak.h** file. Images 5.13 and 5.14 show the code before modification, while Images 5.15 and 5.16 show the code after modification.
++
  [[image:image-20241122094200-23.png]]
                             image 5.13 ui_water_leak.h (1) before modification
@@ -488,6 +488,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"'
@@ -504,6 +504,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
@@ -512,6 +512,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"]]
@@ -522,6 +522,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]]
@@ -532,6 +532,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"]]
@@ -538,6 +538,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]]
@@ -544,6 +544,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"]]
@@ -550,6 +550,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;
@@ -568,6 +568,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.

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

Changes for page LTS5 LoRa HMI Touch Screen

Summary

Details

Applications

Navigation