doc: samples: Adopt code-sample-category across tree

This commit uses the new .. zephyr:code-sample-category directive to
categorize code samples across the tree.
Updates existing legacy references to manually defined targets to now
use :zephyr:code-sample-category: role instead.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2024-09-16 10:55:34 +02:00 committed by Carles Cufí
commit 1db9b009a7
210 changed files with 573 additions and 766 deletions

View file

@ -96,7 +96,7 @@ USB Device Port
===============
The SAMD21 MCU has a USB device port that can be used to communicate
with a host PC. See the :ref:`usb-samples` sample applications for
with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for
more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual
serial port that echos characters back to the host PC.

View file

@ -99,7 +99,7 @@ USB Device Port
===============
The SAMD21 MCU has a USB device port that can be used to communicate
with a host PC. See the :ref:`usb-samples` sample applications for
with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for
more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual
serial port that echos characters back to the host PC.

View file

@ -98,7 +98,7 @@ USB Device Port
===============
The SAMD51 MCU has a USB device port that can be used to communicate
with a host PC. See the :ref:`usb-samples` sample applications for
with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for
more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual
serial port that echos characters back to the host PC.

View file

@ -106,7 +106,7 @@ USB Device Port
===============
The SAMD51 MCU has a USB device port that can be used to communicate
with a host PC. See the :ref:`usb-samples` sample applications for
with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for
more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual
serial port that echos characters back to the host PC.

View file

@ -98,7 +98,7 @@ USB Device Port
===============
The SAMD21 MCU has a USB device port that can be used to communicate
with a host PC. See the :ref:`usb-samples` sample applications for
with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for
more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual
serial port that echos characters back to the host PC.

View file

@ -111,7 +111,7 @@ USB Device Port
===============
The SAMD21 MCU has a USB device port that can be used to communicate
with a host PC. See the :ref:`usb-samples` sample applications for
with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for
more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual
serial port that echos characters back to the host PC.

View file

@ -102,7 +102,7 @@ USB Device Port
===============
The SAMD21 MCU has a USB device port that can be used to communicate
with a host PC. See the :ref:`usb-samples` sample applications for
with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for
more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual
serial port that echos characters back to the host PC.

View file

@ -98,7 +98,7 @@ USB Device Port
===============
The SAMD21 MCU has a USB device port that can be used to communicate
with a host PC. See the :ref:`usb-samples` sample applications for
with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for
more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual
serial port that echos characters back to the host PC.

View file

@ -54,7 +54,7 @@ Asymmetric Multiprocessing (AMP)
********************************
ESP32-DevKitC-WROOM allows 2 different applications to be executed in ESP32 SoC. Due to its dual-core architecture, each core can be enabled to execute customized tasks in stand-alone mode
and/or exchanging data over OpenAMP framework. See :ref:`ipc_samples` folder as code reference.
and/or exchanging data over OpenAMP framework. See :zephyr:code-sample-category:`ipc` folder as code reference.
Supported Features
==================

View file

@ -54,7 +54,7 @@ Asymmetric Multiprocessing (AMP)
********************************
ESP32-DevKitC-WROVER allows 2 different applications to be executed in ESP32 SoC. Due to its dual-core architecture, each core can be enabled to execute customized tasks in stand-alone mode
and/or exchanging data over OpenAMP framework. See :ref:`ipc_samples` folder as code reference.
and/or exchanging data over OpenAMP framework. See :zephyr:code-sample-category:`ipc` folder as code reference.
Supported Features
==================

View file

@ -76,7 +76,7 @@ Asymmetric Multiprocessing (AMP)
ESP32S3-DevKitC allows 2 different applications to be executed in ESP32-S3 SoC. Due to its dual-core
architecture, each core can be enabled to execute customized tasks in stand-alone mode
and/or exchanging data over OpenAMP framework. See :ref:`ipc_samples` folder as code reference.
and/or exchanging data over OpenAMP framework. See :zephyr:code-sample-category:`ipc` folder as code reference.
For more information, check the datasheet at `ESP32-S3 Datasheet`_ or the technical reference
manual at `ESP32-S3 Technical Reference Manual`_.

View file

@ -76,7 +76,7 @@ Asymmetric Multiprocessing (AMP)
ESP32S3-DevKitM allows 2 different applications to be executed in ESP32-S3 SoC. Due to its dual-core
architecture, each core can be enabled to execute customized tasks in stand-alone mode
and/or exchanging data over OpenAMP framework. See :ref:`ipc_samples` folder as code reference.
and/or exchanging data over OpenAMP framework. See :zephyr:code-sample-category:`ipc` folder as code reference.
For more information, check the datasheet at `ESP32-S3 Datasheet`_ or the technical reference
manual at `ESP32-S3 Technical Reference Manual`_.

View file

@ -578,7 +578,7 @@ toolchain and OpenOCD::
You need to make sure this happens every time you use this board.
Now let's compile the :zephyr:code-sample:`hello_world` application. (You can try
others as well; see :ref:`samples-and-demos` for more.)
others as well; see :zephyr:code-sample-category:`samples` for more.)
.. We can't use zephyr-app-commands to provide build instructions
due to the below mentioned linker issue.

View file

@ -74,7 +74,7 @@ USB Device Port
===============
The SAMD21 MCU has a USB device port that can be used to communicate
with a host PC. See the :ref:`usb-samples` sample applications for
with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for
more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which prints "Hello World!"
to the host PC.

View file

@ -98,7 +98,7 @@ USB Device Port
===============
The SAMD21 MCU has a USB device port that can be used to communicate
with a host PC. See the :ref:`usb-samples` sample applications for
with a host PC. See the :zephyr:code-sample-category:`usb` sample applications for
more, such as the :zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual
serial port that echos characters back to the host PC.

View file

@ -121,7 +121,7 @@ USB Device Port
===============
The SAMD51 MCU has a USB device port that can be used to communicate with a
host PC. See the :ref:`usb-samples` sample applications for more, such as the
host PC. See the :zephyr:code-sample-category:`usb` sample applications for more, such as the
:zephyr:code-sample:`usb-cdc-acm` sample which sets up a virtual serial port that echos
characters back to the host PC.

View file

@ -22,7 +22,7 @@ Usage
*****
The shield can be used in any application by setting ``--shield npm1300_ek``
when invoking ``west build``. You can check :ref:`npm1300_ek_sample` for a
when invoking ``west build``. You can check :zephyr:code-sample:`npm1300_ek` for a
comprehensive sample.
References

View file

@ -28,7 +28,7 @@ Usage
*****
The shield can be used in any application by setting ``--shield npm6001_ek``
when invoking ``west build``. You can check :ref:`npm6001_ek_sample` for a
when invoking ``west build``. You can check :zephyr:code-sample:`npm6001_ek` for a
comprehensive sample.
References

View file

@ -387,9 +387,9 @@ Set up Zephyr Software
Building Sample Applications
==============================
You can try many of the :ref:`sample applications and demos
<samples-and-demos>`. We'll use :zephyr:code-sample:`hello_world`, found in
:zephyr_file:`samples/hello_world` as an example.
You can try many of the :zephyr:code-sample-category:`sample applications and demos <samples>`.
We'll use :zephyr:code-sample:`hello_world`, found in :zephyr_file:`samples/hello_world` as an
example.
Configuring
-----------

View file

@ -384,9 +384,8 @@ Set up Zephyr Software
Building Sample Applications
==============================
You can try many of the :ref:`sample applications and demos
<samples-and-demos>`. We'll use :zephyr:code-sample:`hello_world`, found in
:zephyr_file:`samples/hello_world` as an example.
You can try many of the :zephyr:code-sample-category:`sample applications and demos <samples>`.
We'll use :zephyr:code-sample:`hello_world`, found in :zephyr_file:`samples/hello_world` as an example.
Configuring
-----------

View file

@ -52,7 +52,7 @@ Asymmetric Multiprocessing (AMP)
ESP32-S3 allows 2 different applications to be executed in ESP32-S3 SoC. Due to its dual-core
architecture, each core can be enabled to execute customized tasks in stand-alone mode
and/or exchanging data over OpenAMP framework. See :ref:`ipc_samples` folder as code reference.
and/or exchanging data over OpenAMP framework. See :zephyr:code-sample-category:`ipc` folder as code reference.
For more information, check the datasheet at `ESP32-S3 Datasheet`_ or the technical reference
manual at `ESP32-S3 Technical Reference Manual`_.

View file

@ -197,7 +197,7 @@ The stack is split up as follows in the source tree:
have their own drivers.
``samples/bluetooth/``
:ref:`Sample Bluetooth code <bluetooth-samples>`. This is a good reference to
:zephyr:code-sample-category:`Sample Bluetooth code <bluetooth>`. This is a good reference to
get started with Bluetooth application development.
``tests/bluetooth/``

View file

@ -189,7 +189,7 @@ and scan response data.
More Examples
*************
More :ref:`sample Bluetooth applications <bluetooth-samples>` are available in
More :zephyr:code-sample-category:`sample Bluetooth applications <bluetooth>` are available in
``samples/bluetooth/``.
.. _BabbleSim: https://babblesim.github.io/

View file

@ -565,7 +565,7 @@ The USB Vendor ID for the Zephyr project is ``0x2FE3``.
This USB Vendor ID must not be used when a vendor
integrates Zephyr USB device support into its own product.
Each USB :ref:`sample<usb-samples>` has its own unique Product ID.
Each USB :zephyr:code-sample-category:`sample<usb>` has its own unique Product ID.
The USB maintainer, if one is assigned, or otherwise the Zephyr Technical
Steering Committee, may allocate other USB Product IDs based on well-motivated
and documented requests.

View file

@ -17,7 +17,7 @@ It provides the following functionalities:
Currently the device stack supports implementation of Sink only and Source only
devices. Dual Role Power (DRP) devices are not yet supported.
:ref:`List<usbc-samples>` of samples for different purposes.
:zephyr:code-sample-category:`List<usbc>` of samples for different purposes.
Implementing a Sink Type-C and Power Delivery USB-C device
**********************************************************

View file

@ -303,7 +303,7 @@ Creating an Application by Hand
You can follow these steps to create a basic application directory from
scratch. However, using the `example-application`_ repository or one of
Zephyr's :ref:`samples-and-demos` as a starting point is likely to be easier.
Zephyr's :zephyr:code-sample-category:`samples` as a starting point is likely to be easier.
#. Create an application directory.
@ -643,7 +643,7 @@ assignment:
CONFIG_CPP=y
Looking at :ref:`existing samples <samples-and-demos>` is a good way to get
Looking at :zephyr:code-sample-category:`existing samples <samples>` is a good way to get
started.
See :ref:`setting_configuration_values` for detailed documentation on setting

View file

@ -213,7 +213,7 @@ format. Other binary formats, disassembly, and map files may be present
depending on your board.
The other sample applications in the :zephyr_file:`samples` folder are
documented in :ref:`samples-and-demos`.
documented in :zephyr:code-sample-category:`samples`.
.. note:: If you want to reuse an
existing build directory for another board or application, you need to

View file

@ -478,7 +478,7 @@ Next Steps
Here are some next steps for exploring Zephyr:
* Try other :ref:`samples-and-demos`
* Try other :zephyr:code-sample-category:`samples`
* Learn about :ref:`application` and the :ref:`west <west>` tool
* Find out about west's :ref:`flashing and debugging <west-build-flash-debug>`
features, or more about :ref:`flashing_and_debugging` in general

View file

@ -147,7 +147,7 @@ Documentation
* Site-wide glossary added.
* Porting guides added.
* Sample README files converted to documents included in the website.
* Improved consistency of :ref:`boards` and :ref:`samples-and-demos`.
* Improved consistency of :ref:`boards` and :zephyr:code-sample-category:`samples`.
JIRA Related Items

View file

@ -45,7 +45,7 @@ is downloaded and installed. MCUboot can be used to verify the signature before
upgrading the firmware.
There is a :zephyr:code-sample:`hawkbit-api` sample included in the
Zephyr :ref:`mgmt-samples` section.
Zephyr :zephyr:code-sample-category:`mgmt` section.
UpdateHub
=========
@ -56,7 +56,7 @@ the binary is downloaded and installed. MCUboot can be used to verify the
signature before upgrading the firmware.
There is an :zephyr:code-sample:`updatehub-fota` sample included in the Zephyr
:ref:`mgmt-samples` section.
:zephyr:code-sample-category:`mgmt` section.
SMP Server
==========
@ -66,8 +66,8 @@ Bluetooth Low Energy (BLE) or UDP. :ref:`mcu_mgr` is used to send a signed
firmware binary to the remote device where it is verified by MCUboot before the
upgrade occurs.
There is an :zephyr:code-sample:`smp-svr` sample included in the Zephyr :ref:`mgmt-samples`
section.
There is an :zephyr:code-sample:`smp-svr` sample included in the Zephyr
:zephyr:code-sample-category:`mgmt` section.
Lightweight M2M (LWM2M)
=======================

View file

@ -113,7 +113,8 @@ leverages the ``nanosleep()`` and ``perror()`` POSIX functions.
return 0;
}
For more examples of POSIX applications, please see the :ref:`POSIX sample applications<posix-samples>`.
For more examples of POSIX applications, please see the
:zephyr:code-sample-category:`POSIX sample applications<posix>`.
.. _posix_config:

View file

@ -1,16 +1,11 @@
.. _application-development-samples:
.. zephyr:code-sample-category:: application_development
:name: Application Development
:show-listing:
Application development samples
###############################
These samples illustrate some useful application development patterns and techniques.
For application development you should also consider looking at
`example-application`_. Among others, you will find on it out of tree driver
or board examples.
.. toctree::
:maxdepth: 1
:glob:
**/*
.. _example-application: https://github.com/zephyrproject-rtos/example-application

View file

@ -1,10 +1,5 @@
.. _arch-samples:
.. zephyr:code-sample-category:: arch
:name: Architecture-dependent Samples
:show-listing:
Architecture Dependent Samples
##############################
.. toctree::
:maxdepth: 2
:glob:
*/*
Samples that demonstrate some architecture-specific features.

View file

@ -1,10 +1,6 @@
.. _mmu_mpu-samples:
.. zephyr:code-sample-category:: mmu_mpu
:name: MMU/MPU
:show-listing:
MMU/MPU Samples
###############
.. toctree::
:maxdepth: 1
:glob:
**/*
Samples that demonstrate the Memory Management Unit (MMU) and Memory Protection Unit (MPU)
features.

View file

@ -1,10 +1,5 @@
.. _smp-samples:
.. zephyr:code-sample-category:: smp
:name: Symmetric Multiprocessing (SMP)
:show-listing:
Various SMP Samples
###################
.. toctree::
:maxdepth: 1
:glob:
**/*
Samples that demonstrate the use of :ref:`Symmetric Multiprocessing <smp_arch>`.

View file

@ -1,10 +1,5 @@
.. _basic-sample:
.. zephyr:code-sample-category:: basic
:name: Basic
:show-listing:
Basic Samples
#############
.. toctree::
:maxdepth: 1
:glob:
**/*
These samples demonstrate basic functionality of the Zephyr kernel.

View file

@ -21,7 +21,7 @@ Source sample).
This sample can be found under
:zephyr_file:`samples/bluetooth/bap_broadcast_assistant` in the Zephyr tree.
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
Check the :zephyr:code-sample-category:`bluetooth` samples for general information.
Requirements
************

View file

@ -14,7 +14,7 @@ the first found and listens to it until the source is (potentially) stopped.
This sample can be found under
:zephyr_file:`samples/bluetooth/bap_broadcast_sink` in the Zephyr tree.
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
Check the :zephyr:code-sample-category:`bluetooth` samples for general information.
Use :kconfig:option:`CONFIG_TARGET_BROADCAST_NAME` Kconfig to specify the name
(:kconfig:option:`CONFIG_BT_DEVICE_NAME`) of a broadcast source to listen to. With default value

View file

@ -17,7 +17,7 @@ The broadcast source will reset every 30 seconds to show the full API.
This sample can be found under
:zephyr_file:`samples/bluetooth/bap_broadcast_source` in the Zephyr tree.
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
Check the :zephyr:code-sample-category:`bluetooth` samples for general information.
Requirements
************

View file

@ -13,7 +13,7 @@ connects to a LE Audio unicast server and establishes an audio stream.
This sample can be found under
:zephyr_file:`samples/bluetooth/bap_unicast_client` in the Zephyr tree.
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
Check the :zephyr:code-sample-category:`bluetooth` samples for general information.
Requirements
************

View file

@ -13,7 +13,7 @@ Starts advertising and awaits connection from a LE Audio unicast client.
This sample can be found under
:zephyr_file:`samples/bluetooth/bap_unicast_server` in the Zephyr tree.
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
Check the :zephyr:code-sample-category:`bluetooth` samples for general information.
Requirements
************

View file

@ -22,4 +22,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/beacon` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -1,7 +1,7 @@
.. _bluetooth-samples:
.. zephyr:code-sample-category:: bluetooth
:name: Bluetooth
Bluetooth samples
#################
These samples demonstrate the use of Bluetooth in Zephyr.
To build any of the Bluetooth samples, follow the same steps as building
any other Zephyr application. Refer to :ref:`bluetooth-dev` for more information.
@ -29,8 +29,6 @@ documentation and are prefixed with :literal:`hci_` in their folder names.
connections will fail. You can force a re-paring and new key to be created
by removing the device from the associated devices list on the host.
.. toctree::
:maxdepth: 1
:glob:
**/*
.. zephyr:code-sample-listing::
:categories: bluetooth
:live-search:

View file

@ -25,4 +25,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/broadcaster` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -34,4 +34,4 @@ To test this sample use the Observer sample with Extended Scanning enabled,
found under
:zephyr_file:`samples/bluetooth/observer` in the Zephyr tree.
See :ref:`Bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`Bluetooth samples section <bluetooth>` for details.

View file

@ -20,7 +20,7 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/bthome_sensor_template` in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.
When the sample is running, navigate to Devices & Services under settings in Home
Assistant. There you will be asked to configure the BTHome sensor if everything

View file

@ -13,7 +13,7 @@ It can also be configured to start scanning for broadcast audio streams by itsel
This sample can be found under :zephyr_file:`samples/bluetooth/cap_acceptor` in the Zephyr tree.
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
Check the :zephyr:code-sample-category:`bluetooth` samples for general information.
Requirements
************

View file

@ -13,7 +13,7 @@ audio streams, sets up a broadcast audio stream, or both.
This sample can be found under :zephyr_file:`samples/bluetooth/cap_initiator` in the Zephyr tree.
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
Check the :zephyr:code-sample-category:`bluetooth` samples for general information.
Requirements
************

View file

@ -22,4 +22,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/central` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -22,4 +22,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/central_gatt_write`
in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -23,4 +23,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/central_hr` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -23,4 +23,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/central_ht` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -22,4 +22,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/central_multilink`
in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -22,4 +22,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/central_otc` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -29,4 +29,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/peripheral_past` in
the Zephyr tree on another board that will advertise and await a periodic
advertising sync transfer.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -30,4 +30,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/direct_adv` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -26,6 +26,6 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/eddystone` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.
.. _Eddystone Configuration Service: https://github.com/google/eddystone/tree/master/configuration-service

View file

@ -35,7 +35,7 @@ Building and Running
This sample can be found under
:zephyr_file:`samples/bluetooth/encrypted_advertising` in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.
This sample uses two applications, so two devices need to be setup.
Flash one device with the central application, and another device with the

View file

@ -34,7 +34,7 @@ Building and Running
This sample can be found under
:zephyr_file:`samples/bluetooth/extended_adv` in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.
This sample uses two applications, so two devices need to be setup.
Flash one device with the scanner application, and another device with the

View file

@ -21,4 +21,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/handsfree` in
the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -21,4 +21,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/handsfree_ag` in
the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -22,4 +22,4 @@ Building and Running
This sample can be found under
:zephyr_file:`samples/bluetooth/hap_ha` in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -37,4 +37,4 @@ You might need to adjust the Kconfig configuration of this sample to make it
compatible with the peer application. For example, :kconfig:option:`CONFIG_BT_MAX_CONN`
must be equal to the maximum number of connections supported by the peer application.
Refer to :ref:`bluetooth-samples` for general information about Bluetooth samples.
Refer to :zephyr:code-sample-category:`bluetooth` for general information about Bluetooth samples.

View file

@ -35,4 +35,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/hci_pwr_ctrl`
in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -36,6 +36,6 @@ application is compatible with the HCI SPI master driver provided by
Zephyr's Bluetooth HCI driver core; see the help associated with the
:kconfig:option:`CONFIG_BT_SPI` configuration option for more information.
Refer to :ref:`bluetooth-samples` for general Bluetooth information, and
Refer to :zephyr:code-sample-category:`bluetooth` for general Bluetooth information, and
to :ref:`96b_carbon_nrf51_bluetooth` for instructions specific to the
96Boards Carbon board.

View file

@ -21,4 +21,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/hci_usb` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -22,4 +22,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/hci_usb_h4` in
the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -28,4 +28,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/hci_vs_scan_req`
in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -29,7 +29,7 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/ibeacon` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details on how
See :zephyr:code-sample-category:`bluetooth` samples for details on how
to run the sample inside QEMU.
For other boards, build and flash the application as follows:

View file

@ -29,4 +29,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/iso_receive` in the
Zephyr tree that will scan, establish a periodic advertising synchronization,
generate BIGInfo reports and synchronize to BIG events from this sample.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -33,7 +33,7 @@ Building and running
This sample can be found under
:zephyr_file:`samples/bluetooth/iso_broadcast_benchmark` in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.
Testing

View file

@ -44,4 +44,4 @@ the Zephyr tree.
ISO Channel 0x200048f8 connected
See :ref:`bluetooth samples section <bluetooth-samples>` for more details.
See :zephyr:code-sample-category:`bluetooth` samples for more details.

View file

@ -32,7 +32,7 @@ Building and running
This sample can be found under
:zephyr_file:`samples/bluetooth/iso_connected_benchmark` in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.
Testing

View file

@ -64,4 +64,4 @@ This sample can be found under :zephyr_file:`samples/bluetooth/iso_peripheral` i
Incoming data channel 0x20000698 len 12
000102...090a0b
See :ref:`bluetooth samples section <bluetooth-samples>` for more details.
See :zephyr:code-sample-category:`bluetooth` samples for more details.

View file

@ -30,4 +30,4 @@ another board that will start periodic advertising, create BIG to which this
sample will establish periodic advertising synchronization and synchronize to
the Broadcast Isochronous Stream.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -31,7 +31,7 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/mesh` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details on how
See :zephyr:code-sample-category:`bluetooth` samples for details on how
to run the sample inside QEMU.
For other boards, build and flash the application as follows:

View file

@ -42,7 +42,7 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/mesh_demo` in
the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details on how
See :zephyr:code-sample-category:`bluetooth` samples for details on how
to run the sample inside QEMU.
For other boards, build and flash the application as follows:

View file

@ -40,7 +40,7 @@ Building and Running
This sample can be found under
:zephyr_file:`samples/bluetooth/mesh_provisioner` in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details on
See :zephyr:code-sample-category:`bluetooth` samples for details on
how to run the sample inside QEMU.
For other boards, build and flash the application as follows:

View file

@ -76,7 +76,7 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/mtu_update` in
the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.
If the devices are close enough, the central should connect to the peripheral
and send his MTU to the other device. If the MTU exchange succeeds, the central

View file

@ -27,4 +27,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/observer` in the
Zephyr tree.
See :ref:`Bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`Bluetooth samples section <bluetooth>` for details.

View file

@ -15,7 +15,7 @@ a High Quality Public Broadcast Audio Stream configuration.
This sample can be found under
:zephyr_file:`samples/bluetooth/pbp_public_broadcast_sink` in the Zephyr tree.
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
Check the :zephyr:code-sample-category:`bluetooth` samples for general information.
Requirements
************

View file

@ -15,7 +15,7 @@ every 15 seconds.
This sample can be found under
:zephyr_file:`samples/bluetooth/pbp_public_broadcast_source` in the Zephyr tree.
Check the :ref:`bluetooth samples section <bluetooth-samples>` for general information.
Check the :zephyr:code-sample-category:`bluetooth` samples for general information.
Requirements
************

View file

@ -24,4 +24,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/periodic_sync` in the
Zephyr tree that will scan and establish a periodic advertising synchronization
to this sample.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -30,4 +30,4 @@ the Zephyr tree.
Use the sample found under :zephyr_file:`samples/bluetooth/periodic_sync_conn` in the
Zephyr tree that will synchronize and respond to this sample.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -36,4 +36,4 @@ the Zephyr tree.
Use the sample found under :zephyr_file:`samples/bluetooth/periodic_sync_rsp` in the
Zephyr tree that will synchronize and respond to this sample.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -25,4 +25,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/periodic_adv` on
another board that will start periodic advertising, to which this sample will
establish periodic advertising synchronization.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -30,4 +30,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/periodic_adv_conn` on
another board that will start periodic advertising and connect to this sample
once synced.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -38,4 +38,4 @@ Use the sample found under :zephyr_file:`samples/bluetooth/periodic_adv_rsp` on
another board that will start periodic advertising, which will connect to this
sample and transfer the synchronization info.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -23,4 +23,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/peripheral` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -31,4 +31,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_accept_list` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -24,4 +24,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_csc` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -22,4 +22,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_dis` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -23,4 +23,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_esp` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -23,4 +23,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_gatt_write`
in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -29,4 +29,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_hids` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -24,4 +24,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_hr` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -27,4 +27,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_ht` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -22,4 +22,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_identity`
in the Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -24,4 +24,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_nus` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

View file

@ -22,4 +22,4 @@ Building and Running
This sample can be found under :zephyr_file:`samples/bluetooth/peripheral_ots` in the
Zephyr tree.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.
See :zephyr:code-sample-category:`bluetooth` samples for details.

Some files were not shown because too many files have changed in this diff Show more