Skip to content

fix: Demos: Update LVGL demo user guide #534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sadik-smd wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

fix: Demos: Update LVGL demo user guide #534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added source/images/ti-lvgl-demo-arm-analytics1.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/ti-lvgl-demo-arm-analytics2.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/ti-lvgl-demo-arm-analytics3.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/ti-lvgl-demo-legacy-home.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
149 changes: 135 additions & 14 deletions source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst
View file
Open in desktop
Copy link
Member

@cshilwant cshilwant Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For Arm Analytics,

It will be good to highlight the following somewhere in this page,

  • which model is used
  • which DL runtime is used
  • the fact of nnstreamer being used

You can even add cross referencing to below sections,

https://github.com/TexasInstruments/processor-sdk-doc/blob/master/source/linux/Foundational_Components/Machine_Learning/tflite.rst

https://github.com/TexasInstruments/processor-sdk-doc/blob/master/source/linux/Foundational_Components/Machine_Learning/nnstreamer.rst

Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

- EV Charging

- Arm analytics

- Smart Home

- Smart Meter
Expand All @@ -21,6 +23,64 @@

- Security

.. note::

Platform compatibility varies for different demo applications. Please refer to the platform compatibility table below:

Check warning on line 28 in source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsSuggestions] Depending on the context, consider using 'after', 'later', or 'following' rather than 'below'.

Raw Output:
{"message": "[RedHat.TermsSuggestions] Depending on the context, consider using 'after', 'later', or 'following' rather than 'below'.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 28, "column": 116}}}, "severity": "INFO"}

Check warning on line 28 in source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsSuggestions] Depending on the context, consider using 'see' rather than 'refer to'.

Raw Output:
{"message": "[RedHat.TermsSuggestions] Depending on the context, consider using 'see' rather than 'refer to'.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 28, "column": 74}}}, "severity": "INFO"}

.. list-table:: Demo Compatibility by Platform
:header-rows: 1
:widths: 20 16 16 16 16 16 16

* - Platform
- EV Charging
- Arm analytics
- Smart Home
- Smart Meter
- Thermostat
- Security
* - AM62L
- ✓
- ✗
- ✓
- ✓
- ✓
- ✓
* - AM62x
- ✓
- ✗
- ✓
- ✓
- ✓
- ✓
* - AM62P
- ✓
- ✗
- ✓
- ✓
- ✓
- ✓
* - AM335X
- ✗
- ✓
- ✓
- ✓
- ✓
- ✗
* - AM437X
- ✗
- ✓
- ✓
- ✓
- ✓
- ✗
* - AM65X
- ✗
- ✓
- ✓
- ✓
- ✓
- ✗

All necessary equipment and step by step instructions are provided below:

.. note::
Expand All @@ -44,6 +104,19 @@

- TI |__PART_FAMILY_DEVICE_NAMES__| SK

.. ifconfig:: CONFIG_part_variant in ('AM335X')
Copy link
Member

@cshilwant cshilwant Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For all EVMs, Add ti.com product page links with alternate text as their product page OPN name


- AM335x Evaluation Module: AM335x EVM
- BeagleBone Black

.. ifconfig:: CONFIG_part_variant in ('AM437X')

- AM437x Evaluation Module: AM437x GP EVM

.. ifconfig:: CONFIG_part_variant in ('AM65X')

- AM65x Evaluation Module: AM654x GP EVM

- PC (Windows or Linux, to use serial terminal console)

- HDMI/DSI Display (to view the Demo on Display)
Expand Down Expand Up @@ -100,10 +173,16 @@

The landing/home page of the LVGL demo looks like the following:

.. Image:: /images/ti-lvgl-demo-home-page.gif
:height: 500
.. ifconfig:: CONFIG_part_variant in ('AM335X' 'AM437X' 'AM65X')

.. Image:: /images/ti-lvgl-demo-legacy-home.png
:height: 500

.. ifconfig:: CONFIG_part_variant in ('AM62LX' 'AM62PX' 'AM62X')

.. Image:: /images/ti-lvgl-demo-home-page.gif
:height: 500

|

- In the demo, scroll through the various widgets to launch different apps.
- The date/time panel shows the UTC timezone provided the EVM is connected to the internet.
Expand All @@ -127,6 +206,22 @@
.. Image:: /images/ti-lvgl-demo-ev-charging2.png
:height: 300


Launching the Arm analytics

Check warning on line 210 in source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'Launching the Arm analytics'.

Raw Output:
{"message": "[RedHat.Headings] Use sentence-style capitalization in 'Launching the Arm analytics'.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 210, "column": 1}}}, "severity": "INFO"}
=============================

1. Launch the Arm Analytics demo by clicking the **Arm Analytics** widget in the apps scroll menu.
2. Connect the microphone and click the **Play** button to start audio recognition.

.. Image:: /images/ti-lvgl-demo-arm-analytics1.png
:height: 300
3. Expose multiple audio sources to the microphone to view the output results. Click the **Stop** button to stop audio recognition.

Check warning on line 218 in source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.SimpleWords] Use simple language. Consider using 'many' rather than 'multiple'.

Raw Output:
{"message": "[RedHat.SimpleWords] Use simple language. Consider using 'many' rather than 'multiple'.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 218, "column": 11}}}, "severity": "INFO"}

.. Image:: /images/ti-lvgl-demo-arm-analytics2.png
:height: 300
.. Image:: /images/ti-lvgl-demo-arm-analytics3.png
:height: 300

Launching the Smart Home HMI
============================

Expand Down Expand Up @@ -345,27 +440,53 @@
The source code is available at `TI LVGL Demo <https://github.com/TexasInstruments/ti-lvgl-demo.git/>`__ and can be re-compiled with the
following steps:

1. First clone the git repository and its submodules using:
.. note::
Copy link
Member

@cshilwant cshilwant Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this generic note needed?
As you have already handed the command update needed via SOC specific ifconfig in Step 1


**Source Code Repositories by Platform**

For AM335X, AM437X, and AM65X platforms, use the legacy branch of the repository:

Check warning on line 447 in source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsSuggestions] Depending on the context, consider using 'existing', 'traditional', 'established', 'classic', 'earlier', or 'previous' rather than 'legacy'.

Raw Output:
{"message": "[RedHat.TermsSuggestions] Depending on the context, consider using 'existing', 'traditional', 'established', 'classic', 'earlier', or 'previous' rather than 'legacy'.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 447, "column": 53}}}, "severity": "INFO"}

.. code-block:: console
$ git clone --recurse-submodules https://github.com/TexasInstruments/ti-lvgl-demo.git
$ git clone -b legacy --recurse-submodules https://github.com/TexasInstruments/ti-lvgl-demo-legacy.git
1. First clone the appropriate git repository and its submodules using:

.. ifconfig:: CONFIG_part_variant in ('AM62LX', 'AM62X', 'AM62PX')

.. code-block:: console
$ git clone --recurse-submodules https://github.com/TexasInstruments/ti-lvgl-demo.git
.. ifconfig:: CONFIG_part_variant in ('AM335X', 'AM437X', 'AM65X')

.. code-block:: console
$ git clone -b legacy --recurse-submodules https://github.com/TexasInstruments/ti-lvgl-demo.git
2. Create the docker environment and build the application:

.. code-block:: console

$ cd ti-lvgl-demo
$ sudo ./scripts/docker_setup.sh --create-image
$ sudo ./scripts/docker_setup.sh --build-app
.. code-block:: console
$ cd ti-lvgl-demo
$ sudo ./scripts/docker_setup.sh --create-image

Check warning on line 473 in source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'sudo'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'sudo'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 473, "column": 12}}}, "severity": "WARNING"}
$ sudo ./scripts/docker_setup.sh --build-app
3. Copy the compiled binary to :file:`/usr/bin` directory of the device

.. code-block:: console
.. ifconfig:: CONFIG_part_variant in ('AM62LX', 'AM62X', 'AM62PX')

.. code-block:: console
$ scp lv_port_linux/bin/lvglsim root@<ip-addr-of-device>:/usr/bin/

Check warning on line 482 in source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 482, "column": 47}}}, "severity": "INFO"}
$ scp -r lv_port_linux/demos/high_res/assets/* root@<ip-addr-of-device>:/usr/share/ti-lvgl-demo/assets/ #make sure assets directory is there on target

Check warning on line 483 in source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 483, "column": 62}}}, "severity": "INFO"}
$ scp -r lv_port_linux/demos/high_res/slides/* root@<ip-addr-of-device>:/usr/share/ti-lvgl-demo/slides/ #make sure slides directory is there on target

Check warning on line 484 in source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 484, "column": 62}}}, "severity": "INFO"}
$ scp lv_port_linux/certs/<certificate> root@<ip-addr-of-device>:/usr/share/ti-lvgl-demo/cert/ #make sure cert directory is there on target

Check warning on line 485 in source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 485, "column": 55}}}, "severity": "INFO"}
$ scp lv_port_linux/bin/lvglsim root@<ip-addr-of-device>:/usr/bin/
$ scp -r lv_port_linux/demos/high_res/assets/* root@<ip-addr-of-device>:/usr/share/ti-lvgl-demo/assets/ #make sure assets directory is there on target
$ scp -r lv_port_linux/demos/high_res/slides/* root@<ip-addr-of-device>:/usr/share/ti-lvgl-demo/slides/ #make sure slides directory is there on target
$ scp lv_port_linux/certs/<certificate> root@<ip-addr-of-device>:/usr/share/ti-lvgl-demo/cert/ #make sure cert directory is there on target
.. ifconfig:: CONFIG_part_variant in ('AM335X', 'AM437X', 'AM65X')

.. code-block:: console
$ scp lv_port_linux/build-arm64/bin/lvglsim root@<ip-addr-of-device>:/usr/bin/
$ scp -r lv_port_linux/build-arm64/_deps/lv_demos_ext-src/src/high_res/assets/* root@<ip-addr-of-device>:/usr/share/ti-lvgl-demo/assets/ #make sure assets directory is there on target
Loading