Advertiser PAST#

Advertiser PAST.

Transfer the synchronization information of a local active periodic advertising set to a remote device using Periodic Advertising Synchronization Transfer (PAST) over a connection.

Functions#

sl_status_t
sl_bt_advertiser_past_transfer(uint8_t connection, uint16_t service_data, uint8_t advertising_set)
sl_status_t
sl_bt_advertiser_past_transfer_over_pawr_advertiser(uint8_t transferring_advertising_set, uint16_t service_data, uint8_t advertising_set, uint8_t repeat_count, size_t subevents_len, const uint8_t *subevents)

Macros#

#define
sl_bt_cmd_advertiser_past_transfer_id 0x00520020
#define
sl_bt_cmd_advertiser_past_transfer_over_pawr_advertiser_id 0x01520020
#define
sl_bt_rsp_advertiser_past_transfer_id 0x00520020
#define
sl_bt_rsp_advertiser_past_transfer_over_pawr_advertiser_id 0x01520020

Function Documentation#

sl_bt_advertiser_past_transfer#

sl_status_t sl_bt_advertiser_past_transfer (uint8_t connection, uint16_t service_data, uint8_t advertising_set)
Parameters
TypeDirectionArgument NameDescription
uint8_t[in]connection

Connection handle of the connection used to transmit the sync transfer

uint16_t[in]service_data

A value provided by the application for use by the peer device.

uint8_t[in]advertising_set

Handle of the periodic advertising set to transfer

Transfer the synchronization information of an advertising set that is actively performing periodic advertising. The transfer happens over a connection.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


sl_bt_advertiser_past_transfer_over_pawr_advertiser#

sl_status_t sl_bt_advertiser_past_transfer_over_pawr_advertiser (uint8_t transferring_advertising_set, uint16_t service_data, uint8_t advertising_set, uint8_t repeat_count, size_t subevents_len, const uint8_t * subevents)
Parameters
TypeDirectionArgument NameDescription
uint8_t[in]transferring_advertising_set

The handle of the PAwR advertising set used to transfer the synchronization information to the synchronized devices.

uint16_t[in]service_data

A value provided by the application for use by the peer device.

uint8_t[in]advertising_set

Handle of the periodic advertising set to transfer

uint8_t[in]repeat_count

The number of times the synchronization information is sent on the specified subevents of transferring_advertising_set.

  • Range: 0x01 to 0xFF

size_t[in]subevents_len

Length of data in subevents

const uint8_t *[in]subevents

Array of subevent indexes in which to send the synchronization information. If a zero-length array is provided, the synchronization information is sent in all subevents of transferring_advertising_set.

Transfer the synchronization information of an advertising set that is actively performing periodic advertising. The transfer happens over a Periodic Advertising with Responses (PAwR) train.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.