patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

Bluetooth: host: Document peripheral bt_conn_le_conn_update behavior

Browse source 
Document the behavior of the bt_conn_le_conn_update API when the
local device is the peripheral role.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
This commit is contained in:
Joakim Andersson 2020-10-13 12:49:59 +02:00 committed by Johan Hedberg
parent 3d3119b1e7
commit f2a23ee166
2 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
include/bluetooth/conn.h
View file

@ -395,6 +395,10 @@ int bt_conn_get_remote_info(struct bt_conn *conn,
struct bt_conn_remote_info *remote_info);
/** @brief Update the connection parameters.
*
* If the local device is in the peripheral role then updating the connection
* parameters will be delayed. This delay can be configured by through the
* @option{CONFIG_BT_CONN_PARAM_UPDATE_TIMEOUT} option.
*
* @param conn Connection object.
* @param param Updated connection parameters.

12
subsys/bluetooth/host/Kconfig
View file

@ -527,9 +527,15 @@ config BT_CONN_PARAM_UPDATE_TIMEOUT
help
The value is a timeout used by peripheral device to wait until it
starts the connection parameters update procedure to change default
connection parameters. The default value is set to 5s, to comply
with BT protocol specification: Core 4.2 Vol 3, Part C, 9.3.12.2
starts the first connection parameters update procedure after a
connection has been established.
The connection parameters requested will be the parameters set by the
application, or the peripheral preferred connection parameters if
configured.
The default value is set to 5 seconds, to comply with the Bluetooth
Core specification: Core 4.2 Vol 3, Part C, 9.3.12.2:
"The Peripheral device should not perform a Connection Parameter
Update procedure within 5 seconds after establishing a connection."
endif # BT_CONN