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

LE scan parameters. More...

#include <bluetooth.h>

Data Fields

uint8_t type
 Scan type (BT_LE_SCAN_TYPE_ACTIVE or BT_LE_SCAN_TYPE_PASSIVE)
 
uint8_t options
 Bit-field of scanning options.
 
uint16_t interval
 Scan interval (N * 0.625 ms).
 
uint16_t window
 Scan window (N * 0.625 ms)
 
uint16_t timeout
 Scan timeout (N * 10 ms)
 
uint16_t interval_coded
 Scan interval LE Coded PHY (N * 0.625 MS)
 
uint16_t window_coded
 Scan window LE Coded PHY (N * 0.625 MS)
 

Detailed Description

LE scan parameters.

Field Documentation

◆ interval

uint16_t bt_le_scan_param::interval

Scan interval (N * 0.625 ms).

Note
When
CONFIG_BT_SCAN_AND_INITIATE_IN_PARALLEL 
is enabled and the application wants to scan and connect in parallel, the Bluetooth Controller may require the scan interval used for scanning and connection establishment to be equal to obtain the best performance.

◆ interval_coded

uint16_t bt_le_scan_param::interval_coded

Scan interval LE Coded PHY (N * 0.625 MS)

Set zero to use same as LE 1M PHY scan interval.

◆ options

uint8_t bt_le_scan_param::options

Bit-field of scanning options.

◆ timeout

uint16_t bt_le_scan_param::timeout

Scan timeout (N * 10 ms)

Application will be notified by the scan timeout callback. Set zero to disable timeout.

◆ type

uint8_t bt_le_scan_param::type

Scan type (BT_LE_SCAN_TYPE_ACTIVE or BT_LE_SCAN_TYPE_PASSIVE)

◆ window

uint16_t bt_le_scan_param::window

Scan window (N * 0.625 ms)

Note
When
CONFIG_BT_SCAN_AND_INITIATE_IN_PARALLEL 
is enabled and the application wants to scan and connect in parallel, the Bluetooth Controller may require the scan window used for scanning and connection establishment to be equal to obtain the best performance.

◆ window_coded

uint16_t bt_le_scan_param::window_coded

Scan window LE Coded PHY (N * 0.625 MS)

Set zero to use same as LE 1M PHY scan window.


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