Skip to content

docs(fioctl): add examples of tags and apps #840

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.

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
merged 4 commits into from
Jul 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 .jobserv.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,5 @@ scripts:
#!/bin/sh -ex
apk add --update make git graphviz curl ttf-freefont gcc musl-dev python3-dev
pip install -r ./requirements.txt
sed -i "/value == self.search_anchor/c\ if key in ('id', 'name', 'href') and value.strip(\"#\") == self.search_anchor:" /usr/local/lib/python3.12/site-packages/sphinx/builders/linkcheck.py
make BUILDDIR=/archive SPHINXBUILD=sphinx-build linkcheck
2 changes: 1 addition & 1 deletion source/_static/csv/supported-boards.csv
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Device Name,MACHINE
:ref:`NXP i.MX 93 EVK <ref-rm_board_imx93evk>`,imx93-11x11-lpddr4x-evk
:ref:`QEMU AARCH32 <ref-rm_qemu_arm>`,qemuarm
:ref:`QEMU AARCH64 <ref-rm_qemu_arm64>`,qemuarm64-secureboot
`Qualcomm RB3 Gen 2 <https://github.com/foundriesio/meta-partner/tree/qualcomm?tab=readme-ov-file#quick-start-guide>`_,qcs6490-rb3gen2-vision-kit
`Qualcomm RB3 Gen 2 <https://github.com/foundriesio/meta-partner/tree/qualcomm?tab=readme-ov-file#getting-started>`_,qcs6490-rb3gen2-vision-kit
:ref:`Raspberry Pi3/3B (64 bit) <ref-rm_board_rasbperrypi>`,raspberrypi3-64
:ref:`Raspberry Pi4 (and CM) <ref-rm_board_rasbperrypi>`,raspberrypi4-64
:ref:`TI SK-AM62 <ref-rm_board_am62xx-sk>`,am62xx-evm
Expand Down
4 changes: 3 additions & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@
'sphinx_tabs.tabs',
'sphinx_copybutton',
'sphinx_toolbox.confval',
'sphinx-prompt',
'sphinx_prompt',
'sphinx_reredirects',
'sphinx.ext.graphviz',
]
Expand Down Expand Up @@ -197,6 +197,8 @@
r'https://sourceforge.net/.*', # 403 error
'https://www.nsa.gov/portals/75/documents/what-we-do/cybersecurity/professional-resources/csi-uefi-lockdown.pdf', # 403 error
r'https://source.foundries.io/factories/.*',
'https://media.defense.gov/2020/Sep/15/2002497594/-1/-1/0/CTR-UEFI-Secure-Boot-Customization-UOO168873-20.PDF', # 403 error but will work for end user
r'https://www.nxp.com/webapp/Download?colCode=.*' # timeouts
]
# Time in seconds to wait for a response. May result in false errors, but also keeps things from timing out
linkcheck_timeout = 10
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Devices configured to watch a tag and Hardware ID (``MACHINE``) that match your

.. tip::

Read the blog, `What is a Target? <https://foundries.io/insights/blog/2020/05/14/whats-a-target/>`_
Read the blog, `What is a Target? <https://foundries.io/insights/blog/whats-a-target/>`_
to get a high-level overview of **Targets**.
No need to follow the instructions, as we will replicate them for here.

Expand Down
43 changes: 43 additions & 0 deletions source/user-guide/fioctl/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,15 @@ Set device tag
$ fioctl devices config updates ein --tag devel
Changing tag from: main -> devel

Reset device tag
``fioctl devices config updates <device_name> --tag -``
This will reset the tag to whatever the device got flashed with.

.. code-block:: console

$ fioctl devices config updates ein --tag -
Changing tag from: feat -> prod

Set app(s) to be enabled
``fioctl devices config updates <device_name> --apps <app_name1>,<app_name2>``
Set the app(s) a device will run.
Expand All @@ -277,6 +286,40 @@ Set app(s) to be enabled
$ fioctl devices config updates ein --apps simple-app
Changing apps from: [netdata] -> [simple-app]

Set app(s) to be system default
``fioctl devices config updates <device_name> --apps "-"``
Set the app(s) a device will run based on what it got flashed with.

.. code-block:: console

$ fioctl devices config updates ein --apps -
Changing apps from: [] -> [netdata, simple-app]

Disable all apps
``fioctl devices config updates <device_name> --apps ,``
No apps will run.

.. code-block:: console

$ fioctl devices config updates ein --apps ,
Changing apps from: [netdata] -> []

Show current config override
``fioctl devices config updates <device_name> --apps "" --tags ""``
Will show current overrides.

.. code-block:: console

$ fioctl devices config updates ein --apps "" --tags ""
= Reporting to server with
Tag: feat
Apps: netdata

= Configured overrides

[pacman]


Enable :ref:`ref-wireguard`
``fioctl devices config wireguard <device_name> <enable|disable>``
Enable or disable the Wireguard systemd service on a LmP device.
Expand Down
2 changes: 1 addition & 1 deletion source/user-guide/flashing/rb3gen2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
Qualcomm Dragonwing RB3 Gen 2 Development Kit
=============================================

You can find flashing and setup instructions in the ``meta-partners`` `repo <https://github.com/foundriesio/meta-partner/tree/qualcomm?tab=readme-ov-file#quick-start-guide>`_.
You can find flashing and setup instructions in the ``meta-partners`` `repo <https://github.com/foundriesio/meta-partner/tree/qualcomm?tab=readme-ov-file#getting-started>`_.