Periodic Advertising with responses Synchronization#

Periodic Advertising with responses Synchronization.

Provides events and control for synchronized Periodic Advertising with Responses (PAwR) trains. Synchronization is achieved by scanning (see Periodic Advertising Sync Scanner) or by receiving Periodic Advertising Synchronization Transfer (see PAST Receiver).

Modules#

sl_bt_evt_pawr_sync_opened

sl_bt_evt_pawr_sync_transfer_received

sl_bt_evt_pawr_sync_subevent_report

Functions#

sl_status_t
sl_bt_pawr_sync_set_sync_subevents(uint16_t sync, size_t subevents_len, const uint8_t *subevents)
sl_status_t
sl_bt_pawr_sync_set_response_data(uint16_t sync, uint16_t request_event, uint8_t request_subevent, uint8_t response_subevent, uint8_t response_slot, size_t response_data_len, const uint8_t *response_data)

Macros#

Function Documentation#

sl_bt_pawr_sync_set_sync_subevents#

sl_status_t sl_bt_pawr_sync_set_sync_subevents (uint16_t sync, size_t subevents_len, const uint8_t * subevents)
Parameters
[in]sync

PAwR synchronization handle

[in]subevents_len

Length of data in subevents

[in]subevents

Array of subevent indexes to synchronize to

Specify the subevents that this device will synchronize to on the specified PAwR train.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 5293 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/ble_host/ble_bgapi/inc/sl_bt_api.h

sl_bt_pawr_sync_set_response_data#

sl_status_t sl_bt_pawr_sync_set_response_data (uint16_t sync, uint16_t request_event, uint8_t request_subevent, uint8_t response_subevent, uint8_t response_slot, size_t response_data_len, const uint8_t * response_data)
Parameters
[in]sync

PAwR synchronization handle

[in]request_event

The periodic advertising event counter (paEventCounter) of the request. Set this parameter to the value of the event_counter field of the sl_bt_evt_pawr_sync_subevent_report_id event that the application is responding to.

[in]request_subevent

The subevent of the request. Set this parameter to the value of the subevent field of the sl_bt_evt_pawr_sync_subevent_report_id event that the application is responding to.

[in]response_subevent

The subevent in which the response is to be sent

[in]response_slot

The response slot in which the response is to be sent

[in]response_data_len

Length of data in response_data

[in]response_data

Data to be sent in the specified response slot. Maximum of 248 bytes of data can be set with this command.

Set the data to be sent in the specified response slot of a subevent of an active PAwR train.

Use this command when the application receives the sl_bt_evt_pawr_sync_subevent_report event and the application needs to send a response. The application needs to set the response data within the timing requirements implied by the parameters of the PAwR train that the device is synchronized to. If the response data is set too late, this command will fail with result SL_STATUS_BT_CTRL_ADVERTISING_TIMEOUT.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 5328 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/ble_host/ble_bgapi/inc/sl_bt_api.h

Macro Definition Documentation#

sl_bt_cmd_pawr_sync_set_sync_subevents_id#

#define sl_bt_cmd_pawr_sync_set_sync_subevents_id
Value:
0x02540020

Definition at line 5006 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/ble_host/ble_bgapi/inc/sl_bt_api.h

sl_bt_cmd_pawr_sync_set_response_data_id#

#define sl_bt_cmd_pawr_sync_set_response_data_id
Value:
0x03540020

Definition at line 5007 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/ble_host/ble_bgapi/inc/sl_bt_api.h

sl_bt_rsp_pawr_sync_set_sync_subevents_id#

#define sl_bt_rsp_pawr_sync_set_sync_subevents_id
Value:
0x02540020

Definition at line 5008 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/ble_host/ble_bgapi/inc/sl_bt_api.h

sl_bt_rsp_pawr_sync_set_response_data_id#

#define sl_bt_rsp_pawr_sync_set_response_data_id
Value:
0x03540020

Definition at line 5009 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/ble_host/ble_bgapi/inc/sl_bt_api.h