Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_le_adv_param Struct Reference

LE Advertising Parameters. More...

#include <bluetooth.h>

Data Fields

uint8_t id
 Local identity.
 
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.
 
uint32_t interval_min
 Minimum Advertising Interval (N * 0.625 milliseconds) Minimum Advertising Interval shall be less than or equal to the Maximum Advertising Interval.
 
uint32_t interval_max
 Maximum Advertising Interval (N * 0.625 milliseconds) Minimum Advertising Interval shall be less than or equal to the Maximum Advertising Interval.
 
const bt_addr_le_tpeer
 Directed advertising to peer.
 

Detailed Description

LE Advertising Parameters.

Field Documentation

◆ id

uint8_t bt_le_adv_param::id

Local identity.

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) Minimum Advertising Interval shall be less than or equal to the Maximum Advertising Interval.

The Minimum Advertising Interval and Maximum Advertising Interval should not be the same value (as stated in Bluetooth Core Spec 5.2, 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) Minimum Advertising Interval shall be less than or equal to the Maximum Advertising Interval.

The Minimum Advertising Interval and Maximum Advertising Interval should not be the same value (as stated in Bluetooth Core Spec 5.2, section 7.8.5) Range: 0x0020 to 0x4000

◆ options

uint32_t bt_le_adv_param::options

Bit-field of advertising options.

◆ 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

◆ sid

uint8_t bt_le_adv_param::sid

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

Note
Requires BT_LE_ADV_OPT_EXT_ADV

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