From 38f85b304b2a4e2cd67bdadc8a788e929ed528d8 Mon Sep 17 00:00:00 2001 From: Timothy Keys Date: Tue, 3 Dec 2024 16:00:17 +0000 Subject: [PATCH] doc: nrf: bluetooth: Add documentation for the RRSP This adds documentation for the Ranging Service Ranging Responder. Signed-off-by: Timothy Keys --- doc/nrf/libraries/bluetooth/services/rrsp.rst | 56 +++++++++++++++++++ .../releases/release-notes-changelog.rst | 6 ++ 2 files changed, 62 insertions(+) create mode 100644 doc/nrf/libraries/bluetooth/services/rrsp.rst diff --git a/doc/nrf/libraries/bluetooth/services/rrsp.rst b/doc/nrf/libraries/bluetooth/services/rrsp.rst new file mode 100644 index 000000000000..dfce54bd5edb --- /dev/null +++ b/doc/nrf/libraries/bluetooth/services/rrsp.rst @@ -0,0 +1,56 @@ +.. _rrsp_readme: + +Ranging Responder (RRSP) +######################## + +.. contents:: + :local: + :depth: 2 + +Overview +******** + +This library implements the Ranging Responder 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_RRSP` - Enables RRSP Kconfig options. + +* :kconfig:option:`CONFIG_BT_RAS_RRSP_AUTO_ALLOC_INSTANCE` - Sets new connections to be allocated a RRSP instance automatically. + +* :kconfig:option:`CONFIG_BT_RAS_RRSP_MAX_ACTIVE_CONN` - Sets the number of simultaneously supported RRSP instances. + +* :kconfig:option:`CONFIG_BT_RAS_RRSP_RD_BUFFERS_PER_CONN` - Set the number of ranging data buffers per connection. + +* :kconfig:option:`CONFIG_BT_RAS_RRSP_LOG_LEVEL` - Sets the logging level of the RRSP library. + +Usage +***** + +You can set up the RRSP 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 diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst index 4c6ee5338f54..885558340e4c 100644 --- a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst +++ b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst @@ -567,6 +567,12 @@ Bluetooth libraries and services * Added the Ranging Service Ranging Requestor library for Channel Sounding. +* :ref:`rrsp_readme` library: + + * Added + + * Added the Ranging Service Ranging Responder library for Channel Sounding. + * :ref:`hogp_readme` library: * Updated the :c:func:`bt_hogp_rep_read` function to forward the GATT read error code through the registered user callback.