docs: fix wording in display event, viewe and renesas (#8546)

This commit is contained in:
Victor Wheeler
2025-07-09 23:20:32 -06:00
committed by GitHub
parent 96b41a002a
commit e1e7c94476
7 changed files with 79 additions and 48 deletions
@@ -4,7 +4,7 @@ Viewe
`Viewe <https://viewedisplay.com/>`__ specializes in comprehensive display solutions
for more than 10 Years with remarkable capability of software and hardware R&D,
factory manufacturing and sales service. We not only offer one stop
factory manufacturing and sales service. Viewe not only offers one-stop
`bare display and touch solutions <https://viewedisplay.com/display-solutions/>`_
but also `embedded smart displays <https://viewedisplay.com/smart-solutions/>`_
with standard productions and tailored customization to develop your concepts
@@ -34,7 +34,7 @@ IOT AIOT Smart Displays
***********************
The Viewe IOT AIOT Smart Displays are a series of displays that use ESP32
microcontrollers with integrated multi-modal interactions of GUI /voice/camera, ML/AI
microcontrollers with integrated multi-modal interactions of GUI/voice/camera, ML/AI
edge computing, and seamless connectivity. UART/RS232/RS485/CAN Interfaces and
redundant IO interfaces are included to facilitate extended usage. LVGL/Arduino/ESP-IDF
is well-suited to these boards.
@@ -43,7 +43,7 @@ lv_port_viewe_7_espidf
----------------------
`lv_port_viewe_7_espidf <https://github.com/lvgl/lv_port_viewe_7_espidf>`_
is a port repo of LVGL which supports Viewe ESP32 S3 Smart Display 7.0 inch.
is a port repository of LVGL which supports Viewe ESP32 S3 Smart Display 7.0 inch.
It is based on ESP-IDF and uses the ESP32-S3 microcontroller.
- `Viewe ESP32 S3 Smart Display <https://viewedisplay.com/product/esp32-7-inch-800x480-rgb-ips-tft-display-touch-screen-arduino-lvgl-uart/>`_
@@ -52,7 +52,7 @@ lv_port_viewe_knob_15_espidf
----------------------------
`lv_port_viewe_knob_15_espidf <https://github.com/lvgl/lv_port_viewe_knob_15_espidf>`_
is a port repo of LVGL which supports Viewe AMOLED Touch Knob Display.
is a port repository of LVGL which supports Viewe AMOLED Touch Knob Display.
It is based on ESP-IDF and uses the ESP32-S3 microcontroller.
- `Viewe AMOLED Touch Knob Display <https://viewedisplay.com/product/esp32-1-5-inch-466x466-round-amoled-knob-display-touch-screen-arduino-lvgl/>`_
@@ -68,7 +68,7 @@ lv_port_viewe_7_espidf
----------------------
`lv_port_viewe_7_espidf <https://github.com/lvgl/lv_port_viewe_7_espidf>`_
is a port repo of LVGL which supports Viewe ESP32 S3 Smart Display 7.0 inch.
is a port repository of LVGL which supports Viewe ESP32 S3 Smart Display 7.0 inch.
It is based on ESP-IDF and uses the ESP32-S3 microcontroller.
- `Viewe ESP32 S3 Smart Display <https://viewedisplay.com/product/esp32-7-inch-800x480-rgb-ips-tft-display-touch-screen-arduino-lvgl-uart/>`_
@@ -20,7 +20,7 @@ Dave2D is capable of accelerating most of the drawing operations of LVGL:
As Dave2D works in the background, the CPU is free for other tasks. In practice, during rendering, Dave2D can reduce the CPU usage by
half or to one-third, depending on the application.
half to one-third, depending on the application.
GLCDC
@@ -35,14 +35,14 @@ More info can be found at the :ref:`driver's page<renesas_glcdc>`.
MPU Drivers
***********
Renesas MPUs (i.e., the RZ/G family) can use LVGL MPU drivers.
Renesas MPUs (i.e., the RZ/G family) can use these LVGL MPU drivers.
Wayland
-------
Supported on boards with a Wayland desktop AKA a Wayland compositor.
Use of the Wayland driver is supported on boards with a Wayland desktop AKA a Wayland compositor.
fbdev
-----
Almost always available.
The LVGL ``fbdev`` (frame buffer) display driver can almost always be used.
@@ -13,13 +13,17 @@ Supported boards in the RA Family:
- **EK-RA8P1**
- **EK-RA6M3G**
Run the Project
***************
- The official IDE of Renesas is called e\ |sup2| studio. As it's Eclipse-based, it runs on Windows, Linux, and Mac as well.
Members of the RA family require certain minimum versions of the FSP. See the individual README.md files in the repos for info.
FSPs can be downloaded `here <https://www.renesas.com/us/en/software-tool/flexible-software-package-fsp>`__.
- JLink is used for debugging, it can be downloaded `here <https://www.segger.com/downloads/jlink/>`__.
- The official IDE of Renesas is called e\ |sup2| studio. Because it's Eclipse-based,
it runs on Windows, Linux, and Mac as well. Members of the RA family require
certain minimum versions of the Flexible Software Package (FSP). See the individual
README.md files in the applicable repositories for info. FSPs can be downloaded
`here <https://www.renesas.com/us/en/software-tool/flexible-software-package-fsp>`__.
- JLink is used for debugging, it can be downloaded `here
<https://www.segger.com/downloads/jlink/>`__.
- Clone the ready-to-use repository for your selected board:
.. code-block:: shell
@@ -28,12 +32,14 @@ Run the Project
Downloading the `.zip` from GitHub doesn't work as it doesn't download the submodules.
- Open e\ |sup2| studio, go to ``File`` -> ``Import project`` and select ``General`` / ``Existing projects into workspace``
- Browse the cloned folder and press ``Finish``.
- Double click on ``configuration.xml``. This will activate the `Configuration Window`.
- Open e\ |sup2| studio, go to ``File`` -> ``Import project`` and select
``General`` / ``Existing projects into workspace``.
- Select the cloned folder and press ``Finish``.
- Double-click on ``configuration.xml``. This will activate the `Configuration Window`.
Renesas' Flexible Software Package (FSP) includes BSP and HAL layer support extended with multiple RTOS variants and other middleware stacks.
The components will be available via code generation, including the entry point of *"main.c"*.
Renesas' Flexible Software Package (FSP) includes BSP and HAL layer support extended
with multiple RTOS variants and other middleware stacks. The components will be
available via code generation, including the entry point in *"main.c"*.
Press ``Generate Project Content`` in the top right corner.
@@ -41,7 +47,9 @@ Run the Project
:alt: Code generation with FSP
- Build the project by pressing ``Ctrl`` + ``Alt`` + ``B``
- Click the Debug button (|img_debug_btn|). If prompted with `Debug Configurations`, on the `Debugger` tab select the ``J-Link ARM`` as `Debug hardware` and the proper IC as `Target Device`:
- Click the Debug button (|img_debug_btn|). If prompted with `Debug Configurations`,
on the `Debugger` tab select the ``J-Link ARM`` as `Debug hardware` and the proper
IC as `Target Device`:
- ``R7FA8D1BH`` for EK-RA8D1
@@ -54,7 +62,10 @@ Run the Project
:alt: Debugger parameters for RA6
.. note::
On EK-RA8D1 boards, the ``SW1`` DIP switch (middle of the board) 7 should be ON, all others are OFF.
On EK-RA8D1 boards, the ``SW1`` DIP switch 7 (in the middle of the board) should be
ON, all others are OFF.
Modify the project
@@ -66,7 +77,8 @@ Open a demo
The entry point of the main task is contained in ``src/LVGL_thread_entry.c``.
You can disable the LVGL demos (or just comment them out) and call some ``lv_example_...()`` functions, or add your custom code.
You can disable the LVGL demos (or just comment them out) and call some
``lv_example_...()`` functions, or add your own custom code.
Configuration
@@ -75,15 +87,17 @@ Configuration
``src/lv_conf.h`` (or ``src/lv_conf_user.h``) contains the most important settings for LVGL. Namely:
- :c:macro:`LV_COLOR_DEPTH` to set LVGL's default color depth
- :c:macro:`LV_MEM_SIZE` to set the maximum RAM available for LVGL
- :c:macro:`LV_MEM_SIZE` to set the maximum RAM available to LVGL
- :c:macro:`LV_USE_DAVE2D` to enable the GPU
Hardware and software components can be modified in a visual way using the `Configuration Window`.
Hardware and software components can be modified in a visual way using the
``Configuration Window``.
As of e2studio 2025-04.1 and FSP 6.0.0, LVGL is a managed component.
Support
*******
@@ -11,11 +11,14 @@ Supported boards in the RX Family:
- **RX72N Envision Kit**
Run the Project
***************
- The official IDE of Renesas is called e\ |sup2| studio. As it's Eclipse-based, it runs on Windows, Linux, and Mac as well.
It can be downloaded `here <https://www.renesas.com/us/en/software-tool/e-studio>`__.
- The official IDE of Renesas is called e\ |sup2| studio. Because it's Eclipse-based,
it runs on Windows, Linux, and Mac as well. It can be downloaded
`here <https://www.renesas.com/us/en/software-tool/e-studio>`__.
- Download and install the required driver for the debugger
- for Windows: `64 bit here <https://www.renesas.com/us/en/document/uid/usb-driver-renesas-mcu-tools-v27700-64-bit-version-windows-os?r=488806>`__
@@ -23,15 +26,13 @@ Run the Project
- for Linux: `here <https://www.renesas.com/us/en/document/swo/e2-emulator-e2-emulator-lite-linux-driver?r=488806>`__
- RX72 requires an external compiler for the RXv3 core. A free and open-source version is available
`here <https://llvm-gcc-renesas.com/rx-download-toolchains/>`__ after a registration.
`here <https://llvm-gcc-renesas.com/rx-download-toolchains/>`__ after registration.
The compiler must be activated in e\ |sup2| studio:
- Go to go to ``Help`` -> ``Add Renesas Toolchains``
- Press the ``Add...`` button
- Browse the installation folder of the toolchain
<br/>
- Select the installation folder of the toolchain
.. image:: /_static/images/renesas/toolchains.png
:alt: Toolchains
@@ -47,10 +48,11 @@ Run the Project
- Open e\ |sup2| studio, go to ``File`` -> ``Import project`` and select ``General`` / ``Existing projects into workspace``
- Select the cloned folder and press ``Finish``.
- Double click on ``RX72N_EnVision_LVGL.scfg``. This will activate the `Configuration Window`.
- Double-click on ``RX72N_EnVision_LVGL.scfg`` to activate the ``Configuration Window``.
Renesas' Smart Configurator (SMC) includes BSP and HAL layer support extended with multiple RTOS variants and other middleware stacks.
The components will be available via code generation, including the entry point of the application.
Renesas' Smart Configurator (SMC) includes BSP and HAL layer support extended with
multiple RTOS variants and other middleware stacks. The components will be
available via code generation, including the entry point of the application.
Press ``Generate Code`` in the top right corner.
@@ -68,6 +70,7 @@ Run the Project
Make sure that both channels of ``SW1`` DIP switch (next to ``ECN1``) are OFF.
Modify the project
******************
@@ -77,7 +80,8 @@ Open a demo
The entry point of the main task is contained in ``src/LVGL_thread_entry.c``.
You can disable the LVGL demos (or just comment them out) and call some ``lv_example_...()`` functions, or add your custom code.
You can disable the LVGL demos (or just comment them out) and call some
``lv_example_...()`` functions, or add your own custom code.
Configuration
@@ -86,11 +90,13 @@ Configuration
``src/lv_conf.h`` contains the most important settings for LVGL. Namely:
- :c:macro:`LV_COLOR_DEPTH` to set LVGL's default color depth
- :c:macro:`LV_MEM_SIZE` to set the maximum RAM available for LVGL
- :c:macro:`LV_MEM_SIZE` to set the maximum RAM available to LVGL
- :c:macro:`LV_USE_DAVE2D` to enable the GPU
Hardware and software components can be modified in a visual way using the `Configuration Window`.
Hardware and software components can be modified in a visual way using the
``Configuration Window``.
Support
@@ -6,6 +6,8 @@ Supported boards in the RZ/A Family:
- **RZ/A3M**
Run the Project
***************
@@ -21,6 +23,8 @@ Run the Project
- Follow the instructions in the project README.md to
build and flash the project to the board.
Modify the project
******************
@@ -31,7 +35,7 @@ Open a demo
The entry point is contained in ``src/LVGL_thread_entry.c``.
You can disable the LVGL demos (``lv_demo_benchmark()``) (or just comment them out)
and call some ``lv_example_...()`` functions, or add your custom code.
and call some ``lv_example_...()`` functions, or add your own custom code.
Configuration
@@ -39,7 +43,8 @@ Configuration
Edit ``lv_conf.h`` to configure LVGL.
It will automatically run any demo that is enabled in ``lv_conf.h``. You can see ``lv_conf.defaults`` for a summary of the configs which have been changed from the defaults.
It will automatically run any demo that is enabled in ``lv_conf.h``. You can see
``lv_conf.defaults`` for a summary of the configs which have been changed from the defaults.
Support
@@ -7,15 +7,19 @@ Supported boards in the RZ/G Family:
- **RZ/G2L-EVKIT**
- **RZ/G2UL-EVKIT**
Run the Project
***************
- The RZ/G boards are MPUs with support for running Linux. Projects are built for them using a cross-compiler
CLI toolchain SDK in a Linux PC environment (WSL, Docker, etc. can be used on Windows).
- The G2L has a Wayland desktop and the project appears as a Wayland window. The G2UL does not have
a desktop so the project is fullscreen and uses the ``fbdev`` driver.
- The SDK currently uses LVGL v8.3 so this project uses this version to mirror the SDK version,
even though LVGL is statically linked. You may try using newer versions of LVGL.
- The RZ/G boards are MPUs with support for running Linux. Projects are built for them
using a cross-compiler CLI toolchain SDK in a Linux PC environment (WSL, Docker,
etc. can be used on Windows).
- The G2L has a Wayland desktop and the project appears as a Wayland window. The G2UL
does not have a desktop so the project is fullscreen and uses the ``fbdev`` driver.
- The SDK currently uses LVGL v8.3 so this project uses this version to mirror the SDK
version, even though LVGL is statically linked. You may try using newer versions of LVGL.
See the `v8-to-v9 Migration Guide <https://docs.lvgl.io/9.0/CHANGELOG.html#migration-guide>`__ for things you will need to address.
- Clone the ready-to-use repository for your selected board:
.. code-block:: shell
@@ -34,6 +38,7 @@ Run the Project
./lvgl_demo_benchmark
Modify the project
******************
@@ -44,15 +49,15 @@ Open a demo
The entry point is contained in ``src/main.c``.
You can disable the LVGL demos (``lv_demo_benchmark()``) (or just comment them out)
and call some ``lv_example_...()`` functions, or add your custom code.
and call some ``lv_example_...()`` functions, or add your own custom code.
Configuration
-------------
Edit ``lv_conf.h`` and ``lv_drv_conf.h`` to configure LVGL. The board image
contains LVGL and lv_drivers as dynamically linkable libraries. This project builds LVGL statically
for customizability and to port the LVGL v9 benchmark LVGL v8.3.
contains LVGL and lv_drivers as dynamically linkable libraries. This project builds
LVGL statically for customizability and to port the LVGL v9 benchmark from LVGL v8.3.
Support
@@ -1,7 +1,8 @@
.. _display_events:
Events
******
==============
Display Events
==============
:cpp:expr:`lv_display_add_event_cb(disp, event_cb, LV_EVENT_..., user_data)` adds
an event handler to a display.