ef54f3d5ce
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>
77 lines
2.9 KiB
ReStructuredText
77 lines
2.9 KiB
ReStructuredText
.. _bluetooth_direction_finding_connectionless_rx:
|
|
|
|
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
|
|
************
|
|
|
|
* 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.
|
|
|
|
Building and Running
|
|
********************
|
|
|
|
By default the application supports Angle of Arrival and Angle of Departure mode.
|
|
|
|
To use Angle of Departure mode only, build this application as follows,
|
|
changing ``nrf52833dk_nrf52833`` as needed for your board:
|
|
|
|
.. 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:
|
|
|
|
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:
|
|
|
|
* Copy
|
|
:zephyr_file:`samples/bluetooth/direction_finding_connectionless_rx/boards/nrf52833dk_nrf52833.overlay`
|
|
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
|
|
:kconfig:`CONFIG_BT_BUF_CMD_TX_SIZE` to support the LE Set Extended Advertising
|
|
Data command.
|
|
|
|
Antenna matrix configuration
|
|
****************************
|
|
|
|
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.
|
|
|
|
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.
|