Parameters for configuring periodic advertising. More...

#include <zephyr/bluetooth/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_per_adv_opt field.
uint8_t	num_subevents
	Number of subevents.
uint8_t	subevent_interval
	Interval between subevents (N * 1.25 ms).
uint8_t	response_slot_delay
	Time between the advertising packet in a subevent and the first response slot (N * 1.25 ms).
uint8_t	response_slot_spacing
	Time between response slots (N * 0.125 ms).
uint8_t	num_response_slots
	Number of subevent response slots.

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.

◆ num_response_slots

uint8_t bt_le_per_adv_param::num_response_slots

Number of subevent response slots.

If zero, response_slot_delay and response_slot_spacing are ignored.

Attention: Available only when the following Kconfig option is enabled: CONFIG_BT_PER_ADV_RSP.

◆ num_subevents

uint8_t bt_le_per_adv_param::num_subevents

Number of subevents.

If zero, the periodic advertiser will be a broadcaster, without responses.

Attention: Available only when the following Kconfig option is enabled: CONFIG_BT_PER_ADV_RSP.

◆ options

uint32_t bt_le_per_adv_param::options

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

◆ response_slot_delay

uint8_t bt_le_per_adv_param::response_slot_delay

Time between the advertising packet in a subevent and the first response slot (N * 1.25 ms).

Attention: Available only when the following Kconfig option is enabled: CONFIG_BT_PER_ADV_RSP.

◆ response_slot_spacing

uint8_t bt_le_per_adv_param::response_slot_spacing

Time between response slots (N * 0.125 ms).

Shall be between 0.25 and 31.875 ms.

Attention: Available only when the following Kconfig option is enabled: CONFIG_BT_PER_ADV_RSP.

◆ subevent_interval

uint8_t bt_le_per_adv_param::subevent_interval

Interval between subevents (N * 1.25 ms).

Shall be between 7.5ms and 318.75 ms.

Attention: Available only when the following Kconfig option is enabled: CONFIG_BT_PER_ADV_RSP.

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

zephyr/bluetooth/bluetooth.h

Data Fields