Synchronization
Synchronization.
Modules | |
sl_bt_evt_sync_opened | |
Indicates that a periodic advertising synchronization has been opened. | |
sl_bt_evt_sync_data | |
Reports a received periodic advertisement packet. | |
sl_bt_evt_sync_closed | |
Indicates that periodic advertising synchronization was lost or a synchronization establishment procedure was canceled. | |
Enumerations | |
enum | sync_advertiser_clock_accuracy_t { sync_clock_accuracy_500 = 0x500, sync_clock_accuracy_250 = 0x250, sync_clock_accuracy_150 = 0x150, sync_clock_accuracy_100 = 0x100, sync_clock_accuracy_75 = 0x75, sync_clock_accuracy_50 = 0x50, sync_clock_accuracy_30 = 0x30, sync_clock_accuracy_20 = 0x20 } |
Advertiser Clock Accuracy. | |
Functions | |
sl_status_t | sl_bt_sync_set_parameters (uint16_t skip, uint16_t timeout, uint32_t flags) |
sl_status_t | sl_bt_sync_open (bd_addr address, uint8_t address_type, uint8_t adv_sid, uint16_t *sync) |
sl_status_t | sl_bt_sync_close (uint16_t sync) |
Detailed Description
Synchronization.
Provides periodic advertising synchronization feature.
Enumeration Type Documentation
◆ sync_advertiser_clock_accuracy_t
Advertiser Clock Accuracy.
Function Documentation
◆ sl_bt_sync_set_parameters()
sl_status_t sl_bt_sync_set_parameters | ( | uint16_t | skip, |
uint16_t | timeout, |
||
uint32_t | flags |
||
) |
Configure periodic advertiser synchronization parameters. The specified parameters take effect immediately for all advertisers that have not already established synchronization.
The application should determine skip and timeout values based on the periodic advertising interval provided by the advertiser. If skip
and timeout
are used, select appropriate values so that they allow a few receiving attempts. Periodic advertising intervals are reported in event sl_bt_evt_scanner_scan_report.
- Parameters
-
[in] skip
The maximum number of periodic advertising packets that can be skipped after a successful receive. - Range: 0x0000 to 0x01F3
- Default value: 0
[in] timeout
The maximum permitted time between successful receives. If this time is exceeded, synchronization is lost. Unit: 10 ms. - Range: 0x06 to 0xFFFF
- Unit: 10 ms
- Time range: 100 ms ms to 163.84 s
- Default value: 1000 ms
[in] flags
No flags defined currently
- Returns
- SL_STATUS_OK if successful. Error code otherwise.
◆ sl_bt_sync_open()
sl_status_t sl_bt_sync_open | ( | bd_addr | address, |
uint8_t | address_type, |
||
uint8_t | adv_sid, |
||
uint16_t * | sync |
||
) |
Start establishing synchronization with the specified periodic advertiser in parallel with other advertisers given in previous invocations of this command. The stack will internally enable scanning when needed so that synchronizations can occur. The scanning responses from the internal scanning are not passed to the application unless the application has also enabled scanning.
Advertisers that have not already synced before the invocation of this command will be synced using the skip
and timeout
values configured in the most recent invocation of command sl_bt_evt_scanner_scan_report.
- Parameters
-
[in] address
Address of the advertiser [in] address_type
Advertiser address type. Values: - 0: Public address
- 1: Random address
[in] adv_sid
Advertising set identifier [out] sync
A handle that will be assigned to the periodic advertising synchronization after the synchronization is established. This handle is valid only if the result code of this response is SL_STATUS_OK.
- Returns
- SL_STATUS_OK if successful. Error code otherwise.
Events
- sl_bt_evt_sync_opened - Triggered after the synchronization is established.
- sl_bt_evt_sync_data - Indicates that a periodic advertisement packet is received.
- sl_bt_evt_sync_closed - Triggered after periodic advertising synchronization was lost or explicitly closed, or a synchronization establishment procedure was canceled.
◆ sl_bt_sync_close()
sl_status_t sl_bt_sync_close | ( | uint16_t | sync | ) |
Closes a periodic advertising synchronization or cancels an ongoing attempt of establishing a synchronization.
- Parameters
-
[in] sync
Periodic advertising synchronization handle
- Returns
- SL_STATUS_OK if successful. Error code otherwise.
Events
- sl_bt_evt_sync_closed - Triggered after a periodic advertising synchronization has been closed or canceled.