Zephyr API Documentation 4.1.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_le_per_adv_sync_param Struct Reference

Parameters for creating a periodic advertising sync object. More...

#include <bluetooth.h>

Data Fields

bt_addr_le_t addr
 Periodic Advertiser Address.
 
uint8_t sid
 Advertiser SID.
 
uint32_t options
 Bit-field of periodic advertising sync options.
 
uint16_t skip
 Maximum event skip.
 
uint16_t timeout
 Synchronization timeout (N * 10 ms)
 

Detailed Description

Parameters for creating a periodic advertising sync object.

This struct contains the parameters required to create a periodic advertising sync object, which allows the system to synchronize with periodic advertising reports from an advertiser. It includes the advertiser's address, SID, sync options, event skip, and synchronization timeout.

Note
bt_le_per_adv_sync_param is used as a parameter in the bt_le_per_adv_sync_create function to configure synchronization behavior.

Field Documentation

◆ addr

bt_addr_le_t bt_le_per_adv_sync_param::addr

Periodic Advertiser Address.

Only valid if not using the periodic advertising list (BT_LE_PER_ADV_SYNC_OPT_USE_PER_ADV_LIST)

◆ options

uint32_t bt_le_per_adv_sync_param::options

Bit-field of periodic advertising sync options.

◆ sid

uint8_t bt_le_per_adv_sync_param::sid

Advertiser SID.

Only valid if not using the periodic advertising list (BT_LE_PER_ADV_SYNC_OPT_USE_PER_ADV_LIST)

◆ skip

uint16_t bt_le_per_adv_sync_param::skip

Maximum event skip.

Maximum number of periodic advertising events that can be skipped after a successful receive. Range: 0x0000 to 0x01F3

◆ timeout

uint16_t bt_le_per_adv_sync_param::timeout

Synchronization timeout (N * 10 ms)

Synchronization timeout for the periodic advertising sync. Range 0x000A to 0x4000 (100 ms to 163840 ms)


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