From 62e57acea8fac1837b25e2d71e918b53b725a814 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Kopy=C5=9Bci=C5=84ski?= Date: Fri, 5 Apr 2024 09:27:27 +0200 Subject: [PATCH] host/ble_gap.h: Extend description of ble_gap_periodic_adv_sync_create Added to the description condition when the Periodic Sync actually happens. --- nimble/host/include/host/ble_gap.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/nimble/host/include/host/ble_gap.h b/nimble/host/include/host/ble_gap.h index 271933963c..86e589c189 100644 --- a/nimble/host/include/host/ble_gap.h +++ b/nimble/host/include/host/ble_gap.h @@ -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.