Skip to content

Commit

Permalink
doc: nrf: bluetooth: Add documentation for the RREQ
Browse files Browse the repository at this point in the history
This adds documentation for the Ranging service Ranging Requestor.

Signed-off-by: Timothy Keys <[email protected]>
  • Loading branch information
weeTike committed Dec 4, 2024
1 parent 09228a5 commit 0b969f3
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 0 deletions.
54 changes: 54 additions & 0 deletions doc/nrf/libraries/bluetooth/services/rreq.rst
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
2 changes: 2 additions & 0 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -984,6 +984,8 @@
.. _`Current Time Service Specification`: https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=292957
.. _`Running Speed and Cadence Service Specification`: https://www.bluetooth.com/specifications/specs/running-speed-and-cadence-service-1-0/
.. _`Continuous Glucose Monitoring Service Specification`: https://www.bluetooth.org/DocMan/handlers/DownloadDoc.ashx?doc_id=531249
.. _`Ranging Profile Specification`: https://files.bluetooth.com/download/rap_v1-0/
.. _`Ranging Service Specification`: https://files.bluetooth.com/download/ras_v1-0/

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -561,6 +561,12 @@ 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 0b969f3

Please sign in to comment.