michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: host: Document behaviour of the whitelist initiator.

Browse source 
Add documentation for the whitelist initiator behaviour, describing the
one-shot behaviour.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
This commit is contained in:
Joakim Andersson 2020-01-08 12:12:10 +01:00 • committed by Johan Hedberg
commit 0d0957841e
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
include/bluetooth/conn.h
View file

@ -295,6 +295,11 @@ struct bt_conn *bt_conn_create_le(const bt_addr_le_t *peer,
/** @brief Automatically connect to remote devices in whitelist.
*
* This uses the Auto Connection Establishment procedure.
* The procedure will continue until a single connection is established or the
* procedure is stopped through @ref bt_conn_create_auto_stop.
* To establish connections to all devices in the whitelist the procedure
* should be started again in the connected callback after a new connection has
* been established.
*
* @param param Initial connection parameters.
*