OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/samples/bluetooth/direction_finding_connectio.../README.rst

77 lines
2.9 KiB
ReStructuredText
Raw Normal View History

doc: samples: bluetooth: DFE fixes The documentation for Bluetooth Direction Finding Extension (DFE) samples has various issues: - references to 'child' images, which do not exist in mainline zephyr - invalid RST syntax: there are missing ` characters to end arguments to :zephyr_file: roles, creating unintelligible output - incorrect RST usage: - using :zephyr_file: instead of :file: when referring to a file that the user must create, creating broken links to nonexistent files in the zephyr tree - using :code: instead of :kconfig: to refer to kconfig options, creating output without links to the help for those options - redundant or duplicated information - grammar, typos, various bits and pieces Clean this up. As part of that, move various common bits and pieces of information to the devicetree bindings index so they can just be linked to from the sample docs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-07-17 06:26:39 +08:00
.. _bluetooth_direction_finding_connectionless_rx:
samples: Bluetooth: Add Direction Finding connectionless Rx sample Add an application that uses Direction Finding API for reception and sampling of CTE in connectionless mode (periodic adverising PDUs). Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-04-26 19:47:46 +08:00
Bluetooth: Direction Finding Periodic Advertising Locator
#########################################################
Overview
********
A simple application demonstrating the BLE Direction Finding CTE Locator
functionality by receiving and sampling sending Constant Tone Extension with
periodic advertising PDUs.
Requirements
************
doc: samples: bluetooth: DFE fixes The documentation for Bluetooth Direction Finding Extension (DFE) samples has various issues: - references to 'child' images, which do not exist in mainline zephyr - invalid RST syntax: there are missing ` characters to end arguments to :zephyr_file: roles, creating unintelligible output - incorrect RST usage: - using :zephyr_file: instead of :file: when referring to a file that the user must create, creating broken links to nonexistent files in the zephyr tree - using :code: instead of :kconfig: to refer to kconfig options, creating output without links to the help for those options - redundant or duplicated information - grammar, typos, various bits and pieces Clean this up. As part of that, move various common bits and pieces of information to the devicetree bindings index so they can just be linked to from the sample docs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-07-17 06:26:39 +08:00
* Nordic nRF SoC based board with Direction Finding support (example boards:
:ref:`nrf52833dk_nrf52833`, :ref:`nrf5340dk_nrf5340`)
* Antenna matrix for AoA (optional)
Check your SoC's product specification for Direction Finding support if you are
unsure.
samples: Bluetooth: Add Direction Finding connectionless Rx sample Add an application that uses Direction Finding API for reception and sampling of CTE in connectionless mode (periodic adverising PDUs). Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-04-26 19:47:46 +08:00
Building and Running
********************
By default the application supports Angle of Arrival and Angle of Departure mode.
doc: samples: bluetooth: DFE fixes The documentation for Bluetooth Direction Finding Extension (DFE) samples has various issues: - references to 'child' images, which do not exist in mainline zephyr - invalid RST syntax: there are missing ` characters to end arguments to :zephyr_file: roles, creating unintelligible output - incorrect RST usage: - using :zephyr_file: instead of :file: when referring to a file that the user must create, creating broken links to nonexistent files in the zephyr tree - using :code: instead of :kconfig: to refer to kconfig options, creating output without links to the help for those options - redundant or duplicated information - grammar, typos, various bits and pieces Clean this up. As part of that, move various common bits and pieces of information to the devicetree bindings index so they can just be linked to from the sample docs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-07-17 06:26:39 +08:00
To use Angle of Departure mode only, build this application as follows,
changing ``nrf52833dk_nrf52833`` as needed for your board:
samples: Bluetooth: Add Direction Finding connectionless Rx sample Add an application that uses Direction Finding API for reception and sampling of CTE in connectionless mode (periodic adverising PDUs). Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-04-26 19:47:46 +08:00
.. zephyr-app-commands::
:zephyr-app: samples/bluetooth/direction_finding_connectionless_rx
:host-os: unix
:board: nrf52833dk_nrf52833
:gen-args: -DOVERLAY_CONFIG=overlay-aod.conf
:goals: build flash
:compact:
doc: samples: bluetooth: DFE fixes The documentation for Bluetooth Direction Finding Extension (DFE) samples has various issues: - references to 'child' images, which do not exist in mainline zephyr - invalid RST syntax: there are missing ` characters to end arguments to :zephyr_file: roles, creating unintelligible output - incorrect RST usage: - using :zephyr_file: instead of :file: when referring to a file that the user must create, creating broken links to nonexistent files in the zephyr tree - using :code: instead of :kconfig: to refer to kconfig options, creating output without links to the help for those options - redundant or duplicated information - grammar, typos, various bits and pieces Clean this up. As part of that, move various common bits and pieces of information to the devicetree bindings index so they can just be linked to from the sample docs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-07-17 06:26:39 +08:00
To run the application on nRF5340DK, a Bluetooth controller application must
also run on the network core. The :ref:`bluetooth-hci-rpmsg-sample` sample
application may be used. To build this sample with direction finding support
enabled:
samples: Bluetooth: df_rx: Add information about nRF5340 to README.rst Add information about support of nRF5340 SOC in the sample README.rst. Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-06-09 19:26:35 +08:00
doc: samples: bluetooth: DFE fixes The documentation for Bluetooth Direction Finding Extension (DFE) samples has various issues: - references to 'child' images, which do not exist in mainline zephyr - invalid RST syntax: there are missing ` characters to end arguments to :zephyr_file: roles, creating unintelligible output - incorrect RST usage: - using :zephyr_file: instead of :file: when referring to a file that the user must create, creating broken links to nonexistent files in the zephyr tree - using :code: instead of :kconfig: to refer to kconfig options, creating output without links to the help for those options - redundant or duplicated information - grammar, typos, various bits and pieces Clean this up. As part of that, move various common bits and pieces of information to the devicetree bindings index so they can just be linked to from the sample docs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-07-17 06:26:39 +08:00
* Copy
samples: Bluetooth: df_rx: Add information about nRF5340 to README.rst Add information about support of nRF5340 SOC in the sample README.rst. Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-06-09 19:26:35 +08:00
:zephyr_file:`samples/bluetooth/direction_finding_connectionless_rx/boards/nrf52833dk_nrf52833.overlay`
doc: samples: bluetooth: DFE fixes The documentation for Bluetooth Direction Finding Extension (DFE) samples has various issues: - references to 'child' images, which do not exist in mainline zephyr - invalid RST syntax: there are missing ` characters to end arguments to :zephyr_file: roles, creating unintelligible output - incorrect RST usage: - using :zephyr_file: instead of :file: when referring to a file that the user must create, creating broken links to nonexistent files in the zephyr tree - using :code: instead of :kconfig: to refer to kconfig options, creating output without links to the help for those options - redundant or duplicated information - grammar, typos, various bits and pieces Clean this up. As part of that, move various common bits and pieces of information to the devicetree bindings index so they can just be linked to from the sample docs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-07-17 06:26:39 +08:00
to a new file,
:file:`samples/bluetooth/hci_rpmsg/boards/nrf5340dk_nrf5340_cpunet.overlay`.
* Copy
:zephyr_file:`samples/bluetooth/direction_finding_connectionless_rx/boards/nrf52833dk_nrf52833.conf`
to a new file,
:file:`samples/bluetooth/hci_rpmsg/boards/nrf5340dk_nrf5340_cpunet.conf`. Add
the line ``CONFIG_BT_EXT_ADV=y`` to enable extended size of
doc: use :kconfig:option: domain role Kconfig options now belong to the Kconfig domain, therefore, the :kconfig:option: role needs to be used. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-02-08 00:27:43 +08:00
:kconfig:option:`CONFIG_BT_BUF_CMD_TX_SIZE` to support the LE Set Extended Advertising
doc: samples: bluetooth: DFE fixes The documentation for Bluetooth Direction Finding Extension (DFE) samples has various issues: - references to 'child' images, which do not exist in mainline zephyr - invalid RST syntax: there are missing ` characters to end arguments to :zephyr_file: roles, creating unintelligible output - incorrect RST usage: - using :zephyr_file: instead of :file: when referring to a file that the user must create, creating broken links to nonexistent files in the zephyr tree - using :code: instead of :kconfig: to refer to kconfig options, creating output without links to the help for those options - redundant or duplicated information - grammar, typos, various bits and pieces Clean this up. As part of that, move various common bits and pieces of information to the devicetree bindings index so they can just be linked to from the sample docs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-07-17 06:26:39 +08:00
Data command.
samples: Bluetooth: Add Direction Finding connectionless Rx sample Add an application that uses Direction Finding API for reception and sampling of CTE in connectionless mode (periodic adverising PDUs). Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-04-26 19:47:46 +08:00
Antenna matrix configuration
****************************
doc: samples: bluetooth: DFE fixes The documentation for Bluetooth Direction Finding Extension (DFE) samples has various issues: - references to 'child' images, which do not exist in mainline zephyr - invalid RST syntax: there are missing ` characters to end arguments to :zephyr_file: roles, creating unintelligible output - incorrect RST usage: - using :zephyr_file: instead of :file: when referring to a file that the user must create, creating broken links to nonexistent files in the zephyr tree - using :code: instead of :kconfig: to refer to kconfig options, creating output without links to the help for those options - redundant or duplicated information - grammar, typos, various bits and pieces Clean this up. As part of that, move various common bits and pieces of information to the devicetree bindings index so they can just be linked to from the sample docs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-07-17 06:26:39 +08:00
To use this sample with Angle of Departure enabled on Nordic SoCs, additional
configuration must be provided via :ref:`devicetree <dt-guide>` to enable
control of the antenna array.
samples: Bluetooth: Add Direction Finding connectionless Rx sample Add an application that uses Direction Finding API for reception and sampling of CTE in connectionless mode (periodic adverising PDUs). Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-04-26 19:47:46 +08:00
doc: samples: bluetooth: DFE fixes The documentation for Bluetooth Direction Finding Extension (DFE) samples has various issues: - references to 'child' images, which do not exist in mainline zephyr - invalid RST syntax: there are missing ` characters to end arguments to :zephyr_file: roles, creating unintelligible output - incorrect RST usage: - using :zephyr_file: instead of :file: when referring to a file that the user must create, creating broken links to nonexistent files in the zephyr tree - using :code: instead of :kconfig: to refer to kconfig options, creating output without links to the help for those options - redundant or duplicated information - grammar, typos, various bits and pieces Clean this up. As part of that, move various common bits and pieces of information to the devicetree bindings index so they can just be linked to from the sample docs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> Signed-off-by: Piotr Pryga <piotr.pryga@nordicsemi.no>
2021-07-17 06:26:39 +08:00
An example devicetree overlay is in
:zephyr_file:`samples/bluetooth/direction_finding_connectionless_rx/boards/nrf52833dk_nrf52833.overlay`.
You can customize this overlay when building for the same board, or create your
own board-specific overlay in the same directory for a different board. See
:dtcompatible:`nordic,nrf-radio` for documentation on the properties used in
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-rpmsg-sample` is used as the
network core application, the antenna matrix configuration should be stored in
the file
:file:`samples/bluetooth/hci_rpmsg/boards/nrf5340dk_nrf5340_cpunet.overlay`
instead.