|
| 1 | +.. _rrsp_readme: |
| 2 | + |
| 3 | +Ranging Responder (RRSP) |
| 4 | +######################## |
| 5 | + |
| 6 | +.. contents:: |
| 7 | + :local: |
| 8 | + :depth: 2 |
| 9 | + |
| 10 | +Overview |
| 11 | +******** |
| 12 | + |
| 13 | +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`_. |
| 14 | + |
| 15 | +This library supports On Demand Ranging Data. |
| 16 | + |
| 17 | +Configuration |
| 18 | +************* |
| 19 | + |
| 20 | +To enable this library, use the :kconfig:option:`CONFIG_BT_RAS` Kconfig option. |
| 21 | + |
| 22 | +Check and adjust the following Kconfig options: |
| 23 | + |
| 24 | +* :kconfig:option:`CONFIG_BT_RAS_MAX_ANTENNA_PATHS` - Sets the maximum number of antenna paths supported by the device. |
| 25 | + This sets the antenna paths for each step that can be stored inside the Ranging Service. |
| 26 | + This value must match the supported Channel Sounding capabilities of the device. |
| 27 | + This affects the per-instance memory usage of the Ranging Service. |
| 28 | + |
| 29 | +* :kconfig:option:`CONFIG_BT_RAS_MODE_3_SUPPORTED` - Sets support for storing Mode 3 Channel Sounding steps. |
| 30 | + This will allocate memory for the Ranging Service to store Mode 3 Channel Sounding steps. |
| 31 | + This value must match the supported Channel Sounding capabilities of the device. |
| 32 | + This affects the per-instance memory usage of the Ranging Service. |
| 33 | + |
| 34 | +* :kconfig:option:`CONFIG_BT_RAS_RRSP` - Enables RRSP Kconfig options. |
| 35 | + |
| 36 | +* :kconfig:option:`CONFIG_BT_RAS_RRSP_AUTO_ALLOC_INSTANCE` - Sets new connections to be allocated a RRSP instance automatically. |
| 37 | + |
| 38 | +* :kconfig:option:`CONFIG_BT_RAS_RRSP_MAX_ACTIVE_CONN` - Sets the number of simultaneously supported RRSP instances. |
| 39 | + |
| 40 | +* :kconfig:option:`CONFIG_BT_RAS_RRSP_RD_BUFFERS_PER_CONN` - Set the number of ranging data buffers per connection. |
| 41 | + |
| 42 | +* :kconfig:option:`CONFIG_BT_RAS_RRSP_LOG_LEVEL` - Sets the logging level of the RRSP library. |
| 43 | + |
| 44 | +Usage |
| 45 | +***** |
| 46 | + |
| 47 | +You can set up the RRSP either as a Channel Sounding Initiator or Reflector. |
| 48 | + |
| 49 | +| See the sample: :file:`samples/bluetooth/channel_sounding_ras_reflector` |
| 50 | +
|
| 51 | +API documentation |
| 52 | +***************** |
| 53 | + |
| 54 | +| Header file: :file:`include/bluetooth/services/ras.h` |
| 55 | +| Source files: :file:`subsys/bluetooth/services/ras` |
| 56 | +
|
| 57 | +.. doxygengroup:: bt_ras |
0 commit comments