Skip to content

Commit ce9f42b

Browse files
MarekPietaanangl
authored andcommitted
caf: ble_state: Optional security request doc update
Change introduces documentation update related to introducing optional security request. Jira: NCSDK-14084 Signed-off-by: Marek Pieta <[email protected]>
1 parent cd50f3c commit ce9f42b

File tree

4 files changed

+13
-6
lines changed

4 files changed

+13
-6
lines changed

applications/nrf_desktop/doc/ble_discovery.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The |ble_discovery| implementation is tasked with peripheral discovery and verif
5959
Peripheral discovery
6060
====================
6161

62-
The module starts the peripheral device discovery when it receives :c:struct:`ble_peer_event` with :c:member:`ble_peer_event.state` set to :c:enumerator:`PEER_STATE_SECURED`.
62+
The module starts the peripheral device discovery when it receives :c:struct:`ble_peer_event` with :c:member:`ble_peer_event.state` set to :c:enumerator:`PEER_STATE_CONNECTED`.
6363

6464
The peripheral discovery consists of the following steps:
6565

applications/nrf_desktop/doc/ble_scan.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,6 @@ After the scan filter match, the following happens:
129129

130130
a. The scanning is stopped and the |NCS|'s :ref:`nrf_bt_scan_readme` automatically establishes the Bluetooth connection with the peripheral.
131131
The initial Bluetooth connection interval is set by default to 7.5 ms, that is to the shortest connection interval allowed by the Bluetooth specification.
132-
#. The connection is secured.
133132
#. The peer discovery is started.
134133
#. After the :ref:`nrf_desktop_ble_discovery` completes the peer discovery, the :ref:`nrf_desktop_ble_conn_params` receives the ``ble_discovery_complete_event`` and updates the Bluetooth connection interval.
135134

doc/nrf/libraries/caf/ble_state.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ To use the module, you must enable the following Kconfig options:
2727

2828
* :kconfig:option:`CONFIG_BT`
2929
* :kconfig:option:`CONFIG_BT_SMP` - This option enables Security Manager Protocol support.
30-
The |ble_state| on Bluetooth Peripheral requires at least the connection security level 2 (encryption).
3130
* :kconfig:option:`CONFIG_CAF_BLE_STATE` - This option enables the |ble_state| and selects the :kconfig:option:`CONFIG_CAF_BLE_COMMON_EVENTS` Kconfig option, which enables Bluetooth LE common events in CAF.
3231

3332
The following Kconfig options are also available for this module:
@@ -36,6 +35,9 @@ The following Kconfig options are also available for this module:
3635
This option is enabled by default.
3736
* :kconfig:option:`CONFIG_CAF_BLE_USE_LLPM` - This option enables the Low Latency Packet Mode (LLPM).
3837
This option is enabled by default and depends on :kconfig:option:`CONFIG_BT_CTLR_SDC_LLPM` and :kconfig:option:`CONFIG_BT_LL_SOFTDEVICE`.
38+
* :kconfig:option:`CONFIG_CAF_BLE_STATE_SECURITY_REQ` - This option enables setting the security level 2 for a Bluetooth LE connection automatically, right after the connection is established.
39+
The security level 2 or higher enables connection encryption.
40+
The device disconnects if establishing the connection security level 2 fails.
3941

4042
Implementation details
4143
**********************
@@ -66,9 +68,6 @@ The connection state can be set to one of the following values:
6668
Other application modules can call :c:func:`bt_conn_disconnect` to disconnect the remote peer.
6769
The application module can submit a :c:struct:`ble_peer_event` with :c:member:`ble_peer_event.state` set to :c:enum:`PEER_STATE_DISCONNECTING` to let other application modules prepare for the disconnection.
6870

69-
On Bluetooth Peripheral, the |ble_state| requires the connection security level 2.
70-
If the connection security level 2 is not established, the Peripheral disconnects.
71-
7271
Connection parameter change
7372
===========================
7473

doc/nrf/releases/release-notes-changelog.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,11 @@ nRF Machine Learning (Edge Impulse)
101101
nRF Desktop
102102
-----------
103103

104+
* nRF Desktop peripherals no longer automatically send security request right after Bluetooth LE connection is established.
105+
The feature can be turned on using :kconfig:option:`CONFIG_CAF_BLE_STATE_SECURITY_REQ`.
106+
* nRF Desktop dongles start peripheral discovery right after Bluetooth LE connection is established.
107+
The dongles no longer wait until the connection is secured.
108+
104109
|no_changes_yet_note|
105110

106111
Thingy:53 Zigbee weather station
@@ -220,6 +225,10 @@ Other libraries
220225
Common Application Framework (CAF)
221226
----------------------------------
222227

228+
* :ref:`caf_ble_state` running on Bluetooth Peripheral no longer automatically sends security request right after Bluetooth LE connection is established.
229+
The :kconfig:option:`CONFIG_CAF_BLE_STATE_SECURITY_REQ` can be used to enable this feature.
230+
The option can be used for both Bluetooth Peripheral and Bluetooth Central.
231+
223232
|no_changes_yet_note|
224233

225234
Shell libraries

0 commit comments

Comments
 (0)