Bluetooth Low Energy

Modules
	Advertisement & Scan
	This section provides functions for LE advertisement and LE scan operations.
	Connection and Filter Accept List
	This section provides functions for LE connection related and Filter Accept List operations.
	LE Isochronous Channels
	This section describes the API's to use ISOC functionality.
	Macros
	MultiAdv
	This section describes Multiple Advertisement API, using this interface application can enable more than one advertisement train.
	Phy
	This section provides functionality to read and update PHY.
	Struct

Macros
#define	WICED_BT_BLE_MAX_EXT_ADV_DATA_LEN   251
	ADV extension structures.

Typedefs
typedef uint8_t	wiced_bt_ble_host_phy_preferences_t
	Host preferences on PHY. More...
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. More...
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
	LE advertisement type (see wiced_bt_ble_multi_advert_type_e)
typedef uint8_t	wiced_bt_ble_privacy_mode_t
	LE Privacy mode. More...
typedef uint8_t	wiced_bt_ble_multi_advert_filtering_policy_t
	LE advertisement filtering policy (see wiced_bt_ble_multi_advert_filtering_policy_e)
typedef 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. More...
typedef 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. More...
typedef uint8_t	wiced_bt_ble_ext_adv_phy_t
	LE phy to be used for extended advertisement.
typedef uint8_t	wiced_bt_ble_ext_adv_phy_mask_t
	LE phy mask to be used for extended advertisement.
typedef uint16_t	wiced_bt_ble_ext_adv_event_property_t
	LE 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. More...
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 uint8_t	wiced_bt_ble_periodic_adv_sync_transfer_mode_t
	Mode used in create periodic sync to periodic adv command (see wiced_bt_ble_periodic_adv_sync_transfer_mode_e)
typedef uint16_t	wiced_bt_ble_periodic_adv_sync_handle_t
	Sync_Handle to be used to identify the periodic advertiser. More...
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. More...
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 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. More...

Enumerations
enum	wiced_bt_ble_multi_advert_start_e { MULTI_ADVERT_STOP = 0x00, MULTI_ADVERT_START = 0x01 }
	Multi-advertisement start/stop. More...
enum	wiced_bt_ble_multi_advert_type_e {   MULTI_ADVERT_CONNECTABLE_UNDIRECT_EVENT = 0x00, MULTI_ADVERT_CONNECTABLE_DIRECT_EVENT = 0x01, MULTI_ADVERT_DISCOVERABLE_EVENT = 0x02, MULTI_ADVERT_NONCONNECTABLE_EVENT = 0x03,   MULTI_ADVERT_LOW_DUTY_CYCLE_DIRECT_EVENT = 0x04 }
	Multi-advertisement type. More...
enum	wiced_bt_ble_privacy_e { BTM_BLE_PRIVACY_MODE_NETWORK, BTM_BLE_PRIVACY_MODE_DEVICE }
	Privacy mode refer Spec version 5.0 Vol 3 Part C Section 10.7 privacy feature. More...
enum	wiced_bt_ble_multi_advert_filtering_policy_e { MULTI_ADVERT_FILTER_POLICY_NOT_USED = 0x00, MULTI_ADVERT_FILTER_POLICY_ADV_ALLOW_UNKNOWN_CONNECTION = 0x01, MULTI_ADVERT_FILTER_POLICY_ADV_ALLOW_UNKNOWN_SCANNING = 0x02, MULTI_ADVERT_FILTER_POLICY_USE_FOR_ALL = 0x03 }
	Multi-advertisement Filtering policy. More...
enum	{ WICED_BT_BLE_EXT_ADV_PHY_1M = 0x1, WICED_BT_BLE_EXT_ADV_PHY_2M = 0x2, WICED_BT_BLE_EXT_ADV_PHY_LE_CODED = 0x3, WICED_BT_BLE_EXT_ADV_NUM_PHYS = 0x3 }
	LE PHY. More...
enum	{ WICED_BT_BLE_EXT_ADV_PHY_1M_BIT = (1 << 0), WICED_BT_BLE_EXT_ADV_PHY_2M_BIT = (1 << 1), WICED_BT_BLE_EXT_ADV_PHY_LE_CODED_BIT = (1 << 2) }
	LE PHY bit mask. More...
enum	{   WICED_BT_BLE_EXT_ADV_EVENT_CONNECTABLE_ADV = (1 << 0), WICED_BT_BLE_EXT_ADV_EVENT_SCANNABLE_ADV = (1 << 1), WICED_BT_BLE_EXT_ADV_EVENT_DIRECTED_ADV = (1 << 2), WICED_BT_BLE_EXT_ADV_EVENT_HIGH_DUTY_DIRECTED_CONNECTABLE_ADV = (1 << 3),   WICED_BT_BLE_EXT_ADV_EVENT_LEGACY_ADV = (1 << 4), WICED_BT_BLE_EXT_ADV_EVENT_ANONYMOUS_ADV = (1 << 5), WICED_BT_BLE_EXT_ADV_EVENT_INCLUDE_TX_POWER = (1 << 6) }
	Advertising event properties: Describes the type of advertising event that is being configured and its basic properties. More...
enum	{ WICED_BT_BLE_EXT_ADV_HANDLE_MIN = 0x00, WICED_BT_BLE_EXT_ADV_HANDLE_MAX = 0xef }
	Advertisement set handle to identify adv set b/n host and controller. More...
enum	{ WICED_BT_BLE_EXT_ADV_SID_MIN = 0x00, WICED_BT_BLE_EXT_ADV_SID_MAX = 0x0f }
	The Advertising set identifier(SID) is used to uniquely identify adv sets from advertiser. More...
enum	wiced_bt_ble_ext_adv_scan_req_notification_setting_e { WICED_BT_BLE_EXT_ADV_SCAN_REQ_NOTIFY_DISABLE = 0x00, WICED_BT_BLE_EXT_ADV_SCAN_REQ_NOTIFY_ENABLE = 0x01 }
	Value to configure to receive scan request recived notification. More...
enum	wiced_bt_ble_periodic_adv_prop_e { WICED_BT_BLE_PERIODIC_ADV_PROPERTY_INCLUDE_TX_POWER = (1 << 6) }
	Periodic adv property. More...
enum	wiced_bt_ble_ext_scan_filter_duplicate_e { WICED_BT_BLE_EXT_SCAN_FILTER_DUPLICATE_DISABLE, WICED_BT_BLE_EXT_SCAN_FILTER_DUPLICATE_ENABLE, WICED_BT_BLE_EXT_SCAN_FILTER_DUPLICATE_ENABLE_RESET_ON_SCAN_PERIOD }
	Extended scan duplicate filter policy. More...
enum	wiced_bt_ble_ext_filter_policy_e { WICED_BT_BLE_IGNORE_FILTER_ACCEPT_LIST_FOR_CONNS = 0, WICED_BT_BLE_USE_FILTER_ACCEPT_LIST_FOR_CONNS = 1 }
	Filter policy used in extended create connection command. More...
enum	wiced_bt_ble_adv_sync_options_e { WICED_BT_BLE_IGNORE_SYNC_TO_PERIODIC_ADV_LIST, WICED_BT_BLE_SYNC_TO_PERIODIC_ADV_LIST = 1 }
	Options used in create periodic sync to periodic adv command. More...
enum	wiced_bt_ble_periodic_adv_sync_transfer_mode_e { WICED_BT_BLE_IGNORE_PA_SYNC_TRANSFER_EVT, WICED_BT_BLE_ENABLE_PA_SYNC_TRANSFER_DISABLE_PA_REPORT_EVT, WICED_BT_BLE_ENABLE_PA_SYNC_TRANSFER_ENABLE_PA_REPORT_EVT }
	Mode used in Periodic Advertising Sync Transfer Parameters. More...
enum	{ PERIODIC_SYNC_HANDLE_MIN = 0, PERIODIC_SYNC_HANDLE_MAX = 0x0EFF }
	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)
enum	wiced_bt_ble_ext_adv_report_count_e { ADV_REP_EVT_COUNT_MIN = 1, ADV_REP_EVT_COUNT_MAX = 10 }
	Min and Max possible number of reports in LE extended adv report event. More...
enum	wiced_bt_ble_advertiser_clock_accuracy_e {   ADVERTISER_CLK_ACCURACY_500PPM, ADVERTISER_CLK_ACCURACY_250PPM, ADVERTISER_CLK_ACCURACY_150PPM, ADVERTISER_CLK_ACCURACY_100PPM,   ADVERTISER_CLK_ACCURACY_75PPM, ADVERTISER_CLK_ACCURACY_50PPM, ADVERTISER_CLK_ACCURACY_30PPM, ADVERTISER_CLK_ACCURACY_20PPM }
	Advertiser clock accuracy.

Detailed Description

Typedef Documentation

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

event	: Event type (see wiced_bt_ble_adv_ext_event_t)
p_data	: Event data (see wiced_bt_ble_adv_ext_event_data_t)

Returns

Nothing

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_filter_policy_t

Filter policy used.

(see wiced_bt_ble_ext_filter_policy_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 uint16_t wiced_bt_ble_periodic_adv_sync_handle_t

Sync_Handle to be used to identify the periodic advertiser.

Range: 0x0000-0x0EFF

typedef uint8_t wiced_bt_ble_privacy_mode_t

LE Privacy mode.

Refer wiced_bt_ble_privacy_e

typedef 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 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

p_scan_result	: scan result data (NULL indicates end of scanning)
p_adv_data	: Advertisement data (parse using wiced_bt_ble_check_advertising_data)

Returns

Nothing

Enumeration Type Documentation

anonymous enum

LE PHY.

Enumerator
WICED_BT_BLE_EXT_ADV_PHY_1M	advetiser advertisement PHY is LE 1M
WICED_BT_BLE_EXT_ADV_PHY_2M	advetiser advertisement PHY is LE 2M
WICED_BT_BLE_EXT_ADV_PHY_LE_CODED	advetiser advertisement PHY is LE Coded (for long range)
WICED_BT_BLE_EXT_ADV_NUM_PHYS	3 PHYs are defined

anonymous enum

LE PHY bit mask.

Enumerator
WICED_BT_BLE_EXT_ADV_PHY_1M_BIT	Bit mask to specify for LE1M PHY.
WICED_BT_BLE_EXT_ADV_PHY_2M_BIT	Bit mask to specify for LE2M PHY.
WICED_BT_BLE_EXT_ADV_PHY_LE_CODED_BIT	Bit mask to specify for LE coded PHY.

anonymous enum

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

Enumerator
WICED_BT_BLE_EXT_ADV_EVENT_CONNECTABLE_ADV	Connectable ADV.
WICED_BT_BLE_EXT_ADV_EVENT_SCANNABLE_ADV	Scannable ADV.
WICED_BT_BLE_EXT_ADV_EVENT_DIRECTED_ADV	Low duty cycle directed advertisement.
WICED_BT_BLE_EXT_ADV_EVENT_HIGH_DUTY_DIRECTED_CONNECTABLE_ADV	3.75 ms Advertising Interval, only valid in legacy ADV
WICED_BT_BLE_EXT_ADV_EVENT_LEGACY_ADV	Legacy Advertisement. Adv data cannot be more than 31 bytes.
WICED_BT_BLE_EXT_ADV_EVENT_ANONYMOUS_ADV	Omits advertisers address from all PDUs.
WICED_BT_BLE_EXT_ADV_EVENT_INCLUDE_TX_POWER	Include Tx power in ext ADV pdus.

anonymous enum

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

Enumerator
WICED_BT_BLE_EXT_ADV_HANDLE_MIN	min advertisement set handle value
WICED_BT_BLE_EXT_ADV_HANDLE_MAX	max advertisement set handle value

anonymous enum

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

Enumerator
WICED_BT_BLE_EXT_ADV_SID_MIN	min SID value
WICED_BT_BLE_EXT_ADV_SID_MAX	max SID value

enum wiced_bt_ble_adv_sync_options_e

Options used in create periodic sync to periodic adv command.

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.
WICED_BT_BLE_SYNC_TO_PERIODIC_ADV_LIST	Use the Periodic Advertiser List to determine which advertiser to listen to.

enum wiced_bt_ble_ext_adv_report_count_e

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

Enumerator
ADV_REP_EVT_COUNT_MIN	min number of reports in LE extended adv report event
ADV_REP_EVT_COUNT_MAX	max number of reports in LE extended adv report event

enum wiced_bt_ble_ext_adv_scan_req_notification_setting_e

Value to configure to receive scan request recived notification.

Enumerator
WICED_BT_BLE_EXT_ADV_SCAN_REQ_NOTIFY_DISABLE	Do not send Notification on scan request.
WICED_BT_BLE_EXT_ADV_SCAN_REQ_NOTIFY_ENABLE	Send Notification on scan request.

enum wiced_bt_ble_ext_filter_policy_e

Filter policy used in extended create connection command.

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
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_ext_scan_filter_duplicate_e

Extended scan duplicate filter policy.

Enumerator
WICED_BT_BLE_EXT_SCAN_FILTER_DUPLICATE_DISABLE	send all advertisements received from advertisers
WICED_BT_BLE_EXT_SCAN_FILTER_DUPLICATE_ENABLE	duplicate advertisements should not be sent until scan disabled
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_multi_advert_filtering_policy_e

Multi-advertisement Filtering policy.

Enumerator
MULTI_ADVERT_FILTER_POLICY_NOT_USED	Multi adv filter filter Accept List not used.
MULTI_ADVERT_FILTER_POLICY_ADV_ALLOW_UNKNOWN_CONNECTION	Multi adv filter filter Accept List for scan request.
MULTI_ADVERT_FILTER_POLICY_ADV_ALLOW_UNKNOWN_SCANNING	Multi adv filter filter Accept List for connection request.
MULTI_ADVERT_FILTER_POLICY_USE_FOR_ALL	Multi adv filter filter Accept List for all.

enum wiced_bt_ble_multi_advert_start_e

Multi-advertisement start/stop.

Enumerator
MULTI_ADVERT_STOP	Stop Multi-adverstisment.
MULTI_ADVERT_START	Start Multi-adverstisment.

enum wiced_bt_ble_multi_advert_type_e

Multi-advertisement type.

Enumerator
MULTI_ADVERT_CONNECTABLE_UNDIRECT_EVENT	Multi adv Connectable undirected event.
MULTI_ADVERT_CONNECTABLE_DIRECT_EVENT	Multi adv Connectable directed event.
MULTI_ADVERT_DISCOVERABLE_EVENT	Multi adv Discoverable event.
MULTI_ADVERT_NONCONNECTABLE_EVENT	Multi adv NonConnectable event.
MULTI_ADVERT_LOW_DUTY_CYCLE_DIRECT_EVENT	Multi adv Low Cycle directed event.

enum wiced_bt_ble_periodic_adv_prop_e

Periodic adv property.

Enumerator
WICED_BT_BLE_PERIODIC_ADV_PROPERTY_INCLUDE_TX_POWER	Speicify Tx power in periodic adv events.

enum wiced_bt_ble_periodic_adv_sync_transfer_mode_e

Mode used in Periodic Advertising Sync Transfer Parameters.

Enumerator
WICED_BT_BLE_IGNORE_PA_SYNC_TRANSFER_EVT	No attempt is made to synchronize to the periodic advertising and no HCI_LE_Periodic_Advertising_Sync_Transfer_Received event is sent to the Host (default).
WICED_BT_BLE_ENABLE_PA_SYNC_TRANSFER_DISABLE_PA_REPORT_EVT	An HCI_LE_Periodic_Advertising_Sync_Transfer_Received event is sent to the Host. HCI_LE_Periodic_Advertising_Report events will be disabled.
WICED_BT_BLE_ENABLE_PA_SYNC_TRANSFER_ENABLE_PA_REPORT_EVT	An HCI_LE_Periodic_Advertising_Sync_Transfer_Received event is sent to the Host. HCI_LE_Periodic_Advertising_Report events will be enabled.

enum wiced_bt_ble_privacy_e

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

Enumerator
BTM_BLE_PRIVACY_MODE_NETWORK	network privacy mode
BTM_BLE_PRIVACY_MODE_DEVICE	device privacy mode