feat: Add Debian-specific information to LVGL OOB docs #201
Conversation
jsuhaas22
requested review from
cshilwant,
StaticRocket,
praneethbajjuri,
uditkumarti,
aniket-l and
VeeruPrudhvi
as code owners
|
|
||
| .. ifconfig:: CONFIG_sdk in ('DebianSDK') | ||
|
|
||
| Upon booting the EVM, Weston is launched automatically. To launch the LVGL OOB demo, follow the following |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
| 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 |
There was a problem hiding this comment.
| $ 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 |
There was a problem hiding this comment.
| 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: |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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') |
There was a problem hiding this comment.
Incorrect indentation depth
|
@jsuhaas22 is this PR still valid? |
jsuhaas22
force-pushed
the
debianize-lvgl-docs
branch
from
eec1f5c to
545dc2e
Compare
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
force-pushed
the
debianize-lvgl-docs
branch
from
545dc2e to
6575258
Compare
| @@ -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 | |||
There was a problem hiding this comment.
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 | |||
There was a problem hiding this comment.
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`. |
There was a problem hiding this comment.
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') |
There was a problem hiding this comment.
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.
| .. 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. |
There was a problem hiding this comment.
This was completely unnecessary duplication.
| .. 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/>`__ | ||
|
|
There was a problem hiding this comment.
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') |
There was a problem hiding this comment.
Completely unnecessary duplication. Those scripts should have their shebang updated if they specifically need bash. That's a bug.
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.