Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: nrf: bluetooth: RAS RREQ and RRSP docs #19230

Merged
merged 2 commits into from
Dec 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions doc/nrf/libraries/bluetooth/services/rreq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.. _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
*************

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To enable this library, use the :kconfig:option:`CONFIG_BT_RAS` Kconfig option.
To enable this library, use the :kconfig:option:`CONFIG_BT_RAS` and :kconfig:option:`CONFIG_BT_RAS_RREQ` Kconfig options.

Maybe this makes more sense


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.

* :kconfig:option:`CONFIG_BT_RAS_MODE_3_SUPPORTED` - Sets support for storing Mode 3 Channel Sounding steps.

* :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 discovery manager 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`

API documentation
*****************

| Header file: :file:`include/bluetooth/services/ras.h`
| Source files: :file:`subsys/bluetooth/services/ras`

.. doxygengroup:: bt_ras
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
weeTike marked this conversation as resolved.
Show resolved Hide resolved
*************

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
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
Loading