Zephyr API Documentation 4.1.99
A Scalable Open Source RTOS
 4.1.99
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
bt_le_per_adv_param Struct Reference

Parameters for configuring periodic advertising. More...

#include <bluetooth.h>

Data Fields

uint16_t interval_min
 Minimum Periodic Advertising Interval (N * 1.25 ms)
 
uint16_t interval_max
 Maximum Periodic Advertising Interval (N * 1.25 ms)
 
uint32_t options
 Bit-field of periodic advertising options, see the bt_le_adv_opt field.
 

Detailed Description

Parameters for configuring periodic advertising.

This struct is used to configure the parameters for periodic advertising, including the minimum and maximum advertising intervals, options, and settings for subevents if periodic advertising responses are supported. The intervals are specified in units of 1.25 ms, and the options field can be used to modify other advertising behaviors. For extended advertisers, the periodic advertising parameters can be set or updated using this structure. Some parameters are conditional based on whether the device supports periodic advertising responses (configured via CONFIG_BT_PER_ADV_RSP).

Note
Used in bt_le_per_adv_set_param function.

Field Documentation

◆ interval_max

uint16_t bt_le_per_adv_param::interval_max

Maximum Periodic Advertising Interval (N * 1.25 ms)

Shall be less or equal to BT_GAP_PER_ADV_MAX_INTERVAL and greater or equal to interval_min.

◆ interval_min

uint16_t bt_le_per_adv_param::interval_min

Minimum Periodic Advertising Interval (N * 1.25 ms)

Shall be greater or equal to BT_GAP_PER_ADV_MIN_INTERVAL and less or equal to interval_max.

◆ options

uint32_t bt_le_per_adv_param::options

Bit-field of periodic advertising options, see the bt_le_adv_opt field.


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