michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: Clarify bt_conn_create_slave_le documentation

Browse source 
Clarify how the bt_conn_create_slave_le() API can be used to get each
of the two possible advertising packet types.

Fixes #14160

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
This commit is contained in:
Johan Hedberg 2019-03-07 18:00:51 +02:00 • committed by Carles Cufí
commit 1f74e0b1f7
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
include/bluetooth/conn.h
View file

@ -231,8 +231,9 @@ int bt_le_set_auto_conn(const bt_addr_le_t *addr,
* Allows initiating a new LE connection to remote peer with the remote
* acting in central role and the local device in peripheral role.
*
* The advertising type must be either BT_LE_ADV_DIRECT_IND or
* BT_LE_ADV_DIRECT_IND_LOW_DUTY.
* The advertising type will either be BT_LE_ADV_DIRECT_IND, or
* BT_LE_ADV_DIRECT_IND_LOW_DUTY if the BT_LE_ADV_OPT_DIR_MODE_LOW_DUTY
* option was used as part of the advertising parameters.
*
* In case of high duty cycle this will result in a callback with
* connected() with a new connection or with an error.