Skip to content

feat(linux): Update GUI Frameworks guide #683

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

Merged
StaticRocket merged 1 commit into from
Apr 21, 2026
Merged

feat(linux): Update GUI Frameworks guide #683

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 modified source/images/flutter-samples-material-3-demo.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/slint_energy_monitor.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 modified source/images/slint_home_automation.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 modified source/images/slint_opengl_underlay.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 modified source/images/slint_printer_demo.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 modified source/images/slint_puzzle_demo.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.
52 changes: 13 additions & 39 deletions source/linux/Demo_User_Guides/GUI_Frameworks_User_Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
git clone https://git.ti.com/git/arago-project/oe-layersetup.git tisdk
cd tisdk

# Replace <oeconfig-file> with the appropriate file for the release
# Replace <oeconfig-file> with the default oe-config file for the release

Check warning on line 44 in source/linux/Demo_User_Guides/GUI_Frameworks_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/GUI_Frameworks_User_Guide.rst", "range": {"start": {"line": 44, "column": 17}}}, "severity": "INFO"}
# uncomment the meta-flutter layer configuration in the selected <oeconfig-file>
./oe-layertool-setup.sh -f configs/processor-sdk/<oeconfig-file>
cd build
Expand Down Expand Up @@ -102,46 +102,14 @@
Building with Slint
===================

This guide provides instructions on how to add the `meta-slint <https://layers.openembedded.org/layerindex/branch/master/layer/meta-slint/>`__ layer
to the Yocto build system of the TI Processor SDK to build and run Slint applications.
#. Slint version 1.15 example demos are integrated by default in the :file:`tisdk-default-image`. User can download

Check warning on line 105 in source/linux/Demo_User_Guides/GUI_Frameworks_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.PassiveVoice] 'are integrated' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.

Raw Output:
{"message": "[RedHat.PassiveVoice] 'are integrated' 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/GUI_Frameworks_User_Guide.rst", "range": {"start": {"line": 105, "column": 37}}}, "severity": "INFO"}
the :file:`tisdk-default-image` wic image from |__SDK_DOWNLOAD_URL__|.

Check warning on line 106 in source/linux/Demo_User_Guides/GUI_Frameworks_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'wic'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'wic'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.", "location": {"path": "source/linux/Demo_User_Guides/GUI_Frameworks_User_Guide.rst", "range": {"start": {"line": 106, "column": 36}}}, "severity": "WARNING"}

#. **Prepare your Yocto environment:**
Complete the one-time setup prerequisites listed in the |__SDK_FULL_NAME__| documentation at :ref:`building-the-sdk-with-yocto`.

#. **Configure and build the SDK:**
The following commands will set up the necessary Slint and dependent layers and build the image.

.. code-block:: console

# Set up the base SDK layers
git clone https://git.ti.com/git/arago-project/oe-layersetup.git tisdk
cd tisdk

# Create a new config for Slint and add the required meta-layers
# Replace <oeconfig-file> with the appropriate file for the release
cp configs/processor-sdk/<oeconfig-file> configs/slint-config.txt
echo "meta-slint,https://github.com/slint-ui/meta-slint.git,main,7406ee51c140968345b86f3927a8c67984a2dda8,layers=" >> configs/slint-config.txt
echo "meta-rust-bin,https://github.com/rust-embedded/meta-rust-bin.git,master,79c077fac9694eb5fbcee7b15e800c21e887bb5d,layers=" >> configs/slint-config.txt
#. Follow the steps in :ref:`building-the-sdk-with-yocto` to build the image from sources.
Use the default oe-config file, which includes the ``meta-slint`` layer.
See :ref:`Yocto Layer Configuration <yocto-layer-configuration>` to find the correct oe-config file for the release.

Check warning on line 110 in source/linux/Demo_User_Guides/GUI_Frameworks_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/GUI_Frameworks_User_Guide.rst", "range": {"start": {"line": 110, "column": 40}}}, "severity": "INFO"}

# Set up the bitbake build environment
./oe-layertool-setup.sh -f configs/slint-config.txt
cd build/

# Add the slint-demos package to the image
echo 'IMAGE_INSTALL:append = " slint-demos"' >> conf/local.conf

# Source the environment and build the image
. conf/setenv
MACHINE=<machine> bitbake -k tisdk-default-image

.. note::

See the :ref:`Yocto Layer Configuration <yocto-layer-configuration>` guide to find the
correct :file:`<oeconfig-file>` for the SDK release. Set the ``<machine>`` variable
to your target device as in :ref:`Build_Options`.

#. **Flash the SD Card:**
Once the build is complete, flash the generated image at :file:`build/deploy-ti/images/<machine>/tisdk-default-image-<machine>.wic.xz`
#. Once the build is complete, flash the generated image at :file:`build/deploy-ti/images/<machine>/tisdk-default-image-<machine>.wic.xz`
onto a SD card. See :ref:`Flash an SD card <processor-sdk-linux-create-sd-card>` for instructions.

Running the Demos
Expand Down Expand Up @@ -201,3 +169,9 @@
:alt: Slint Puzzle Demo

Puzzle demo

.. figure:: /images/slint_energy_monitor.png
:align: left
:alt: Slint Energy Monitor Demo

Energy Monitor
Loading