From 443b3769f507181cddaf6536fa4bb02e624f9b04 Mon Sep 17 00:00:00 2001 From: Timothy Keys Date: Tue, 3 Dec 2024 14:46:26 +0000 Subject: [PATCH] Subsys: Bluetooth: Add documentation for the RREQ This adds documentation for the Ranging service Ranging Requestor. Signed-off-by: Timothy Keys --- doc/nrf/libraries/bluetooth/services/rreq.rst | 57 +++++++++++++++++++ doc/nrf/links.txt | 2 + 2 files changed, 59 insertions(+) create mode 100644 doc/nrf/libraries/bluetooth/services/rreq.rst diff --git a/doc/nrf/libraries/bluetooth/services/rreq.rst b/doc/nrf/libraries/bluetooth/services/rreq.rst new file mode 100644 index 000000000000..bd10b91ba63a --- /dev/null +++ b/doc/nrf/libraries/bluetooth/services/rreq.rst @@ -0,0 +1,57 @@ +.. _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`_. + +Supported features +================== + +- On Demand Ranging Data + +Configuration +************* + +Enable RREQ and RRSP kconfig options using the :kconfig:option:`CONFIG_BT_RAS` kconfig option. + +Set the maximum number of antenna paths supported by the device using the :kconfig:option:`CONFIG_BT_RAS_MAX_ANTENNA_PATHS` kconfig option. +This sets the antenna paths per 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. + +Set support for storing Mode 3 Channel Sounding steps using the :kconfig:option:`CONFIG_BT_RAS_MODE_3_SUPPORTED` kconfig option. +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. + +Enable RREQ kconfig options using the :kconfig:option:`CONFIG_BT_RAS_RREQ` kconfig option. + +Set the number of simultaneously supported RREQ instances using the :kconfig:option:`CONFIG_BT_RAS_RREQ_MAX_ACTIVE_CONN` kconfig option. + +Set the heap size for the GATT distance measurement module using the :kconfig:option:`CONFIG_HEAP_MEM_POOL_ADD_SIZE_RAS_RREQ_GATT_DM` kconfig option. + +Set the logging level of the RREQ library using the :kconfig:option:`CONFIG_BT_RAS_RREQ_LOG_LEVEL` Kconfig option. + +Usage +***** + +The RREQ can be setup as either 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/links.txt b/doc/nrf/links.txt index 4074bdd941f3..1b4f01a2ef96 100644 --- a/doc/nrf/links.txt +++ b/doc/nrf/links.txt @@ -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/