Skip to content

Commit

Permalink
doc: nrf: bluetooth: Add documentation for the RRSP
Browse files Browse the repository at this point in the history
This adds documentation for the Ranging Service Ranging Responder.

Signed-off-by: Timothy Keys <[email protected]>
  • Loading branch information
weeTike authored and carlescufi committed Dec 4, 2024
1 parent 5f09960 commit 2d93fda
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 6 deletions.
57 changes: 57 additions & 0 deletions doc/nrf/libraries/bluetooth/services/rrsp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
.. _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
*************

To enable this library, use the :kconfig:option:`CONFIG_BT_RAS` Kconfig option.

Check and adjust the following 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_reflector`
API documentation
*****************

| Header file: :file:`include/bluetooth/services/ras.h`
| Source files: :file:`subsys/bluetooth/services/ras`
.. doxygengroup:: bt_ras
Original file line number Diff line number Diff line change
Expand Up @@ -571,12 +571,6 @@ Binary libraries
Bluetooth libraries and services
--------------------------------

* :ref:`rreq_readme` library:

* Added

* Added the Ranging Service Ranging Requestor 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.
Expand Down

0 comments on commit 2d93fda

Please sign in to comment.