diff --git a/boards/96boards/carbon/doc/stm32f401xe.rst b/boards/96boards/carbon/doc/stm32f401xe.rst index 222c6056a38fc64..8f0d38c8dc9ddb8 100644 --- a/boards/96boards/carbon/doc/stm32f401xe.rst +++ b/boards/96boards/carbon/doc/stm32f401xe.rst @@ -347,7 +347,7 @@ in general, see :ref:`build_an_application`. :board: 96b_carbon/stm32f401xe :goals: build flash -#. Refer to the instructions in :ref:`peripheral_hr` for how +#. Refer to the instructions in :zephyr:code-sample:`ble_peripheral_hr` for how to verify functionality. Congratulations! Your 96Boards Carbon now has Bluetooth diff --git a/boards/ezurio/bl5340_dvk/doc/index.rst b/boards/ezurio/bl5340_dvk/doc/index.rst index 700838f0764ab33..ff761cca100a38b 100644 --- a/boards/ezurio/bl5340_dvk/doc/index.rst +++ b/boards/ezurio/bl5340_dvk/doc/index.rst @@ -410,8 +410,8 @@ Many of the Bluetooth examples will work on the BL5340 DVK. Try them out: * :ref:`ble_peripheral` -* :ref:`bluetooth-eddystone-sample` -* :ref:`bluetooth-ibeacon-sample` +* :zephyr:code-sample:`bluetooth_eddystone` +* :zephyr:code-sample:`bluetooth_ibeacon` References ********** diff --git a/boards/ezurio/bl652_dvk/doc/bl652_dvk.rst b/boards/ezurio/bl652_dvk/doc/bl652_dvk.rst index b6fffcc4aa78b35..8231b15a16bfb72 100644 --- a/boards/ezurio/bl652_dvk/doc/bl652_dvk.rst +++ b/boards/ezurio/bl652_dvk/doc/bl652_dvk.rst @@ -246,8 +246,8 @@ Many of the Bluetooth examples will work on the BL652 DVK. Try them out: * :ref:`ble_peripheral` -* :ref:`bluetooth-eddystone-sample` -* :ref:`bluetooth-ibeacon-sample` +* :zephyr:code-sample:`bluetooth_eddystone` +* :zephyr:code-sample:`bluetooth_ibeacon` Testing the LEDs and buttons in the BL652 DVK ********************************************* diff --git a/boards/ezurio/bl653_dvk/doc/bl653_dvk.rst b/boards/ezurio/bl653_dvk/doc/bl653_dvk.rst index ec8fdb0e02d8ca7..a4291e8f2f902a2 100644 --- a/boards/ezurio/bl653_dvk/doc/bl653_dvk.rst +++ b/boards/ezurio/bl653_dvk/doc/bl653_dvk.rst @@ -152,8 +152,8 @@ Many of the Bluetooth examples will work on the BL653 DVK. Try them out: * :ref:`ble_peripheral` -* :ref:`bluetooth-eddystone-sample` -* :ref:`bluetooth-ibeacon-sample` +* :zephyr:code-sample:`bluetooth_eddystone` +* :zephyr:code-sample:`bluetooth_ibeacon` Testing the LEDs and buttons on the BL653 DVK diff --git a/boards/ezurio/bl654_dvk/doc/bl654_dvk.rst b/boards/ezurio/bl654_dvk/doc/bl654_dvk.rst index fba2bafba9cbb74..5ef6f9f0ff50235 100644 --- a/boards/ezurio/bl654_dvk/doc/bl654_dvk.rst +++ b/boards/ezurio/bl654_dvk/doc/bl654_dvk.rst @@ -163,8 +163,8 @@ Many of the Bluetooth examples will work on the BL654 DVK. Try them out: * :ref:`ble_peripheral` -* :ref:`bluetooth-eddystone-sample` -* :ref:`bluetooth-ibeacon-sample` +* :zephyr:code-sample:`bluetooth_eddystone` +* :zephyr:code-sample:`bluetooth_ibeacon` Testing the LEDs and buttons on the BL654 DVK diff --git a/boards/ezurio/bl654_sensor_board/doc/bl654_sensor_board.rst b/boards/ezurio/bl654_sensor_board/doc/bl654_sensor_board.rst index 50eb94cf5b26682..1be994507cca7f5 100644 --- a/boards/ezurio/bl654_sensor_board/doc/bl654_sensor_board.rst +++ b/boards/ezurio/bl654_sensor_board/doc/bl654_sensor_board.rst @@ -223,8 +223,8 @@ Many of the Bluetooth examples will work on the BL654 Sensor Board. Try them out: * :ref:`ble_peripheral` -* :ref:`bluetooth-eddystone-sample` -* :ref:`bluetooth-ibeacon-sample` +* :zephyr:code-sample:`bluetooth_eddystone` +* :zephyr:code-sample:`bluetooth_ibeacon` Testing the LED and button on the BL654 Sensor Board diff --git a/boards/ezurio/bl654_usb/doc/bl654_usb.rst b/boards/ezurio/bl654_usb/doc/bl654_usb.rst index 34a64c14aec47db..eb0a9b862ead665 100644 --- a/boards/ezurio/bl654_usb/doc/bl654_usb.rst +++ b/boards/ezurio/bl654_usb/doc/bl654_usb.rst @@ -161,8 +161,8 @@ Many of the Bluetooth examples will work on the BL654 USB. Try them out: * :ref:`ble_peripheral` -* :ref:`bluetooth-eddystone-sample` -* :ref:`bluetooth-ibeacon-sample` +* :zephyr:code-sample:`bluetooth_eddystone` +* :zephyr:code-sample:`bluetooth_ibeacon` Testing the LED on the BL654 USB diff --git a/boards/ezurio/bt510/doc/bt510.rst b/boards/ezurio/bt510/doc/bt510.rst index 2d0dbcbf5069bb3..cc65badc0320d6c 100644 --- a/boards/ezurio/bt510/doc/bt510.rst +++ b/boards/ezurio/bt510/doc/bt510.rst @@ -229,8 +229,8 @@ Many of the Bluetooth examples will work on the BT510. Try them out: * :ref:`ble_peripheral` -* :ref:`bluetooth-eddystone-sample` -* :ref:`bluetooth-ibeacon-sample` +* :zephyr:code-sample:`bluetooth_eddystone` +* :zephyr:code-sample:`bluetooth_ibeacon` Testing the LEDs and buttons on the BT510 diff --git a/boards/ezurio/bt610/doc/bt610.rst b/boards/ezurio/bt610/doc/bt610.rst index 20527ceb1e08a51..6fc4027654a53ec 100644 --- a/boards/ezurio/bt610/doc/bt610.rst +++ b/boards/ezurio/bt610/doc/bt610.rst @@ -583,8 +583,8 @@ Many of the Bluetooth examples will work on the BT610. Try them out: * :ref:`ble_peripheral` -* :ref:`bluetooth-eddystone-sample` -* :ref:`bluetooth-ibeacon-sample` +* :zephyr:code-sample:`bluetooth_eddystone` +* :zephyr:code-sample:`bluetooth_ibeacon` Testing the LEDs and buttons on the BT610 diff --git a/boards/ezurio/mg100/doc/index.rst b/boards/ezurio/mg100/doc/index.rst index b665997a762ca32..d9a65b9d9292f23 100644 --- a/boards/ezurio/mg100/doc/index.rst +++ b/boards/ezurio/mg100/doc/index.rst @@ -214,8 +214,8 @@ Many of the Bluetooth examples will work on the MG100. Try them out: * :ref:`ble_peripheral` -* :ref:`bluetooth-eddystone-sample` -* :ref:`bluetooth-ibeacon-sample` +* :zephyr:code-sample:`bluetooth_eddystone` +* :zephyr:code-sample:`bluetooth_ibeacon` Testing the LEDs and buttons in the MG100 ==================================================== diff --git a/boards/ezurio/pinnacle_100_dvk/doc/index.rst b/boards/ezurio/pinnacle_100_dvk/doc/index.rst index 9650d0c8e25ea6e..37d55ac41d60004 100644 --- a/boards/ezurio/pinnacle_100_dvk/doc/index.rst +++ b/boards/ezurio/pinnacle_100_dvk/doc/index.rst @@ -188,8 +188,8 @@ Many of the Bluetooth examples will work on the Pinnacle 100 DVK. Try them out: * :ref:`ble_peripheral` -* :ref:`bluetooth-eddystone-sample` -* :ref:`bluetooth-ibeacon-sample` +* :zephyr:code-sample:`bluetooth_eddystone` +* :zephyr:code-sample:`bluetooth_ibeacon` Testing the LEDs and buttons in the Pinnacle 100 DVK ==================================================== diff --git a/boards/silabs/dev_kits/sltb010a/doc/index.rst b/boards/silabs/dev_kits/sltb010a/doc/index.rst index 1299bef0bc2cd86..c7f3452ce485f9d 100644 --- a/boards/silabs/dev_kits/sltb010a/doc/index.rst +++ b/boards/silabs/dev_kits/sltb010a/doc/index.rst @@ -177,7 +177,7 @@ blobs from the SiLabs HAL repository. west blobs fetch hal_silabs Then build the Zephyr kernel and a Bluetooth sample with the following -command. The :ref:`bluetooth-observer-sample` sample application is used in +command. The :zephyr:code-sample:`bluetooth_observer` sample application is used in this example. BRD4184A: diff --git a/boards/silabs/dev_kits/xg24_dk2601b/doc/index.rst b/boards/silabs/dev_kits/xg24_dk2601b/doc/index.rst index 551d08765de8810..c5ec0f6a683a817 100644 --- a/boards/silabs/dev_kits/xg24_dk2601b/doc/index.rst +++ b/boards/silabs/dev_kits/xg24_dk2601b/doc/index.rst @@ -160,7 +160,7 @@ blobs from the SiLabs HAL repository. west blobs fetch hal_silabs Then build the Zephyr kernel and a Bluetooth sample with the following -command. The :ref:`bluetooth-observer-sample` sample application is used in +command. The :zephyr:code-sample:`bluetooth_observer` sample application is used in this example. .. zephyr-app-commands:: diff --git a/boards/sparkfun/thing_plus_matter_mgm240p/doc/index.rst b/boards/sparkfun/thing_plus_matter_mgm240p/doc/index.rst index 71227d6e0ba6f57..f9ffd1f62020624 100644 --- a/boards/sparkfun/thing_plus_matter_mgm240p/doc/index.rst +++ b/boards/sparkfun/thing_plus_matter_mgm240p/doc/index.rst @@ -141,7 +141,7 @@ blobs from the SiLabs HAL repository. west blobs fetch silabs Then build the Zephyr kernel and a Bluetooth sample with the following -command. The :ref:`bluetooth-observer-sample` sample application is used in +command. The :zephyr:code-sample:`bluetooth_observer` sample application is used in this example. .. zephyr-app-commands:: diff --git a/boards/st/stm32wb5mmg/doc/stm32wb5mmg.rst b/boards/st/stm32wb5mmg/doc/stm32wb5mmg.rst index 13446524535a734..b9724248b797dd1 100644 --- a/boards/st/stm32wb5mmg/doc/stm32wb5mmg.rst +++ b/boards/st/stm32wb5mmg/doc/stm32wb5mmg.rst @@ -245,7 +245,7 @@ Flashing `hci_uart` application to STM32WB5MMG Connect the B-U585I-IOT02A to your host computer using the USB port. Put the SW4 (MCU SWD) in OFF mode and SW5 (SWD BLE) in ON mode. Then build and flash an application. Here is an example for the -:ref:`hci_uart ` application. +:zephyr:code-sample:`bluetooth_hci_uart` application. Run a serial host program to connect with your B-U585I-IOT02A board: @@ -287,7 +287,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hci_uart ` application. +:zephyr:code-sample:`bluetooth_hci_uart` application. .. zephyr-app-commands:: :zephyr-app: samples/bluetooth/observer diff --git a/boards/vngiotlab/nrf51_vbluno51/doc/index.rst b/boards/vngiotlab/nrf51_vbluno51/doc/index.rst index e4f6b58a68a4011..92d74c00c99e2b5 100644 --- a/boards/vngiotlab/nrf51_vbluno51/doc/index.rst +++ b/boards/vngiotlab/nrf51_vbluno51/doc/index.rst @@ -138,8 +138,8 @@ Testing the VBLUno51 with Zephyr: buttons, LEDs, UART, BLE * :ref:`hello_world` * :zephyr:code-sample:`blinky` * :zephyr:code-sample:`button` - * :ref:`bluetooth-beacon-sample` - * :ref:`peripheral_hr` + * :zephyr:code-sample:`bluetooth_beacon` + * :zephyr:code-sample:`ble_peripheral_hr` References ********** diff --git a/boards/vngiotlab/nrf52_vbluno52/doc/index.rst b/boards/vngiotlab/nrf52_vbluno52/doc/index.rst index 5342fdf81c4751a..f534ae372057ee8 100644 --- a/boards/vngiotlab/nrf52_vbluno52/doc/index.rst +++ b/boards/vngiotlab/nrf52_vbluno52/doc/index.rst @@ -103,5 +103,5 @@ components on the VBLUno52 board: * :ref:`hello_world` * :zephyr:code-sample:`blinky` * :zephyr:code-sample:`button` -* :ref:`bluetooth-beacon-sample` -* :ref:`peripheral_hr` +* :zephyr:code-sample:`bluetooth_beacon` +* :zephyr:code-sample:`ble_peripheral_hr` diff --git a/doc/build/dts/api/api.rst b/doc/build/dts/api/api.rst index 63017d4d66781a1..744f796ae298815 100644 --- a/doc/build/dts/api/api.rst +++ b/doc/build/dts/api/api.rst @@ -382,7 +382,7 @@ device. - Purpose * - zephyr,bt-c2h-uart - Selects the UART used for host communication in the - :ref:`bluetooth-hci-uart-sample` + :zephyr:code-sample:`bluetooth_hci_uart` * - zephyr,bt-mon-uart - Sets UART device used for the Bluetooth monitor logging * - zephyr,bt-hci diff --git a/doc/connectivity/bluetooth/bluetooth-arch.rst b/doc/connectivity/bluetooth/bluetooth-arch.rst index c36879fe02aee46..c442412d2f4e32b 100644 --- a/doc/connectivity/bluetooth/bluetooth-arch.rst +++ b/doc/connectivity/bluetooth/bluetooth-arch.rst @@ -97,9 +97,9 @@ BLE-enabled builds that can be produced from the Zephyr project codebase: the Link Layer and a special application. This application is different depending on the physical transport chosen for HCI: - * :ref:`hci_uart ` - * :ref:`hci_usb ` - * :ref:`hci_spi ` + * :zephyr:code-sample:`bluetooth_hci_uart` + * :zephyr:code-sample:`bluetooth_hci_usb` + * :zephyr:code-sample:`bluetooth_hci_spi` This application acts as a bridge between the UART, SPI or USB peripherals and the Controller subsystem, listening for HCI commands, sending application data @@ -160,8 +160,8 @@ must be built with different configurations, yielding two separate images that must be programmed into each of the chips respectively. The Host build image contains the application, the BLE Host and the selected HCI driver (UART or SPI), while the Controller build runs either the -:ref:`hci_uart `, or the -:ref:`hci_spi ` app to provide an interface to +:zephyr:code-sample:`bluetooth_hci_uart`, or the +:zephyr:code-sample:`bluetooth_hci_spi` app to provide an interface to the BLE Controller. This configuration is not limited to using a Zephyr OS Host, as the right side diff --git a/doc/connectivity/bluetooth/bluetooth-dev.rst b/doc/connectivity/bluetooth/bluetooth-dev.rst index 1a4484534b22fa0..05a7a6729228691 100644 --- a/doc/connectivity/bluetooth/bluetooth-dev.rst +++ b/doc/connectivity/bluetooth/bluetooth-dev.rst @@ -153,7 +153,7 @@ devices in either of :ref:`these boards's documentation `, typically you do :ref:`Combined builds `, but it is also possible to build the controller with one of the -:ref:`HCI UART ` samples in one simulated device, and the host with +:zephyr:code-sample:`bluetooth_hci_uart` samples in one simulated device, and the host with the H4 driver instead of the integrated controller in another simulated device. With the :ref:`nrf5340bsim `, you can build with either, both controller and host diff --git a/doc/connectivity/bluetooth/bluetooth-shell.rst b/doc/connectivity/bluetooth/bluetooth-shell.rst index 80ae3c35b433588..94a0c2d9e70afd4 100644 --- a/doc/connectivity/bluetooth/bluetooth-shell.rst +++ b/doc/connectivity/bluetooth/bluetooth-shell.rst @@ -394,7 +394,7 @@ The server can now notify the client with the command :code:`gatt notify`. Another option available through the GATT command is initiating the MTU exchange. To do it, use the :code:`gatt exchange-mtu` command. To update the shell maximum MTU, you need to update Kconfig symbols in the configuration file of the shell. For more details, see -:ref:`bluetooth_mtu_update_sample`. +:zephyr:code-sample:`bluetooth_mtu_update`. L2CAP ***** diff --git a/doc/connectivity/bluetooth/bluetooth-tools.rst b/doc/connectivity/bluetooth/bluetooth-tools.rst index 21188f49b28dfaf..04d6fc0e8985605 100644 --- a/doc/connectivity/bluetooth/bluetooth-tools.rst +++ b/doc/connectivity/bluetooth/bluetooth-tools.rst @@ -166,9 +166,9 @@ Using a Zephyr-based BLE Controller Depending on which hardware you have available, you can choose between two transports when building a single-mode, Zephyr-based BLE Controller: -* UART: Use the :ref:`hci_uart ` sample and follow +* UART: Use the :zephyr:code-sample:`bluetooth_hci_uart` sample and follow the instructions in :ref:`bluetooth-hci-uart-qemu-posix`. -* USB: Use the :ref:`hci_usb ` sample and then +* USB: Use the :zephyr:code-sample:`bluetooth_hci_usb` sample and then treat it as a Host System Bluetooth Controller (see previous section) .. _bluetooth-hci-tracing: @@ -301,7 +301,7 @@ After following these steps the Zephyr application will be available to the Andr over the virtual Bluetooth controller that was bridged with Bumble. You can verify that the Zephyr application can communicate over Bluetooth by opening the Bluetooth settings in your AVD and scanning for your Zephyr application device. To test this you can build the Bluetooth -peripheral samples such as :ref:`Peripheral HR ` or :ref:`Peripheral DIS ` +peripheral samples such as :zephyr:code-sample:`ble_peripheral_hr` or :ref:`Peripheral DIS ` .. _bluetooth_ctlr_bluez: diff --git a/doc/connectivity/usb/device/usb_device.rst b/doc/connectivity/usb/device/usb_device.rst index ea4ad88d7a1425a..fac9069072745bb 100644 --- a/doc/connectivity/usb/device/usb_device.rst +++ b/doc/connectivity/usb/device/usb_device.rst @@ -64,7 +64,7 @@ the next interface, preventing other composite functions from working. Because of this problem, HCI USB should not be used in a composite configuration. This problem is fixed in the implementation for new USB support. -See :ref:`bluetooth-hci-usb-sample` sample for reference. +See :zephyr:code-sample:`bluetooth_hci_usb` sample for reference. .. _usb_device_cdc_acm: @@ -168,7 +168,7 @@ List of few Zephyr specific chosen properties which can be used to select CDC ACM UART as backend for a subsystem or application: * ``zephyr,bt-c2h-uart`` used in Bluetooth, - for example see :ref:`bluetooth-hci-uart-sample` + for example see :zephyr:code-sample:`bluetooth_hci_uart` * ``zephyr,ot-uart`` used in OpenThread, for example see :zephyr:code-sample:`coprocessor` * ``zephyr,shell-uart`` used by shell for serial backend, @@ -595,9 +595,9 @@ The following Product IDs are currently used: +----------------------------------------------------+--------+ | :zephyr:code-sample:`webusb` | 0x000A | +----------------------------------------------------+--------+ -| :ref:`bluetooth-hci-usb-sample` | 0x000B | +| :zephyr:code-sample:`bluetooth_hci_usb` | 0x000B | +----------------------------------------------------+--------+ -| :ref:`bluetooth-hci-usb-h4-sample` | 0x000C | +| :zephyr:code-sample:`bluetooth_hci_usb_h4` | 0x000C | +----------------------------------------------------+--------+ | Reserved (previously: wpan-usb) | 0x000D | +----------------------------------------------------+--------+ diff --git a/doc/connectivity/usb/device_next/usb_device.rst b/doc/connectivity/usb/device_next/usb_device.rst index b73f7c0f6a8bfaa..f2e3556000bc85b 100644 --- a/doc/connectivity/usb/device_next/usb_device.rst +++ b/doc/connectivity/usb/device_next/usb_device.rst @@ -64,7 +64,7 @@ To build a sample that supports both the old and new USB device stack, set the configuration ``-DCONF_FILE=usbd_next_prj.conf`` either directly or via ``west``. -* :ref:`bluetooth-hci-usb-sample` +* :zephyr:code-sample:`bluetooth_hci_usb` * :zephyr:code-sample:`usb-cdc-acm` diff --git a/samples/bluetooth/bap_broadcast_assistant/README.rst b/samples/bluetooth/bap_broadcast_assistant/README.rst index bf472b8a0317959..011631d6120f949 100644 --- a/samples/bluetooth/bap_broadcast_assistant/README.rst +++ b/samples/bluetooth/bap_broadcast_assistant/README.rst @@ -1,8 +1,8 @@ .. zephyr:code-sample:: bluetooth_bap_broadcast_assistant - :name: Bluetooth: Broadcast Audio Assistant + :name: Broadcast Audio Assistant :relevant-api: bt_bap - Use LE Audio Broadcast Assistant functionality + Use LE Audio Broadcast Assistant functionality. Overview ******** diff --git a/samples/bluetooth/bap_broadcast_sink/README.rst b/samples/bluetooth/bap_broadcast_sink/README.rst index 39ca9a483e7b38e..0ec8fb70542d659 100644 --- a/samples/bluetooth/bap_broadcast_sink/README.rst +++ b/samples/bluetooth/bap_broadcast_sink/README.rst @@ -1,8 +1,8 @@ .. zephyr:code-sample:: bluetooth_bap_broadcast_sink - :name: Bluetooth: Broadcast Audio Sink + :name: Broadcast Audio Sink :relevant-api: bluetooth - Bluetooth: Broadcast Audio Sink + Use LE Audio Broadcast Sink functionality. Overview ******** @@ -53,7 +53,7 @@ If you prefer to only build the application core image, you can do so by doing i :goals: build In that case you can pair this application core image with the -:ref:`hci_ipc sample ` +:zephyr:code-sample:`bluetooth_hci_ipc` sample :zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration. Building for a simulated nrf5340bsim diff --git a/samples/bluetooth/bap_broadcast_source/README.rst b/samples/bluetooth/bap_broadcast_source/README.rst index b4a3ac722656562..4afa96da77eb4ee 100644 --- a/samples/bluetooth/bap_broadcast_source/README.rst +++ b/samples/bluetooth/bap_broadcast_source/README.rst @@ -1,8 +1,8 @@ .. zephyr:code-sample:: bluetooth_bap_broadcast_source - :name: Bluetooth: Broadcast Audio Source + :name: Broadcast Audio Source :relevant-api: bluetooth - Bluetooth: Broadcast Audio Source + Use LE Audio Broadcast Source functionality. Overview ******** @@ -52,7 +52,7 @@ If you prefer to only build the application core image, you can do so by doing i :goals: build In that case you can pair this application core image with the -:ref:`hci_ipc sample ` +:zephyr:code-sample:`bluetooth_hci_ipc` sample :zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration. Building for a simulated nrf5340bsim diff --git a/samples/bluetooth/bap_unicast_client/README.rst b/samples/bluetooth/bap_unicast_client/README.rst index f38cecd8dc2d0fa..7ff7a387afd9249 100644 --- a/samples/bluetooth/bap_unicast_client/README.rst +++ b/samples/bluetooth/bap_unicast_client/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_bap_unicast_client: +.. zephyr:code-sample:: bluetooth_bap_unicast_client + :name: Unicast Audio Client + :relevant-api: bt_bap bt_audio -Bluetooth: Unicast Audio Client -############################### + Use LE Audio Unicast Client functionality. Overview ******** @@ -56,7 +57,7 @@ If you prefer to only build the application core image, you can do so by doing i :goals: build In that case you can pair this application core image with the -:ref:`hci_ipc sample ` +:zephyr:code-sample:`bluetooth_hci_ipc` sample :zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration. Building for a simulated nrf52_bsim diff --git a/samples/bluetooth/bap_unicast_server/README.rst b/samples/bluetooth/bap_unicast_server/README.rst index d7f3b8b277657dc..8ef31b7373633c7 100644 --- a/samples/bluetooth/bap_unicast_server/README.rst +++ b/samples/bluetooth/bap_unicast_server/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_bap_unicast_server: +.. zephyr:code-sample:: bluetooth_bap_unicast_server + :name: Unicast Audio Server + :relevant-api: bt_bap bt_audio -Bluetooth: Unicast Audio Server -############################### + Use LE Audio Unicast Server functionality. Overview ******** @@ -56,7 +57,7 @@ If you prefer to only build the application core image, you can do so by doing i :goals: build In that case you can pair this application core image with the -:ref:`hci_ipc sample ` +:zephyr:code-sample:`bluetooth_hci_ipc` sample :zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration. Building for a simulated nrf52_bsim diff --git a/samples/bluetooth/beacon/README.rst b/samples/bluetooth/beacon/README.rst index b9786429f145b60..e7d091dd7630d55 100644 --- a/samples/bluetooth/beacon/README.rst +++ b/samples/bluetooth/beacon/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-beacon-sample: +.. zephyr:code-sample:: bluetooth_beacon + :name: Beacon + :relevant-api: bluetooth -Bluetooth: Beacon -################# + Advertise an Eddystone URL using BLE Broadcaster role. Overview ******** diff --git a/samples/bluetooth/bluetooth.rst b/samples/bluetooth/bluetooth.rst index 35b49bfd0abfcd0..1c3d4d18d81fd72 100644 --- a/samples/bluetooth/bluetooth.rst +++ b/samples/bluetooth/bluetooth.rst @@ -20,7 +20,7 @@ documentation and are prefixed with :literal:`hci_` in their folder names. ``-DBOARD=nrf5340dk/nrf5340/cpuapp`` or ``-DBOARD=nrf5340dk/nrf5340/cpuapp/ns``) you must also build and program the corresponding sample for the nRF5340 network core - :ref:`bluetooth-hci-ipc-sample` which implements the Bluetooth + :zephyr:code-sample:`bluetooth_hci_ipc` which implements the Bluetooth Low Energy controller. .. note:: diff --git a/samples/bluetooth/broadcaster/README.rst b/samples/bluetooth/broadcaster/README.rst index 90a944d92212277..943e3687cc4fb81 100644 --- a/samples/bluetooth/broadcaster/README.rst +++ b/samples/bluetooth/broadcaster/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-broadcaster-sample: +.. zephyr:code-sample:: bluetooth_broadcaster + :name: Broadcaster + :relevant-api: bluetooth -Bluetooth: Broadcaster -########################### + Periodically send out advertising packets with a manufacturer data element. Overview ******** diff --git a/samples/bluetooth/broadcaster_multiple/README.rst b/samples/bluetooth/broadcaster_multiple/README.rst index fd0e9cf786f83e5..ab24c541270a929 100644 --- a/samples/bluetooth/broadcaster_multiple/README.rst +++ b/samples/bluetooth/broadcaster_multiple/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-broadcaster-multiple-sample: +.. zephyr:code-sample:: bluetooth_broadcaster_multiple + :name: Multiple Broadcaster + :relevant-api: bluetooth -Bluetooth: Multiple Broadcaster -############################### + Advertise multiple advertising sets. Overview ******** diff --git a/samples/bluetooth/bthome_sensor_template/README.rst b/samples/bluetooth/bthome_sensor_template/README.rst index 8b91fb432770ea9..575eab5d6fc1704 100644 --- a/samples/bluetooth/bthome_sensor_template/README.rst +++ b/samples/bluetooth/bthome_sensor_template/README.rst @@ -1,9 +1,13 @@ -.. _bluetooth-bthome-sensor-template-sample: +.. zephyr:code-sample:: bluetooth_bt_home_sensor_template + :name: BTHome sensor template + :relevant-api: bluetooth -Bluetooth: BTHome sensor template -################################# + Implement a BTHome sensor. -Template for a `BTHome `_ sensor. +Overview +******** + +This code sample provides a template for implementing a `BTHome `_ sensor. Requirements ************ diff --git a/samples/bluetooth/cap_acceptor/README.rst b/samples/bluetooth/cap_acceptor/README.rst index dce148cfd0116ff..b964ae544ce94c4 100644 --- a/samples/bluetooth/cap_acceptor/README.rst +++ b/samples/bluetooth/cap_acceptor/README.rst @@ -1,8 +1,8 @@ .. zephyr:code-sample:: bluetooth_cap_acceptor - :name: Bluetooth: Common Audio Profile Acceptor + :name: Common Audio Profile Acceptor :relevant-api: bt_cap bt_bap bluetooth - CAP Acceptor sample that advertises audio availability to CAP Initiators. + Advertise audio availability to CAP Initiators using the CAP Acceptor role. Overview ******** @@ -47,7 +47,7 @@ If you prefer to only build the application core image, you can do so by doing i :goals: build In that case you can pair this application core image with the -:ref:`hci_ipc sample ` +:zephyr:code-sample:`bluetooth_hci_ipc` sample :zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration. Building for a simulated nrf5340bsim diff --git a/samples/bluetooth/cap_initiator/README.rst b/samples/bluetooth/cap_initiator/README.rst index 0149dfe96d1e191..71e01a07713b878 100644 --- a/samples/bluetooth/cap_initiator/README.rst +++ b/samples/bluetooth/cap_initiator/README.rst @@ -1,9 +1,8 @@ .. zephyr:code-sample:: bluetooth_cap_initiator - :name: Bluetooth: Common Audio Profile Initiator + :name: Common Audio Profile Initiator :relevant-api: bt_cap bt_bap bluetooth - CAP Initiator sample that connects to CAP Acceptors and setup unicast audio streaming, - or broadcast audio streams. + Connect to CAP Acceptors and setup unicast audio streaming or broadcast audio streams. Overview ******** @@ -49,7 +48,7 @@ If you prefer to only build the application core image, you can do so by doing i :goals: build In that case you can pair this application core image with the -:ref:`hci_ipc sample ` +:zephyr:code-sample:`bluetooth_hci_ipc` sample :zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration. Building for a simulated nrf5340bsim diff --git a/samples/bluetooth/central/README.rst b/samples/bluetooth/central/README.rst index 78f3cb6d2dbd7b7..d4424595d03ea76 100644 --- a/samples/bluetooth/central/README.rst +++ b/samples/bluetooth/central/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_central: +.. zephyr:code-sample:: bluetooth_central + :name: Central + :relevant-api: bluetooth -Bluetooth: Central -################## + Implement basic BLE Central role functionality (scanning and connecting). Overview ******** @@ -10,8 +11,6 @@ Application demonstrating very basic BLE Central role functionality by scanning for other BLE devices and establishing a connection to the first one with a strong enough signal. - - Requirements ************ diff --git a/samples/bluetooth/central_gatt_write/README.rst b/samples/bluetooth/central_gatt_write/README.rst index 58d96930c56c1c1..1c96577183469be 100644 --- a/samples/bluetooth/central_gatt_write/README.rst +++ b/samples/bluetooth/central_gatt_write/README.rst @@ -1,12 +1,13 @@ -.. _bluetooth_central_gatt_write: +.. zephyr:code-sample:: bluetooth_central_gatt_write + :name: Central / GATT Write + :relevant-api: bluetooth -Bluetooth: Central / GATT Write -############################### + Scan for a BLE device, connect to it and write a value to a characteristic. Overview ******** -Similar to the :ref:`Central ` sample, except that this +Similar to the :zephyr:code-sample:`Central ` sample, except that this application use GATT Write Without Response. Requirements diff --git a/samples/bluetooth/central_hr/README.rst b/samples/bluetooth/central_hr/README.rst index 48757eedbefdc65..d81d4553af66710 100644 --- a/samples/bluetooth/central_hr/README.rst +++ b/samples/bluetooth/central_hr/README.rst @@ -1,12 +1,13 @@ -.. _bluetooth_central_hr: +.. zephyr:code-sample:: ble_central_hr + :name: Heart-rate Monitor (Central) + :relevant-api: bluetooth -Bluetooth: Central / Heart-rate Monitor -####################################### + Connect to a BLE heart-rate monitor and read heart-rate measurements. Overview ******** -Similar to the :ref:`Central ` sample, except that this +Similar to the :zephyr:code-sample:`Central ` sample, except that this application specifically looks for heart-rate monitors and reports the heart-rate readings once connected. diff --git a/samples/bluetooth/central_ht/README.rst b/samples/bluetooth/central_ht/README.rst index 9525717100fccda..35a6299800f4b59 100644 --- a/samples/bluetooth/central_ht/README.rst +++ b/samples/bluetooth/central_ht/README.rst @@ -1,12 +1,13 @@ -.. _bluetooth_central_ht: +.. zephyr:code-sample:: bluetooth_central_ht + :name: Health Thermometer (Central) + :relevant-api: bluetooth -Bluetooth: Central / Health Thermometer sensor -############################################## + Connect to a BLE health thermometer sensor and read temperature measurements. Overview ******** -Similar to the :ref:`Central ` sample, except that this +Similar to the :zephyr:code-sample:`Central ` sample, except that this application specifically looks for health thermometer sensor and reports the die temperature readings once connected. diff --git a/samples/bluetooth/central_iso/README.rst b/samples/bluetooth/central_iso/README.rst index 13e6f56d7786a20..0698aadc1d4eea6 100644 --- a/samples/bluetooth/central_iso/README.rst +++ b/samples/bluetooth/central_iso/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_central_iso: +.. zephyr:code-sample:: bluetooth_central_iso + :name: ISO (Central) + :relevant-api: bt_iso bluetooth -Bluetooth: Central ISO -###################### + Transfer isochronous data to a peer device using an isochronous channel as a central. Overview ******** @@ -9,7 +10,7 @@ Overview This sample demonstrates how to use an isochronous channel as a central. The sample scans for a peripheral, establishes a connection, and sets up a connected isochronous channel to it. Once the isochronous channel is connected, isochronous data is transferred to the peer device every 10 milliseconds. -It is recommended to run this sample together with the :ref:`Bluetooth: Peripheral ISO ` sample. +It is recommended to run this sample together with the :zephyr:code-sample:`ble_peripheral_iso` sample. To run the sample with an encrypted isochronous channel, enable :kconfig:option:`CONFIG_BT_SMP`. diff --git a/samples/bluetooth/central_multilink/README.rst b/samples/bluetooth/central_multilink/README.rst index d2b82b97c089c2e..850d9ea35a58cbe 100644 --- a/samples/bluetooth/central_multilink/README.rst +++ b/samples/bluetooth/central_multilink/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_central_multilink: +.. zephyr:code-sample:: bluetooth_central_multilink + :name: Central Multilink + :relevant-api: bluetooth -Bluetooth: Central -################## + Scan, connect and establish connection to up to 62 peripherals. Overview ******** diff --git a/samples/bluetooth/central_otc/README.rst b/samples/bluetooth/central_otc/README.rst index 59ef2e28025b355..20bbaefab3fc416 100644 --- a/samples/bluetooth/central_otc/README.rst +++ b/samples/bluetooth/central_otc/README.rst @@ -1,12 +1,13 @@ -.. _central_otc: +.. zephyr:code-sample:: bluetooth_central_otc + :name: Central OTC + :relevant-api: bluetooth -Bluetooth: Central OTC -###################### + Connect to a BLE peripheral that supports the Object Transfer Service (OTS) Overview ******** -Similar to the :ref:`Central ` sample, except that this +Similar to the :zephyr:code-sample:`Central ` sample, except that this application specifically looks for the OTS (Object Transfer) GATT Service. And this sample is to select object sequentially, to read metadata, to write data, to read data, and to calculate checksum of selected objects. diff --git a/samples/bluetooth/central_past/README.rst b/samples/bluetooth/central_past/README.rst index ce7d8d65d0a2a10..bdf151a4a843e1a 100644 --- a/samples/bluetooth/central_past/README.rst +++ b/samples/bluetooth/central_past/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-central-past-sample: +.. zephyr:code-sample:: bluetooth_central_past + :name: Central Periodic Advertising Sync Transfer (PAST) + :relevant-api: bt_gap bluetooth -Bluetooth: Central Periodic Advertising Sync Transfer (PAST) -############################################################ + Use the Periodic Advertising Sync Transfer (PAST) feature as the sender. Overview ******** diff --git a/samples/bluetooth/direct_adv/README.rst b/samples/bluetooth/direct_adv/README.rst index ca0375eca60c044..e1c80e9b62b79a4 100644 --- a/samples/bluetooth/direct_adv/README.rst +++ b/samples/bluetooth/direct_adv/README.rst @@ -1,7 +1,8 @@ -.. _ble_direct_adv: +.. zephyr:code-sample:: _ble_direct_adv + :name: Direct Advertising + :relevant-api: bluetooth -Bluetooth: Direct Advertising -############################# + Advertise directly to a bonded central device. Overview ******** diff --git a/samples/bluetooth/direction_finding_central/README.rst b/samples/bluetooth/direction_finding_central/README.rst index 1a6d6519dcf6bd5..fe160c8e52d9551 100644 --- a/samples/bluetooth/direction_finding_central/README.rst +++ b/samples/bluetooth/direction_finding_central/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_direction_finding_central: +.. zephyr:code-sample:: bluetooth_direction_finding_central + :name: Direction Finding Central + :relevant-api: bluetooth -Bluetooth: Direction Finding Central -#################################### + Connect to a BLE Direction Finding peripheral and request Constant Tone Extension. Overview ******** @@ -37,7 +38,7 @@ changing ``nrf52833dk/nrf52833`` as needed for your board: :compact: To run the application on nRF5340DK, a Bluetooth controller application must -also run on the network core. The :ref:`bluetooth-hci-ipc-sample` sample +also run on the network core. The :zephyr:code-sample:`bluetooth_hci_ipc` sample application may be used. To build this sample with direction finding support enabled: @@ -69,7 +70,7 @@ this overlay. See :ref:`set-devicetree-overlays` for information on setting up and using overlays. Note that antenna matrix configuration for the nRF5340 SoC is part of the -network core application. When :ref:`bluetooth-hci-ipc-sample` is used as the +network core application. When :zephyr:code-sample:`bluetooth_hci_ipc` is used as the network core application, the antenna matrix configuration should be stored in the file :file:`samples/bluetooth/hci_ipc/boards/nrf5340dk_nrf5340_cpunet.overlay` diff --git a/samples/bluetooth/direction_finding_connectionless_rx/README.rst b/samples/bluetooth/direction_finding_connectionless_rx/README.rst index c9380c6e7e6bca5..51c3286e4eed420 100644 --- a/samples/bluetooth/direction_finding_connectionless_rx/README.rst +++ b/samples/bluetooth/direction_finding_connectionless_rx/README.rst @@ -37,7 +37,7 @@ changing ``nrf52833dk/nrf52833`` as needed for your board: :compact: To run the application on nRF5340DK, a Bluetooth controller application must -also run on the network core. The :ref:`bluetooth-hci-ipc-sample` sample +also run on the network core. The :zephyr:code-sample:`bluetooth_hci_ipc` sample application may be used. To build this sample with direction finding support enabled: @@ -72,7 +72,7 @@ this overlay. See :ref:`set-devicetree-overlays` for information on setting up and using overlays. Note that antenna matrix configuration for the nRF5340 SoC is part of the -network core application. When :ref:`bluetooth-hci-ipc-sample` is used as the +network core application. When :zephyr:code-sample:`bluetooth_hci_ipc` is used as the network core application, the antenna matrix configuration should be stored in the file :file:`samples/bluetooth/hci_ipc/boards/nrf5340dk_nrf5340_cpunet.overlay` diff --git a/samples/bluetooth/direction_finding_connectionless_tx/README.rst b/samples/bluetooth/direction_finding_connectionless_tx/README.rst index 8ccd97d9251a926..8034a942a10e58c 100644 --- a/samples/bluetooth/direction_finding_connectionless_tx/README.rst +++ b/samples/bluetooth/direction_finding_connectionless_tx/README.rst @@ -73,7 +73,7 @@ this overlay. See :ref:`set-devicetree-overlays` for information on setting up and using overlays. Note that antenna matrix configuration for the nRF5340 SoC is part of the -network core application. When :ref:`bluetooth-hci-ipc-sample` is used as +network core application. When :zephyr:code-sample:`bluetooth_hci_ipc` is used as network core application, the antenna matrix configuration should be stored in the file :file:`samples/bluetooth/hci_ipc/boards/nrf5340dk_nrf5340_cpunet.overlay` diff --git a/samples/bluetooth/direction_finding_peripheral/README.rst b/samples/bluetooth/direction_finding_peripheral/README.rst index 68d709173d9855a..ceb45eea7f29870 100644 --- a/samples/bluetooth/direction_finding_peripheral/README.rst +++ b/samples/bluetooth/direction_finding_peripheral/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_direction_finding_peripheral: +.. zephyr:code-sample:: bluetooth_direction_finding_peripheral + :name: Direction Finding Peripheral + :relevant-api: bluetooth -Bluetooth: Direction Finding Peripheral -####################################### + Implement BLE Direction Finding peripheral transmitting CTE in connected mode. Overview ******** @@ -36,7 +37,7 @@ changing ``nrf52833dk/nrf52833`` as needed for your board: :compact: To run the application on nRF5340DK, a Bluetooth controller application must -also run on the network core. The :ref:`bluetooth-hci-ipc-sample` sample +also run on the network core. The :zephyr:code-sample:`bluetooth_hci_ipc` sample application may be used. To build this sample with direction finding support enabled: @@ -68,7 +69,7 @@ this overlay. See :ref:`set-devicetree-overlays` for information on setting up and using overlays. Note that antenna matrix configuration for the nRF5340 SoC is part of the -network core application. When :ref:`bluetooth-hci-ipc-sample` is used as the +network core application. When :zephyr:code-sample:`bluetooth_hci_ipc` is used as the network core application, the antenna matrix configuration should be stored in the file :file:`samples/bluetooth/hci_ipc/boards/nrf5340dk_nrf5340_cpunet.overlay` diff --git a/samples/bluetooth/eddystone/README.rst b/samples/bluetooth/eddystone/README.rst index 3c5ed5e27750df4..0fcb82da0e89e43 100644 --- a/samples/bluetooth/eddystone/README.rst +++ b/samples/bluetooth/eddystone/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-eddystone-sample: +.. zephyr:code-sample:: bluetooth_eddystone + :name: Eddystone + :relevant-api: bluetooth -Bluetooth: Eddystone -#################### + Export an Eddystone Configuration Service as a BLE GATT service. Overview ******** diff --git a/samples/bluetooth/encrypted_advertising/README.rst b/samples/bluetooth/encrypted_advertising/README.rst index 5c107d8a6347d79..89fad4fe322f844 100644 --- a/samples/bluetooth/encrypted_advertising/README.rst +++ b/samples/bluetooth/encrypted_advertising/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_encrypted_advertising_sample: +.. zephyr:code-sample:: bluetooth_encrypted_advertising + :name: Encrypted Advertising + :relevant-api: bluetooth -Bluetooth: Encrypted Advertising -################################ + Use the BLE encrypted advertising feature. Overview ******** diff --git a/samples/bluetooth/extended_adv/README.rst b/samples/bluetooth/extended_adv/README.rst index c5c402818e629a8..6909aa32a09c7f2 100644 --- a/samples/bluetooth/extended_adv/README.rst +++ b/samples/bluetooth/extended_adv/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_extended_advertising_sample: +.. zephyr:code-sample:: bluetooth_extended_advertising + :name: Extended Advertising + :relevant-api: bluetooth -Bluetooth: Extended Advertising -################################ + Use the BLE extended advertising feature. Overview ******** diff --git a/samples/bluetooth/handsfree/README.rst b/samples/bluetooth/handsfree/README.rst index e04e07738104105..609139ef04a9455 100644 --- a/samples/bluetooth/handsfree/README.rst +++ b/samples/bluetooth/handsfree/README.rst @@ -1,7 +1,8 @@ -.. _bt_handsfree: +.. zephyr:code-sample:: bluetooth_handsfree + :name: Hands-free + :relevant-api: bt_hfp bluetooth -Bluetooth: Handsfree -#################### + Use the Hands-Free Profile (HFP) APIs. Overview ******** diff --git a/samples/bluetooth/handsfree_ag/README.rst b/samples/bluetooth/handsfree_ag/README.rst index 9d2e2d9343aca35..21c190ab360cc9a 100644 --- a/samples/bluetooth/handsfree_ag/README.rst +++ b/samples/bluetooth/handsfree_ag/README.rst @@ -1,7 +1,8 @@ -.. _bt_handsfree_ag: +.. zephyr:code-sample:: bluetooth_handsfree_ag + :name: Hands-free Audio Gateway (AG) + :relevant-api: bt_hfp bluetooth -Bluetooth: Handsfree Audio Gateway -################################## + Use the Hands-Free Profile Audio Gateway (AG) APIs. Overview ******** diff --git a/samples/bluetooth/hap_ha/README.rst b/samples/bluetooth/hap_ha/README.rst index 9347185882ce27b..93e2b3a9c7552e0 100644 --- a/samples/bluetooth/hap_ha/README.rst +++ b/samples/bluetooth/hap_ha/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_hap_ha: +.. zephyr:code-sample:: bluetooth_hap_ha + :name: Hearing Access Profile (HAP) Hearing Aid (HA) + :relevant-api: bt_has -Bluetooth: HAP Hearing Aid (HA) -############################### + Advertise and XXX Overview ******** diff --git a/samples/bluetooth/hci_ipc/README.rst b/samples/bluetooth/hci_ipc/README.rst index 605898d7220e19d..041827d5aef4077 100644 --- a/samples/bluetooth/hci_ipc/README.rst +++ b/samples/bluetooth/hci_ipc/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-hci-ipc-sample: +.. zephyr:code-sample:: bluetooth_hci_ipc + :name: HCI IPC + :relevant-api: hci_raw bluetooth -Bluetooth: HCI IPC -################## + Expose Zephyr Bluetooth controller to another device or CPU using the IPC subsystem. Overview ******** diff --git a/samples/bluetooth/hci_pwr_ctrl/README.rst b/samples/bluetooth/hci_pwr_ctrl/README.rst index 9388157d6c224ec..4ce16c5d944b84b 100644 --- a/samples/bluetooth/hci_pwr_ctrl/README.rst +++ b/samples/bluetooth/hci_pwr_ctrl/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-hci-pwr-ctrl-sample: +.. zephyr:code-sample:: bluetooth_hci_pwr_ctrl + :name: HCI Power Control + :relevant-api: bt_hrs bluetooth -Bluetooth: HCI Power Control -############################ + Dynamically control the Tx power of a BLE Controller using HCI vendor-specific commands. Overview ******** diff --git a/samples/bluetooth/hci_spi/README.rst b/samples/bluetooth/hci_spi/README.rst index 176c5da8a195aff..4c6aff6d8d6d681 100644 --- a/samples/bluetooth/hci_spi/README.rst +++ b/samples/bluetooth/hci_spi/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-hci-spi-sample: +.. zephyr:code-sample:: bluetooth_hci_spi + :name: HCI SPI + :relevant-api: hci_raw bluetooth spi_interface -Bluetooth: HCI SPI -################## + Expose Zephyr Bluetooth controller to another device or CPU over SPI. Overview ******** diff --git a/samples/bluetooth/hci_uart/README.rst b/samples/bluetooth/hci_uart/README.rst index 955a443a995baed..85b6b2e8dade557 100644 --- a/samples/bluetooth/hci_uart/README.rst +++ b/samples/bluetooth/hci_uart/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-hci-uart-sample: +.. zephyr:code-sample:: bluetooth_hci_uart + :name: HCI UART + :relevant-api: hci_raw bluetooth uart_interface -Bluetooth: HCI UART -#################### + Expose Zephyr Bluetooth controller to another device or CPU over UART. Overview ********* diff --git a/samples/bluetooth/hci_uart_3wire/README.rst b/samples/bluetooth/hci_uart_3wire/README.rst index cabd79616be9b54..46aa5dd2cf7fe1c 100644 --- a/samples/bluetooth/hci_uart_3wire/README.rst +++ b/samples/bluetooth/hci_uart_3wire/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-hci-uart-3wire-sample: +.. zephyr:code-sample:: bluetooth_hci_uart_3wire + :name: HCI 3-wire (H:5) + :relevant-api: hci_raw bluetooth uart_interface -Bluetooth: HCI UART 3WIRE -######################### + Expose a Bluetooth controller to another device or CPU over H5:HCI transport. Overview ********* diff --git a/samples/bluetooth/hci_uart_async/README.rst b/samples/bluetooth/hci_uart_async/README.rst index 473d3437d0538ba..39af7b8f9b3b00b 100644 --- a/samples/bluetooth/hci_uart_async/README.rst +++ b/samples/bluetooth/hci_uart_async/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-hci-uart-async-sample: +.. zephyr:code-sample:: bluetooth_hci_uart_async + :name: HCI UART async + :relevant-api: hci_raw bluetooth uart_interface -Bluetooth: HCI UART based on ASYNC UART -####################################### + Expose a Bluetooth controller to another device or CPU over asynchronous UART. Expose a Zephyr Bluetooth Controller over a standard Bluetooth HCI UART interface. diff --git a/samples/bluetooth/hci_usb/README.rst b/samples/bluetooth/hci_usb/README.rst index 91e4fb7f4fcd9db..558620fd756d48f 100644 --- a/samples/bluetooth/hci_usb/README.rst +++ b/samples/bluetooth/hci_usb/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-hci-usb-sample: +.. zephyr:code-sample:: bluetooth_hci_usb + :name: HCI USB + :relevant-api: hci_raw bluetooth _usb_device_core_api usbd_api -Bluetooth: HCI USB -################## + Turn a Zephyr board into a USB Bluetooth dongle. Overview ******** diff --git a/samples/bluetooth/hci_usb_h4/README.rst b/samples/bluetooth/hci_usb_h4/README.rst index 74d5b214715d114..f662c2dfcffe68c 100644 --- a/samples/bluetooth/hci_usb_h4/README.rst +++ b/samples/bluetooth/hci_usb_h4/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-hci-usb-h4-sample: +.. zephyr:code-sample:: bluetooth_hci_usb_h4 + :name: HCI H4 over USB + :relevant-api: hci_raw bluetooth _usb_device_core_api usbd_api -Bluetooth: HCI H4 over USB -########################## + Turn a Zephyr board into a USB H4 Bluetooth dongle. Overview ******** diff --git a/samples/bluetooth/hci_vs_scan_req/README.rst b/samples/bluetooth/hci_vs_scan_req/README.rst index a05f91ae613b602..a2d695fb9358484 100644 --- a/samples/bluetooth/hci_vs_scan_req/README.rst +++ b/samples/bluetooth/hci_vs_scan_req/README.rst @@ -1,13 +1,14 @@ -.. _bluetooth-hci-vs-scan-req-sample: +.. zephyr:code-sample:: bluetooth_hci_vs_scan_req + :name: HCI Vendor-Specific Scan Request + :relevant-api: bluetooth -Bluetooth: HCI VS Scan Request -############################## + Manage vendor-specific HCI commands to obtain scan request events even using xxx. Overview ******** This simple application is a usage example to manage HCI VS commands to obtain -scan equest events even using legacy advertisements, while may result in lower +scan request events even using legacy advertisements, while may result in lower RAM usage than using extended advertising. This is quite important in applications in which the broadcaster role is added to the central role, where the RAM saving can be bigger. diff --git a/samples/bluetooth/ibeacon/README.rst b/samples/bluetooth/ibeacon/README.rst index 548c69bc1ab448f..81947c4733e9747 100644 --- a/samples/bluetooth/ibeacon/README.rst +++ b/samples/bluetooth/ibeacon/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-ibeacon-sample: +.. zephyr:code-sample:: bluetooth_ibeacon + :name: iBeacon + :relevant-api: bluetooth -Bluetooth: iBeacon -################## + Advertise an Apple iBeacon using BLE Broadcaster role. Overview ******** diff --git a/samples/bluetooth/iso_broadcast/README.rst b/samples/bluetooth/iso_broadcast/README.rst index 6b4bb276ab16131..c560e0e5fab3e9b 100644 --- a/samples/bluetooth/iso_broadcast/README.rst +++ b/samples/bluetooth/iso_broadcast/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-isochronous-broadcaster-sample: +.. zephyr:code-sample:: bluetooth_isochronous_broadcaster + :name: Isochronous Broadcaster + :relevant-api: bt_iso bluetooth -Bluetooth: Isochronous Broadcaster -################################## + Use the Bluetooth Low Energy Isochronous Broadcaster functionality. Overview ******** diff --git a/samples/bluetooth/iso_broadcast_benchmark/README.rst b/samples/bluetooth/iso_broadcast_benchmark/README.rst index a89d4255a051784..cd371c3e11ff53d 100644 --- a/samples/bluetooth/iso_broadcast_benchmark/README.rst +++ b/samples/bluetooth/iso_broadcast_benchmark/README.rst @@ -1,7 +1,8 @@ -.. _iso_broadcast_benchmark: +.. zephyr:code-sample:: bluetooth_isochronous_broadcaster_benchmark + :name: Isochronous Broadcaster Benchmark + :relevant-api: bt_iso bluetooth -Bluetooth: Throughput -##################### + Measure packet loss and sync loss of an ISO broadcaster against one or more receivers. The ISO Broadcast Benchmark sample measures and report packet loss and sync loss of an ISO broadcaster against one or more ISO broadcast receivers. diff --git a/samples/bluetooth/iso_connected_benchmark/README.rst b/samples/bluetooth/iso_connected_benchmark/README.rst index 7b8f00596c6a727..c4c30f732632a3b 100644 --- a/samples/bluetooth/iso_connected_benchmark/README.rst +++ b/samples/bluetooth/iso_connected_benchmark/README.rst @@ -1,12 +1,12 @@ -.. _iso_connected_benchmark: +.. zephyr:code-sample:: bluetooth_isochronous_connected_benchmark + :name: Isochronous Connected Channels Benchmark + :relevant-api: bt_iso bluetooth -Bluetooth: Throughput -##################### + Measure packet loss and sync loss in connected ISO channels. The ISO Connected Channels Benchmark sample measures and reports packet loss and sync loss in connected ISO channels. - Overview ******** diff --git a/samples/bluetooth/iso_receive/README.rst b/samples/bluetooth/iso_receive/README.rst index d4bb1a4951ba0ac..7cdfd80c53ce893 100644 --- a/samples/bluetooth/iso_receive/README.rst +++ b/samples/bluetooth/iso_receive/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-iso-receive-sample: +.. zephyr:code-sample:: bluetooth_isochronous_receiver + :name: Synchronized Receiver + :relevant-api: bt_iso bluetooth -Bluetooth: Synchronized Receiver -############################################### + Use BLE Synchronized Receiver functionality. Overview ******** diff --git a/samples/bluetooth/mesh/README.rst b/samples/bluetooth/mesh/README.rst index 58532a0600bbaa3..323a6277c078275 100644 --- a/samples/bluetooth/mesh/README.rst +++ b/samples/bluetooth/mesh/README.rst @@ -1,7 +1,8 @@ -.. _ble_mesh: +.. zephyr:code-sample:: ble_mesh + :name: Mesh + :relevant-api: bt_mesh bluetooth -Bluetooth: Mesh -############### + Use basic BLE Mesh functionality. Overview ******** @@ -45,7 +46,7 @@ Refer to your :ref:`board's documentation ` for alternative flash instructions if your board doesn't support the ``flash`` target. To run the application on an :ref:`nrf5340dk_nrf5340`, a Bluetooth controller application -must also run on the network core. The :ref:`bluetooth-hci-ipc-sample` sample +must also run on the network core. The :zephyr:code-sample:`bluetooth_hci_ipc` sample application may be used. Build this sample with configuration :zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_bt_mesh-bt_ll_sw_split.conf` to enable mesh support. diff --git a/samples/bluetooth/mesh_demo/README.rst b/samples/bluetooth/mesh_demo/README.rst index 2edb690ab196ac5..97efebdbeba84f7 100644 --- a/samples/bluetooth/mesh_demo/README.rst +++ b/samples/bluetooth/mesh_demo/README.rst @@ -1,7 +1,8 @@ -.. _ble_mesh_demo: +.. zephyr:code-sample:: ble_mesh_demo + :name: Mesh Demo + :relevant-api: bt_mesh bluetooth -Bluetooth: Mesh Demo -#################### + Implement a Bluetooth Mesh demo application. xxx Overview ******** @@ -56,7 +57,7 @@ Refer to your :ref:`board's documentation ` for alternative flash instructions if your board doesn't support the ``flash`` target. To run the application on an :ref:`nrf5340dk_nrf5340`, a Bluetooth controller application -must also run on the network core. The :ref:`bluetooth-hci-ipc-sample` sample +must also run on the network core. The :zephyr:code-sample:`bluetooth_hci_ipc` sample application may be used. Build this sample with configuration :zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_bt_mesh-bt_ll_sw_split.conf` to enable mesh support. diff --git a/samples/bluetooth/mesh_provisioner/README.rst b/samples/bluetooth/mesh_provisioner/README.rst index 1b37a04a4a83dec..b4c5c7e286e9508 100644 --- a/samples/bluetooth/mesh_provisioner/README.rst +++ b/samples/bluetooth/mesh_provisioner/README.rst @@ -54,7 +54,7 @@ Refer to your :ref:`board's documentation ` for alternative flash instructions if your board doesn't support the ``flash`` target. To run the application on an :ref:`nrf5340dk_nrf5340`, a Bluetooth controller application -must also run on the network core. The :ref:`bluetooth-hci-ipc-sample` sample +must also run on the network core. The :zephyr:code-sample:`bluetooth_hci_ipc` sample application may be used. Build this sample with configuration :zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_bt_mesh-bt_ll_sw_split.conf` to enable mesh support. diff --git a/samples/bluetooth/mtu_update/README.rst b/samples/bluetooth/mtu_update/README.rst index aa9678f0a416150..fb5069aa11fa270 100644 --- a/samples/bluetooth/mtu_update/README.rst +++ b/samples/bluetooth/mtu_update/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_mtu_update_sample: +.. zephyr:code-sample:: bluetooth_mtu_update + :name: MTU Update + :relevant-api: bt_gatt bluetooth -Bluetooth: MTU Update -##################### + Configure and exchange MTU between two devices. Q&A: **** diff --git a/samples/bluetooth/observer/README.rst b/samples/bluetooth/observer/README.rst index 3eb171a691a599d..8f807b915b4820b 100644 --- a/samples/bluetooth/observer/README.rst +++ b/samples/bluetooth/observer/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-observer-sample: +.. zephyr:code-sample:: bluetooth_observer + :name: Observer + :relevant-api: bt_gap bluetooth -Bluetooth: Observer -################### + Scan for Bluetooth devices nearby and print their information. Overview ******** diff --git a/samples/bluetooth/pbp_public_broadcast_sink/README.rst b/samples/bluetooth/pbp_public_broadcast_sink/README.rst index 4e4ecaaa38df00d..8414eba7e33494a 100644 --- a/samples/bluetooth/pbp_public_broadcast_sink/README.rst +++ b/samples/bluetooth/pbp_public_broadcast_sink/README.rst @@ -1,5 +1,5 @@ .. zephyr:code-sample:: bluetooth_public_broadcast_sink - :name: Bluetooth: Public Broadcast Sink + :name: Public Broadcast Sink :relevant-api: bluetooth Bluetooth: Public Broadcast Sink @@ -50,7 +50,7 @@ If you prefer to only build the application core image, you can do so by doing i :goals: build In that case you can pair this application core image with the -:ref:`hci_ipc sample ` +:zephyr:code-sample:`bluetooth_hci_ipc` sample :zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration. Building for a simulated nrf5340bsim diff --git a/samples/bluetooth/pbp_public_broadcast_source/README.rst b/samples/bluetooth/pbp_public_broadcast_source/README.rst index 80856f43a24627c..5e5f855137c9386 100644 --- a/samples/bluetooth/pbp_public_broadcast_source/README.rst +++ b/samples/bluetooth/pbp_public_broadcast_source/README.rst @@ -1,5 +1,5 @@ .. zephyr:code-sample:: bluetooth_public_broadcast_source - :name: Bluetooth: Public Broadcast Source + :name: Public Broadcast Source :relevant-api: bluetooth Bluetooth: Public Broadcast Source @@ -50,7 +50,7 @@ If you prefer to only build the application core image, you can do so by doing i :goals: build In that case you can pair this application core image with the -:ref:`hci_ipc sample ` +:zephyr:code-sample:`bluetooth_hci_ipc` sample :zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration. Building for a simulated nrf5340bsim diff --git a/samples/bluetooth/peripheral_hr/README.rst b/samples/bluetooth/peripheral_hr/README.rst index ff9be5e991696c8..767de569de31809 100644 --- a/samples/bluetooth/peripheral_hr/README.rst +++ b/samples/bluetooth/peripheral_hr/README.rst @@ -1,7 +1,8 @@ -.. _peripheral_hr: +.. zephyr:code-sample:: ble_peripheral_hr + :name: Heart-rate Monitor (Peripheral) + :relevant-api: bt_hrs bt_bas bluetooth -Bluetooth: Peripheral HR -######################## + Expose a Heart Rate (HR) GATT Service generating dummy heart-rate values. Overview ******** diff --git a/samples/bluetooth/peripheral_ht/README.rst b/samples/bluetooth/peripheral_ht/README.rst index b5770ef4842c770..3baa23314edc2a2 100644 --- a/samples/bluetooth/peripheral_ht/README.rst +++ b/samples/bluetooth/peripheral_ht/README.rst @@ -1,7 +1,8 @@ -.. _peripheral_ht: +.. zephyr:code-sample:: ble_peripheral_ht + :name: Health Thermometer (Peripheral) + :relevant-api: bt_bas bluetooth -Bluetooth: Peripheral HT -######################## + Expose a Health Thermometer (HT) GATT Service generating dummy temperature values. Overview ******** diff --git a/samples/bluetooth/peripheral_identity/README.rst b/samples/bluetooth/peripheral_identity/README.rst index 2619e52a89533ca..c1ee414b8aa950d 100644 --- a/samples/bluetooth/peripheral_identity/README.rst +++ b/samples/bluetooth/peripheral_identity/README.rst @@ -1,7 +1,8 @@ -.. _peripheral_identity: +.. zephyr:code-sample:: ble_peripheral_identity + :name: Peripheral Identity + :relevant-api: bluetooth -Bluetooth: Peripheral Identity -############################## + Use multiple identities to allow connections from multiple central devices. Overview ******** diff --git a/samples/bluetooth/peripheral_iso/README.rst b/samples/bluetooth/peripheral_iso/README.rst index d877cf3a98f51a2..05bfae301f6417e 100644 --- a/samples/bluetooth/peripheral_iso/README.rst +++ b/samples/bluetooth/peripheral_iso/README.rst @@ -1,7 +1,8 @@ -.. _peripheral_iso: +.. zephyr:code-sample:: ble_peripheral_iso + :name: ISO (Peripheral) + :relevant-api: bt_bas bluetooth -Bluetooth: Peripheral ISO -######################### + Use isochronous channels as a peripheral. Overview ******** @@ -9,7 +10,7 @@ Overview This sample demonstrates how to use isochronous channels as a peripheral. The sample starts advertising, waits for a central to connect to it and set up an isochronous channel. Once the isochronous channel is set up, received isochronous data is printed out. -It is recommended to run this sample together with the :ref:`Bluetooth: Central ISO ` sample. +It is recommended to run this sample together with the :zephyr:code-sample:`bluetooth_central_iso` sample. Requirements ************ diff --git a/samples/bluetooth/peripheral_nus/README.rst b/samples/bluetooth/peripheral_nus/README.rst index 2cbf68f80caf810..a4c1afbf5d2464e 100644 --- a/samples/bluetooth/peripheral_nus/README.rst +++ b/samples/bluetooth/peripheral_nus/README.rst @@ -1,7 +1,8 @@ -.. _peripheral_nus: +.. zephyr:code-sample:: ble_peripheral_nus + :name: Peripheral NUS + :relevant-api: bluetooth -Bluetooth: Peripheral NUS -######################### + Use the Nordic UART Service (NUS) to implement a simple echo server. Overview ******** diff --git a/samples/bluetooth/peripheral_ots/README.rst b/samples/bluetooth/peripheral_ots/README.rst index 3061caa1f669a21..602736165a08393 100644 --- a/samples/bluetooth/peripheral_ots/README.rst +++ b/samples/bluetooth/peripheral_ots/README.rst @@ -1,7 +1,8 @@ -.. _peripheral_ots: +.. zephyr:code-sample:: ble_peripheral_ots + :name: Peripheral Object Transfer Service (OTS) + :relevant-api: bt_ots bluetooth -Bluetooth: Peripheral OTS -######################### + Expose an Object Transfer Service (OTS) GATT Service. Overview ******** diff --git a/samples/bluetooth/peripheral_past/README.rst b/samples/bluetooth/peripheral_past/README.rst index fc5226ed7f34696..59bfcff34422bd7 100644 --- a/samples/bluetooth/peripheral_past/README.rst +++ b/samples/bluetooth/peripheral_past/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-peripheral-past-sample: +.. zephyr:code-sample:: ble_peripheral_past + :name: Periodic Advertising Synchronization Transfer Peripheral + :relevant-api: bt_gap bluetooth -Bluetooth: Periodic Advertising Synchronization Transfer -######################################################## + Use the Periodic Advertising Sync Transfer (PAST) feature as the receiver. Overview ******** diff --git a/samples/bluetooth/peripheral_sc_only/README.rst b/samples/bluetooth/peripheral_sc_only/README.rst index a96e63c8bf4b979..c582d1198f9ab2a 100644 --- a/samples/bluetooth/peripheral_sc_only/README.rst +++ b/samples/bluetooth/peripheral_sc_only/README.rst @@ -1,7 +1,8 @@ -.. _peripheral_sc_only: +.. zephyr:code-sample:: ble_peripheral_sc_only + :name: Peripheral SC-only + :relevant-api: bt_conn bluetooth -Bluetooth: Peripheral SC-only -############################# + Enable "Secure Connections Only" mode for a BLE peripheral. Overview ******** diff --git a/samples/bluetooth/scan_adv/README.rst b/samples/bluetooth/scan_adv/README.rst index 8c8a20ddf39a6be..109aa18a6648d0b 100644 --- a/samples/bluetooth/scan_adv/README.rst +++ b/samples/bluetooth/scan_adv/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-scan-adv-sample: +.. zephyr:code-sample:: ble_scan_adv + :name: Scan & Advertise + :relevant-api: bt_gap bluetooth -Bluetooth: Scan & Advertise -########################### + Combine BLE Broadcaster & Observer roles to advertise and scan for devices simultaneously. Overview ******** diff --git a/samples/bluetooth/st_ble_sensor/README.rst b/samples/bluetooth/st_ble_sensor/README.rst index 1b893619c764186..a4667c3be00510f 100644 --- a/samples/bluetooth/st_ble_sensor/README.rst +++ b/samples/bluetooth/st_ble_sensor/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth-st_ble_sensor: +.. zephyr:code-sample:: bluetooth_st_ble_sensor + :name: ST BLE Sensor Demo + :relevant-api: bt_gatt bluetooth -Bluetooth: ST BLE Sensor Demo -############################# + Export vendor-specific GATT services over BLE. Overview ******** diff --git a/samples/bluetooth/tmap_bmr/README.rst b/samples/bluetooth/tmap_bmr/README.rst index 0c904803062ce83..356ab6f2abf7c90 100644 --- a/samples/bluetooth/tmap_bmr/README.rst +++ b/samples/bluetooth/tmap_bmr/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_tmap_bmr: +.. zephyr:code-sample:: ble_peripheral_tmap_bmr + :name: TMAP Broadcast Media Receiver (BMR) + :relevant-api: bt_audio bt_bap bluetooth -Bluetooth: TMAP BMR -################### + Implement the LE Audio TMAP Broadcast Media Receiver (BMR) role. Overview ******** diff --git a/samples/bluetooth/tmap_bms/README.rst b/samples/bluetooth/tmap_bms/README.rst index 92c36a48e543ea9..a5f19fdbf4557a2 100644 --- a/samples/bluetooth/tmap_bms/README.rst +++ b/samples/bluetooth/tmap_bms/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_tmap_bms: +.. zephyr:code-sample:: ble_peripheral_tmap_bms + :name: TMAP Broadcast Media Sender (BMS) + :relevant-api: bt_audio bt_bap bluetooth -Bluetooth: TMAP BMS -################### + Implement the LE Audio TMAP Broadcast Media Sender (BMS) role. Overview ******** diff --git a/samples/bluetooth/tmap_central/README.rst b/samples/bluetooth/tmap_central/README.rst index 74183a931ee38e1..8195b79eccee0f1 100644 --- a/samples/bluetooth/tmap_central/README.rst +++ b/samples/bluetooth/tmap_central/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_tmap_central: +.. zephyr:code-sample:: ble_peripheral_tmap_central + :name: TMAP (Central) + :relevant-api: bt_audio bt_bap bluetooth -Bluetooth: TMAP Central -####################### + Implement the LE Audio TMAP central functionality (CG and UMS roles). Overview ******** diff --git a/samples/bluetooth/tmap_peripheral/README.rst b/samples/bluetooth/tmap_peripheral/README.rst index b9ee028429b4c68..d0ebd02e5488c6b 100644 --- a/samples/bluetooth/tmap_peripheral/README.rst +++ b/samples/bluetooth/tmap_peripheral/README.rst @@ -1,7 +1,8 @@ -.. _bluetooth_tmap_peripheral: +.. zephyr:code-sample:: ble_peripheral_tmap_peripheral + :name: TMAP (Peripheral) + :relevant-api: bt_audio bt_bap bluetooth -Bluetooth: TMAP Peripheral -########################## + Implement the LE Audio TMAP central functionality (CT and UMR roles). Overview ********