bt_le_ext_adv_start_param Struct Reference

Parameters for starting an extended advertising session. More...

#include <bluetooth.h>

Data Fields
uint16_t	timeout
	Maximum advertising set duration (N * 10 ms)
uint8_t	num_events
	Maximum number of extended advertising events to be sent.

Detailed Description

Parameters for starting an extended advertising session.

This struct provides the parameters to control the behavior of an extended advertising session, including the timeout and the number of advertising events to send. The timeout is specified in units of 10 ms, and the number of events determines how many times the advertising will be sent before stopping. If either the timeout or number of events is reached, the advertising session will be stopped, and the application will be notified via the advertiser sent callback. If both parameters are provided, the advertising session will stop when either limit is reached.

Note

Used in bt_le_ext_adv_start function.

Field Documentation

num_events

uint8_t bt_le_ext_adv_start_param::num_events

Maximum number of extended advertising events to be sent.

The advertiser can be automatically disabled once the whole advertisement (i.e. extended advertising event) has been sent a certain number of times. The number of advertising PDUs sent may be higher and is not relevant.

Set to zero for no limit.

When the advertising set is automatically disabled because of this limit, bt_le_ext_adv_cb::sent will be called.

For background information, see parameter "Max_Extended_Advertising_Events" in Bluetooth Core Specification Version 6.0 Vol. 4 Part E, Section 7.8.56.

timeout

uint16_t bt_le_ext_adv_start_param::timeout

Maximum advertising set duration (N * 10 ms)

The advertising set can be automatically disabled after a certain amount of time has passed since it first appeared on air.

Set to zero for no limit. Set in units of 10 ms.

When the advertising set is automatically disabled because of this limit, bt_le_ext_adv_cb::sent will be called.

When using high duty cycle directed connectable advertising then this parameters must be set to a non-zero value less than or equal to the maximum of BT_GAP_ADV_HIGH_DUTY_CYCLE_MAX_TIMEOUT.

If privacy CONFIG_BT_PRIVACY is enabled then the timeout must be less than CONFIG_BT_RPA_TIMEOUT.

For background information, see parameter "Duration" in Bluetooth Core Specification Version 6.0 Vol. 4 Part E, Section 7.8.56.

---

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

• zephyr/bluetooth/bluetooth.h