PAST Receiver#

PAST Receiver.

Synchronize to periodic advertising trains by receiving Periodic Advertising Synchronization Transfer over a connection.

Enumerations#

enum
sl_bt_past_receiver_mode_t {
sl_bt_past_receiver_mode_ignore = 0x0
sl_bt_past_receiver_mode_synchronize = 0x1
}

Specifies the mode for receiving synchronization transfers.

Functions#

sl_status_t
sl_bt_past_receiver_set_default_sync_receive_parameters(uint8_t mode, uint16_t skip, uint16_t timeout, uint8_t reporting_mode)
sl_status_t
sl_bt_past_receiver_set_sync_receive_parameters(uint8_t connection, uint8_t mode, uint16_t skip, uint16_t timeout, uint8_t reporting_mode)

Macros#

Enumeration Documentation#

sl_bt_past_receiver_mode_t#

sl_bt_past_receiver_mode_t

Specifies the mode for receiving synchronization transfers.

Enumerator
sl_bt_past_receiver_mode_ignore
sl_bt_past_receiver_mode_synchronize

Definition at line 5106 of file /mnt/raid/workspaces/ws.vHmYkJajL/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

Function Documentation#

sl_bt_past_receiver_set_default_sync_receive_parameters#

sl_status_t sl_bt_past_receiver_set_default_sync_receive_parameters (uint8_t mode, uint16_t skip, uint16_t timeout, uint8_t reporting_mode)
Parameters
[in]mode

Enum sl_bt_past_receiver_mode_t. The mode to specify how the Bluetooth stack reacts when synchronization information is received. Values:

  • sl_bt_past_receiver_mode_ignore (0x0): No attempt is made to synchronize to a periodic advertising train for which the synchronization information was received. No event will be triggered towards the application.

  • sl_bt_past_receiver_mode_synchronize (0x1): Attempt to synchronize to a periodic advertising train for which the synchronization information was received. When the information is received, an event will be triggered to indicate success or failure and to provide the application with the periodic advertising synchronization handle.

Default: sl_bt_past_receiver_mode_ignore (No attempt is made to synchronize)

[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: 0x0A to 0x4000

  • Unit: 10 ms

  • Time range: 100 ms to 163.84 s

  • Default value: 1000 ms

[in]reporting_mode

Enum sl_bt_sync_reporting_mode_t. Specifies the initial mode for reporting data received in the periodic advertising train after it has achieved synchronization. Values:

  • sl_bt_sync_report_none (0x0): Data received in periodic advertising trains is not reported to the application.

  • sl_bt_sync_report_all (0x1): Data received in periodic advertising trains is reported to the application.

Default: sl_bt_sync_report_all (Data received in periodic advertising trains is reported to the application)

Set the default parameters for receiving Periodic Advertising Synchronization Transfers (PAST) over connections. The default parameters will be in effect for all subsequent connections, unless overridden by command sl_bt_past_receiver_set_sync_receive_parameters after the connection is opened.

This command sets parameters that do not limit the synchronization based on the CTE type. If the application includes bluetooth_feature_aoa_receiver or bluetooth_feature_aod_receiver component and wants to specify a particular CTE limitation, the application should use the command sl_bt_cte_receiver_set_default_sync_receive_parameters to set the default parameters.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events

  • sl_bt_evt_sync_transfer_received - Triggered after synchronization transfer is received for a periodic advertising train that does not have subevents or response slots. This event is used only when the application does not include bluetooth_feature_periodic_sync or bluetooth_feature_pawr_sync components.

  • sl_bt_evt_periodic_sync_transfer_received - If the application includes the bluetooth_feature_periodic_sync or bluetooth_feature_pawr_sync component, triggered after synchronization transfer is received for a periodic advertising train that does not have subevents or response slots.

  • sl_bt_evt_pawr_sync_transfer_received - If the application includes the bluetooth_feature_pawr_sync component, triggered after synchronization transfer is received for a Periodic Advertising with Responses (PAwR) train.


Definition at line 5203 of file /mnt/raid/workspaces/ws.vHmYkJajL/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_past_receiver_set_sync_receive_parameters#

sl_status_t sl_bt_past_receiver_set_sync_receive_parameters (uint8_t connection, uint8_t mode, uint16_t skip, uint16_t timeout, uint8_t reporting_mode)
Parameters
[in]connection

Connection handle of the connection used to receive the sync transfer

[in]mode

Enum sl_bt_past_receiver_mode_t. The mode to specify how the Bluetooth stack reacts when synchronization information is received. Values:

  • sl_bt_past_receiver_mode_ignore (0x0): No attempt is made to synchronize to a periodic advertising train for which the synchronization information was received. No event will be triggered towards the application.

  • sl_bt_past_receiver_mode_synchronize (0x1): Attempt to synchronize to a periodic advertising train for which the synchronization information was received. When the information is received, an event will be triggered to indicate success or failure and to provide the application with the periodic advertising synchronization handle.

Default: sl_bt_past_receiver_mode_ignore (Do not attempt to synchronize)

[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: 0x0A to 0x4000

  • Unit: 10 ms

  • Time range: 100 ms to 163.84 s

  • Default value: 1000 ms

[in]reporting_mode

Enum sl_bt_sync_reporting_mode_t. Specifies the initial mode for reporting data received in the periodic advertising train after it has achieved synchronization. Values:

  • sl_bt_sync_report_none (0x0): Data received in periodic advertising trains is not reported to the application.

  • sl_bt_sync_report_all (0x1): Data received in periodic advertising trains is reported to the application.

Default: sl_bt_sync_report_all (Data received in periodic advertising trains is reported to the application)

Set the parameters for receiving Periodic Advertising Synchronization Transfers (PAST) over the specified connection. The parameters do not affect periodic advertising trains that the device has already synchronized to.

This command sets parameters that do not limit the synchronization based on the CTE type. If the application includes bluetooth_feature_aoa_receiver or bluetooth_feature_aod_receiver component and wants to specify a particular CTE limitation, the application should use the command sl_bt_cte_receiver_set_sync_receive_parameters to set the parameters.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events

  • sl_bt_evt_sync_transfer_received - Triggered after synchronization transfer is received for a periodic advertising train that does not have subevents or response slots. This event is used only when the application does not include bluetooth_feature_periodic_sync or bluetooth_feature_pawr_sync components.

  • sl_bt_evt_periodic_sync_transfer_received - If the application includes the bluetooth_feature_periodic_sync or bluetooth_feature_pawr_sync component, triggered after synchronization transfer is received for a periodic advertising train that does not have subevents or response slots.

  • sl_bt_evt_pawr_sync_transfer_received - If the application includes the bluetooth_feature_pawr_sync component, triggered after synchronization transfer is received for a Periodic Advertising with Responses (PAwR) train.


Definition at line 5281 of file /mnt/raid/workspaces/ws.vHmYkJajL/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

Macro Definition Documentation#

sl_bt_cmd_past_receiver_set_default_sync_receive_parameters_id#

#define sl_bt_cmd_past_receiver_set_default_sync_receive_parameters_id
Value:
0x00510020

Definition at line 5098 of file /mnt/raid/workspaces/ws.vHmYkJajL/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_past_receiver_set_sync_receive_parameters_id#

#define sl_bt_cmd_past_receiver_set_sync_receive_parameters_id
Value:
0x01510020

Definition at line 5099 of file /mnt/raid/workspaces/ws.vHmYkJajL/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_past_receiver_set_default_sync_receive_parameters_id#

#define sl_bt_rsp_past_receiver_set_default_sync_receive_parameters_id
Value:
0x00510020

Definition at line 5100 of file /mnt/raid/workspaces/ws.vHmYkJajL/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_past_receiver_set_sync_receive_parameters_id#

#define sl_bt_rsp_past_receiver_set_sync_receive_parameters_id
Value:
0x01510020

Definition at line 5101 of file /mnt/raid/workspaces/ws.vHmYkJajL/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h