michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: host: Document settings_load is required to finalize init

Browse source 
Document that calling settings_load is required when the application is
not creating and managing the identities of the stack itself.
The application will not be able to use all features of the stack before
the identities have been loaded.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
This commit is contained in:
Joakim Andersson 2021-06-16 09:53:04 +02:00 • committed by Kumar Gala
commit c15b1693f6
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
include/bluetooth/bluetooth.h
View file

@ -130,6 +130,11 @@ typedef void (*bt_ready_cb_t)(int err);
* Enable Bluetooth. Must be the called before any calls that
* require communication with the local Bluetooth hardware.
*
* When @option{CONFIG_BT_SETTINGS} has been enabled and the application is not
* managing identities of the stack itself then the application must call
* @ref settings_load() before the stack is fully enabled.
* See @ref bt_id_create() for more information.
*
* @param cb Callback to notify completion or NULL to perform the
* enabling synchronously.
*