Skip to content

Commit 765197c

Browse files
committed
feat: Add Debian-specific information to LVGL OOB docs
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]>
1 parent 91beb86 commit 765197c

File tree

4 files changed

+66
-17
lines changed

4 files changed

+66
-17
lines changed

configs/AM62LX/AM62LX_debian_toc.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ debian/Building_Debian_Packages
77
debian/How_to_Guides/index_How_to_Guides
88
linux/How_to_Guides/Target/How_To_Enable_M2CC3301_in_linux
99
debian/Demo_User_Guides/index_Demos
10+
linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide

source/debian/Demo_User_Guides/index_Demos.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ The default Debian image supports the following demo-applications
1010
:maxdepth: 1
1111

1212
/debian/Demo_User_Guides/Chromium_Browser
13-
13+
/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide

source/devices/AM62LX/debian/Getting_Started_Guide.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ In addition to the EVM itself, the following hardware is needed:
2424
6. USB mouse and Keyboard (For controlling the UI)
2525
7. Ethernet cable (For network access)
2626

27+
.. _processor-sdk-debian-create-sd-card:
28+
2729
Create SD Card using balenaEtcher
2830
---------------------------------
2931

source/linux/Demo_User_Guides/TI_LVGL_Demo_User_Guide.rst

Lines changed: 62 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,31 @@ Hardware Prerequisites
6969
Launching the TI LVGL Demo
7070
**************************
7171

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

74-
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__|.
74+
The demo will auto launch upon Linux booting on the EVM. Follow the below instructions to flash the SD card:
75+
76+
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__|.
7577
Please follow the instructions from here to :ref:`Flash an SD card <processor-sdk-linux-create-sd-card>`.
7678

77-
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.
79+
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.
7880
The TI LVGL Demo will launch automatically when the device is fully booted.
7981

82+
.. ifconfig:: CONFIG_sdk in ('DebianSDK')
83+
84+
Upon booting the EVM, Weston is launched automatically. To launch the LVGL demo, refer the following
85+
instructions:
86+
87+
1. Flash an SD card with the :file:`tisdk-debian-trixie` wic image. User can download the wic image from |__SDK_DOWNLOAD_URL__|.
88+
Please follow the instructions from here to :ref:`Flash an SD card <processor-sdk-debian-create-sd-card>`.
89+
90+
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.
91+
92+
3. Weston is launched on boot. Shut it down with `systemctl stop weston`.
93+
94+
4. Launch the demo by typing `/usr/bin/lvglsim` into the UART command prompt.
95+
96+
8097
**********************
8198
Using the TI LVGL Demo
8299
**********************
@@ -176,16 +193,29 @@ To launch the Smart Home HMI demo, click on the `Smart Home` widget in the apps
176193
177194
.. note::
178195

179-
By default CC33xx is configured at boot, so here are the steps that can be followed to enable it:
196+
By default CC33xx is configured at boot, so here are the steps that can be followed to enable it:
197+
198+
.. ifconfig:: CONFIG_sdk in ('SITARA')
199+
200+
.. code-block:: console
180201
181-
.. code-block:: console
202+
root@<machine>:~ systemctl stop ti-lvgl-demo
203+
root@<machine>:~ cd /usr/share/cc33xx
204+
root@<machine>:~ ./sta_start.sh
205+
root@<machine>:~ ./sta_connect.sh -s WPA-PSK -n <SSID> -p <PASSWORD>
206+
root@<machine>:~ udhcpc -i wlan0
207+
root@<machine>:~ systemctl start ti-lvgl-demo
182208
183-
$ systemctl stop ti-lvgl-demo
184-
$ cd /usr/share/cc33xx
185-
$ ./sta_start.sh
186-
$ ./sta_connect.sh -s WPA-PSK -n <SSID> -p <PASSWORD>
187-
$ udhcpc -i wlan0
188-
$ systemctl start ti-lvgl-demo
209+
.. ifconfig:: CONFIG_sdk in ('DebianSDK')
210+
211+
.. code-block:: console
212+
213+
root@<machine>:~ systemctl stop ti-lvgl-demo
214+
root@<machine>:~ cd /usr/share/cc33xx
215+
root@<machine>:~ bash ./sta_start.sh
216+
root@<machine>:~ bash ./sta_connect.sh -s WPA-PSK -n <SSID> -p <PASSWORD>
217+
root@<machine>:~ udhcpc -i wlan0
218+
root@<machine>:~ systemctl start ti-lvgl-demo
189219
190220
For more details on how to enable CC33xx and connect to WiFi, visit :ref:`How to Enable M.2-CC33x1 in Linux <enable_m2cc3301>`
191221

@@ -290,11 +320,27 @@ This widget contains a slide-show on Application Processor Security for AM6X dev
290320
Building the TI LVGL Demo from Sources
291321
**************************************
292322

293-
The TI LVGL Demo is enabled in :file:`tisdk-default-image` yocto filesystem for |__PART_FAMILY_DEVICE_NAMES__| by default. Note, that
294-
the binary itself does not have asset images and slides built in it. :file:`tisdk-default-image` contains the required assets within
295-
:file:`/usr/share/ti-lvgl-demo/*`. Place any additional assets here while making any modifications. Yocto recipe for
296-
building this demo can be found at
297-
`github: ti-lvgl-demo.bb <https://github.com/TexasInstruments/meta-tisdk/blob/scarthgap/recipes-demos/ti-lvgl-demo/ti-lvgl-demo.bb>`__
323+
.. ifconfig:: CONFIG_sdk in ('SITARA')
324+
325+
The TI LVGL Demo is enabled in :file:`tisdk-default-image` yocto filesystem for |__PART_FAMILY_DEVICE_NAMES__| by default.
326+
327+
.. ifconfig:: CONFIG_sdk in ('DebianSDK')
328+
329+
The TI LVGL Demo is packaged in :file:`tisdk-debian-trixie` wic image for |__PART_FAMILY_DEVICE_NAMES__| by default.
330+
331+
Note, that the binary itself does not have asset images and slides built in it.
332+
The image contains the required assets within :file:`/usr/share/ti-lvgl-demo/`. Place any additional
333+
assets here while making any modifications.
334+
335+
.. ifconfig:: CONFIG_sdk in ('SITARA')
336+
337+
Yocto recipe for building this demo can be found at
338+
`github: ti-lvgl-demo.bb <https://github.com/TexasInstruments/meta-tisdk/blob/scarthgap/recipes-demos/ti-lvgl-demo/ti-lvgl-demo.bb>`__
339+
340+
.. ifconfig:: CONFIG_sdk in ('DebianSDK')
341+
342+
Debian package for building this demo can be found at
343+
`github: ti-lvgl-demo debian package <https://github.com/TexasInstruments/debian-repos/blob/master/ti-lvgl-demo/suite/trixie/debian/>`__
298344

299345
The source code is available at `TI LVGL Demo <https://github.com/TexasInstruments/ti-lvgl-demo.git/>`__ and can be re-compiled with the
300346
following steps:

0 commit comments

Comments
 (0)