bt_le_adv_param Struct Reference

LE Advertising Parameters. More...

#include <bluetooth.h>

Data Fields
uint8_t	id
	Local identity handle.
uint8_t	sid
	Advertising Set Identifier, valid range 0x00 - 0x0f.
uint8_t	secondary_max_skip
	Secondary channel maximum skip count.
uint32_t	options
	Bit-field of advertising options, see the bt_le_adv_opt field.
uint32_t	interval_min
	Minimum Advertising Interval (N * 0.625 milliseconds)
uint32_t	interval_max
	Maximum Advertising Interval (N * 0.625 milliseconds)
const bt_addr_le_t *	peer
	Directed advertising to peer.

Detailed Description

LE Advertising Parameters.

Field Documentation

id

uint8_t bt_le_adv_param::id

Local identity handle.

The index of the identity address in the local Bluetooth controller.

Note

When extended advertising CONFIG_BT_EXT_ADV is not enabled or not supported by the controller it is not possible to scan and advertise simultaneously using two different random addresses.

interval_max

uint32_t bt_le_adv_param::interval_max

Maximum Advertising Interval (N * 0.625 milliseconds)

The Maximum Advertising Interval shall be more than or equal to the Minimum Advertising Interval. The Minimum Advertising Interval and Maximum Advertising Interval aren't recommended to be the same value to enable the Controller to determine the best advertising interval given other activities. (See Bluetooth Core Spec 6.0, Vol 4, Part E, section 7.8.5) Range: 0x0020 to 0x4000

interval_min

uint32_t bt_le_adv_param::interval_min

Minimum Advertising Interval (N * 0.625 milliseconds)

The Minimum Advertising Interval shall be less than or equal to the Maximum Advertising Interval. The Minimum Advertising Interval and Maximum Advertising Interval aren't recommended to be the same value to enable the Controller to determine the best advertising interval given other activities. (See Bluetooth Core Spec 6.0, Vol 4, Part E, section 7.8.5) Range: 0x0020 to 0x4000

options

uint32_t bt_le_adv_param::options

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

peer

const bt_addr_le_t* bt_le_adv_param::peer

Directed advertising to peer.

When this parameter is set the advertiser will send directed advertising to the remote device.

The advertising type will either be high duty cycle, or low duty cycle if the BT_LE_ADV_OPT_DIR_MODE_LOW_DUTY option is enabled. When using BT_LE_ADV_OPT_EXT_ADV then only low duty cycle is allowed.

In case of connectable high duty cycle if the connection could not be established within the timeout the connected() callback will be called with the status set to BT_HCI_ERR_ADV_TIMEOUT.

secondary_max_skip

uint8_t bt_le_adv_param::secondary_max_skip

Secondary channel maximum skip count.

Maximum advertising events the advertiser can skip before it must send advertising data on the secondary advertising channel.

Note

Requires BT_LE_ADV_OPT_EXT_ADV bit (see bt_le_adv_opt field) to be set as bt_le_adv_param::options.

sid

uint8_t bt_le_adv_param::sid

Advertising Set Identifier, valid range 0x00 - 0x0f.

Note

Requires BT_LE_ADV_OPT_EXT_ADV bit (see bt_le_adv_opt field) to be set as bt_le_adv_param::options.

---

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

• zephyr/bluetooth/bluetooth.h