Periodic Advertising Sync Scanner#

sl_bt_sync_scanner_set_sync_parameters#

sl_status_t sl_bt_sync_scanner_set_sync_parameters (uint16_t skip, uint16_t timeout, uint8_t reporting_mode)

Configure synchronization parameters for synchronizing to periodic advertising trains. The specified parameters take effect immediately for all periodic advertising trains that have not already established synchronization.

The application should determine skip and timeout values based on the periodic advertising interval provided by the advertiser. Ensure that you use a long enough timeout to allow multiple receives. If skip and timeout are used, select appropriate values so that they allow a few receiving attempts. Irrespective of the value of the skip parameter, the Controller stops skipping packets if the skipping would cause a timeout. Periodic advertising intervals are reported in sl_bt_evt_scanner_extended_advertisement_report event.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_sync_scanner_open#

sl_status_t sl_bt_sync_scanner_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.

If the application has not already started scanning with the sl_bt_scanner_start command, the stack will internally enable scanning so that synchronizations can occur. The internal scanning uses the PHY that was most recently used with sl_bt_scanner_start and the parameters that have been configured with sl_bt_scanner_set_parameters. The internal scanning is automatically stopped when all requested synchronizations have occurred.

The scanning responses from the internal scanning are not passed to the application unless the application starts scanning with the sl_bt_scanner_start command. If the application starts scanning while synchronizations are being established, the scanning PHY and settings set by the application take effect immediately and scanning for synchronizations continues with the new settings. When the application has started scanning with the sl_bt_scanner_start command, scanning continues until the application stops scanning with the sl_bt_scanner_stop command.

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_extended_advertisement_report.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_bt_evt_periodic_sync_opened - Triggered after synchronization is established to a periodic advertising train that does not have subevents or response slots.

• sl_bt_evt_pawr_sync_opened - Triggered after synchronization is established to a Periodic Advertising with Responses (PAwR) train.

• sl_bt_evt_periodic_sync_report - Triggered when data for periodic advertising train that does not have subevents or response slots is received and accepted by the reporting mode currently set to the train.

• sl_bt_evt_pawr_sync_subevent_report - Triggered when subevent data for Periodic Advertising with Responses (PAwR) train is received and accepted by the reporting mode currently set to the train.

• sl_bt_evt_sync_closed - Triggered after periodic advertising synchronization was lost or explicitly closed, or a synchronization establishment procedure was canceled.

sl_bt_cmd_sync_scanner_set_sync_parameters_id#

#define sl_bt_cmd_sync_scanner_set_sync_parameters_id

0x00500020

sl_bt_cmd_sync_scanner_open_id#

#define sl_bt_cmd_sync_scanner_open_id

0x01500020

sl_bt_rsp_sync_scanner_set_sync_parameters_id#

#define sl_bt_rsp_sync_scanner_set_sync_parameters_id

0x00500020

sl_bt_rsp_sync_scanner_open_id#

#define sl_bt_rsp_sync_scanner_open_id

0x01500020