Information about the successful synchronization with periodic advertising. More...

#include <zephyr/bluetooth/bluetooth.h>

Data Fields
const bt_addr_le_t *	addr
	Advertiser LE address and type.
uint8_t	sid
	Advertising Set Identifier, valid range BT_GAP_SID_MIN to BT_GAP_SID_MAX.
uint16_t	interval
	Periodic advertising interval (N * 1.25 ms).
uint8_t	phy
	Advertiser PHY (see bt_gap_le_phy).
bool	recv_enabled
	True if receiving periodic advertisements, false otherwise.
uint16_t	service_data
	Service Data provided by the peer when sync is transferred.
struct bt_conn *	conn
	Peer that transferred the periodic advertising sync.
uint8_t	num_subevents
	Number of subevents.
uint8_t	subevent_interval
	Subevent interval (N * 1.25 ms).
uint8_t	response_slot_delay
	Response slot delay (N * 1.25 ms).
uint8_t	response_slot_spacing
	Response slot spacing (N * 1.25 ms).

Detailed Description

Information about the successful synchronization with periodic advertising.

This struct provides information about the periodic advertising sync once it has been successfully established. It includes the advertiser's address, SID, the advertising interval, PHY, and the synchronization state. It also contains details about the sync, such as service data and the peer device that transferred the sync. When using periodic advertising response (configured via CONFIG_BT_PER_ADV_SYNC_RSP), additional details such as subevent information and response timings are provided.

Note: Used in bt_le_per_adv_sync_cb structure.

Field Documentation

◆ addr

const bt_addr_le_t* bt_le_per_adv_sync_synced_info::addr

Advertiser LE address and type.

◆ conn

struct bt_conn* bt_le_per_adv_sync_synced_info::conn

Peer that transferred the periodic advertising sync.

Will always be NULL when the sync is locally created.

◆ interval

uint16_t bt_le_per_adv_sync_synced_info::interval

Periodic advertising interval (N * 1.25 ms).

◆ num_subevents

uint8_t bt_le_per_adv_sync_synced_info::num_subevents

Number of subevents.

◆ phy

uint8_t bt_le_per_adv_sync_synced_info::phy

Advertiser PHY (see bt_gap_le_phy).

◆ recv_enabled

bool bt_le_per_adv_sync_synced_info::recv_enabled

True if receiving periodic advertisements, false otherwise.

◆ response_slot_delay

uint8_t bt_le_per_adv_sync_synced_info::response_slot_delay

Response slot delay (N * 1.25 ms).

◆ response_slot_spacing

uint8_t bt_le_per_adv_sync_synced_info::response_slot_spacing

Response slot spacing (N * 1.25 ms).

◆ service_data

uint16_t bt_le_per_adv_sync_synced_info::service_data

Service Data provided by the peer when sync is transferred.

Will always be 0 when the sync is locally created.

◆ sid

uint8_t bt_le_per_adv_sync_synced_info::sid

Advertising Set Identifier, valid range BT_GAP_SID_MIN to BT_GAP_SID_MAX.

◆ subevent_interval

uint8_t bt_le_per_adv_sync_synced_info::subevent_interval

Subevent interval (N * 1.25 ms).

The documentation for this struct was generated from the following file:

zephyr/bluetooth/bluetooth.h

Data Fields