Skip to content

Commit

Permalink
host/ble_gap.h: Extend description of ble_gap_periodic_adv_sync_create
Browse files Browse the repository at this point in the history
Added to the description condition when the Periodic Sync actually
happens.
  • Loading branch information
KKopyscinski authored and sjanc committed Apr 8, 2024
1 parent e56389a commit 795264b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion nimble/host/include/host/ble_gap.h
Original file line number Diff line number Diff line change
Expand Up @@ -1826,7 +1826,10 @@ int ble_gap_periodic_adv_set_data(uint8_t instance,
const struct ble_gap_periodic_adv_set_data_params *params);

/**
* Performs the Synchronization procedure with periodic advertiser.
* Schedule the Synchronization procedure with periodic advertiser.
* Procedure is performed as soon as Extended Discovery procedure is started.
* If Extended Discovery is already active when issuing this procedure,
* it will be performed immediately. It is up to application to start Extended Discovery.
*
* @param addr Peer address to synchronize with. If NULL than
* peers from periodic list are used.
Expand Down

0 comments on commit 795264b

Please sign in to comment.