Skip to content

Commit 4f7540e

Browse files
MarekPietajukkar
authored andcommitted
applications: nrf_desktop: Update ble_conn_params module documentation
Change updates Bluetooth LE connection parameters module documentation to align it with the current implementation. Jira: NCSDK-30471 Signed-off-by: Marek Pieta <[email protected]> Signed-off-by: Divya Pillai <[email protected]>
1 parent c4a02e0 commit 4f7540e

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

applications/nrf_desktop/doc/ble_conn_params.rst

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,22 @@ The |ble_conn_params| is enabled by the :ref:`CONFIG_DESKTOP_BLE_CONN_PARAMS_ENA
3232
The option is implied by :ref:`CONFIG_DESKTOP_BT_CENTRAL <config_desktop_app_options>` together with other features used by a HID dongle that forwards the HID reports received over Bluetooth LE.
3333

3434
Enable :ref:`CONFIG_DESKTOP_BLE_USB_MANAGED_CI <config_desktop_app_options>` to manage Bluetooth connections' parameters reacting on the USB state change.
35-
The connection intervals for all of the Bluetooth connected peripherals are set to :ref:`CONFIG_DESKTOP_BLE_USB_MANAGED_CI_VALUE <config_desktop_app_options>` (100 ms by default) while USB is suspended.
36-
The connections' peripheral latencies are set to 0.
37-
The connection parameter change is reverted when USB is active.
35+
The connection intervals for all of the Bluetooth connected peripherals are set to the value of :ref:`CONFIG_DESKTOP_BLE_USB_MANAGED_CI_VALUE <config_desktop_app_options>` Kconfig option (100 ms by default) while USB is suspended.
36+
The connections' peripheral latencies are set to the value of :ref:`CONFIG_DESKTOP_BLE_USB_MANAGED_LATENCY_VALUE <config_desktop_app_options>` Kconfig option (``1`` by default).
37+
The non-zero peripheral latency is used to prevent peripheral latency increase requests triggered by the :ref:`nrf_desktop_ble_latency` used on the peripheral's end.
38+
The connection parameter change is reverted when USB is active or disconnected.
3839
The :ref:`CONFIG_DESKTOP_BLE_USB_MANAGED_CI <config_desktop_app_options>` is enabled by default.
3940

4041
Implementation details
4142
**********************
4243

43-
The |ble_conn_params| receives the peripheral's connection parameters update request as :c:struct:`ble_peer_conn_params_event`.
44+
After setting Bluetooth LE connection parameters using Bluetooth stack APIs, the module waits until the update is completed (for :c:struct:`ble_peer_conn_params_event` with :c:member:`ble_peer_conn_params_event.updated` set to ``true``) before performing subsequent connection parameter updates for a given connection.
45+
Subsequent connection parameter update for a given connection can be done right after the previous one is completed.
46+
47+
Handling peripheral's requests
48+
==============================
49+
50+
The |ble_conn_params| receives the peripheral's connection parameters update request as :c:struct:`ble_peer_conn_params_event` with :c:member:`ble_peer_conn_params_event.updated` set to ``false``.
4451
The module updates only the connection latency.
4552
The connection interval and supervision timeout are not changed according to the peripheral's request.
4653

0 commit comments

Comments
 (0)