-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: nrf: bluetooth: Add documentation for the RREQ
This adds documentation for the Ranging service Ranging Requestor. Signed-off-by: Timothy Keys <[email protected]>
- Loading branch information
Showing
3 changed files
with
62 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
.. _rreq_readme: | ||
|
||
Ranging Requestor (RREQ) | ||
######################## | ||
|
||
.. contents:: | ||
:local: | ||
:depth: 2 | ||
|
||
Overview | ||
******** | ||
|
||
This library implements the Ranging Requestor for Channel Sounding with the corresponding set of characteristics defined in the `Ranging Service Specification`_ and the `Ranging Profile Specification`_. | ||
|
||
This library supports On Demand Ranging Data. | ||
|
||
Configuration | ||
************* | ||
|
||
* :kconfig:option:`CONFIG_BT_RAS` - Enables RREQ and RRSP Kconfig options. | ||
|
||
* :kconfig:option:`CONFIG_BT_RAS_MAX_ANTENNA_PATHS` - Sets the maximum number of antenna paths supported by the device. | ||
This sets the antenna paths for each step that can be stored inside the Ranging Service. | ||
This value must match the supported Channel Sounding capabilities of the device. | ||
This affects the per-instance memory usage of the Ranging Service. | ||
|
||
* :kconfig:option:`CONFIG_BT_RAS_MODE_3_SUPPORTED` - Sets support for storing Mode 3 Channel Sounding steps. | ||
This will allocate memory for the Ranging Service to store Mode 3 Channel Sounding steps. | ||
This value must match the supported Channel Sounding capabilities of the device. | ||
This affects the per-instance memory usage of the Ranging Service. | ||
|
||
* :kconfig:option:`CONFIG_BT_RAS_RREQ` - Enables RREQ Kconfig options. | ||
|
||
* :kconfig:option:`CONFIG_BT_RAS_RREQ_MAX_ACTIVE_CONN` - Sets the number of simultaneously supported RREQ instances. | ||
|
||
* :kconfig:option:`CONFIG_HEAP_MEM_POOL_ADD_SIZE_RAS_RREQ_GATT_DM` - Sets the heap size for the GATT distance measurement module. | ||
|
||
* :kconfig:option:`CONFIG_BT_RAS_RREQ_LOG_LEVEL` - Sets the logging level of the RREQ library. | ||
|
||
Usage | ||
***** | ||
|
||
You can set up the RREQ either as a Channel Sounding Initiator or Reflector. | ||
|
||
| See the sample: :file:`samples/bluetooth/channel_sounding_ras_initiator` | ||
| See the sample: :file:`samples/bluetooth/channel_sounding_ras_reflector` | ||
API documentation | ||
***************** | ||
|
||
| Header file: :file:`include/bluetooth/services/ras.h` | ||
| Source files: :file:`subsys/bluetooth/services/ras` | ||
.. doxygengroup:: bt_ras |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters