Skip to content

edgeai: Minor sphinx fixes #336

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
VeeruPrudhvi merged 2 commits into from
Jul 2, 2025
Merged

edgeai: Minor sphinx fixes #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59e0c7a
fix: Switch to role-file
cshilwant Jun 30, 2025
09fca62
fix(edgeai): Switch to code-block & perform miscellaneous fixes
cshilwant Jun 30, 2025
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
27 changes: 15 additions & 12 deletions source/devices/AM62AX/edgeai/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,16 +96,17 @@
.. note::

By default IMX219 is disabled. After connecting the camera you can enable it
by specifying the dtb overlay file in
``/run/media/BOOT-mmcblk1p1/uEnv.txt`` as below,
by specifying the dtb overlay file in :file:`/run/media/BOOT-mmcblk1p1/uEnv.txt` as below,

Check warning on line 99 in source/devices/AM62AX/edgeai/getting_started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsSuggestions] Depending on the context, consider using 'after', 'later', or 'following' rather than 'below'.

Raw Output:
{"message": "[RedHat.TermsSuggestions] Depending on the context, consider using 'after', 'later', or 'following' rather than 'below'.", "location": {"path": "source/devices/AM62AX/edgeai/getting_started.rst", "range": {"start": {"line": 99, "column": 88}}}, "severity": "INFO"}

Check warning on line 99 in source/devices/AM62AX/edgeai/getting_started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'mmcblk1p1/uEnv'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'mmcblk1p1/uEnv'", "location": {"path": "source/devices/AM62AX/edgeai/getting_started.rst", "range": {"start": {"line": 99, "column": 65}}}, "severity": "WARNING"}

Check warning on line 99 in source/devices/AM62AX/edgeai/getting_started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'BOOT') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'BOOT') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/devices/AM62AX/edgeai/getting_started.rst", "range": {"start": {"line": 99, "column": 60}}}, "severity": "INFO"}

Check warning on line 99 in source/devices/AM62AX/edgeai/getting_started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'dtb'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'dtb'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/devices/AM62AX/edgeai/getting_started.rst", "range": {"start": {"line": 99, "column": 22}}}, "severity": "WARNING"}

``name_overlays=ti/k3-am62x-sk-csi2-imx219.dtbo ti/k3-am62a7-sk-edgeai.dtbo``
.. code-block:: text

name_overlays=ti/k3-am62x-sk-csi2-imx219.dtbo ti/k3-am62a7-sk-edgeai.dtbo

Reboot the board after editing and saving the file. Dtb files can be found
under /boot/dtb/ti.
under :file:`/boot/dtb/ti`.

Config file to run analytics pipeline with IMX219 camera is present under
``/opt/edgeai-gst-apps/configs/imx219_cam_example.yaml``. Please refer
:file:`/opt/edgeai-gst-apps/configs/imx219_cam_example.yaml`. Please refer

Check warning on line 109 in source/devices/AM62AX/edgeai/getting_started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'apps/configs'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'apps/configs'", "location": {"path": "source/devices/AM62AX/edgeai/getting_started.rst", "range": {"start": {"line": 109, "column": 27}}}, "severity": "WARNING"}
:ref:`pub_edgeai_sample_apps` to use the file.

Please refer :ref:`pub_edgeai_camera_sources` to know how to list all the cameras
Expand All @@ -131,7 +132,7 @@
mv /opt/imaging/imx219/linear/dcc_2a_10b_1920x1080.bin /opt/imaging/imx219/linear/dcc_2a.bin
mv /opt/imaging/imx219/linear/dcc_viss_10b_1920x1080.bin /opt/imaging/imx219/linear/dcc_viss.bin

- Set the input format in the ``/opt/edgeai-gst-apps/configs/imx219_cam_example.yaml`` as ``rggb10``
- Set the input format in the :file:`/opt/edgeai-gst-apps/configs/imx219_cam_example.yaml` as ``rggb10``

.. _pub_edgeai_fusion_mini:

Expand All @@ -157,21 +158,23 @@
.. note::

After connecting the camera you can enable it by specifying the dtb overlay
file in ``/run/media/BOOT-mmcblk1p1/uEnv.txt``. Let's take an example of
file in :file:`/run/media/BOOT-mmcblk1p1/uEnv.txt`. Let's take an example of

Check warning on line 161 in source/devices/AM62AX/edgeai/getting_started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'mmcblk1p1/uEnv'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'mmcblk1p1/uEnv'", "location": {"path": "source/devices/AM62AX/edgeai/getting_started.rst", "range": {"start": {"line": 161, "column": 35}}}, "severity": "WARNING"}

Check warning on line 161 in source/devices/AM62AX/edgeai/getting_started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'BOOT') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'BOOT') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/devices/AM62AX/edgeai/getting_started.rst", "range": {"start": {"line": 161, "column": 30}}}, "severity": "INFO"}
single IMX219 camera connected to Mini fusion board at Port 0.

``name_overlays=ti/k3-am62x-sk-csi2-v3link-fusion.dtbo ti/k3-v3link-imx219-0-0.dtbo ti/k3-am62a7-sk-edgeai.dtbo``
.. code-block:: text

name_overlays=ti/k3-am62x-sk-csi2-v3link-fusion.dtbo ti/k3-v3link-imx219-0-0.dtbo ti/k3-am62a7-sk-edgeai.dtbo

Similarly for camera connected to other port, dtbo can be appended above.
Reboot the board after editing and saving the file. Dtb files can be found
under /boot/dtb/ti.
under :file:`/boot/dtb/ti`.

Run the script to setup the cameras.

``source /opt/edgeai-gst-apps/scripts/setup_cameras_v3link.sh``

Config file to run analytics pipeline with IMX219 camera is present under
``/opt/edgeai-gst-apps/configs/imx219_cam_example.yaml``. Please refer
:file:`/opt/edgeai-gst-apps/configs/imx219_cam_example.yaml`. Please refer

Check warning on line 177 in source/devices/AM62AX/edgeai/getting_started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'apps/configs'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'apps/configs'", "location": {"path": "source/devices/AM62AX/edgeai/getting_started.rst", "range": {"start": {"line": 177, "column": 27}}}, "severity": "WARNING"}
:ref:`pub_edgeai_sample_apps` to use the file.


Expand Down Expand Up @@ -247,7 +250,7 @@
use a serial port communications program. 4 serial ports will come up on your
PC, you should connect to port 0 to get the boot logs

For Linux OS minicom** works well.
For **Linux OS minicom** works well.

Check warning on line 253 in source/devices/AM62AX/edgeai/getting_started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'minicom'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'minicom'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/devices/AM62AX/edgeai/getting_started.rst", "range": {"start": {"line": 253, "column": 16}}}, "severity": "WARNING"}

Check warning on line 253 in source/devices/AM62AX/edgeai/getting_started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'operating system' rather than 'OS'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'operating system' rather than 'OS'.", "location": {"path": "source/devices/AM62AX/edgeai/getting_started.rst", "range": {"start": {"line": 253, "column": 13}}}, "severity": "WARNING"}
Please refer to the below documentation on 'minicom' for more details.

https://help.ubuntu.com/community/Minicom
Expand Down Expand Up @@ -282,7 +285,7 @@

.. _pub_edgeai_getting_started_init_script:

As part of the linux systemd ``/opt/edgeai-gst-apps/init_script.sh`` is executed
As part of the linux systemd :file:`/opt/edgeai-gst-apps/init_script.sh` is executed
which does the below,

- This sets up necessary environment variables.
Expand Down
10 changes: 6 additions & 4 deletions source/devices/AM62AX/edgeai/pi_hdr_programming.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,20 @@ TI GPIO Library packages. The libraries have the same API as the RPi.GPIO
library for Raspberry Pi in order to provide an easy way to move applications
running on the Raspberry Pi to the TI board.

TI GPIO Libraries are packaged under ``/opt`` directory. Run the below script
TI GPIO Libraries are packaged under :file:`/opt` directory. Run the below script
to build and install the gpio libraries

.. code-block:: bash

/opt/edgeai-gst-apps# ./scripts/install_ti_gpio_libs.sh

By default, the 40-pin header is not enabled on AM69A SK board. This can be enabled by
specifying the dtb overlay file ``k3-am62a7-sk-rpi-hdr-ehrpwm.dtbo`` in
``/run/media/BOOT-mmcblk1p1/uEnv.txt`` as given below.
specifying the dtb overlay file :file:`k3-am62a7-sk-rpi-hdr-ehrpwm.dtbo` in
:file:`/run/media/BOOT-mmcblk1p1/uEnv.txt` as given below.

``name_overlays=ti/k3-am62a7-sk-rpi-hdr-ehrpwm.dtbo ti/k3-am62a7-sk-edgeai.dtbo``
.. code-block:: text

name_overlays=ti/k3-am62a7-sk-rpi-hdr-ehrpwm.dtbo ti/k3-am62a7-sk-edgeai.dtbo

Reboot the board after editing and saving the file.

Expand Down
Loading