BLE (Bluetooth Low Energy)

API Reference


group btm_ble_api_functions

This section describes the API’s to use BLE functionality such as advertisement, scanning BLE Connection, Data transfer, BLE Security etc.

Defines

BTM_AFH_CHNL_MAP_SIZE

AFH channel map size.

BLE_CHANNEL_MAP_LEN

AFH Channel Map len.

BTM_BLE_DEFAULT_ADVERT_CHNL_MAP

default advertising channel map

BTM_BLE_ADVERT_FILTER_DEFAULT

default advertising filter policy

BTM_BLE_ADVERT_INTERVAL_MIN

adv parameter Min value

BTM_BLE_ADVERT_INTERVAL_MAX

adv parameter Max value

BTM_BLE_SCAN_INTERVAL_MIN

Scan interval minimum value.

BTM_BLE_SCAN_INTERVAL_MAX

Scan interval miximum value.

BTM_BLE_SCAN_WINDOW_MIN

Scan window minimum value.

BTM_BLE_SCAN_WINDOW_MAX

Scan window maximum value.

BTM_BLE_CONN_INTERVAL_MIN

Connection interval minimum value.

BTM_BLE_CONN_INTERVAL_MAX

Connection interval maximum value.

BTM_BLE_CONN_LATENCY_MAX

Maximum Connection Latency.

BTM_BLE_CONN_SUP_TOUT_MIN

Minimum Supervision Timeout.

BTM_BLE_CONN_SUP_TOUT_MAX

Maximum Supervision Timeout.

BTM_BLE_CONN_PARAM_UNDEF

use this value when a specific value not to be overwritten

BTM_BLE_CONN_SUP_TOUT_DEF

Default Supervision Timeout.

BTM_BLE_SCAN_FAST_INTERVAL

default scan interval 30 ~ 60 ms (use 60) = 96 *0.625

BTM_BLE_SCAN_FAST_WINDOW

default scan window for background connection, applicable for auto connection or selective conenction 30 ms = 48 *0.625

BTM_BLE_SCAN_SLOW_INTERVAL_1

default scan interval used in reduced power cycle (background scanning) 1.28 s = 2048 *0.625

BTM_BLE_SCAN_SLOW_WINDOW_1

default scan window used in reduced power cycle (background scanning) 11.25 ms = 18 *0.625

BTM_BLE_SCAN_SLOW_INTERVAL_2

default scan interval used in reduced power cycle (background scanning) 2.56 s = 4096 *0.625

BTM_BLE_SCAN_SLOW_WINDOW_2

default scan window used in reduced power cycle (background scanning) 22.5 ms = 36 *0.625

BTM_BLE_CONN_INTERVAL_MIN_DEF

default connection interval min recommended min: 30ms = 24 * 1.25

BTM_BLE_CONN_INTERVAL_MAX_DEF

default connection interval max recommended max: 50 ms = 56 * 1.25

BTM_BLE_CONN_PERIPHERAL_LATENCY_DEF

default Peripheral latency

BTM_BLE_CONN_TIMEOUT_DEF

default supervision timeout

BTM_BLE_AUTH_SIGNATURE_SIZE

BLE Signature BLE data signature length 8 Bytes + 4 bytes counter.

BTM_BLE_POLICY_REJECT_ALL

relevant to both

BTM_BLE_POLICY_ALLOW_SCAN

relevant to advertiser

BTM_BLE_POLICY_ALLOW_CONN

relevant to advertiser

BTM_BLE_POLICY_ALLOW_ALL

relevant to both

BTM_BLE_LIMITED_DISCOVERABLE_FLAG

Limited Discoverable.

BTM_BLE_GENERAL_DISCOVERABLE_FLAG

General Discoverable.

BTM_BLE_BREDR_NOT_SUPPORTED

BR/EDR Not Supported.

BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_CONTROLLER_SUPPORTED

Simultaneous LE and BR/EDR to Same Device Capable (Controller).

BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_HOST_SUPPORTED

Simultaneous LE and BR/EDR to Same Device Capable (Host).

BTM_BLE_NON_LIMITED_DISCOVERABLE_FLAG

Non Discoverable.

BTM_BLE_ADVERT_FLAG_MASK

BLE adverisement mask.

BTM_BLE_LIMITED_DISCOVERABLE_MASK

BLE Limited discovery mask.

BTM_BLE_PREFER_1M_PHY

LE 1M PHY preference.

BTM_BLE_PREFER_2M_PHY

LE 2M PHY preference.

BTM_BLE_PREFER_LELR_PHY

LE LELR PHY preference.

BTM_BLE_PREFER_NO_LELR

No preferred coding.

BTM_BLE_PREFER_LELR_125K

Preferred coding is S=2.

BTM_BLE_PREFER_LELR_512K

Preferred coding is S=8.

MULTI_ADV_TX_POWER_MIN_INDEX

Multi adv tx min power index.

MULTI_ADV_TX_POWER_MAX_INDEX

Multi adv tx max power index.

WICED_BT_BLE_MAX_EXT_ADV_DATA_LEN

ADV extension structures.

IS_CONNECTABLE_ADV_REPORT(x)

adv is connectable

IS_SCANNABLE_ADV_REPORT(x)

adv is scannable

IS_DIRECTED_ADV_REPORT(x)

directed adv

IS_SCAN_RSP_ADV_REPORT(x)

scan response

IS_LEGACY_ADV_REPORT(x)

legacy adv

IS_ADV_REPORT_DATA_STATUS_INCOMPLETE(x)

adv data incomplete, more data to come

IS_ADV_REPORT_DATA_STATUS_TRUNCATED(x)

Incomplete, data truncated, no more to come.

Typedefs

typedef uint8_t wiced_bt_ble_chnl_map_t[BLE_CHANNEL_MAP_LEN]

BLE Channel Map.

typedef uint8_t wiced_bt_ble_scanner_filter_policy_t

BLE Scanner filter policy.

Scanner filter policy (see wiced_bt_ble_scanner_filter_policy_e)

typedef uint8_t wiced_bt_ble_advert_filter_policy_t

Advertising filter policy (see wiced_bt_ble_advert_filter_policy_e)

typedef uint8_t wiced_dev_ble_signature_t[BTM_BLE_AUTH_SIGNATURE_SIZE]

Device address (see BTM_BLE_AUTH_SIGNATURE_SIZE)

typedef uint8_t wiced_bt_ble_advert_type_t

BLE advertisement data type (see wiced_bt_ble_advert_type_e)

typedef uint8_t wiced_bt_dev_ble_evt_type_t

Scan result event value (see wiced_bt_dev_ble_evt_type_e)

typedef uint8_t wiced_bt_ble_conn_type_t

Connection type (see wiced_bt_ble_conn_type_e)

typedef uint8_t wiced_bt_ble_sec_action_type_t

BLE security type.

refer wiced_bt_ble_sec_action_type_e

typedef uint8_t wiced_bt_ble_host_phy_preferences_t

Host preferences on PHY.

bit field that indicates the transmitter PHYs that the Host prefers the Controller to use.Bit number 3 -7 reserved for future.

typedef uint16_t wiced_bt_ble_lelr_phy_preferences_t

The PHY_options parameter is a bit field that allows the Host to specify options for LE long range PHY.

Default connection is with no LE coded PHY.The Controller may override any preferred coding (S2 coded phy for 512k speed and s8 coded phy for 128K) for transmitting on the LE Coded PHY. The Host may specify a preferred coding even if it prefers not to use the LE Coded transmitter PHY since the Controller may override the PHY preference. Bit 2-15 reserved for future use.

note

These preferences applicable only when BTM_BLE_PREFER_LELR_PHY flag gest set

typedef int8_t wiced_bt_ble_adv_tx_power_t

Transmit Power in dBm ( MULTI_ADV_TX_POWER_MIN_INDEX to MULTI_ADV_TX_POWER_MAX_INDEX )

typedef uint8_t wiced_bt_ble_multi_advert_type_t

BLE advertisement type (see wiced_bt_ble_multi_advert_type_e)

typedef uint8_t wiced_bt_ble_privacy_mode_t

BLE Privacy mode.

Refer wiced_bt_ble_privacy_e

typedef uint8_t wiced_bt_ble_multi_advert_filtering_policy_t

BLE advertisement filtering policy (see wiced_bt_ble_multi_advert_filtering_policy_e)

wiced_bool_t() wiced_bt_ble_selective_conn_cback_t (wiced_bt_device_address_t remote_bda, uint8_t *p_remote_name)

Callback wiced_bt_ble_selective_conn_cback_t.

Selective connection callback (registered with wiced_bt_ble_set_background_connection_type)

Parameters
  • remote_bda – : remote device

  • p_remote_name – : remote device name

Returns

void() wiced_bt_ble_scan_result_cback_t (wiced_bt_ble_scan_results_t *p_scan_result, uint8_t *p_adv_data)

Callback wiced_bt_ble_scan_result_cback_t.

Scan result callback (from calling wiced_bt_ble_scan)

Parameters
Returns

Nothing

void() wiced_bt_ble_read_phy_complete_callback_t (wiced_bt_ble_phy_update_t *p_phy_result)

Callback wiced_bt_ble_read_phy_complete_callback_t.

read phy complete callback (from calling wiced_bt_ble_read_phy)

Parameters

p_phy_result – : read phys result

Returns

Nothing

typedef uint8_t wiced_bt_ble_ext_adv_phy_t

BLE phy to be used for extended advertisement.

typedef uint8_t wiced_bt_ble_ext_adv_phy_mask_t

BLE phy mask to be used for extended advertisement.

typedef uint16_t wiced_bt_ble_ext_adv_event_property_t

BLE extended advertisement event property.

typedef uint8_t wiced_bt_ble_ext_adv_handle_t

advertisement set handle value

typedef uint8_t wiced_bt_ble_ext_adv_sid_t

SID value.

typedef uint8_t wiced_bt_ble_ext_adv_scan_req_notification_setting_t

Enable or disable notification value (see wiced_bt_ble_ext_adv_scan_req_notification_setting_e)

typedef uint16_t wiced_bt_ble_periodic_adv_prop_t

Periodic adv property (see wiced_bt_ble_periodic_adv_prop_e)

typedef uint8_t wiced_bt_ble_ext_scan_filter_duplicate_t

Extended scan duplicate filter policy (see wiced_bt_ble_ext_scan_filter_duplicate_e)

typedef uint8_t wiced_bt_ble_ext_filter_policy_t

Filter policy used.

(see wiced_bt_ble_ext_filter_policy_e)

typedef uint8_t wiced_bt_ble_adv_sync_options_t

Options used in create periodic sync to periodic adv command (see wiced_bt_ble_adv_sync_options_e)

typedef uint16_t wiced_bt_ble_periodic_adv_sync_handle_t

Sync_Handle to be used to identify the periodic advertiser.

Range: 0x0000-0x0EFF

typedef uint16_t wiced_bt_ble_adv_report_event_mask_t

Bit mask to identify the type of the adv received in extended adv report.

(see wiced_bt_ble_ext_adv_report_t) event_type filed

typedef uint8_t wiced_bt_ble_ext_adv_report_count_t

Min and Max reports (see wiced_bt_ble_ext_adv_report_count_e)

typedef uint8_t wiced_bt_ble_advertiser_clock_accuracy_t

Advertiser clock accuracy (see wiced_bt_ble_advertiser_clock_accuracy_e)

typedef wiced_bt_ble_periodic_adv_sync_handle_t wiced_bt_ble_connection_handle_t

sync handle and connection handle are same range

typedef uint8_t wiced_bt_ble_channel_sel_algo_t

LE channel algorithm selection (see wiced_bt_ble_channel_sel_algo_e)

typedef void (*wiced_bt_ble_adv_ext_event_cb_fp_t)(wiced_bt_ble_adv_ext_event_t event, wiced_bt_ble_adv_ext_event_data_t *p_data)

Callback wiced_bt_ble_adv_ext_event_cb_fp_t.

Adv extension command status, command complete event and LE adv extension meta event callback

Parameters
Returns

Nothing

Enums

enum wiced_bt_ble_scanner_filter_policy_e

wiced_bt_ble_scanner_filter_policy_e: Scanner filter policy.

Values:

enumerator BTM_BLE_SCAN_POLICY_ACCEPT_ADV_RSP

accept adv packet from all, directed adv pkt not directed to local device is ignored

enumerator BTM_BLE_SCAN_POLICY_FILTER_ADV_RSP

accept adv packet from device in filter Accept List, directed adv packet not directed to local device is ignored

enumerator BTM_BLE_SCAN_POLICY_ACCEPT_RPA_DIR_ADV_RSP

accept adv packet from all, directed adv pkt not directed to local device is ignored except direct adv with RPA

enumerator BTM_BLE_SCAN_POLICY_FILTER_RPA_DIR_ADV_RSP

accept adv packet from device in filter Accept List, directed adv pkt not directed to me is ignored except direct adv with RPA

enumerator BTM_BLE_SCAN_POLICY_MAX

Max Scan filter policy value.

enum wiced_bt_ble_advert_filter_policy_e

wiced_bt_ble_advert_filter_policy_e: Advertising filter policy.

Values:

enumerator BTM_BLE_ADV_POLICY_ACCEPT_CONN_AND_SCAN

Process scan and connection requests from all devices (i.e., the Filter Accept List is not in use) (default)

enumerator BTM_BLE_ADV_POLICY_ACCEPT_CONN_FILTER_SCAN

Process connection requests from all devices and only scan requests from devices that are in the Filter Accept List.

enumerator BTM_BLE_ADV_POLICY_FILTER_CONN_ACCEPT_SCAN

Process scan requests from all devices and only connection requests from devices that are in the Filter Accept List.

enumerator BTM_BLE_ADV_POLICY_FILTER_CONN_FILTER_SCAN

Process scan and connection requests only from devices in the Filter Accept List.

enumerator BTM_BLE_ADV_POLICY_MAX

Max Adv filter value.

enum wiced_bt_ble_advert_type_e

wiced_bt_ble_advert_type_e: Advertisement data types.

Values:

enumerator BTM_BLE_ADVERT_TYPE_FLAG

Advertisement flags.

enumerator BTM_BLE_ADVERT_TYPE_16SRV_PARTIAL

List of supported services - 16 bit UUIDs (partial)

enumerator BTM_BLE_ADVERT_TYPE_16SRV_COMPLETE

List of supported services - 16 bit UUIDs (complete)

enumerator BTM_BLE_ADVERT_TYPE_32SRV_PARTIAL

List of supported services - 32 bit UUIDs (partial)

enumerator BTM_BLE_ADVERT_TYPE_32SRV_COMPLETE

List of supported services - 32 bit UUIDs (complete)

enumerator BTM_BLE_ADVERT_TYPE_128SRV_PARTIAL

List of supported services - 128 bit UUIDs (partial)

enumerator BTM_BLE_ADVERT_TYPE_128SRV_COMPLETE

List of supported services - 128 bit UUIDs (complete)

enumerator BTM_BLE_ADVERT_TYPE_NAME_SHORT

Short name.

enumerator BTM_BLE_ADVERT_TYPE_NAME_COMPLETE

Complete name.

enumerator BTM_BLE_ADVERT_TYPE_TX_POWER

TX Power level.

enumerator BTM_BLE_ADVERT_TYPE_DEV_CLASS

Device Class.

enumerator BTM_BLE_ADVERT_TYPE_SIMPLE_PAIRING_HASH_C

Simple Pairing Hash C.

enumerator BTM_BLE_ADVERT_TYPE_SIMPLE_PAIRING_RAND_C

Simple Pairing Randomizer R.

enumerator BTM_BLE_ADVERT_TYPE_SM_TK

Security manager TK value.

enumerator BTM_BLE_ADVERT_TYPE_SM_OOB_FLAG

Security manager Out-of-Band data.

enumerator BTM_BLE_ADVERT_TYPE_INTERVAL_RANGE

Peripheral connection interval range.

enumerator BTM_BLE_ADVERT_TYPE_SOLICITATION_SRV_UUID

List of solicitated services - 16 bit UUIDs.

enumerator BTM_BLE_ADVERT_TYPE_128SOLICITATION_SRV_UUID

List of solicitated services - 128 bit UUIDs.

enumerator BTM_BLE_ADVERT_TYPE_SERVICE_DATA

Service data - 16 bit UUID.

enumerator BTM_BLE_ADVERT_TYPE_PUBLIC_TARGET

Public target address.

enumerator BTM_BLE_ADVERT_TYPE_RANDOM_TARGET

Random target address.

enumerator BTM_BLE_ADVERT_TYPE_APPEARANCE

Appearance.

enumerator BTM_BLE_ADVERT_TYPE_ADVERT_INTERVAL

Advertising interval.

enumerator BTM_BLE_ADVERT_TYPE_LE_BD_ADDR

LE device bluetooth address.

enumerator BTM_BLE_ADVERT_TYPE_LE_ROLE

LE role.

enumerator BTM_BLE_ADVERT_TYPE_256SIMPLE_PAIRING_HASH

Simple Pairing Hash C-256.

enumerator BTM_BLE_ADVERT_TYPE_256SIMPLE_PAIRING_RAND

Simple Pairing Randomizer R-256.

enumerator BTM_BLE_ADVERT_TYPE_32SOLICITATION_SRV_UUID

List of solicitated services - 32 bit UUIDs.

enumerator BTM_BLE_ADVERT_TYPE_32SERVICE_DATA

Service data - 32 bit UUID.

enumerator BTM_BLE_ADVERT_TYPE_128SERVICE_DATA

Service data - 128 bit UUID.

enumerator BTM_BLE_ADVERT_TYPE_CONN_CONFIRM_VAL

LE Secure Connections Confirmation Value.

enumerator BTM_BLE_ADVERT_TYPE_CONN_RAND_VAL

LE Secure Connections Random Value.

enumerator BTM_BLE_ADVERT_TYPE_URI

URI.

enumerator BTM_BLE_ADVERT_TYPE_INDOOR_POS

Indoor Positioning.

enumerator BTM_BLE_ADVERT_TYPE_TRANS_DISCOVER_DATA

Transport Discovery Data.

enumerator BTM_BLE_ADVERT_TYPE_SUPPORTED_FEATURES

LE Supported Features.

enumerator BTM_BLE_ADVERT_TYPE_UPDATE_CH_MAP_IND

Channel Map Update Indication.

enumerator BTM_BLE_ADVERT_TYPE_PB_ADV

PB-ADV.

enumerator BTM_BLE_ADVERT_TYPE_MESH_MSG

Mesh Message.

enumerator BTM_BLE_ADVERT_TYPE_MESH_BEACON

Mesh Beacon.

enumerator BTM_BLE_ADVERT_TYPE_PSRI

Generic Audio Provate Set Random Identifier.

enumerator BTM_BLE_ADVERT_TYPE_3D_INFO_DATA

3D Information Data

enumerator BTM_BLE_ADVERT_TYPE_MANUFACTURER

Manufacturer data.

enum wiced_bt_ble_sec_flags_e

wiced_bt_ble_sec_flags_e: security settings used with L2CAP LE COC

Values:

Link encrypted.

Paired without man-in-the-middle protection.

Link with man-in-the-middle protection.

enum wiced_bt_dev_ble_evt_type_e

wiced_bt_dev_ble_evt_type_e: Scan result event type.

Values:

enumerator BTM_BLE_EVT_CONNECTABLE_ADVERTISEMENT

Connectable advertisement.

enumerator BTM_BLE_EVT_CONNECTABLE_DIRECTED_ADVERTISEMENT

Connectable Directed advertisement.

enumerator BTM_BLE_EVT_SCANNABLE_ADVERTISEMENT

Scannable advertisement.

enumerator BTM_BLE_EVT_NON_CONNECTABLE_ADVERTISEMENT

Non connectable advertisement.

enumerator BTM_BLE_EVT_SCAN_RSP

Scan response.

enum wiced_bt_ble_conn_type_e

wiced_bt_ble_conn_type_e: Background connection type.

Values:

enumerator BTM_BLE_CONN_NONE

No background connection.

enumerator BTM_BLE_CONN_AUTO

Auto connection.

enumerator BTM_BLE_CONN_SELECTIVE

Selective connection.

enum wiced_bt_ble_sec_action_type_e

wiced_bt_ble_sec_action_type_e: LE encryption method.

Values:

enumerator BTM_BLE_SEC_NONE

No encryption.

enumerator BTM_BLE_SEC_ENCRYPT

encrypt the link using current key

enumerator BTM_BLE_SEC_ENCRYPT_NO_MITM

encryption without MITM

enumerator BTM_BLE_SEC_ENCRYPT_MITM

encryption with MITM

enum wiced_bt_ble_multi_advert_start_e

wiced_bt_ble_multi_advert_start_e: Multi-advertisement start/stop.

Values:

enumerator MULTI_ADVERT_STOP

Stop Multi-adverstisment.

enumerator MULTI_ADVERT_START

Start Multi-adverstisment.

enum wiced_bt_ble_multi_advert_type_e

wiced_bt_ble_multi_advert_type_e: Multi-advertisement type.

Values:

enumerator MULTI_ADVERT_CONNECTABLE_UNDIRECT_EVENT

Multi adv Connectable undirected event.

enumerator MULTI_ADVERT_CONNECTABLE_DIRECT_EVENT

Multi adv Connectable directed event.

enumerator MULTI_ADVERT_DISCOVERABLE_EVENT

Multi adv Discoverable event.

enumerator MULTI_ADVERT_NONCONNECTABLE_EVENT

Multi adv NonConnectable event.

enumerator MULTI_ADVERT_LOW_DUTY_CYCLE_DIRECT_EVENT

Multi adv Low Cycle directed event.

enum wiced_bt_ble_privacy_e

wiced_bt_ble_privacy_e: Privacy mode refer Spec version 5.0 Vol 3 Part C Section 10.7 privacy feature.

Values:

enumerator BTM_BLE_PRIVACY_MODE_NETWORK

network privacy mode

enumerator BTM_BLE_PRIVACY_MODE_DEVICE

device privacy mode

enum wiced_bt_ble_multi_advert_filtering_policy_e

wiced_bt_ble_multi_advert_filtering_policy_e: Multi-advertisement Filtering policy.

Values:

enumerator MULTI_ADVERT_FILTER_POLICY_NOT_USED

Multi adv filter filter Accept List not used.

enumerator MULTI_ADVERT_FILTER_POLICY_ADV_ALLOW_UNKNOWN_CONNECTION

Multi adv filter filter Accept List for scan request.

enumerator MULTI_ADVERT_FILTER_POLICY_ADV_ALLOW_UNKNOWN_SCANNING

Multi adv filter filter Accept List for connection request.

enumerator MULTI_ADVERT_FILTER_POLICY_USE_FOR_ALL

Multi adv filter filter Accept List for all.

enum [anonymous]

@9: BLE PHY.

Values:

enumerator WICED_BT_BLE_EXT_ADV_PHY_1M

advetiser advertisement PHY is LE 1M

enumerator WICED_BT_BLE_EXT_ADV_PHY_2M

advetiser advertisement PHY is LE 2M

enumerator WICED_BT_BLE_EXT_ADV_PHY_LE_CODED

advetiser advertisement PHY is LE Coded (for long range)

enumerator WICED_BT_BLE_EXT_ADV_NUM_PHYS

3 PHYs are defined

enum [anonymous]

@10: BLE PHY bit mask.

Values:

enumerator WICED_BT_BLE_EXT_ADV_PHY_1M_BIT

Bit mask to specify for LE1M PHY.

enumerator WICED_BT_BLE_EXT_ADV_PHY_2M_BIT

Bit mask to specify for LE2M PHY.

enumerator WICED_BT_BLE_EXT_ADV_PHY_LE_CODED_BIT

Bit mask to specify for LE coded PHY.

enum [anonymous]

@11: Advertising event properties: Describes the type of advertising event that is being configured and its basic properties.

Values:

enumerator WICED_BT_BLE_EXT_ADV_EVENT_CONNECTABLE_ADV

Connectable ADV.

enumerator WICED_BT_BLE_EXT_ADV_EVENT_SCANNABLE_ADV

Scannable ADV.

enumerator WICED_BT_BLE_EXT_ADV_EVENT_DIRECTED_ADV

Low duty cycle directed advertisement.

enumerator WICED_BT_BLE_EXT_ADV_EVENT_HIGH_DUTY_DIRECTED_CONNECTABLE_ADV

3.75 ms Advertising Interval, only valid in legacy ADV

enumerator WICED_BT_BLE_EXT_ADV_EVENT_LEGACY_ADV

Legacy Advertisement.

Adv data cannot be more than 31 bytes.

enumerator WICED_BT_BLE_EXT_ADV_EVENT_ANONYMOUS_ADV

Omits advertisers address from all PDUs.

enumerator WICED_BT_BLE_EXT_ADV_EVENT_INCLUDE_TX_POWER

Include Tx power in ext ADV pdus.

enum [anonymous]

@12: Advertisement set handle to identify adv set b/n host and controller.

Values:

enumerator WICED_BT_BLE_EXT_ADV_HANDLE_MIN

min advertisement set handle value

enumerator WICED_BT_BLE_EXT_ADV_HANDLE_MAX

max advertisement set handle value

enum [anonymous]

@13: The Advertising set identifier(SID) is used to uniquely identify adv sets from advertiser.

SID the value to be transmitted in the advertising SID subfield of the ADI field of the Extended ADV PDUs

Values:

enumerator WICED_BT_BLE_EXT_ADV_SID_MIN

min SID value

enumerator WICED_BT_BLE_EXT_ADV_SID_MAX

max SID value

enum wiced_bt_ble_ext_adv_scan_req_notification_setting_e

wiced_bt_ble_ext_adv_scan_req_notification_setting_e: Value to configure to receive scan request recived notification.

Values:

enumerator WICED_BT_BLE_EXT_ADV_SCAN_REQ_NOTIFY_DISABLE

Do not send Notification on scan request.

enumerator WICED_BT_BLE_EXT_ADV_SCAN_REQ_NOTIFY_ENABLE

Send Notification on scan request.

enum wiced_bt_ble_periodic_adv_prop_e

wiced_bt_ble_periodic_adv_prop_e: Periodic adv property.

Values:

enumerator WICED_BT_BLE_PERIODIC_ADV_PROPERTY_INCLUDE_TX_POWER

Speicify Tx power in periodic adv events.

enum wiced_bt_ble_ext_scan_filter_duplicate_e

wiced_bt_ble_ext_scan_filter_duplicate_e: Extended scan duplicate filter policy.

Values:

enumerator WICED_BT_BLE_EXT_SCAN_FILTER_DUPLICATE_DISABLE

send all advertisements received from advertisers

enumerator WICED_BT_BLE_EXT_SCAN_FILTER_DUPLICATE_ENABLE

duplicate advertisements should not be sent until scan disabled

enumerator WICED_BT_BLE_EXT_SCAN_FILTER_DUPLICATE_ENABLE_RESET_ON_SCAN_PERIOD

filter duplicate adv during single scan Duration (see wiced_bt_ble_ext_scan_enable_t).Period should be non zero on using this option

enum wiced_bt_ble_ext_filter_policy_e

wiced_bt_ble_ext_filter_policy_e: Filter policy used in extended create connection command.

Values:

enumerator WICED_BT_BLE_IGNORE_FILTER_ACCEPT_LIST_FOR_CONNS

Filter Accept List is not used to determine which advertiser to connect to.

Peer_Address_Type and Peer_Address shall be used

enumerator WICED_BT_BLE_USE_FILTER_ACCEPT_LIST_FOR_CONNS

Filter Accept List is used to determine which advertiser to connect to.

Peer_Address_Type and Peer_Address shall be ignored.

enum wiced_bt_ble_adv_sync_options_e

wiced_bt_ble_adv_sync_options_e: Options used in create periodic sync to periodic adv command.

Values:

enumerator WICED_BT_BLE_IGNORE_SYNC_TO_PERIODIC_ADV_LIST

Use the Advertising_SID, Advertising_Address_Type, and Advertising Address parameters specified in create sync command to determine which advertiser to listen to.

enumerator WICED_BT_BLE_SYNC_TO_PERIODIC_ADV_LIST

Use the Periodic Advertiser List to determine which advertiser to listen to.

enum [anonymous]

@14: When controller receives succesfully periodic adv event based on create sync to periodic advertiser command, sync handle get generated by controller and reported in periodic sync established event scanner uniquely identifies periodic adv data from adv reports using this handle and advertismenet set id(SID)

Values:

enumerator PERIODIC_SYNC_HANDLE_MIN
enumerator PERIODIC_SYNC_HANDLE_MAX
enum wiced_bt_ble_ext_adv_report_count_e

wiced_bt_ble_ext_adv_report_count_e: Min and Max possible number of reports in LE extended adv report event.

Values:

enumerator ADV_REP_EVT_COUNT_MIN

min number of reports in LE extended adv report event

enumerator ADV_REP_EVT_COUNT_MAX

max number of reports in LE extended adv report event

enum wiced_bt_ble_advertiser_clock_accuracy_e

wiced_bt_ble_advertiser_clock_accuracy_e: Advertiser clock accuracy.

Values:

enumerator ADVERTISER_CLK_ACCURACY_500PPM
enumerator ADVERTISER_CLK_ACCURACY_250PPM
enumerator ADVERTISER_CLK_ACCURACY_150PPM
enumerator ADVERTISER_CLK_ACCURACY_100PPM
enumerator ADVERTISER_CLK_ACCURACY_75PPM
enumerator ADVERTISER_CLK_ACCURACY_50PPM
enumerator ADVERTISER_CLK_ACCURACY_30PPM
enumerator ADVERTISER_CLK_ACCURACY_20PPM
enum wiced_bt_ble_channel_sel_algo_e

wiced_bt_ble_channel_sel_algo_e: BLE channel selection algorithms.

Values:

enumerator LE_CHANNEL_SEL_ALGO_1_USED

LE channel selection algorithm#1 used.

enumerator LE_CHANNEL_SEL_ALGO_2_USED

LE channel selection algorithm#2 used.

enum wiced_bt_ble_adv_ext_event_t

wiced_bt_ble_adv_ext_event_t: ADV extension events to the application.

Values:

enumerator WICED_BT_BLE_PERIODIC_ADV_SYNC_ESTABLISHED_EVENT

Sync established to periodic advertiser’s periodic advertisement.

Event Data : wiced_bt_ble_periodic_adv_sync_established_event_data_t

enumerator WICED_BT_BLE_PERIODIC_ADV_REPORT_EVENT

Periodic adv report.

Event Data: wiced_bt_ble_periodic_adv_report_event_data_t

enumerator WICED_BT_BLE_PERIODIC_ADV_SYNC_LOST_EVENT

Periodic sync lost event.

Event Data: wiced_bt_ble_periodic_adv_sync_handle_t

enumerator WICED_BT_BLE_ADV_SET_TERMINATED_EVENT

Advertising set terminated becaue either connection being created or adv timeout.

Event data: wiced_bt_ble_ext_adv_set_terminated_event_data_t

enumerator WICED_BT_BLE_SCAN_REQUEST_RECEIVED_EVENT

scan request received event.

Event data: wiced_bt_ble_scan_req_received_event_data_t

enumerator WICED_BT_BLE_CHANNEL_SEL_ALGO_EVENT

LE Channel selected algorithm event.

Event Data: wiced_bt_ble_channel_sel_algo_event_data_t

struct wiced_bt_ble_advert_elem_t
#include <>

Advertisement element.

Public Members

uint8_t *p_data

Advertisement data.

uint16_t len

Advertisement length.

wiced_bt_ble_advert_type_t advert_type

Advertisement data type.

struct wiced_bt_ble_scan_results_t
#include <>

LE inquiry result type.

Public Members

wiced_bool_t is_extended

True if an extended ADV.

wiced_bt_device_address_t remote_bd_addr

Device address.

uint8_t ble_addr_type

LE Address type.

wiced_bt_dev_ble_evt_type_t ble_evt_type

Scan result event type.

int8_t rssi

Set to BTM_INQ_RES_IGNORE_RSSI, if not valid.

uint8_t flag

Adverisement Flag value.

uint8_t primary_phy

Primary PHY.

uint8_t secondary_phy

Secondary PHY.

uint8_t adv_sid

advertisement security ID

uint8_t tx_power

Tx power.

uint16_t periodic_adv_interval

Periodic advertisement interval.

uint8_t direct_addr_type

Directed address type.

wiced_bt_device_address_t direct_bda

Directed address.

struct wiced_bt_ble_phy_preferences_t
#include <>

Host PHY preferences.

Public Members

wiced_bt_device_address_t remote_bd_addr

Peer Device address.

wiced_bt_ble_host_phy_preferences_t tx_phys

Host preference among the TX PHYs.

wiced_bt_ble_host_phy_preferences_t rx_phys

Host preference among the RX PHYs.

wiced_bt_ble_lelr_phy_preferences_t phy_opts

Host preference on LE coded PHY.

struct wiced_bt_ble_conn_params_t
#include <>

BLE connection parameteres.

Public Members

uint8_t role

Connection role 0: Central 1: Peripheral.

uint16_t conn_interval

Connection interval in slots.

uint16_t conn_latency

Connection latency.

uint16_t supervision_timeout

Supervision timeout.

struct wiced_bt_ble_pref_conn_params_t
#include <>

BLE preferred connection parameters.

Public Members

uint16_t conn_interval_min

minimum connection interval

uint16_t conn_interval_max

maximum connection interval

uint16_t conn_latency

connection latency

uint16_t conn_supervision_timeout

connection supervision timeout

struct wiced_bt_ble_multi_adv_params_t
#include <>

LE Multi advertising parameter.

Public Members

uint16_t adv_int_min

< BTM_BLE_ADVERT_INTERVAL_MIN to BTM_BLE_ADVERT_INTERVAL_MAX ( As per spec )

Minimum adv interval BTM_BLE_ADVERT_INTERVAL_MIN to BTM_BLE_ADVERT_INTERVAL_MAX ( As per spec )

uint16_t adv_int_max

Maximum adv interval.

wiced_bt_ble_multi_advert_type_t adv_type

Adv event type.

wiced_bt_ble_advert_chnl_map_t channel_map

Adv channel map.

wiced_bt_ble_advert_filter_policy_t adv_filter_policy

Advertising filter policy.

wiced_bt_ble_adv_tx_power_t adv_tx_power

Adv tx power.

wiced_bt_device_address_t peer_bd_addr

Peer Device address.

wiced_bt_ble_address_type_t peer_addr_type

Peer LE Address type.

wiced_bt_device_address_t own_bd_addr

Own LE address.

wiced_bt_ble_address_type_t own_addr_type

Own LE Address type.

struct wiced_bt_ble_ext_adv_duration_config_t
#include <>

Advertisement duration configuration for specified adv handle.

Public Members

wiced_bt_ble_ext_adv_handle_t adv_handle

advertisement set handle

uint16_t adv_duration

0 = No advertising duration.

Advertising to continue until the Host disables it. 0xXXXX = Range: 0x0001 - 0xFFFF (10 ms to 655,350 ms)

uint8_t max_ext_adv_events

0xXX: Maximum number of extended advertising events the Controller shall attempt to send prior to disabling the extended advertising set even if the adv_duration parameter has not expired.

0x00: No maximum number of advertising events

struct wiced_bt_ble_ext_conn_cfg_t
#include <>

Extended ADV connection configuration structure.

Public Members

wiced_bt_ble_ext_adv_phy_mask_t initiating_phys

< Bit 0 = 1: Scan connectable advertisements on the LE 1M PHY.

Connection parameters for the LE 1M PHY are provided. Bit 1 = 1: Connection parameters for the LE 2M PHY are provided. Bit 2 = 1: Scan connectable advertisements on the LE Coded PHY. Connection parameters for the LE Coded PHY are provided the PHY(s) bit mask on which the advertising packets should be received on the primary advertising channel and the PHYs for which connection parameters have been specified.

uint16_t scan_int[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0004 to 0xFFFF.Time = N * 0.625 ms.

Time Range: 2.5 ms to 40.959375 s

uint16_t scan_window[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0004 to 0xFFFF.Time = N * 0.625 ms.

Time Range: 2.5 ms to 40.959375 s

uint16_t min_conn_int[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0006 to 0x0C80 Time = N * 1.25 ms Time Range: 7.5 ms to 4 s.

uint16_t max_conn_int[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0006 to 0x0C80 Time = N * 1.25 ms Time Range: 7.5 ms to 4 s.

uint16_t conn_latency[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0000 to 0x01F3.

uint16_t supervision_to[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x000A to 0x0C80 Time = N * 10 ms Time Range: 100 ms to 32 s.

uint16_t min_ce_len[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0000 � 0xFFFF.

Time = N * 0.625 ms

uint16_t max_ce_len[WICED_BT_BLE_EXT_ADV_NUM_PHYS]

Range N: 0x0000 � 0xFFFF.

Time = N * 0.625 ms

struct wiced_bt_ble_ext_adv_report_t
#include <>

Extended advertisement report data format.

Note:When multiple advertising packets are used to complete a single advertising report(i.e. if adv set data received as multipl adv reports), the RSSI and TxPower event parameters shall be set based on the last packet received.

Public Members

wiced_bt_ble_adv_report_event_mask_t event_type

Type of the adv.

(See wiced_bt_ble_adv_report_event_mask_t)

wiced_bt_ble_address_type_t addr_type

advertiser address type

wiced_bt_device_address_t bd_addr

advertiser address

wiced_bt_ble_ext_adv_phy_t prim_phy

PHY on which extended ADV PDUs received.

wiced_bt_ble_ext_adv_phy_t sec_phy

PHY on which auxilary ADV PDUs received.

wiced_bt_ble_ext_adv_sid_t adv_sid

advertising set identifier

int8_t tx_pwr

advertisement transmit power

int8_t rssi

advertisement RSSI

uint16_t periodic_adv_int

Interval of the periodic advertisements if periodic adv enabled on the same set.

Range: N = 0x0006 to 0xFFFF, Time = N * 1.25 ms

wiced_bt_ble_address_type_t dir_addr_type

Target device address type in case of directed adv report.

wiced_bt_device_address_t dir_bdaddr

Target device address in case of directed adv report.

uint8_t data_len

adv data length

uint8_t ad_data[]

adv data

struct wiced_bt_ble_periodic_adv_sync_established_event_data_t
#include <>

Sync extablished to periodic advertiser event data format.

(The LE Periodic Advertising Sync Established event indicates that the Controller has received the first periodic advertising packet from an advertiser after the LE_Periodic_Advertising_Create_Sync Command has been sent to the Controller.)

Public Members

uint8_t status

HCI status.

wiced_bt_ble_periodic_adv_sync_handle_t sync_handle

sync handle

wiced_bt_ble_ext_adv_sid_t adv_sid

advertisement set identifier

wiced_bt_ble_address_type_t adv_addr_type

advertiser address type

wiced_bt_device_address_t adv_addr

advertiser address

wiced_bt_ble_ext_adv_phy_t adv_phy

advertiser phy

uint16_t periodic_adv_int

Periodic adv interval.

wiced_bt_ble_advertiser_clock_accuracy_t advertiser_clock_accuracy

advertiser clock accuracy

struct wiced_bt_ble_periodic_adv_report_event_data_t
#include <>

Periodic advertising report data format.

Public Members

wiced_bt_ble_periodic_adv_sync_handle_t sync_handle

sync handle

int8_t adv_tx_power

advertisement transmit power Range: -127 to +126 dbm.

127 means tx power is not available

int8_t adv_rssi

RSSI.

range: -127 to +126. 127 means RSSI is not available

uint8_t cte_type

CTE Type.

uint8_t data_status

0 = complete data, 1 = data incomplete more data to come, 2 = data truncated.other RFU

uint8_t data_len

Range: 0 -248.

Other values RFU

uint8_t adv_data[WICED_BT_BLE_MAX_EXT_ADV_DATA_LEN]

periodic adv data

struct wiced_bt_ble_ext_adv_set_terminated_event_data_t
#include <>

extended adv set terminated event data format.

This event generated asynchronously by the controller when adv set get terminated either adv duration expires or connection being created

Public Members

uint8_t status

HCI status.

wiced_bt_ble_ext_adv_handle_t adv_handle

advertisement set handle

wiced_bt_ble_connection_handle_t conn_handle

connection handle.

The conn_handle parameter is only valid when advertising ends because a connection was created

uint8_t num_completed_ext_adv_events

number of completed extended advertising events the Controller had transmitted when either the duration elapsed or the maximum number of extended advertising events was reached; otherwise it shall be set to zero.

struct wiced_bt_ble_scan_req_received_event_data_t
#include <>

scan request received event data format

Public Members

wiced_bt_ble_ext_adv_handle_t adv_handle

advertisement set handle

wiced_bt_ble_address_type_t scanner_addr_type

Scanner address type.

wiced_bt_device_address_t scanner_address

Scanner address.

struct wiced_bt_ble_channel_sel_algo_event_data_t
#include <>

Channel selection algorithm event data format.

Public Members

wiced_bt_ble_connection_handle_t connection_handle

HCI connection handle.

wiced_bt_ble_channel_sel_algo_t channel_sel_algo

BLE channel selection algorithm used for this connection.

union wiced_bt_ble_adv_ext_event_data_t
#include <>

union of events data

Public Members

wiced_bt_ble_periodic_adv_sync_established_event_data_t sync_establish

Data for WICED_BT_BLE_PERIODIC_ADV_SYNC_ESTABLISHED_EVENT.

wiced_bt_ble_periodic_adv_report_event_data_t periodic_adv_report

Data for WICED_BT_BLE_PERIODIC_ADV_REPORT_EVENT.

wiced_bt_ble_periodic_adv_sync_handle_t sync_handle

Data for WICED_BT_BLE_PERIODIC_ADV_SYNC_LOST_EVENT.

wiced_bt_ble_ext_adv_set_terminated_event_data_t adv_set_terminated

Data for WICED_BT_BLE_ADV_SET_TERMINATED_EVENT.

wiced_bt_ble_scan_req_received_event_data_t scan_req_received

Data for WICED_BT_BLE_SCAN_REQUEST_RECEIVED_EVENT.

wiced_bt_ble_channel_sel_algo_event_data_t channel_sel_algo

Data for WICED_BT_BLE_CHANNEL_SEL_ALGO_EVENT.

struct wiced_bt_ble_ext_scan_config_t
#include <>

Configuration for extended scanning.

Public Members

wiced_bt_ble_ext_adv_phy_mask_t scanning_phys

The Scanning_PHYs parameter indicates the PHY(s) on which the advertising packets should be received on the primary advertising channel.

uint8_t enc_phy_scan_type

encoded phy scan type.

(active or passive)

uint16_t enc_phy_scan_int

encoded phy scan interval

uint16_t enc_phy_scan_win

encoded phy scan window

uint16_t duration

When the Duration and Period parameters are non-zero, the Controller shall scan for the duration of the Duration parameter within a scan period specified by the Period parameter.

After the scan period has expired, a new scan period shall begin and scanning shall begin again for the duration specified. The scan periods continue until the Host disables scanning. Duration parameter cannot be greater than or equal to the Period parameter If the Duration parameter is zero or both the Duration parameter and Period parameter are non-zero controller continue scanning until host disable scanning with enable set to false Scan duration

uint16_t period

Scan period.