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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+66 −17
Open

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

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
1 change: 1 addition & 0 deletions configs/AM62LX/AM62LX_debian_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide
2 changes: 1 addition & 1 deletion source/debian/Demo_User_Guides/index_Demos.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ The default Debian image supports the following demo-applications
:maxdepth: 1

/debian/Demo_User_Guides/Chromium_Browser

/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide
2 changes: 2 additions & 0 deletions source/devices/AM62LX/debian/Getting_Started_Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ In addition to the EVM itself, the following hardware is needed:
6. USB mouse and Keyboard (For controlling the UI)
7. Ethernet cable (For network access)

.. _processor-sdk-debian-create-sd-card:

Create SD Card using balenaEtcher
---------------------------------

Expand Down
78 changes: 62 additions & 16 deletions source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

Normalize this indentation to match the contribution guidelines

Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,31 @@
Launching the TI LVGL Demo
**************************

The demo will auto launch upon Linux booting on the EVM. Follow the below instructions to flash the SD card:
.. ifconfig:: CONFIG_sdk in ('SITARA')

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__|.
The demo will auto launch upon Linux booting on the EVM. Follow the below instructions to flash the SD card:

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.
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_sdk in ('DebianSDK')

Upon booting the EVM, Weston is launched automatically. To launch the LVGL demo, refer the following
instructions:

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

Check warning on line 88 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": 88, "column": 71}}}, "severity": "INFO"}

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Not really, there are some differences. On Yocto the demo launches by-default as OOB, while on Debian the OOB is Weston. This is why I have kept them in separate ifconfigs.


4. Launch the demo by typing `/usr/bin/lvglsim` into the UART command prompt.


**********************
Using the TI LVGL Demo
**********************
Expand Down Expand Up @@ -176,16 +193,29 @@

.. note::

By default CC33xx is configured at boot, so here are the steps that can be followed to enable it:
By default CC33xx is configured at boot, so here are the steps that can be followed to enable it:

Check warning on line 196 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.PassiveVoice] 'be followed' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.

Raw Output:
{"message": "[RedHat.PassiveVoice] 'be followed' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 196, "column": 80}}}, "severity": "INFO"}

Check warning on line 196 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.PassiveVoice] 'is configured' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.

Raw Output:
{"message": "[RedHat.PassiveVoice] 'is configured' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 196, "column": 26}}}, "severity": "INFO"}

.. ifconfig:: CONFIG_sdk in ('SITARA')
Comment on lines +196 to +198
Copy link
Member

Choose a reason for hiding this comment

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

Whitespace regression


.. code-block:: console

.. code-block:: console
root@<machine>:~ systemctl stop ti-lvgl-demo
root@<machine>:~ cd /usr/share/cc33xx
root@<machine>:~ ./sta_start.sh
root@<machine>:~ ./sta_connect.sh -s WPA-PSK -n <SSID> -p <PASSWORD>
root@<machine>:~ udhcpc -i wlan0
root@<machine>:~ systemctl start ti-lvgl-demo

$ systemctl stop ti-lvgl-demo
$ cd /usr/share/cc33xx
$ ./sta_start.sh
$ ./sta_connect.sh -s WPA-PSK -n <SSID> -p <PASSWORD>
$ 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.

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have sent them a message. Will update this soon.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@StaticRocket Buildroot uses #!/bin/sh, therefore they are unwilling to make it work with bash by-default. For now, we will have to continue doing it this way.

Copy link
Member

Choose a reason for hiding this comment

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

@jsuhaas22 if you expect it to run with bash, then use the bash shebang directly - #!/bin/bash


.. code-block:: console

root@<machine>:~ systemctl stop ti-lvgl-demo
root@<machine>:~ cd /usr/share/cc33xx
root@<machine>:~ bash ./sta_start.sh
root@<machine>:~ bash ./sta_connect.sh -s WPA-PSK -n <SSID> -p <PASSWORD>
root@<machine>:~ udhcpc -i wlan0
root@<machine>:~ systemctl start ti-lvgl-demo

For more details on how to enable CC33xx and connect to WiFi, visit :ref:`How to Enable M.2-CC33x1 in Linux <enable_m2cc3301>`

Expand Down Expand Up @@ -290,11 +320,27 @@
Building the TI LVGL Demo from Sources
**************************************

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 ('SITARA')

The TI LVGL Demo is enabled in :file:`tisdk-default-image` yocto filesystem for |__PART_FAMILY_DEVICE_NAMES__| by default.

.. 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.

Check failure on line 331 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.TermsErrors] Use 'built-in' rather than 'built in'.

Raw Output:
{"message": "[RedHat.TermsErrors] Use 'built-in' rather than 'built in'.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 331, "column": 68}}}, "severity": "ERROR"}

Check warning on line 331 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 'that' or ', which' rather than ', that'.

Raw Output:
{"message": "[RedHat.TermsSuggestions] Depending on the context, consider using 'that' or ', which' rather than ', that'.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 331, "column": 5}}}, "severity": "INFO"}
The image contains the required assets within :file:`/usr/share/ti-lvgl-demo/`. Place any additional

Check warning on line 332 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 'has' rather than 'contains'.

Raw Output:
{"message": "[RedHat.SimpleWords] Use simple language. Consider using 'has' rather than 'contains'.", "location": {"path": "source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst", "range": {"start": {"line": 332, "column": 11}}}, "severity": "INFO"}
assets here while making any modifications.

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

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')

Debian package 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/>`__

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:
Expand Down