Skip to content

Commit 5f09960

Browse files
weeTikecarlescufi
authored andcommitted
doc: nrf: bluetooth: Add documentation for the RREQ
This adds documentation for the Ranging service Ranging Requestor. Signed-off-by: Timothy Keys <[email protected]>
1 parent 6871faf commit 5f09960

File tree

3 files changed

+57
-0
lines changed

3 files changed

+57
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
.. _rreq_readme:
2+
3+
Ranging Requestor (RREQ)
4+
########################
5+
6+
.. contents::
7+
:local:
8+
:depth: 2
9+
10+
Overview
11+
********
12+
13+
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`_.
14+
15+
This library supports On Demand Ranging Data.
16+
17+
Configuration
18+
*************
19+
20+
To enable this library, use the :kconfig:option:`CONFIG_BT_RAS` Kconfig option.
21+
22+
Check and adjust the following Kconfig options:
23+
24+
* :kconfig:option:`CONFIG_BT_RAS_MAX_ANTENNA_PATHS` - Sets the maximum number of antenna paths supported by the device.
25+
26+
* :kconfig:option:`CONFIG_BT_RAS_MODE_3_SUPPORTED` - Sets support for storing Mode 3 Channel Sounding steps.
27+
28+
* :kconfig:option:`CONFIG_BT_RAS_RREQ` - Enables RREQ Kconfig options.
29+
30+
* :kconfig:option:`CONFIG_BT_RAS_RREQ_MAX_ACTIVE_CONN` - Sets the number of simultaneously supported RREQ instances.
31+
32+
* :kconfig:option:`CONFIG_HEAP_MEM_POOL_ADD_SIZE_RAS_RREQ_GATT_DM` - Sets the heap size for the GATT discovery manager module.
33+
34+
* :kconfig:option:`CONFIG_BT_RAS_RREQ_LOG_LEVEL` - Sets the logging level of the RREQ library.
35+
36+
Usage
37+
*****
38+
39+
You can set up the RREQ either as a Channel Sounding Initiator or Reflector.
40+
41+
| See the sample: :file:`samples/bluetooth/channel_sounding_ras_initiator`
42+
43+
API documentation
44+
*****************
45+
46+
| Header file: :file:`include/bluetooth/services/ras.h`
47+
| Source files: :file:`subsys/bluetooth/services/ras`
48+
49+
.. doxygengroup:: bt_ras

doc/nrf/links.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -984,6 +984,8 @@
984984
.. _`Current Time Service Specification`: https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=292957
985985
.. _`Running Speed and Cadence Service Specification`: https://www.bluetooth.com/specifications/specs/running-speed-and-cadence-service-1-0/
986986
.. _`Continuous Glucose Monitoring Service Specification`: https://www.bluetooth.org/DocMan/handlers/DownloadDoc.ashx?doc_id=531249
987+
.. _`Ranging Profile Specification`: https://files.bluetooth.com/download/rap_v1-0/
988+
.. _`Ranging Service Specification`: https://files.bluetooth.com/download/ras_v1-0/
987989

988990
.. _`Bluetooth SIG company identifiers`: https://www.bluetooth.com/specifications/assigned-numbers/company-identifiers/
989991

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -571,6 +571,12 @@ Binary libraries
571571
Bluetooth libraries and services
572572
--------------------------------
573573

574+
* :ref:`rreq_readme` library:
575+
576+
* Added
577+
578+
* Added the Ranging Service Ranging Requestor library for Channel Sounding.
579+
574580
* :ref:`hogp_readme` library:
575581

576582
* Updated the :c:func:`bt_hogp_rep_read` function to forward the GATT read error code through the registered user callback.

0 commit comments

Comments
 (0)