Skip to content

feat: Add Debian-specific information to LVGL OOB docs #201

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jsuhaas22
Copy link
Collaborator

Presently, the LVGL OOB page is written under the assumption that the user is using Yocto. For Debian, some of the lines have to be changed. Therefore make those changes.

Also add the doc in Debian's tree.

VeeruPrudhvi
VeeruPrudhvi previously approved these changes Mar 4, 2025
Copy link
Contributor

@VeeruPrudhvi VeeruPrudhvi left a comment

Choose a reason for hiding this comment

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

LGTM


.. ifconfig:: CONFIG_sdk in ('DebianSDK')

Upon booting the EVM, Weston is launched automatically. To launch the LVGL OOB demo, follow the following
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Upon booting the EVM, Weston is launched automatically. To launch the LVGL OOB demo, follow the following
Upon booting the EVM, Weston is launched automatically. To launch the LVGL demo, refer the following

Drop OOB => Out of the Box as that's not the case in Debian

Also, follow the following sounds odd...better to use refer


3. Weston is launched on boot. Shut it down with `systemctl stop weston`.

4. Lauch the demo by typing `lvglsim` into the UART command prompt.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
4. Lauch the demo by typing `lvglsim` into the UART command prompt.
4. Lauch the demo by typing :code:`/usr/bin/lvglsim` into the UART command prompt.

It's a good practice to mention absolute path

$ systemctl start ti-lvgl-demo
.. code-block:: console

$ systemctl stop ti-lvgl-demo
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
$ systemctl stop ti-lvgl-demo
root@<machine>:~ systemctl stop ti-lvgl-demo

For all references


.. ifconfig:: CONFIG_sdk in ('DebianSDK')

The TI LVGL Demo is installed in :file:`tisdk-debian-trixie` wic image for |__PART_FAMILY_DEVICE_NAMES__| by default. Note, that
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The TI LVGL Demo is installed in :file:`tisdk-debian-trixie` wic image for |__PART_FAMILY_DEVICE_NAMES__| by default. Note, that
The TI LVGL Demo is packaged in :file:`tisdk-debian-trixie` wic image for |__PART_FAMILY_DEVICE_NAMES__| by default. Note, that


1. Flash an SD card with the :file:`tisdk-default-image`. User can download the :file:`tisdk-default-image` wic image from |__SDK_DOWNLOAD_URL__|.
Please follow the instructions from here to :ref:`Flash an SD card <processor-sdk-linux-create-sd-card>`.
The demo will auto launch upon Linux booting on the EVM. Follow the below instructions to flash the SD card:
Copy link
Member

Choose a reason for hiding this comment

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

Incorrect indentation depth

1. Flash an SD card with the :file:`tisdk-default-image`. User can download the :file:`tisdk-default-image` wic image from |__SDK_DOWNLOAD_URL__|.
Please follow the instructions from here to :ref:`Flash an SD card <processor-sdk-linux-create-sd-card>`.

2. Insert the flashed SD card to the board, connect the display, mouse/touch-input, ethernet cable, aux cable, jumper wire and power on the EVM.
Copy link
Member

Choose a reason for hiding this comment

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

Mentioning the device specific jumper wire in a device agnostic section. Please clarify that this is only required if mentioned previously.

$ ./sta_connect.sh -s WPA-PSK -n <SSID> -p <PASSWORD>
$ udhcpc -i wlan0
$ systemctl start ti-lvgl-demo
.. code-block:: console
Copy link
Member

Choose a reason for hiding this comment

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

Incorrect indentation depth. A lot of this file is mixed indentation depths.

$ udhcpc -i wlan0
$ systemctl start ti-lvgl-demo

.. ifconfig:: CONFIG_sdk in ('DebianSDK')
Copy link
Member

Choose a reason for hiding this comment

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

Incorrect indentation depth

@cshilwant
Copy link
Member

@jsuhaas22 is this PR still valid?
If yes, please plan to address the review comments

Copy link
Member

@cshilwant cshilwant left a comment

Choose a reason for hiding this comment

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

Resolve merge conflicts

Presently, the LVGL OOB page is written under the assumption that the
user is using Yocto. For Debian, some of the lines have to be changed.
Therefore make those changes.

Also add the doc in Debian's tree.

Signed-off-by: Suhaas Joshi <[email protected]>
@jsuhaas22 jsuhaas22 force-pushed the debianize-lvgl-docs branch from 545dc2e to 6575258 Compare May 16, 2025 04:25
@@ -7,3 +7,4 @@ debian/Building_Debian_Packages
debian/How_to_Guides/index_How_to_Guides
linux/How_to_Guides/Target/How_To_Enable_M2CC3301_in_linux
debian/Demo_User_Guides/index_Demos
system/Demo_User_Guides/TI_LVGL_Demo_User_Guide
Copy link
Member

Choose a reason for hiding this comment

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

This path needs to be updated

@@ -10,4 +10,4 @@ The default Debian image supports the following demo-applications
:maxdepth: 1

/debian/Demo_User_Guides/Chromium_Browser

/system/Demo_User_Guides/TI_LVGL_Demo_User_Guide
Copy link
Member

Choose a reason for hiding this comment

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

This path needs to be updated


2. Insert the flashed SD card to the board, connect the display, mouse/touch-input, ethernet cable, aux cable, jumper wire and power the EVM on.

3. Weston is launched on boot. Shut it down with `systemctl stop weston`.
Copy link
Member

Choose a reason for hiding this comment

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

This behavior is the same on both SDKs, though I do admit that stopping it is now different.

Please follow the instructions from here to :ref:`Flash an SD card <processor-sdk-linux-create-sd-card>`.

2. Insert the flashed SD card to the board, connect the display, mouse/touch-input, ethernet cable, aux cable, jumper wire and power on the EVM.
The TI LVGL Demo will launch automatically when the device is fully booted.
.. ifconfig:: CONFIG_part_variant not in ('AM62LX')
Copy link
Member

Choose a reason for hiding this comment

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

Why were these ifconfigs allowed in the first place? This is all very specific to the version of the SDK provided with the AM62LX and this entire file is masked by the toc tree on every other device right now.

Comment on lines +97 to +103
.. ifconfig:: CONFIG_sdk not in ('AM62LX')

2. Insert the flashed SD card to the board, connect the display, mouse/touch-input, ethernet cable, aux cable, jumper wire and power the EVM on.

.. ifconfig:: CONFIG_sdk in ('AM62LX')

2. Insert the flashed SD card to the board, connect the display, mouse/touch-input, ethernet cable, aux cable, jumper wire and power the EVM on.
Copy link
Member

Choose a reason for hiding this comment

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

This was completely unnecessary duplication.

Comment on lines +336 to +351
.. ifconfig:: CONFIG_sdk in ('SITARA')

The TI LVGL Demo is enabled in :file:`tisdk-default-image` yocto filesystem for |__PART_FAMILY_DEVICE_NAMES__| by default. Note, that
the binary itself does not have asset images and slides built in it. :file:`tisdk-default-image` contains the required assets within
:file:`/usr/share/ti-lvgl-demo/`. Place any additional assets here while making any modifications. Yocto recipe for
building this demo can be found at
`github: ti-lvgl-demo.bb <https://github.com/TexasInstruments/meta-tisdk/blob/scarthgap/recipes-demos/ti-lvgl-demo/ti-lvgl-demo.bb>`__

.. ifconfig:: CONFIG_sdk in ('DebianSDK')

The TI LVGL Demo is packaged in :file:`tisdk-debian-trixie` wic image for |__PART_FAMILY_DEVICE_NAMES__| by default. Note, that
the binary itself does not have asset images and slides built in it. :file:`tisdk-debian-trixie` contains the required assets within
:file:`/usr/share/ti-lvgl-demo/`. Place any additional assets here while making any modifications. Debian package
files for building this demo can be found at
`github: ti-lvgl-demo debian package <https://github.com/TexasInstruments/debian-repos/blob/master/ti-lvgl-demo/suite/trixie/debian/>`__

Copy link
Member

Choose a reason for hiding this comment

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

Split the common parts of this paragraph into something that can be ifconfiged directly. Too much duplication here.


.. code-block:: console
.. ifconfig:: CONFIG_sdk in ('DebianSDK')
Copy link
Member

Choose a reason for hiding this comment

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

Completely unnecessary duplication. Those scripts should have their shebang updated if they specifically need bash. That's a bug.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants