Skip to content
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

Re-organize board-specific samples per vendor and add zephyr:code-sample directive #78089

Merged
merged 22 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
29ce82e
samples: boards: espressif: use zephyr:code-sample directive
kartben Sep 6, 2024
048cf0f
samples: boards: espressif: group Espressif board samples
kartben Sep 6, 2024
6e1caee
samples: boards: nrf: use zephyr:code-sample directive
kartben Sep 6, 2024
dd13641
samples: boards: nrf: group Nordic board samples
kartben Sep 6, 2024
aca06e1
samples: boards: nxp: group NXP board samples
kartben Sep 6, 2024
8975271
samples: boards: nxp: use zephyr:code-sample directive
kartben Sep 6, 2024
784f428
samples: boards: bbc: group BBC board samples
kartben Sep 6, 2024
a291b80
samples: boards: bbc_microbit: use zephyr:code-sample directive
kartben Sep 6, 2024
90f196c
samples: boards: 96boards: group 96boards board samples
kartben Sep 6, 2024
e880299
samples: boards: 96boards: use zephyr:code-sample directive
kartben Sep 8, 2024
3641981
samples: boards: microchip: group Microchip board samples
kartben Sep 6, 2024
ffc8637
samples: boards: stm32: use zephyr:code-sample directive
kartben Sep 6, 2024
62cca0e
samples: boards: stm32: group STM32 board samples
kartben Sep 6, 2024
54ed5ea
samples: boards: quicklogic: group quicklogic board samples
kartben Sep 6, 2024
b17edc6
samples: boards: intel: group Intel board samples
kartben Sep 6, 2024
19a775d
samples: boards: phytec: group Phytec board samples
kartben Sep 6, 2024
aea894c
samples: boards: google: group Google board samples
kartben Sep 6, 2024
baba7dc
samples: boards: raspberrypi: group Raspberry Pi board samples
kartben Sep 6, 2024
a43da2c
samples: boards: nuvoton: group Nuvoton board samples
kartben Sep 6, 2024
f2c1482
samples: boards: enjoydigital: group Enjoydigital board samples
kartben Sep 6, 2024
851c41b
samples: boards: ti: use zephyr:code-sample directive
kartben Sep 8, 2024
46f81d5
samples: doc: clean-up table of contents for board samples
kartben Sep 6, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
14 changes: 7 additions & 7 deletions MAINTAINERS.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2317,7 +2317,7 @@ Google Platforms:
- duda-patryk
files:
- boards/google/
- samples/boards/google_*/
- samples/boards/google/

Hash Utilities:
status: maintained
Expand Down Expand Up @@ -3567,7 +3567,7 @@ Intel Platforms (Xtensa):
- soc/intel/intel_adsp/
- dts/xtensa/intel/
- tests/boards/intel_adsp/
- samples/boards/intel_adsp/
- samples/boards/intel/adsp/
- dts/bindings/*/intel,adsp*
- scripts/west_commands/runners/intel_adsp.py
labels:
Expand Down Expand Up @@ -3693,7 +3693,7 @@ NXP Platforms (S32):
- drivers/misc/*nxp_s32*/
- dts/bindings/*/nxp,s32*
- dts/arm/nxp/*s32*
- samples/boards/nxp_s32/
- samples/boards/nxp/s32/
- include/zephyr/dt-bindings/*/nxp-s32*
- include/zephyr/dt-bindings/*/nxp_s32*
- include/zephyr/drivers/*/*nxp_s32*
Expand Down Expand Up @@ -3800,7 +3800,7 @@ nRF Platforms:
- drivers/*/*nrf*.c
- drivers/*/*nordic*/
- soc/nordic/
- samples/boards/nrf/
- samples/boards/nordic/
- dts/*/nordic/
- dts/bindings/*/nordic,*
- tests/drivers/*/*nrf*/
Expand Down Expand Up @@ -3925,7 +3925,7 @@ STM32 Platforms:
- dts/arm/st/
- dts/bindings/*/*stm32*
- soc/st/stm32/
- samples/boards/stm32/
- samples/boards/st/
labels:
- "platform: STM32"
description: >-
Expand All @@ -3949,7 +3949,7 @@ Espressif Platforms:
- dts/xtensa/espressif/
- dts/riscv/espressif/
- dts/bindings/*/*esp32*
- samples/boards/esp32*/
- samples/boards/espressif/
- tests/boards/espressif_esp32/
- drivers/*/*esp32*/
labels:
Expand Down Expand Up @@ -4075,7 +4075,7 @@ LiteX Platforms:
- dts/bindings/*/litex*
- dts/riscv/riscv32-litex-vexriscv.dtsi
- include/zephyr/drivers/*/*litex*
- samples/boards/litex/
- samples/boards/enjoydigital/litex/
- samples/drivers/*litex/
- soc/litex/
labels:
Expand Down
2 changes: 1 addition & 1 deletion boards/nxp/s32z2xxdc2/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Ethernet

NETC driver supports to manage the Physical Station Interface (PSI0) and/or a
single Virtual SI (VSI). The rest of the VSI's shall be assigned to different
cores of the system. Refer to :ref:`nxp_s32_netc-samples` to learn how to
cores of the system. Refer to :zephyr:code-sample:`nxp_s32_netc` to learn how to
configure the Ethernet network controller.

Controller Area Network
Expand Down
2 changes: 1 addition & 1 deletion boards/quicklogic/qomu/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Below are steps to run Qomu sample application:
#. Build the sample in an usual way:

.. zephyr-app-commands::
:zephyr-app: samples/boards/qomu
:zephyr-app: samples/boards/quicklogic/qomu
:board: qomu
:goals: build

Expand Down
2 changes: 1 addition & 1 deletion boards/st/sensortile_box/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ You should see following confirmation on your Linux host:
usb 2-2: SerialNumber: 204A325D574D

You can build and flash the provided sample application
(:ref:`sensortile_box sensors`) that reads sensors data and outputs
(:zephyr:code-sample:`sensortile_box_sensors`) that reads sensors data and outputs
values on the console.

References
Expand Down
2 changes: 1 addition & 1 deletion boards/st/sensortile_box_pro/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ You should see following confirmation on your Linux host:
usb 2-2: SerialNumber: 204A325D574D

You can build and flash the provided sample application
(:ref:`sensortile_box_pro_sample_sensors`) that reads sensors data and outputs
(:zephyr:code-sample:`sensortile_box_pro_sensors`) that reads sensors data and outputs
values on the console.

References
Expand Down
2 changes: 1 addition & 1 deletion boards/st/steval_stwinbx1/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ You should see the following confirmation on your Linux host:
usb 3-1: SerialNumber: 207136863530

You can build and flash the provided sample application
(:ref:`steval_stwinbx1_sample_sensors`) that reads sensors data and outputs
(:zephyr:code-sample:`stwinbx1_sensors`) that reads sensors data and outputs
values on the console.

.. _STEVAL-STWINBX1 Development kit website:
Expand Down
46 changes: 46 additions & 0 deletions doc/_scripts/redirects.py
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,52 @@
('samples/bluetooth/public_broadcast_source/README', 'samples/bluetooth/pbp_public_broadcast_source/README'),
('samples/bluetooth/unicast_audio_client/README', 'samples/bluetooth/bap_unicast_client/README'),
('samples/bluetooth/unicast_audio_server/README', 'samples/bluetooth/bap_unicast_server/README'),
('samples/boards/96b_argonkey/microphone/README', 'samples/boards/96boards/argonkey/microphone/README'),
('samples/boards/96b_argonkey/sensors/README', 'samples/boards/96boards/argonkey/sensors/README'),
('samples/boards/esp32/deep_sleep/README', 'samples/boards/espressif/deep_sleep/README'),
('samples/boards/esp32/flash_encryption/README', 'samples/boards/espressif/flash_encryption/README'),
('samples/boards/esp32/flash_memory_mapped/README', 'samples/boards/espressif/flash_memory_mapped/README'),
('samples/boards/esp32/light_sleep/README', 'samples/boards/espressif/light_sleep/README'),
('samples/boards/esp32/spiram_test/README', 'samples/boards/espressif/spiram_test/README'),
('samples/boards/esp32/wifi_apsta_mode/README', 'samples/boards/espressif/wifi_apsta_mode/README'),
('samples/boards/esp32/xt_wdt/README', 'samples/boards/espressif/xt_wdt/README'),
('samples/boards/google_twinkie_v2_pda/README', 'samples/boards/google/twinkie_v2/pda/README'),
('samples/boards/intel_adsp/code_relocation/README', 'samples/boards/intel/adsp/code_relocation/README'),
('samples/boards/litex/i2s/README', 'samples/boards/enjoydigital/litex/i2s/README'),
('samples/boards/mec15xxevb_assy6853/power_management/README', 'samples/boards/microchip/mec15xxevb_assy6853/power_management/README'),
('samples/boards/mimxrt1060_evk/system_off/README', 'samples/boards/nxp/mimxrt1060_evk/system_off/README'),
('samples/boards/mimxrt1170_evk_cm7/magic_addr/README', 'samples/boards/nxp/mimxrt1170_evk_cm7/magic_addr/README'),
('samples/boards/mimxrt595_evk/system_off/README', 'samples/boards/nxp/mimxrt595_evk/system_off/README'),
('samples/boards/nrf/battery/README', 'samples/boards/nordic/battery/README'),
('samples/boards/nrf/clock_skew/README', 'samples/boards/nordic/clock_skew/README'),
('samples/boards/nrf/dynamic_pinctrl/README', 'samples/boards/nordic/dynamic_pinctrl/README'),
('samples/boards/nrf/ieee802154/802154_rpmsg/README', 'samples/boards/nordic/ieee802154/802154_rpmsg/README'),
('samples/boards/nrf/mesh/onoff-app/README', 'samples/boards/nordic/mesh/onoff-app/README'),
('samples/boards/nrf/mesh/onoff_level_lighting_vnd_app/README', 'samples/boards/nordic/mesh/onoff_level_lighting_vnd_app/README'),
('samples/boards/nrf/nrf53_sync_rtc/README', 'samples/boards/nordic/nrf53_sync_rtc/README'),
('samples/boards/nrf/nrf_led_matrix/README', 'samples/boards/nordic/nrf_led_matrix/README'),
('samples/boards/nrf/nrfx/README', 'samples/boards/nordic/nrfx/README'),
('samples/boards/nrf/nrfx_prs/README', 'samples/boards/nordic/nrfx_prs/README'),
('samples/boards/nrf/system_off/README', 'samples/boards/nordic/system_off/README'),
('samples/boards/nxp_s32/netc/README', 'samples/boards/nxp/s32/netc/README'),
('samples/boards/qomu/README', 'samples/boards/quicklogic/qomu/README'),
('samples/boards/stm32/backup_sram/README', 'samples/boards/st/backup_sram/README'),
('samples/boards/stm32/bluetooth/interactive_gui/README', 'samples/boards/st/bluetooth/interactive_gui/README'),
('samples/boards/stm32/ccm/README', 'samples/boards/st/ccm/README'),
('samples/boards/stm32/h7_dual_core/README', 'samples/boards/st/h7_dual_core/README'),
('samples/boards/stm32/i2c_timing/README', 'samples/boards/st/i2c_timing/README'),
('samples/boards/stm32/mco/README', 'samples/boards/st/mco/README'),
('samples/boards/stm32/power_mgmt/adc/README', 'samples/boards/st/power_mgmt/adc/README'),
('samples/boards/stm32/power_mgmt/blinky/README', 'samples/boards/st/power_mgmt/blinky/README'),
('samples/boards/stm32/power_mgmt/serial_wakeup/README', 'samples/boards/st/power_mgmt/serial_wakeup/README'),
('samples/boards/stm32/power_mgmt/standby_shutdown/README', 'samples/boards/st/power_mgmt/standby_shutdown/README'),
('samples/boards/stm32/power_mgmt/stm32wb_ble/README', 'samples/boards/st/power_mgmt/stm32wb_ble/README'),
('samples/boards/stm32/power_mgmt/stop3/README', 'samples/boards/st/power_mgmt/stop3/README'),
('samples/boards/stm32/power_mgmt/suspend_to_ram/README', 'samples/boards/st/power_mgmt/suspend_to_ram/README'),
('samples/boards/stm32/power_mgmt/wkup_pins/README', 'samples/boards/st/power_mgmt/wkup_pins/README'),
('samples/boards/stm32/sensortile_box/README', 'samples/boards/st/sensortile_box/README'),
('samples/boards/stm32/sensortile_box_pro/sensors-on-board/README', 'samples/boards/st/sensortile_box_pro/sensors-on-board/README'),
('samples/boards/stm32/steval_stwinbx1/sensors/README', 'samples/boards/st/steval_stwinbx1/sensors/README'),
('samples/drivers/adc/README', 'samples/drivers/adc/adc_dt/README'),
('samples/drivers/kscan_touch', 'samples/subsys/input/input'),
('samples/drivers/led_apa102/README', 'samples/drivers/led_strip/README'),
Expand Down
4 changes: 2 additions & 2 deletions doc/services/pm/system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,8 @@ Examples

Some helpful examples showing different power management features:

* :zephyr_file:`samples/boards/stm32/power_mgmt/blinky/`
* :zephyr_file:`samples/boards/esp32/deep_sleep/`
* :zephyr_file:`samples/boards/st/power_mgmt/blinky/`
* :zephyr_file:`samples/boards/espressif/deep_sleep/`
* :zephyr_file:`samples/subsys/pm/device_pm/`
* :zephyr_file:`tests/subsys/pm/power_mgmt/`
* :zephyr_file:`tests/subsys/pm/power_mgmt_soc/`
Expand Down
10 changes: 10 additions & 0 deletions samples/boards/96boards/argonkey/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _argonkey-samples:

Argonkey Samples
################

.. toctree::
:maxdepth: 1
:glob:

*/*
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.. _ArgonKey_Microphone:
.. zephyr:code-sample:: argonkey_microphone
:name: Microphone
:relevant-api: audio_interface

ArgonKey Board Microphone
#########################
Acquire audio through the ArgonKey's on-board MP34DT05 microphone.

Overview
********
Expand Down Expand Up @@ -31,7 +32,7 @@ Building and Running
********************

.. zephyr-app-commands::
:zephyr-app: samples/boards/96b_argonkey/microphone
:zephyr-app: samples/boards/96boards/argonkey/microphone
:host-os: unix
:board: 96b_argonkey
:goals: run
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _ArgonKey_Sensors:
.. zephyr:code-sample:: argonkey_sensors
:name: Sensors

ArgonKey Board Sensors
######################
Read sensor data from the ArgonKey board's onboard sensors.

Overview
********
Expand Down Expand Up @@ -46,7 +46,7 @@ Building and Running
********************

.. zephyr-app-commands::
:zephyr-app: samples/boards/96b_argonkey/sensors
:zephyr-app: samples/boards/96boards/argonkey/sensors
:host-os: unix
:board: 96b_argonkey
:goals: run
Expand Down
File renamed without changes.
10 changes: 10 additions & 0 deletions samples/boards/96boards/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _96boards_samples:

96Boards
========

.. toctree::
:titlesonly:
:glob:

*/*
11 changes: 11 additions & 0 deletions samples/boards/bbc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _bbc_samples:

BBC
===

.. toctree::
:titlesonly:
:maxdepth: 1
:glob:

*/*
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _microbit_display:
.. zephyr:code-sample:: bbc_microbit_display
:name: LED matrix display

BBC micro:bit display
#####################
Use the 5x5 LED matrix display on the BBC micro:bit board.

Overview
********
Expand All @@ -15,7 +15,7 @@ This project outputs various things on the BBC micro:bit display. It can
be built as follows:

.. zephyr-app-commands::
:zephyr-app: samples/boards/bbc_microbit/display
:zephyr-app: samples/boards/bbc/microbit/display
:board: bbc_microbit
:goals: build
:compact:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _microbit_line_follower_robot:
.. zephyr:code-sample:: bbc_microbit_line_follower_robot
:name: Line following robot

BBC micro:bit line-follower robot
#################################
Implement a line following robot using a BBC micro:bit board and robot chassis.

Overview
********
Expand All @@ -25,7 +25,7 @@ Building and running
Build and flash this sample project using these commands:

.. zephyr-app-commands::
:zephyr-app: samples/boards/bbc_microbit/line_follower_robot
:zephyr-app: samples/boards/bbc/microbit/line_follower_robot
:board: bbc_microbit
:goals: build flash
:compact:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.. _microbit_pong:
.. zephyr:code-sample:: bbc_microbit_pong
:name: Pong game

BBC micro:bit pong game
#######################
Play pong as single player or over Bluetooth between two micro:bit devices.

Overview
********

Play pong over as single player or Bluetooth between two micro:bit
Play pong as single player or over Bluetooth between two micro:bit
devices.

The game works by controlling a paddle with the two buttons of the
Expand All @@ -26,7 +26,7 @@ Building and running
********************

.. zephyr-app-commands::
:zephyr-app: samples/boards/bbc_microbit/pong
:zephyr-app: samples/boards/bbc/microbit/pong
:board: bbc_microbit
:goals: build flash
:compact:
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.. _microbit_sound:
.. zephyr:code-sample:: bbc_microbit_sound
:name: Sound
:relevant-api: pwm_interface

BBC micro:bit sound
###################
Use the piezo buzzer on the BBC micro:bit board.

Overview
********
Expand Down Expand Up @@ -30,7 +31,7 @@ Building for a BBC micro:bit v1
-------------------------------

.. zephyr-app-commands::
:zephyr-app: samples/boards/bbc_microbit/sound
:zephyr-app: samples/boards/bbc/microbit/sound
:board: bbc_microbit
:goals: build flash
:compact:
Expand All @@ -39,7 +40,7 @@ Building for a BBC micro:bit v2
-------------------------------

.. zephyr-app-commands::
:zephyr-app: samples/boards/bbc_microbit/sound
:zephyr-app: samples/boards/bbc/microbit/sound
:board: bbc_microbit_v2
:goals: build flash
:compact:
Expand Down
5 changes: 3 additions & 2 deletions samples/boards/boards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Board-specific samples
######################

.. toctree::
:maxdepth: 1
:titlesonly:
:maxdepth: 2
:glob:

**/*
*/*
10 changes: 10 additions & 0 deletions samples/boards/enjoydigital/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _enjoydigital_samples:

EnjoyDigital
============

.. toctree::
:titlesonly:
:glob:

**/*
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _esp32-deep-sleep-sample:
.. zephyr:code-sample:: esp32-deep-sleep
:name: Deep Sleep

ESP32 Deep Sleep demo
#####################
Use deep sleep with wake on timer, GPIO, and EXT1 sources on ESP32.

Overview
********
Expand Down Expand Up @@ -50,7 +50,7 @@ Building, Flashing and Running
******************************

.. zephyr-app-commands::
:zephyr-app: samples/boards/esp32/deep_sleep
:zephyr-app: samples/boards/espressif/deep_sleep
:board: esp32_devkitc_wroom/esp32/procpu
:goals: build flash
:compact:
Expand Down
Loading
Loading