# GAP API

[English]

## 应用示例

- bluetooth/bluedroid/ble/gatt_security_client 演示使用 ESP 低功耗蓝牙 security API，ESP32-C3 作为 GATT 客户端时如何建立安全连接并加密与对等设备的通信。

- bluetooth/bluedroid/ble/gatt_security_server 演示使用 ESP 低功耗蓝牙 security API，ESP32-C3 作为 GATT 服务器时如何建立安全连接并加密与对等设备的通信。

## API 参考

### Header File

- components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h

- This header file can be included with:

  >     #include "esp_gap_ble_api.h"

- This header file is a part of the API provided by the `bt` component. To declare that your component depends on `bt`, add the following to your CMakeLists.txt:

  >     REQUIRES bt

  > or

  >     PRIV_REQUIRES bt

### Functions

esp_err_t esp_ble_gap_register_callback(esp_gap_ble_cb_t callback)

  This function is called to occur gap event, such as scan result.

  备注

  Do NOT perform time-consuming operations in the callback. Time-consuming operations include: taking semaphores that may block for a long time (e.g. xSemaphoreTake with long timeout or portMAX_DELAY), blocking delays (e.g. vTaskDelay), and flash read/write/erase. Such operations may block the Bluetooth stack and lead to instability or deadlock. Defer heavy work to a separate task if needed.

  参数:

    callback -- [in] callback function

  返回:

    - ESP_OK : success

    - other : failed

esp_gap_ble_cb_t esp_ble_gap_get_callback(void)

  This function is called to get the current gap callback.

  返回:

    - esp_gap_ble_cb_t : callback function

esp_err_t esp_ble_gap_config_adv_data(esp_ble_adv_data_t *adv_data)

  This function is called to override the BTA default ADV parameters.

  参数:

    adv_data -- [in] Pointer to User defined ADV data structure. This memory space can not be freed until callback of config_adv_data is received.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_scan_params(esp_ble_scan_params_t *scan_params)

  This function is called to set scan parameters.

  参数:

    scan_params -- [in] Pointer to User defined scan_params data structure. This memory space can not be freed until callback of set_scan_params

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_start_scanning(uint32_t duration)

  This procedure keep the device scanning the peer device which advertising on the air.

  参数:

    duration -- [in] The scanning duration in seconds. Set to 0 for continuous scanning until explicitly stopped.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_stop_scanning(void)

  This function call to stop the device scanning the peer device which advertising on the air.

  返回:

    - ESP_OK : success

      - other : failed

esp_err_t esp_ble_gap_start_advertising(esp_ble_adv_params_t *adv_params)

  This function is called to start advertising.

  参数:

    adv_params -- [in] pointer to User defined adv_params data structure.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_stop_advertising(void)

  This function is called to stop advertising.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_update_conn_params(esp_ble_conn_update_params_t *params)

  Update connection parameters, can only be used when connection is up.

  参数:

    params -- [in] - connection update parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_pkt_data_len(esp_bd_addr_t remote_device, uint16_t tx_data_length)

  This function is to set maximum LE data packet size.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_rand_addr(esp_bd_addr_t rand_addr)

  This function allows configuring either a Non-Resolvable Private Address or a Static Random Address.

  参数:

    rand_addr -- [in] The address to be configured. Refer to the table below for possible address subtypes:

                  | address [47:46] | Address Type                | Corresponding API                      |
                  |-----------------|-----------------------------|----------------------------------------|
                  |      0b00       | Non-Resolvable Private      | esp_ble_gap_addr_create_nrpa           |
                  |                 | Address (NRPA)              |                                        |
                  |-----------------|-----------------------------|----------------------------------------|
                  |      0b11       | Static Random Address       | esp_ble_gap_addr_create_static         |
                  |-----------------|-----------------------------|----------------------------------------|

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_addr_create_static(esp_bd_addr_t rand_addr)

  Create a static device address.

  参数:

    rand_addr -- [out] Pointer to the buffer where the static device address will be stored.

  返回:

    - ESP_OK : Success

    - Other : Failed

esp_err_t esp_ble_gap_addr_create_nrpa(esp_bd_addr_t rand_addr)

  Create a non-resolvable private address (NRPA)

  参数:

    rand_addr -- [out] Pointer to the buffer where the NRPA will be stored.

  返回:

    - ESP_OK : Success

    - Other : Failed

esp_err_t esp_ble_gap_set_resolvable_private_address_timeout(uint16_t rpa_timeout)

  This function sets the length of time the Controller uses a Resolvable Private Address before generating and starting to use a new resolvable private address.

  备注

  Note: This function is currently not supported on the ESP32 but will be enabled in a future update.

  参数:

    rpa_timeout -- [in] The timeout duration in seconds for how long a Resolvable Private Address is used before a new one is generated. The value must be within the range specified by the Bluetooth specification (0x0001 to 0x0E10), which corresponds to a time range of 1 second to 1 hour. The default value is 0x0384 (900 seconds or 15 minutes).

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_add_device_to_resolving_list(esp_bd_addr_t peer_addr, uint8_t addr_type, uint8_t *peer_irk)

  This function adds a device to the resolving list used to generate and resolve Resolvable Private Addresses in the Controller.

  备注

  Note: This function shall not be used when address resolution is enabled in the Controller and:

  - Advertising (other than periodic advertising) is enabled,

  - Scanning is enabled, or

  - an HCI_LE_Create_Connection, HCI_LE_Extended_Create_Connection, or HCI_LE_Periodic_Advertising_Create_Sync command is pending. This command may be used at any time when address resolution is disabled in the Controller. The added device shall be set to Network Privacy mode.

  参数:

    - peer_addr -- [in] The peer identity address of the device to be added to the resolving list.

    - addr_type -- [in] The address type of the peer identity address (BLE_ADDR_TYPE_PUBLIC or BLE_ADDR_TYPE_RANDOM).

    - peer_irk -- [in] The Identity Resolving Key (IRK) of the device.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_clear_rand_addr(void)

  This function clears the random address for the application.

  备注

  This function shall not be used when:

  - Advertising is enabled,

  - Scanning is enabled, or

  - any LE connection exists / a create connection command is pending.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_config_local_privacy(bool privacy_enable)

  Enable/disable privacy (including address resolution) on the local device.

  参数:

    privacy_enable -- [in] - enable/disable privacy on remote device.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_config_local_icon(uint16_t icon)

  Set the local GAP appearance icon.

  For a complete list of valid appearance values, please refer to "2.6.2 Appearance Category ranges" at: https://www.bluetooth.com/specifications/assigned-numbers/

  备注

  This API does not restrict the input icon value. If an undefined or incorrect icon value is used, the device icon may not display properly.

  参数:

    icon -- [in] - External appearance value (16-bit), as defined by the Bluetooth SIG.

  返回:

    - ESP_OK : Success

    - ESP_FAIL : Internal failure

esp_err_t esp_ble_gap_update_whitelist(bool add_remove, esp_bd_addr_t remote_bda, esp_ble_wl_addr_type_t wl_addr_type)

  Add or remove device from white list.

  参数:

    - add_remove -- [in] the value is true if added the ble device to the white list, and false remove to the white list.

    - remote_bda -- [in] the remote device address add/remove from the white list.

    - wl_addr_type -- [in] whitelist address type

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_clear_whitelist(void)

  Clear all white list.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_get_whitelist_size(uint16_t *length)

  Get the whitelist size in the controller Note: This API returns a constant value indicating the maximum number of whitelists supported by the controller.

  参数:

    length -- [out] the white list length.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_prefer_conn_params(esp_bd_addr_t bd_addr, uint16_t min_conn_int, uint16_t max_conn_int, uint16_t slave_latency, uint16_t supervision_tout)

  This function is called to set the preferred connection parameters when default connection parameter is not desired before connecting. This API can only be used in the master role.

  参数:

    - bd_addr -- [in] BD address of the peripheral

    - min_conn_int -- [in] minimum preferred connection interval

    - max_conn_int -- [in] maximum preferred connection interval

    - slave_latency -- [in] preferred slave latency

    - supervision_tout -- [in] preferred supervision timeout

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_device_name(const char *name)

  Set device name to the local device Note: This API don't affect the advertising data.

  参数:

    name -- [in] - device name.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_get_device_name(void)

  Get device name of the local device.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_get_local_used_addr(esp_bd_addr_t local_used_addr, uint8_t *addr_type)

  This function is called to get local used address and address type. uint8_t *esp_bt_dev_get_address(void) get the public address.

  参数:

    - local_used_addr -- [in] - current local used ble address (six bytes)

    - addr_type -- [in] - ble address type

  返回:

    - ESP_OK : success

    - other : failed

uint8_t *esp_ble_resolve_adv_data_by_type(uint8_t *adv_data, uint16_t adv_data_len, esp_ble_adv_data_type type, uint8_t *length)

  This function is called to get ADV data for a specific type.

  备注

  This is the recommended function to use for resolving ADV data by type. It improves upon the deprecated `esp_ble_resolve_adv_data` function by including an additional parameter to specify the length of the ADV data, thereby offering better safety and reliability.

  参数:

    - adv_data -- [in] - pointer of ADV data which to be resolved

    - adv_data_len -- [in] - the length of ADV data which to be resolved.

    - type -- [in] - finding ADV data type

    - length -- [out] - return the length of ADV data not including type

  返回:

    pointer of ADV data

uint8_t *esp_ble_resolve_adv_data(uint8_t *adv_data, uint8_t type, uint8_t *length)

  This function is called to get ADV data for a specific type.

  备注

  This function has been deprecated and will be removed in a future release. Please use `esp_ble_resolve_adv_data_by_type` instead, which provides better parameter validation and supports more accurate data resolution.

  参数:

    - adv_data -- [in] - pointer of ADV data which to be resolved

    - type -- [in] - finding ADV data type

    - length -- [out] - return the length of ADV data not including type

  返回:

    pointer of ADV data

esp_err_t esp_ble_gap_config_adv_data_raw(uint8_t *raw_data, uint32_t raw_data_len)

  This function is called to set raw advertising data. User need to fill ADV data by self.

  参数:

    - raw_data -- [in] : raw advertising data with the format: [Length 1][Data Type 1][Data 1][Length 2][Data Type 2][Data 2] ...

    - raw_data_len -- [in] : raw advertising data length , less than 31 bytes

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_config_scan_rsp_data_raw(uint8_t *raw_data, uint32_t raw_data_len)

  This function is called to set raw scan response data. User need to fill scan response data by self.

  参数:

    - raw_data -- [in] : raw scan response data

    - raw_data_len -- [in] : raw scan response data length , less than 31 bytes

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_read_rssi(esp_bd_addr_t remote_addr)

  This function is called to read the RSSI of remote device. The address of link policy results are returned in the gap callback function with ESP_GAP_BLE_READ_RSSI_COMPLETE_EVT event.

  参数:

    remote_addr -- [in] : The remote connection device address.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_add_duplicate_scan_exceptional_device(esp_ble_duplicate_exceptional_info_type_t type, esp_duplicate_info_t device_info)

  This function is called to add a device info into the duplicate scan exceptional list.

  参数:

    - type -- [in] device info type, it is defined in esp_ble_duplicate_exceptional_info_type_t when type is MESH_BEACON_TYPE, MESH_PROV_SRV_ADV or MESH_PROXY_SRV_ADV , device_info is invalid.

    - device_info -- [in] the device information.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_remove_duplicate_scan_exceptional_device(esp_ble_duplicate_exceptional_info_type_t type, esp_duplicate_info_t device_info)

  This function is called to remove a device info from the duplicate scan exceptional list.

  参数:

    - type -- [in] device info type, it is defined in esp_ble_duplicate_exceptional_info_type_t when type is MESH_BEACON_TYPE, MESH_PROV_SRV_ADV or MESH_PROXY_SRV_ADV , device_info is invalid.

    - device_info -- [in] the device information.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_clean_duplicate_scan_exceptional_list(esp_duplicate_scan_exceptional_list_type_t list_type)

  This function is called to clean the duplicate scan exceptional list. This API will delete all device information in the duplicate scan exceptional list.

  参数:

    list_type -- [in] duplicate scan exceptional list type, the value can be one or more of esp_duplicate_scan_exceptional_list_type_t.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_security_param(esp_ble_sm_param_t param_type, void *value, uint8_t len)

  Set a GAP security parameter value. Overrides the default value.

                     Secure connection is highly recommended to avoid some major
                     vulnerabilities like 'Impersonation in the Pin Pairing Protocol'
                     (CVE-2020-26555) and 'Authentication of the LE Legacy Pairing
                     Protocol'.

                     To accept only `secure connection mode`, it is necessary do as following:

                     1. Set bit `ESP_LE_AUTH_REQ_SC_ONLY` (`param_type` is
                     `ESP_BLE_SM_AUTHEN_REQ_MODE`), bit `ESP_LE_AUTH_BOND` and bit
                     `ESP_LE_AUTH_REQ_MITM` is optional as required.

                     2. Set to `ESP_BLE_ONLY_ACCEPT_SPECIFIED_AUTH_ENABLE` (`param_type` is
                     `ESP_BLE_SM_ONLY_ACCEPT_SPECIFIED_SEC_AUTH`).

  参数:

    - param_type -- [in] : the type of the param which to be set

    - value -- [in] : the param value

    - len -- [in] : the length of the param value

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_security_rsp(esp_bd_addr_t bd_addr, bool accept)

  Grant security request access.

  参数:

    - bd_addr -- [in] : BD address of the peer

    - accept -- [in] : accept the security request or not

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_set_encryption(esp_bd_addr_t bd_addr, esp_ble_sec_act_t sec_act)

  Set a gap parameter value. Use this function to change the default GAP parameter values.

  参数:

    - bd_addr -- [in] : the address of the peer device need to encryption

    - sec_act -- [in] : This is the security action to indicate what kind of BLE security level is required for the BLE link if the BLE is supported

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_passkey_reply(esp_bd_addr_t bd_addr, bool accept, uint32_t passkey)

  Reply the key value to the peer device in the legacy connection stage.

  参数:

    - bd_addr -- [in] : BD address of the peer

    - accept -- [in] : passkey entry successful or declined.

    - passkey -- [in] : passkey value, must be a 6 digit number, can be lead by 0.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_confirm_reply(esp_bd_addr_t bd_addr, bool accept)

  Reply the confirm value to the peer device in the secure connection stage.

  参数:

    - bd_addr -- [in] : BD address of the peer device

    - accept -- [in] : numbers to compare are the same or different.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_remove_bond_device(esp_bd_addr_t bd_addr)

  Removes a device from the security database list of peer device. It manages unpairing event while connected.

  参数:

    bd_addr -- [in] : BD address of the peer device

  返回:

    - ESP_OK : success

    - other : failed

int esp_ble_get_bond_device_num(void)

  Get the device number from the security database list of peer device. It will return the device bonded number immediately.

  返回:

    - >= 0 : bonded devices number.

    - ESP_FAIL : failed

esp_err_t esp_ble_get_bond_device_list(int *dev_num, esp_ble_bond_dev_t *dev_list)

  Get the device from the security database list of peer device. It will return the device bonded information immediately.

  参数:

    - dev_num -- [inout] Indicate the dev_list array(buffer) size as input. If dev_num is large enough, it means the actual number as output. Suggest that dev_num value equal to esp_ble_get_bond_device_num().

    - dev_list -- [out] an array(buffer) of `esp_ble_bond_dev_t` type. Use for storing the bonded devices address. The dev_list should be allocated by who call this API.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_oob_req_reply(esp_bd_addr_t bd_addr, uint8_t *TK, uint8_t len)

  This function is called to provide the OOB data for SMP in response to ESP_GAP_BLE_OOB_REQ_EVT.

  参数:

    - bd_addr -- [in] BD address of the peer device.

    - TK -- [in] Temporary Key value, the TK value shall be a 128-bit random number

    - len -- [in] length of temporary key, should always be 128-bit

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_sc_oob_req_reply(esp_bd_addr_t bd_addr, uint8_t p_c[16], uint8_t p_r[16])

  This function is called to provide the OOB data for SMP in response to ESP_GAP_BLE_SC_OOB_REQ_EVT.

  参数:

    - bd_addr -- [in] BD address of the peer device.

    - p_c -- [in] Confirmation value, it shall be a 128-bit random number

    - p_r -- [in] Randomizer value, it should be a 128-bit random number

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_create_sc_oob_data(void)

  This function is called to create the OOB data for SMP when secure connection.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_get_local_irk(uint8_t local_irk[16])

  Get the local Identity Resolving Key (IRK).

  备注

  This API retrieves the local IRK stored in the device's security database. The IRK is used by the controller to generate and resolve Resolvable Private Addresses (RPA). The IRK length is always 16 bytes (ESP_BT_OCTET16_LEN).

  备注

  Usage Restrictions: Do NOT call this API during a disconnection event or while a BLE disconnection is in progress. Calling this API during disconnection may lead to undefined behavior or accessing invalid information.

  参数:

    local_irk -- [out] Buffer to hold the 16-byte IRK. The array notation [16] explicitly indicates the required buffer size (ESP_BT_OCTET16_LEN).

  返回:

    - ESP_OK : success

    - ESP_ERR_INVALID_ARG : local_irk is NULL

    - ESP_ERR_INVALID_STATE : BLE stack not initialized or IRK not available

esp_err_t esp_ble_gap_disconnect(esp_bd_addr_t remote_device)

  This function is to disconnect the physical connection of the peer device gattc may have multiple virtual GATT server connections when multiple app_id registered. esp_ble_gattc_close (esp_gatt_if_t gattc_if, uint16_t conn_id) only close one virtual GATT server connection. if there exist other virtual GATT server connections, it does not disconnect the physical connection. esp_ble_gap_disconnect(esp_bd_addr_t remote_device) disconnect the physical connection directly.

  参数:

    remote_device -- [in] : BD address of the peer device

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_get_current_conn_params(esp_bd_addr_t bd_addr, esp_gap_conn_params_t *conn_params)

  This function is called to read the connection parameters information of the device.

  参数:

    - bd_addr -- [in] BD address of the peer device.

    - conn_params -- [out] the connection parameters information

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_gap_ble_set_channels(esp_gap_ble_channels channels)

  BLE set channels.

  参数:

    channels -- [in] : The n th such field (in the range 0 to 36) contains the value for the link layer channel index n. 0 means channel n is bad. 1 means channel n is unknown. The most significant bits are reserved and shall be set to 0. At least one channel shall be marked as unknown.

  返回:

    - ESP_OK : success

    - ESP_ERR_INVALID_STATE: if bluetooth stack is not yet enabled

    - other : failed

esp_err_t esp_ble_gap_read_channel_map(esp_bd_addr_t bd_addr)

  This function is used to read the current channel map for the connection identified by remote address.

  参数:

    bd_addr -- [in] : BD address of the peer device

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_gap_ble_set_authorization(esp_bd_addr_t bd_addr, bool authorize)

  This function is called to authorized a link after Authentication(MITM protection)

  参数:

    - bd_addr -- [in] BD address of the peer device.

    - authorize -- [out] Authorized the link or not.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_read_phy(esp_bd_addr_t bd_addr)

  This function is used to read the current transmitter PHY and receiver PHY on the connection identified by remote address.

  参数:

    bd_addr -- [in] : BD address of the peer device

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_preferred_default_phy(esp_ble_gap_phy_mask_t tx_phy_mask, esp_ble_gap_phy_mask_t rx_phy_mask)

  This function is used to allows the Host to specify its preferred values for the transmitter PHY and receiver PHY to be used for all subsequent connections over the LE transport.

  备注

  Including the LE Coded PHY in tx_phy_mask / rx_phy_mask may cause subsequent ACL connections to run on the LE Coded PHY, which will significantly degrade Wi-Fi performance in Bluetooth/Wi-Fi coexistence scenarios because Coded PHY (S=2/S=8) packets occupy the radio for much longer than 1M/2M PHY packets. It is recommended to use the LE 2M PHY (or LE 1M PHY) first, and only include the LE Coded PHY when the long-range capability is really required.

  参数:

    - tx_phy_mask -- [in] : indicates the transmitter PHYs that the Host prefers the Controller to use

    - rx_phy_mask -- [in] : indicates the receiver PHYs that the Host prefers the Controller to use

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_preferred_phy(esp_bd_addr_t bd_addr, esp_ble_gap_all_phys_t all_phys_mask, esp_ble_gap_phy_mask_t tx_phy_mask, esp_ble_gap_phy_mask_t rx_phy_mask, esp_ble_gap_prefer_phy_options_t phy_options)

  This function is used to set the PHY preferences for the connection identified by the remote address. The Controller might not be able to make the change (e.g. because the peer does not support the requested PHY) or may decide that the current PHY is preferable.

  备注

  Switching an existing ACL connection to the LE Coded PHY via tx_phy_mask / rx_phy_mask will significantly degrade Wi-Fi performance in Bluetooth/Wi-Fi coexistence scenarios, because Coded PHY (S=2/S=8) packets occupy the radio for much longer than 1M/2M PHY packets. It is recommended to use the LE 2M PHY (or LE 1M PHY) first, and only switch to the LE Coded PHY when the long-range capability is really required.

  参数:

    - bd_addr -- [in] : remote address

    - all_phys_mask -- [in] : a bit field that allows the Host to specify

    - tx_phy_mask -- [in] : a bit field that indicates the transmitter PHYs that the Host prefers the Controller to use

    - rx_phy_mask -- [in] : a bit field that indicates the receiver PHYs that the Host prefers the Controller to use

    - phy_options -- [in] : a bit field that allows the Host to specify options for PHYs

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_ext_adv_set_rand_addr(uint8_t instance, esp_bd_addr_t rand_addr)

  This function is used by the Host to set the random device address specified by the Random_Address parameter.

  参数:

    - instance -- [in] : Used to identify an advertising set

    - rand_addr -- [in] : Random Device Address

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_ext_adv_set_params(uint8_t instance, const esp_ble_gap_ext_adv_params_t *params)

  This function is used by the Host to set the advertising parameters.

  参数:

    - instance -- [in] : identifies the advertising set whose parameters are being configured.

    - params -- [in] : advertising parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_config_ext_adv_data_raw(uint8_t instance, uint16_t length, const uint8_t *data)

  This function is used to set the data used in advertising PDUs that have a data field.

  参数:

    - instance -- [in] : identifies the advertising set whose data are being configured

    - length -- [in] : data length

    - data -- [in] : data information

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_config_ext_scan_rsp_data_raw(uint8_t instance, uint16_t length, const uint8_t *scan_rsp_data)

  This function is used to provide scan response data used in scanning response PDUs.

  参数:

    - instance -- [in] : identifies the advertising set whose response data are being configured.

    - length -- [in] : responsedata length

    - scan_rsp_data -- [in] : response data information

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_ext_adv_start(uint8_t num_adv, const esp_ble_gap_ext_adv_t *ext_adv)

  This function is used to request the Controller to enable one or more advertising sets using the advertising sets identified by the instance parameter.

  参数:

    - num_adv -- [in] : Number of advertising sets to enable or disable

    - ext_adv -- [in] : adv parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_ext_adv_stop(uint8_t num_adv, const uint8_t *ext_adv_inst)

  This function is used to request the Controller to disable one or more advertising sets using the advertising sets identified by the instance parameter.

  参数:

    - num_adv -- [in] : Number of advertising sets to enable or disable

    - ext_adv_inst -- [in] : ext adv instance

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_ext_adv_set_remove(uint8_t instance)

  This function is used to remove an advertising set from the Controller.

  参数:

    instance -- [in] : Used to identify an advertising set

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_ext_adv_set_clear(void)

  This function is used to remove all existing advertising sets from the Controller.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_periodic_adv_set_params(uint8_t instance, const esp_ble_gap_periodic_adv_params_t *params)

  This function is used by the Host to set the parameters for periodic advertising.

  参数:

    - instance -- [in] : identifies the advertising set whose periodic advertising parameters are being configured.

    - params -- [in] : periodic adv parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_config_periodic_adv_data_raw(uint8_t instance, uint16_t length, const uint8_t *data)

  This function is used to set the data used in periodic advertising PDUs.

  参数:

    - instance -- [in] : identifies the advertising set whose periodic advertising parameters are being configured.

    - length -- [in] : the length of periodic data

    - data -- [in] : periodic data information

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_periodic_adv_start(uint8_t instance)

  This function is used to request the Controller to enable the periodic advertising for the advertising set specified.

  参数:

    instance -- [in] : Used to identify an advertising set

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_periodic_adv_stop(uint8_t instance)

  This function is used to request the Controller to disable the periodic advertising for the advertising set specified.

  参数:

    instance -- [in] : Used to identify an advertising set

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_ext_scan_params(const esp_ble_ext_scan_params_t *params)

  This function is used to set the extended scan parameters to be used on the advertising channels.

  参数:

    params -- [in] : scan parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_start_ext_scan(uint32_t duration, uint16_t period)

  Enables extended scanning.

  参数:

    - duration -- [in] Scan duration in units of 10 ms.

      - Range: 0x0001 to 0xFFFF (Time = N * 10 ms).

      - 0x0000: Scan continuously until explicitly disabled.

    - period -- [in] Time interval between the start of consecutive scan durations, in units of 1.28 seconds.

      - Range: 0x0001 to 0xFFFF (Time = N * 1.28 sec).

      - 0x0000: Scan continuously.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_stop_ext_scan(void)

  This function is used to disable scanning.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_periodic_adv_create_sync(const esp_ble_gap_periodic_adv_sync_params_t *params)

  This function is used to synchronize with periodic advertising from an advertiser and begin receiving periodic advertising packets.

  参数:

    params -- [in] : sync parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_periodic_adv_sync_cancel(void)

  This function is used to cancel the LE_Periodic_Advertising_Create_Sync command while it is pending.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_periodic_adv_sync_terminate(uint16_t sync_handle)

  This function is used to stop reception of the periodic advertising identified by the Sync Handle parameter.

  参数:

    sync_handle -- [in] : identify the periodic advertiser

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_periodic_adv_add_dev_to_list(esp_ble_addr_type_t addr_type, esp_bd_addr_t addr, uint8_t sid)

  This function is used to add a single device to the Periodic Advertiser list stored in the Controller.

  参数:

    - addr_type -- [in] : address type

    - addr -- [in] : Device Address

    - sid -- [in] : Advertising SID subfield in the ADI field used to identify the Periodic Advertising

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_periodic_adv_remove_dev_from_list(esp_ble_addr_type_t addr_type, esp_bd_addr_t addr, uint8_t sid)

  This function is used to remove one device from the list of Periodic Advertisers stored in the Controller. Removals from the Periodic Advertisers List take effect immediately.

  参数:

    - addr_type -- [in] : address type

    - addr -- [in] : Device Address

    - sid -- [in] : Advertising SID subfield in the ADI field used to identify the Periodic Advertising

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_periodic_adv_clear_dev(void)

  This function is used to remove all devices from the list of Periodic Advertisers in the Controller.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_get_periodic_list_size(uint8_t *size)

  Retrieve the capacity of the periodic advertiser list in the controller.

  参数:

    size -- [out] Pointer to a variable where the capacity of the periodic advertiser list will be stored.

  返回:

    - ESP_OK : Success

    - Others : Failure

esp_err_t esp_ble_gap_prefer_ext_connect_params_set(esp_bd_addr_t addr, esp_ble_gap_phy_mask_t phy_mask, const esp_ble_gap_conn_params_t *phy_1m_conn_params, const esp_ble_gap_conn_params_t *phy_2m_conn_params, const esp_ble_gap_conn_params_t *phy_coded_conn_params)

  This function is used to set aux connection parameters.

  备注

  Using the LE Coded PHY for the ACL connection will significantly degrade Wi-Fi performance, because the on-air transmission time of a Coded PHY packet (S=2 or S=8) is much longer than that of a 1M/2M PHY packet, so the Bluetooth controller occupies the radio for a longer time and leaves less airtime for Wi-Fi. In Bluetooth/Wi-Fi coexistence scenarios, it is recommended to use the LE 2M PHY or LE 1M PHY first, and only fall back to the LE Coded PHY when the long-range capability is really required.

  参数:

    - addr -- [in] : device address

    - phy_mask -- [in] : indicates the PHY(s) on which the advertising packets should be received on the primary advertising channel and the PHYs for which connection parameters have been specified.

    - phy_1m_conn_params -- [in] : Scan connectable advertisements on the LE 1M PHY. Connection parameters for the LE 1M PHY are provided.

    - phy_2m_conn_params -- [in] : Connection parameters for the LE 2M PHY are provided.

    - phy_coded_conn_params -- [in] : Scan connectable advertisements on the LE Coded PHY. Connection parameters for the LE Coded PHY are provided.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_add_monitor_adv_list(const esp_ble_gap_add_monitor_adv_params_t *params)

  This function is used to add a single device to the list of Monitored Advertisers in the Controller. When the Controller receives advertising that matches the address and meets the RSSI threshold condition, it will send an LE Monitor Advertising Report event (ESP_GAP_BLE_MONITOR_ADV_REPORT_EVT).

  参数:

    params -- [in] : Pointer to parameters (addr_type, addr, rssi_low, rssi_high, timeout). Reserved fields allow future extension.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_remove_monitor_adv_list(const esp_ble_gap_remove_monitor_adv_params_t *params)

  This function is used to remove one device from the list of Monitored Advertisers in the Controller. Removals take effect immediately.

  参数:

    params -- [in] : Pointer to parameters (addr_type, addr). Reserved fields allow future extension.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_clear_monitor_adv_list(void)

  This function is used to remove all devices from the list of Monitored Advertisers in the Controller.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_read_monitor_adv_list_size(void)

  This function is used to read the capacity of the list of Monitored Advertisers in the Controller. The HCI command is sent asynchronously; the list size is reported via command complete if needed.

  返回:

    - ESP_OK : success (command sent)

    - other : failed

esp_err_t esp_ble_gap_enable_monitor_adv(bool enable)

  This function is used to enable or disable the reporting of LE Monitor Advertising Report events. When enabled, the Controller will generate ESP_GAP_BLE_MONITOR_ADV_REPORT_EVT when advertising from devices in the monitor list meets the configured RSSI threshold condition.

  参数:

    enable -- [in] : true to enable monitor advertising reports, false to disable

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_periodic_adv_recv_enable(uint16_t sync_handle, uint8_t enable)

  This function is used to set periodic advertising receive enable.

  参数:

    - sync_handle -- [in] : Handle of periodic advertising sync

    - enable -- [in] : Determines whether reporting and duplicate filtering are enabled or disabled

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_periodic_adv_sync_trans(esp_bd_addr_t addr, uint16_t service_data, uint16_t sync_handle)

  This function is used to transfer periodic advertising sync.

  参数:

    - addr -- [in] : Peer device address

    - service_data -- [in] : Service data used by Host

    - sync_handle -- [in] : Handle of periodic advertising sync

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_periodic_adv_set_info_trans(esp_bd_addr_t addr, uint16_t service_data, uint8_t adv_handle)

  This function is used to transfer periodic advertising set info.

  参数:

    - addr -- [in] : Peer device address

    - service_data -- [in] : Service data used by Host

    - adv_handle -- [in] : Handle of advertising set

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_periodic_adv_sync_trans_params(esp_bd_addr_t addr, const esp_ble_gap_past_params_t *params)

  This function is used to set periodic advertising sync transfer params.

  参数:

    - addr -- [in] : Peer device address

    - params -- [in] : Params of periodic advertising sync transfer

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_dtm_tx_start(const esp_ble_dtm_tx_t *tx_params)

  This function is used to start a test where the DUT generates reference packets at a fixed interval.

  参数:

    tx_params -- [in] : DTM Transmitter parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_dtm_rx_start(const esp_ble_dtm_rx_t *rx_params)

  This function is used to start a test where the DUT receives test reference packets at a fixed interval.

  参数:

    rx_params -- [in] : DTM Receiver parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_dtm_enh_tx_start(const esp_ble_dtm_enh_tx_t *tx_params)

  This function is used to start a test where the DUT generates reference packets at a fixed interval.

  参数:

    tx_params -- [in] : DTM Transmitter parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_dtm_enh_rx_start(const esp_ble_dtm_enh_rx_t *rx_params)

  This function is used to start a test where the DUT receives test reference packets at a fixed interval.

  参数:

    rx_params -- [in] : DTM Receiver parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_dtm_stop(void)

  This function is used to stop any test which is in progress.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_clear_advertising(void)

  This function is used to clear legacy advertising.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_vendor_command_send(esp_ble_vendor_cmd_params_t *vendor_cmd_param)

  This function is called to send vendor hci command.

  参数:

    vendor_cmd_param -- [in] vendor hci command parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_privacy_mode(esp_ble_addr_type_t addr_type, esp_bd_addr_t addr, esp_ble_privacy_mode_t mode)

  This function set the privacy mode of the device in resolving list.

  备注

  This feature is not supported on ESP32.

  参数:

    - addr_type -- [in] The address type of the peer identity address (BLE_ADDR_TYPE_PUBLIC or BLE_ADDR_TYPE_RANDOM).

    - addr -- [in] The peer identity address of the device.

    - mode -- [in] The privacy mode of the device.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_csa_support(uint8_t csa_select)

  This function is used to set which channel selection algorithm(CSA) is supported.

  备注

  - This function should only be used when there are BLE compatibility issues about channel hopping after connected. For example, if the peer device only supports CSA#1, this function can be called to make the Controller use CSA#1.

  - This function is not supported on ESP32.

  参数:

    csa_select -- [in] 0: Channel Selection Algorighm will be selected by Controller 1: Select the LE Channel Selection Algorighm #1 2: Select the LE Channel Selection Algorighm #2

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_vendor_event_mask(esp_ble_vendor_evt_mask_t event_mask)

  This function is used to control which vendor events are generated by the HCI for the Host.

  参数:

    event_mask -- [in] The BLE vendor HCI event mask

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_common_factor(uint32_t common_factor)

  This function is used to set a common connection interval factor for multiple central-role connections. When multiple BLE connections in the central role exist, it is recommended that each connection interval be configured to either the same value or an integer multiple of the others. And use this function to set the common factor of all connection intervalsin the controller. The controller will then arrange the scheduling of each connection based on this factor to minimize or avoid connection conflicts.

  备注

  - This function is used in multi-connection scenarios.

  - This function takes effect only when the connection role is central.

  - This function only needs to be called once and before establishing the connection.

  参数:

    common_factor -- [in] The common connection interval factor (in units of 625us) used for scheduling across all central-role connections.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_sch_len(uint8_t role, uint32_t len)

  This function is used to Set the scheduling protection time for specific LE role. It can be used to configures the minimum protection time to be reserved for a connection's TX/RX operations, ensuring that a complete transmission and reception cycle is not interrupted. It helps prevent disconnect in scenarios with multiple connections competing for time slots.

  备注

  - This function is used in multi-connection scenarios.

  - This function must be called before establishing the connection.

  参数:

    - role -- [in] 0: Central 1: Peripheral

    - len -- [in] The protection time length of the corresponding role (in units of us)

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_scan_chan_map(uint8_t state, uint8_t chan_map[5])

  This function is used to Set the channel map for LE scanning or initiating state.

  备注

  - This function must be called before starting scanning or initiating.

  - At least one channel should be marked as used.

  参数:

    - state -- [in] The LE state for which the channel map is applied.

      - 0 : Scanning state

      - 1 : Initiating state

    - chan_map -- [in] A 5-byte array representing the channel usage bit mask. Each bit corresponds to one channel from channel 0 to channel 39. The least significant bit of chan_map[0] corresponds to channel 0. The most significant bit of chan_map[4] corresponds to channel 39.

      - Bit = 1 : channel is used

      - Bit = 0 : channel is not used

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_enhanced_read_transmit_power_level(uint16_t conn_handle, esp_ble_tx_power_phy_t phy)

  This function is used to read the current and maximum transmit power levels of the local Controller.

  参数:

    - conn_handle -- [in] The ACL connection identified.

    - phy -- [in] 1M, 2M, Coded S2 or Coded S8.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_read_remote_transmit_power_level(uint16_t conn_handle, esp_ble_tx_power_phy_t phy)

  This function is used to read the transmit power level used by the remote Controller on the ACL connection.

  参数:

    - conn_handle -- [in] The ACL connection identifier.

    - phy -- [in] 1M, 2M, Coded S2 or Coded S8.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_path_loss_reporting_params(esp_ble_path_loss_rpt_params_t *path_loss_rpt_params)

  This function is used to set the path loss threshold reporting parameters.

  参数:

    path_loss_rpt_params -- [in] The path loss threshold reporting parameters.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_path_loss_reporting_enable(uint16_t conn_handle, bool enable)

  This function is used to enable or disable path loss reporting.

  参数:

    - conn_handle -- [in] The ACL connection identifier.

    - enable -- [in] Reporting disabled or enabled.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_transmit_power_reporting_enable(uint16_t conn_handle, bool local_enable, bool remote_enable)

  This function is used to enable or disable the reporting to the local Host of transmit power level changes in the local and remote Controllers.

  参数:

    - conn_handle -- [in] The ACL connection identifier.

    - local_enable -- [in] Disable or enable local transmit power reports.

    - remote_enable -- [in] Disable or enable remote transmit power reports.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_default_subrate(esp_ble_default_subrate_param_t *default_subrate_params)

  This function is used to set the initial values for the acceptable parameters for subrating requests, for all future ACL connections where the Controller is the Central. This command does not affect any existing connection.

  参数:

    default_subrate_params -- [in] The default subrate parameters.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_subrate_request(esp_ble_subrate_req_param_t *subrate_req_params)

  This function is used by a Central or a Peripheral to request a change to the subrating factor and/or other parameters applied to an existing connection.

  If this API is issued on the Central, the following rules shall apply when the Controller initiates the Connection Subrate Update procedure:

  1. The Peripheral latency shall be less than or equal to max_latency.

  2. The subrate factor shall be between subrate_min and subrate_max.

  3. The continuation number shall be equal to the lesser of continuation_number and (subrate factor - 1).

  4. The connection supervision timeout shall be equal to supervision_timeout.

  If this API is issued on the Peripheral, the following rules shall apply when the Controller initiates the Connection Subrate Request procedure:

  1. The Peripheral latency shall be less than or equal to max_latency.

  2. The minimum and maximum subrate factors shall be between subrate_min and subrate_max.

  3. The continuation number shall be equal to the lesser of continuation_number and (maximum subrate factor - 1). 4.The connection supervision timeout shall be equal to supervision_timeout.

  参数:

    subrate_req_params -- [in] The subrate request parameters.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_host_feature(uint16_t bit_num, uint8_t bit_val)

  This function is called to set host feature.

  参数:

    - bit_num -- [in] the bit position in the FeatureSet.

    - bit_val -- [in] the feature is enabled or disabled

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_periodic_adv_subevent_data(esp_ble_per_adv_subevent_data_params *subevent_data_params)

  This function is used to set the data for one or more subevents of PAwR in reply to a PA subevent data request event. The data for a subevent shall be transmitted only once.

  参数:

    subevent_data_params -- [in] Periodic adv subevent data parameters.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_periodic_adv_response_data(esp_ble_per_adv_response_data_params *rsp_data_params)

  This function is used to set the data for a response slot in a specific subevent of the PAwR identified. The data for a response slot shall be transmitted only once.

  参数:

    rsp_data_params -- [in] Periodic adv response data parameters.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_gap_set_periodic_sync_subevent(esp_ble_per_sync_subevent_params *sync_subevent_params)

  This function is used to instruct the Controller to synchronize with a subset of the subevents within a PAwR train, listen for packets sent by the peer device and pass any received data up to the Host.

  参数:

    sync_subevent_params -- [in] Periodic sync subevent parameters.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_cs_read_local_supported_capabilities(void)

  This function is used to read the CS capabilities that are supported by the local Controller.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_cs_read_remote_supported_capabilities(uint16_t conn_handle)

  This function is used to query the CS capabilities that are supported by the remote Controller.

  参数:

    conn_handle -- [in] connection handle.

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_cs_write_cached_remote_supported_capabilities(esp_ble_cs_write_cached_remote_supp_caps_params *cached_remote_supp_caps_params)

  This function is used to write the cached copy of the CS capabilities that are supported by the remote Controller.

  参数:

    cached_remote_supp_caps_params -- [in] CS write cached remote supported capabilities parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_cs_security_enable(uint16_t conn_handle)

  This function is used to start or restart the Channel Sounding Security Start procedure in the local Controller.

  参数:

    conn_handle -- [in] the ACL connection identified

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_cs_set_default_settings(esp_ble_cs_set_default_settings_params *default_setting_params)

  This function is used to set default CS settings in the local Controller.

  参数:

    default_setting_params -- [in] CS set default settings parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_cs_read_remote_fae_table(uint16_t conn_handle)

  This function is used to read the per-channel mode-0 Frequency Actuation Error table of the remote Controller.

  参数:

    conn_handle -- [in] the ACL connection identified

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_cs_write_cached_remote_fae_table(esp_ble_cs_write_cached_remote_fae_table_params *write_cached_remote_fae_tab_params)

  This function is used to write a cached copy of the per-channel mode-0 Frequency Actuation Error table of the remote device in the local Controller.

  参数:

    write_cached_remote_fae_tab_params -- [in] CS write cached remote FAE table parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_cs_create_config(esp_ble_cs_create_config_params *create_config_params)

  This function is used to create a new CS configuration or update an existing CS configuration in the local and/or the remote Controller.

  参数:

    create_config_params -- [in] CS create config parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_cs_remove_config(esp_ble_cs_remove_config_params *remove_config_params)

  This function is used to remove a CS configuration from the local Controller.

  参数:

    remove_config_params -- [in] CS remove config parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_cs_set_channel_classification(esp_ble_cs_set_channel_class_params *channel_class_params)

  This function is used to update the channel classification based on its local information.

  参数:

    channel_class_params -- [in] CS set channel classification parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_cs_set_procedure_params(esp_ble_cs_set_proc_params *procedure_params)

  This function is used to set the parameters for the scheduling of one or more CS procedures by the local Controller.

  参数:

    procedure_params -- [in] CS set channel procedure parameters

  返回:

    - ESP_OK : success

    - other : failed

esp_err_t esp_ble_cs_procedure_enable(esp_ble_cs_procedure_enable_params *procedure_enable_params)

  This function is used to enable or disable the scheduling of CS procedures by the local Controller.

  参数:

    procedure_enable_params -- [in] CS procedure enable parameters

  返回:

    - ESP_OK : success

    - other : failed

### Unions

union esp_ble_key_value_t
  #include <esp_gap_ble_api.h>

  union type of the security key value

  Public Members

  esp_ble_penc_keys_t penc_key

    received peer encryption key

  esp_ble_pcsrk_keys_t pcsrk_key

    received peer device SRK

  esp_ble_pid_keys_t pid_key

    peer device ID key

  esp_ble_lenc_keys_t lenc_key

    local encryption reproduction keys LTK = = d1(ER,DIV,0)

  esp_ble_lcsrk_keys lcsrk_key

    local device CSRK = d1(ER,DIV,1)

union esp_ble_sec_t
  #include <esp_gap_ble_api.h>

  union associated with ble security

  Public Members

  esp_ble_sec_key_notif_t key_notif

    passkey notification

  esp_ble_sec_req_t ble_req

    BLE SMP related request

  esp_ble_key_t ble_key

    BLE SMP keys used when pairing

  esp_ble_local_id_keys_t ble_id_keys

    BLE IR event

  esp_ble_local_oob_data_t oob_data

    BLE SMP secure connection OOB data

  esp_ble_auth_cmpl_t auth_cmpl

    Authentication complete indication.

union esp_ble_vendor_evt_param_t
  #include <esp_gap_ble_api.h>

  BLE vendor event parameters union.

  Public Members

  struct esp_ble_vendor_evt_param_t::ble_pdu_recv_evt_param pdu_recv

    Event parameter of ESP_BLE_VENDOR_PDU_RECV_EVT

  struct esp_ble_vendor_evt_param_t::ble_chan_map_update_evt_param chan_map_update

    Event parameter of ESP_BLE_VENDOR_CHAN_MAP_UPDATE_EVT

  struct esp_ble_vendor_evt_param_t::ble_sleep_wakeup_evt_param sleep_wakeup

    Event parameter of ESP_BLE_VENDOR_SLEEP_WAKEUP_EVT

  struct ble_chan_map_update_evt_param
    #include <esp_gap_ble_api.h>

    ESP_BLE_VENDOR_CHAN_MAP_UPDATE_EVT.

    Public Members

    uint8_t status

      Indicate the channel map update status (HCI error code)

    uint16_t conn_handle

      The connection handle

    esp_gap_ble_channels ch_map

      The channel map after updated

  struct ble_pdu_recv_evt_param
    #include <esp_gap_ble_api.h>

    ESP_BLE_VENDOR_PDU_RECV_EVT.

    Public Members

    esp_ble_vendor_pdu_t type

      The type of LE PDU

    uint8_t handle

      The handle of advertising set

    esp_ble_addr_type_t addr_type

      The address type of peer device

    esp_bd_addr_t peer_addr

      The address of peer device

  struct ble_sleep_wakeup_evt_param
    #include <esp_gap_ble_api.h>

    ESP_BLE_VENDOR_SLEEP_WAKEUP_EVT.

union esp_ble_gap_cb_param_t
  #include <esp_gap_ble_api.h>

  Gap callback parameters union.

  Public Members

  struct esp_ble_gap_cb_param_t::ble_get_dev_name_cmpl_evt_param get_dev_name_cmpl

    Event parameter of ESP_GAP_BLE_GET_DEV_NAME_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_adv_data_cmpl_evt_param adv_data_cmpl

    Event parameter of ESP_GAP_BLE_ADV_DATA_SET_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_scan_rsp_data_cmpl_evt_param scan_rsp_data_cmpl

    Event parameter of ESP_GAP_BLE_SCAN_RSP_DATA_SET_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_scan_param_cmpl_evt_param scan_param_cmpl

    Event parameter of ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_scan_result_evt_param scan_rst

    Event parameter of ESP_GAP_BLE_SCAN_RESULT_EVT

  struct esp_ble_gap_cb_param_t::ble_adv_data_raw_cmpl_evt_param adv_data_raw_cmpl

    Event parameter of ESP_GAP_BLE_ADV_DATA_RAW_SET_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_scan_rsp_data_raw_cmpl_evt_param scan_rsp_data_raw_cmpl

    Event parameter of ESP_GAP_BLE_SCAN_RSP_DATA_RAW_SET_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_adv_start_cmpl_evt_param adv_start_cmpl

    Event parameter of ESP_GAP_BLE_ADV_START_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_scan_start_cmpl_evt_param scan_start_cmpl

    Event parameter of ESP_GAP_BLE_SCAN_START_COMPLETE_EVT

  esp_ble_sec_t ble_security

    ble gap security union type

  struct esp_ble_gap_cb_param_t::ble_scan_stop_cmpl_evt_param scan_stop_cmpl

    Event parameter of ESP_GAP_BLE_SCAN_STOP_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_adv_stop_cmpl_evt_param adv_stop_cmpl

    Event parameter of ESP_GAP_BLE_ADV_STOP_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_set_rand_cmpl_evt_param set_rand_addr_cmpl

    Event parameter of ESP_GAP_BLE_SET_STATIC_RAND_ADDR_EVT

  struct esp_ble_gap_cb_param_t::ble_update_conn_params_evt_param update_conn_params

    Event parameter for ESP_GAP_BLE_UPDATE_CONN_PARAMS_EVT

  struct esp_ble_gap_cb_param_t::ble_pkt_data_length_cmpl_evt_param pkt_data_length_cmpl

    Event parameter of ESP_GAP_BLE_SET_PKT_LENGTH_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_local_privacy_cmpl_evt_param local_privacy_cmpl

    Event parameter of ESP_GAP_BLE_SET_LOCAL_PRIVACY_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_rpa_timeout_cmpl_evt_param set_rpa_timeout_cmpl

    Event parameter of ESP_GAP_BLE_SET_RPA_TIMEOUT_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_add_dev_to_resolving_list_cmpl_evt_param add_dev_to_resolving_list_cmpl

    Event parameter of ESP_GAP_BLE_ADD_DEV_TO_RESOLVING_LIST_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_remove_bond_dev_cmpl_evt_param remove_bond_dev_cmpl

    Event parameter of ESP_GAP_BLE_REMOVE_BOND_DEV_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_clear_bond_dev_cmpl_evt_param clear_bond_dev_cmpl

    Event parameter of ESP_GAP_BLE_CLEAR_BOND_DEV_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_get_bond_dev_cmpl_evt_param get_bond_dev_cmpl

    Event parameter of ESP_GAP_BLE_GET_BOND_DEV_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_read_rssi_cmpl_evt_param read_rssi_cmpl

    Event parameter of ESP_GAP_BLE_READ_RSSI_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_read_ble_channel_map_cmpl_evt_param read_ble_channel_map_cmpl

    Event parameter of ESP_GAP_BLE_READ_CHANNEL_MAP_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_update_whitelist_cmpl_evt_param update_whitelist_cmpl

    Event parameter of ESP_GAP_BLE_UPDATE_WHITELIST_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_update_duplicate_exceptional_list_cmpl_evt_param update_duplicate_exceptional_list_cmpl

    Event parameter of ESP_GAP_BLE_UPDATE_DUPLICATE_EXCEPTIONAL_LIST_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_set_channels_evt_param ble_set_channels

    Event parameter of ESP_GAP_BLE_SET_CHANNELS_EVT

  struct esp_ble_gap_cb_param_t::ble_read_phy_cmpl_evt_param read_phy

    Event parameter of ESP_GAP_BLE_READ_PHY_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_set_perf_def_phy_cmpl_evt_param set_perf_def_phy

    Event parameter of ESP_GAP_BLE_SET_PREFERRED_DEFAULT_PHY_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_set_perf_phy_cmpl_evt_param set_perf_phy

    Event parameter of ESP_GAP_BLE_SET_PREFERRED_PHY_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_ext_adv_set_rand_addr_cmpl_evt_param ext_adv_set_rand_addr

    Event parameter of ESP_GAP_BLE_EXT_ADV_SET_RAND_ADDR_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_ext_adv_set_params_cmpl_evt_param ext_adv_set_params

    Event parameter of ESP_GAP_BLE_EXT_ADV_SET_PARAMS_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_ext_adv_data_set_cmpl_evt_param ext_adv_data_set

    Event parameter of ESP_GAP_BLE_EXT_ADV_DATA_SET_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_ext_adv_scan_rsp_set_cmpl_evt_param scan_rsp_set

    Event parameter of ESP_GAP_BLE_EXT_SCAN_RSP_DATA_SET_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_ext_adv_start_cmpl_evt_param ext_adv_start

    Event parameter of ESP_GAP_BLE_EXT_ADV_START_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_ext_adv_stop_cmpl_evt_param ext_adv_stop

    Event parameter of ESP_GAP_BLE_EXT_ADV_STOP_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_ext_adv_set_remove_cmpl_evt_param ext_adv_remove

    Event parameter of ESP_GAP_BLE_EXT_ADV_SET_REMOVE_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_ext_adv_set_clear_cmpl_evt_param ext_adv_clear

    Event parameter of ESP_GAP_BLE_EXT_ADV_SET_CLEAR_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_periodic_adv_set_params_cmpl_param peroid_adv_set_params

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_SET_PARAMS_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_periodic_adv_data_set_cmpl_param period_adv_data_set

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_DATA_SET_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_periodic_adv_start_cmpl_param period_adv_start

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_START_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_periodic_adv_stop_cmpl_param period_adv_stop

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_STOP_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_period_adv_create_sync_cmpl_param period_adv_create_sync

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_CREATE_SYNC_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_period_adv_sync_cancel_cmpl_param period_adv_sync_cancel

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_SYNC_CANCEL_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_period_adv_sync_terminate_cmpl_param period_adv_sync_term

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_SYNC_TERMINATE_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_period_adv_add_dev_cmpl_param period_adv_add_dev

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_ADD_DEV_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_period_adv_remove_dev_cmpl_param period_adv_remove_dev

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_REMOVE_DEV_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_period_adv_clear_dev_cmpl_param period_adv_clear_dev

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_CLEAR_DEV_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_set_ext_scan_params_cmpl_param set_ext_scan_params

    Event parameter of ESP_GAP_BLE_SET_EXT_SCAN_PARAMS_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_ext_scan_start_cmpl_param ext_scan_start

    Event parameter of ESP_GAP_BLE_EXT_SCAN_START_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_ext_scan_stop_cmpl_param ext_scan_stop

    Event parameter of ESP_GAP_BLE_EXT_SCAN_STOP_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_ext_conn_params_set_cmpl_param ext_conn_params_set

    Event parameter of ESP_GAP_BLE_PREFER_EXT_CONN_PARAMS_SET_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_adv_terminate_param adv_terminate

    Event parameter of ESP_GAP_BLE_ADV_TERMINATED_EVT

  struct esp_ble_gap_cb_param_t::ble_scan_req_received_param scan_req_received

    Event parameter of ESP_GAP_BLE_SCAN_REQ_RECEIVED_EVT

  struct esp_ble_gap_cb_param_t::ble_monitor_adv_report_param monitor_adv_report

    Event parameter of ESP_GAP_BLE_MONITOR_ADV_REPORT_EVT

  struct esp_ble_gap_cb_param_t::ble_add_monitor_adv_cmpl_param add_monitor_adv

    Event parameter of ESP_GAP_BLE_ADD_MONITOR_ADV_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_remove_monitor_adv_cmpl_param remove_monitor_adv

    Event parameter of ESP_GAP_BLE_REMOVE_MONITOR_ADV_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_clear_monitor_adv_cmpl_param clear_monitor_adv

    Event parameter of ESP_GAP_BLE_CLEAR_MONITOR_ADV_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_read_monitor_adv_list_size_cmpl_param read_monitor_adv_list_size

    Event parameter of ESP_GAP_BLE_READ_MONITOR_ADV_LIST_SIZE_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_enable_monitor_adv_cmpl_param enable_monitor_adv

    Event parameter of ESP_GAP_BLE_ENABLE_MONITOR_ADV_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_channel_sel_alg_param channel_sel_alg

    Event parameter of ESP_GAP_BLE_CHANNEL_SELECT_ALGORITHM_EVT

  struct esp_ble_gap_cb_param_t::ble_periodic_adv_sync_lost_param periodic_adv_sync_lost

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_SYNC_LOST_EVT

  struct esp_ble_gap_cb_param_t::ble_periodic_adv_sync_estab_param periodic_adv_sync_estab

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_SYNC_ESTAB_EVT

  struct esp_ble_gap_cb_param_t::ble_phy_update_cmpl_param phy_update

    Event parameter of ESP_GAP_BLE_PHY_UPDATE_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_ext_adv_report_param ext_adv_report

    Event parameter of ESP_GAP_BLE_EXT_ADV_REPORT_EVT

  struct esp_ble_gap_cb_param_t::ble_periodic_adv_report_param period_adv_report

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_REPORT_EVT

  struct esp_ble_gap_cb_param_t::ble_periodic_adv_recv_enable_cmpl_param period_adv_recv_enable

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_RECV_ENABLE_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_periodic_adv_sync_trans_cmpl_param period_adv_sync_trans

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_SYNC_TRANS_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_periodic_adv_set_info_trans_cmpl_param period_adv_set_info_trans

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_SET_INFO_TRANS_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_set_past_params_cmpl_param set_past_params

    Event parameter of ESP_GAP_BLE_SET_PAST_PARAMS_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_periodic_adv_sync_trans_recv_param past_received

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_SYNC_TRANS_RECV_EVT

  struct esp_ble_gap_cb_param_t::ble_dtm_state_update_evt_param dtm_state_update

    Event parameter of ESP_GAP_BLE_DTM_TEST_UPDATE_EVT

  struct esp_ble_gap_cb_param_t::ble_set_privacy_mode_cmpl_evt_param set_privacy_mode_cmpl

    Event parameter of ESP_GAP_BLE_SET_PRIVACY_MODE_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_adv_clear_cmpl_evt_param adv_clear_cmpl

    Event parameter of ESP_GAP_BLE_ADV_CLEAR_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::vendor_cmd_cmpl_evt_param vendor_cmd_cmpl

    Event parameter of ESP_GAP_BLE_VENDOR_CMD_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_set_csa_support_cmpl_evt_param set_csa_support_cmpl

    Event parameter of ESP_GAP_BLE_SET_CSA_SUPPORT_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_set_vendor_evt_mask_cmpl_evt_param set_vendor_evt_mask_cmpl

    Event parameter of ESP_GAP_BLE_SET_VENDOR_EVT_MASK_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_vendor_hci_event_evt_param vendor_hci_evt

    Event parameter of ESP_GAP_BLE_VENDOR_HCI_EVT

  struct esp_ble_gap_cb_param_t::ble_set_common_factor_cmpl_evt_param set_common_factor_cmpl

    Event parameter of ESP_GAP_BLE_SET_COMMON_FACTOR_CMPL_EVT

  struct esp_ble_gap_cb_param_t::ble_set_sch_len_cmpl_evt_param set_sch_len_cmpl

    Event parameter of ESP_GAP_BLE_SET_SCH_LEN_CMPL_EVT

  struct esp_ble_gap_cb_param_t::ble_set_scan_chan_map_cmpl_evt_param set_scan_chan_map_cmpl

    Event parameter of ESP_GAP_BLE_SET_SCAN_CHAN_MAP_CMPL_EVT

  struct esp_ble_gap_cb_param_t::ble_enh_read_trans_pwr_level_param enh_trans_pwr_level_cmpl

    Event parameter of ESP_GAP_BLE_SET_CSA_SUPPORT_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_read_remote_trans_pwr_level_param read_remote_trans_pwr_level_cmpl

    Event parameter of ESP_GAP_BLE_READ_REMOTE_TRANS_PWR_LEVEL_EVT

  struct esp_ble_gap_cb_param_t::ble_set_path_loss_rpting_param set_path_loss_rpting_params

    Event parameter of ESP_GAP_BLE_SET_PATH_LOSS_RPTING_PARAMS_EVT

  struct esp_ble_gap_cb_param_t::ble_set_path_loss_rpting_enable set_path_loss_rpting_enable

    Event parameter of ESP_GAP_BLE_SET_PATH_LOSS_RPTING_ENABLE_EVT

  struct esp_ble_gap_cb_param_t::ble_set_trans_pwr_rpting_enable set_trans_pwr_rpting_enable

    Event parameter of ESP_GAP_BLE_SET_TRANS_PWR_RPTING_ENABLE_EVT

  struct esp_ble_gap_cb_param_t::ble_path_loss_thres_evt path_loss_thres_evt

    Event parameter of ESP_GAP_BLE_PATH_LOSS_THRESHOLD_EVT

  struct esp_ble_gap_cb_param_t::ble_trans_power_report_evt trans_power_report_evt

    Event parameter of ESP_GAP_BLE_TRANS_PWR_RPTING_EVT

  struct esp_ble_gap_cb_param_t::ble_default_subrate_evt set_default_subrate_evt

    Event parameter of ESP_GAP_BLE_SET_DEFAULT_SUBRATE_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_subrate_request_evt subrate_req_cmpl_evt

    Event parameter of ESP_GAP_BLE_SUBRATE_REQUEST_COMPLETE_EVT

  struct esp_ble_gap_cb_param_t::ble_subrate_change_evt subrate_change_evt

    Event parameter of ESP_GAP_BLE_SUBRATE_CHANGE_EVT

  struct esp_ble_gap_cb_param_t::ble_set_host_feature_evt_param host_feature

    Event parameter of ESP_GAP_BLE_SET_HOST_FEATURE_CMPL_EVT

  struct esp_ble_gap_cb_param_t::ble_pa_subevt_data_evt pa_subevt_data_evt

    Event parameter of ESP_GAP_BLE_SET_PERIODIC_ADV_SUBEVT_DATA_EVT

  struct esp_ble_gap_cb_param_t::ble_pa_rsp_data_evt pa_rsp_data_evt

    Event parameter of ESP_GAP_BLE_SET_PERIODIC_ADV_RESPONSE_DATA_EVT

  struct esp_ble_gap_cb_param_t::ble_pa_sync_subevt_evt pa_sync_subevt_evt

    Event parameter of ESP_GAP_BLE_SET_PERIODIC_SYNC_SUBEVT_EVT

  struct esp_ble_gap_cb_param_t::ble_pa_subevt_data_req_evt pa_subevt_data_req_evt

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_SUBEVT_DATA_REQUEST_EVT

  struct esp_ble_gap_cb_param_t::ble_pa_rsp_rpt_evt pa_rsp_rpt_evt

    Event parameter of ESP_GAP_BLE_PERIODIC_ADV_RESPONSE_REPORT_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_read_local_supp_caps_evt cs_read_local_supp_caps

    Event parameter of ESP_GAP_BLE_CS_READ_LOCAL_SUPP_CAPS_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_read_remote_supp_caps cs_read_remote_supp_caps

    Event parameter of ESP_GAP_BLE_CS_READ_REMOTE_SUPP_CAPS_CMPL_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_write_cached_remote_supp_caps cs_write_cached_remote_supp_caps

    Event parameter of ESP_GAP_BLE_CS_WRITE_CACHED_REMOTE_SUPP_CAPS_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_security_enable cs_security_enable

    Event parameter of ESP_GAP_BLE_CS_SECURITY_ENABLE_CMPL_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_set_default_settings cs_set_default_settings

    Event parameter of ESP_GAP_BLE_CS_SET_DEFAULT_SETTINGS_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_read_remote_fae_tab cs_read_remote_fae_tab

    Event parameter of ESP_GAP_BLE_CS_READ_REMOTE_FAE_TABLE_CMPL_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_write_cached_remote_fae_tab cs_write_cached_remote_fae_tab

    Event parameter of ESP_GAP_BLE_CS_WRITE_CACHED_REMOTE_FAE_TABLE_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_config_udpate cs_config_update

    Event parameter of ESP_GAP_BLE_CS_CONFIG_CMPL_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_set_proc_params cs_set_proc_params

    Event parameter of ESP_GAP_BLE_CS_SET_PROC_PARAMS_CMPL_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_set_channel_class cs_set_channel_class

    Event parameter of ESP_GAP_BLE_CS_SET_CHANNEL_CLASS_CMPL_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_proc_enable cs_proc_enable

    Event parameter of ESP_GAP_BLE_CS_PROC_ENABLE_CMPL_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_subevt_result cs_subevt_result

    Event parameter of ESP_GAP_BLE_CS_SUBEVENT_RESULT_EVT

  struct esp_ble_gap_cb_param_t::ble_cs_subevt_result_continue cs_subevt_result_continue

    Event parameter of ESP_GAP_BLE_CS_SUBEVENT_RESULT_CONTINUE_EVT

  struct ble_add_dev_to_resolving_list_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_ADD_DEV_TO_RESOLVING_LIST_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicates the success status of adding a device to the resolving list

  struct ble_add_monitor_adv_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_ADD_MONITOR_ADV_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate add monitor advertiser operation success status

  struct ble_adv_clear_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_ADV_CLEAR_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate adv clear operation success status

  struct ble_adv_data_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_ADV_DATA_SET_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the set advertising data operation success status

  struct ble_adv_data_raw_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_ADV_DATA_RAW_SET_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the set raw advertising data operation success status

  struct ble_adv_start_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_ADV_START_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate advertising start operation success status

  struct ble_adv_stop_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_ADV_STOP_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate adv stop operation success status

  struct ble_adv_terminate_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_ADV_TERMINATED_EVT.

    Public Members

    uint8_t status

      Indicate adv terminate status

    uint8_t adv_instance

      extend advertising handle

    uint16_t conn_idx

      connection index

    uint8_t completed_event

      the number of completed extend advertising events

  struct ble_channel_sel_alg_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CHANNEL_SELECT_ALGORITHM_EVT.

    Public Members

    uint16_t conn_handle

      connection handle

    uint8_t channel_sel_alg

      channel selection algorithm

  struct ble_clear_bond_dev_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CLEAR_BOND_DEV_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the clear bond device operation success status

  struct ble_clear_monitor_adv_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CLEAR_MONITOR_ADV_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate clear monitor advertiser list operation success status

  struct ble_cs_config_udpate
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_CONFIG_CMPL_EVT.

    Public Members

    esp_bt_status_t status

      0x00: Channel Sounding Configuration procedure succeeded other: Channel Sounding Configuration procedure failed

    uint16_t conn_handle

      Connection Handle

    uint8_t config_id

      CS configuration identifier

    uint8_t action

      0x00: CS configuration is removed 0x01: CS configuration is created

    uint8_t main_mode_type

      0x01: Mode-1 0x02: Mode-2 0x03: Mode-3

    uint8_t sub_mode_type

      0x01: Mode-1 0x02: Mode-2 0x03: Mode-3 0xFF: Unused

    uint8_t min_main_mode_steps

      Minimum number of CS main mode steps to be executed before a submode step is executed

    uint8_t max_main_mode_steps

      Maximum number of CS main mode steps to be executed before a submode step is executed

    uint8_t main_mode_repetition

      Number of main mode steps taken from the end of the last CS subevent to be repeated at the beginning of the current CS subevent directly after the last mode-0 step of that event

    uint8_t mode_0_steps

      Number of CS mode-0 steps to be included at the beginning of each CS subevent

    uint8_t role

      0x00: Initiator 0x01: Reflector

    uint8_t rtt_type

      0x00: RTT AA Only 0x01: RTT with 32-bit sounding sequence 0x02: RTT with 96-bit sounding sequence 0x03: RTT with 32-bit random sequence 0x04: RTT with 64-bit random sequence 0x05: RTT with 96-bit random sequence 0x06: RTT with 128-bit random sequence

    uint8_t cs_sync_phy

      0x01: LE 1M PHY 0x02: LE 2M PHY 0x03: LE 2M 2BT PHY

    uint8_t channel_map[ESP_BLE_CS_CHAN_MAP_LEN]

      This parameter contains 80 1-bit fields. The nth such field (in the range 0 to 78) contains the value for the CS channel index n. Channel n is enabled for CS procedure = 1 Channel n is disabled for CS procedure = 0 Channels n = 0, 1, 23, 24, 25, 77, and 78 shall be ignored and shall be set to zero. At least 15 channels shall be enabled. The most significant bit (bit 79) is reserved for future use.

    uint8_t channel_map_repetition

      The number of times the Channel_Map field will be cycled through for non-mode-0 steps within a CS procedure

    uint8_t channel_selection_type

      0x00: Use Channel Selection Algorithm #3b for non-mode-0 CS steps 0x01: Use Channel Selection Algorithm #3c for non-mode-0 CS steps

    uint8_t ch3c_shape

      0x00: Use Hat shape for user-specified channel sequence 0x01: Use X shape for user-specified channel sequence

    uint8_t ch3c_jump

      Number of channels skipped in each rising and falling sequence

    uint8_t reserved

      Reserved, shall be set to 0x00

    uint8_t t_ip1_time

      0x0A, 0x14, 0x1E, 0x28, 0x32, 0x3C, 0x50, or 0x91: Interlude time in microseconds between the RTT packets

    uint8_t t_ip2_time

      0x0A, 0x14, 0x1E, 0x28, 0x32, 0x3C, 0x50, or 0x91: nterlude time in microseconds between the CS tones

    uint8_t t_fcs_time

      0x0F, 0x14, 0x1E, 0x28, 0x32, 0x3C, 0x50, 0x64, 0x78, or 0x96: Time in microseconds for frequency changes

    uint8_t t_pm_time

      0x0A, 0x14, or 0x28: Time in microseconds for the phase measurement period of the CS tones

  struct ble_cs_proc_enable
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_PROC_ENABLE_CMPL_EVT.

    Public Members

    esp_bt_status_t status

      0x00: Channel sounding procedure enable command successful other: Channel sounding procedure enable command failed

    uint16_t conn_handle

      Connection Handle

    uint8_t config_id

      CS configuration identifier

    uint8_t state

      0x00: CS procedures are disabled 0x01: CS procedures are enabled

    uint8_t tone_ant_config_select

      Antenna Configuration Index. Range:0x00 to 0x07

    int8_t select_tx_power

      Transmit power level used for CS procedure. Range: -127 to 20. Units: dBm

    uint32_t subevent_Len

      Duration for each CS subevent in microseconds. Range: 1250 μs to 4 s

    uint8_t subevents_per_event

      Number of CS subevents anchored off the same ACL connection event. Range: 0x01 to 0x20

    uint16_t subevent_interval

      Time between consecutive CS subevents anchored off the same ACL connection event. Units: 0.625 ms

    uint16_t event_interval

      Number of ACL connection events between consecutive CS event anchor points

    uint16_t procedure_interval

      Number of ACL connection events between consecutive CS procedure anchor points

    uint16_t procedure_count

      0x0000: CS procedures to continue until disabled other: Number of CS procedures to be scheduled

    uint16_t max_procedure_len

      Maximum duration for each CS procedure. Range: 0x0001 to 0xFFFF. Time = N × 0.625 ms. Time range: 0.625 ms to 40.959375 s

  struct ble_cs_read_local_supp_caps_evt
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_READ_LOCAL_SUPP_CAPS_EVT.

    Public Members

    esp_bt_status_t status

      Indicate channel sounding read local supported capabilities command successfully completed

    uint8_t num_config_supported

      Number of CS configurations supported per connection

    uint16_t max_consecutive_proc_supported

      0x0000: Support for both a fixed number of consecutive CS procedures and for an indefinite number of CS procedures until termination 0x0001 to 0xFFFF: Maximum number of consecutive CS procedures supported

    uint8_t num_ant_supported

      Number of antennas supported

    uint8_t max_ant_paths_supported

      Maximum number of antenna paths supported

    uint8_t roles_supported

      bit 0: Initiator bit 1: Reflector

    uint8_t modes_supported

      bit 0: Mode-3

    uint8_t rtt_capability

      time-of-flight precision requirement

    uint8_t rtt_aa_only_n

      0x00: RTT AA Only not supported 0x01 to 0xFF: Number of CS steps of single packet exchanges needed to satisfy the precision requirements

    uint8_t rtt_sounding_n

      0x00: RTT Sounding not supported 0x01 to 0xFF: Number of CS steps of single packet exchanges needed to satisfy the precision requirements

    uint8_t rtt_random_payload_n

      0x00: RTT Random Payload not supported 0x01 to 0xFF: Number of CS steps of single packet exchanges needed to satisfy the precision requirements

    uint16_t NADM_sounding_capability

      bit 0: Support for Phase-based Normalized Attack Detector Metric when a CS_SYNC with sounding sequence is received

    uint16_t NADM_random_capability

      bit 0: Support for Phase-based Normalized Attack Detector Metric when a CS_SYNC with random sequence is received

    uint8_t cs_sync_phys_supported

      bit 1: LE 2M PHY bit 2: LE 2M 2BT PHY

    uint16_t subfeatures_supported

      bit 1: CS with no transmitter Frequency Actuation Error bit 2: CS Channel Selection Algorithm #3c bit 3: CS phase-based ranging from RTT sounding sequence

    uint16_t T_IP1_times_supported

      bit 0: 10 μs supported bit 1: 20 μs supported bit 2: 30 μs supported bit 3: 40 μs supported bit 4: 50 μs supported bit 5: 60 μs supported bit 6: 80 μs supported

    uint16_t T_IP2_times_supported

      bit 0: 10 μs supported bit 1: 20 μs supported bit 2: 30 μs supported bit 3: 40 μs supported bit 4: 50 μs supported bit 5: 60 μs supported bit 6: 80 μs supported

    uint16_t T_FCS_times_supported

      bit 0: 15 μs supported bit 1: 20 μs supported bit 2: 30 μs supported bit 3: 40 μs supported bit 4: 50 μs supported bit 5: 60 μs supported bit 6: 80 μs supported bit 7: 100 μs supported bit 8: 120 μs supported

    uint16_t T_PM_times_supported

      bit 0: 10 μs supported bit 1: 20 μs supported

    uint8_t T_SW_times_supported

      0x00, 0x01, 0x02, 0x04, or 0x0A: Time in microseconds for the antenna switch period of the CS tones

    uint8_t TX_SNR_capability

      bit 0: 18 dB supported bit 1: 21 dB supported bit 2: 24 dB supported bit 3: 27 dB supported bit 4: 30 dB supported

  struct ble_cs_read_remote_fae_tab
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_READ_REMOTE_FAE_TABLE_CMPL_EVT.

    Public Members

    esp_bt_status_t status

      0x00: Channel sounding read remote FAE Table command successfully completed other: Channel sounding read remote FAE Table command failed

    uint16_t conn_handle

      Connection Handle

    uint8_t remote_fae_table[72]

      Per-channel mode-0 Frequency Actuation Error table of the remote Controller

  struct ble_cs_read_remote_supp_caps
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_READ_REMOTE_SUPP_CAPS_CMPL_EVT.

    Public Members

    esp_bt_status_t status

      0x00: Channel sounding read remote supported capabilities command successfully completed other: Channel sounding read remote supported capabilities command failed

    uint16_t conn_handle

      Connection Handle

    uint8_t num_config_supported

      Number of CS configurations supported per connection

    uint16_t max_consecutive_proc_supported

      Maximum number of consecutive CS procedures supported

    uint8_t num_ant_supported

      Number of antennas supported

    uint8_t max_ant_paths_supported

      Maximum number of antenna paths supported

    uint8_t roles_supported

      bit 0: Initiator bit 1: Reflector

    uint8_t modes_supported

      bit 0: Mode-3

    uint8_t rtt_capability

      Time-of-flight precision requirement

    uint8_t rtt_aa_only_n

      Number of CS steps of single packet exchanges needed to satisfy the precision requirements

    uint8_t rtt_sounding_n

      Number of CS steps of single packet exchanges needed to satisfy the precision requirements

    uint8_t rtt_random_payload_n

      Number of CS steps of single packet exchanges needed to satisfy the precision requirements

    uint16_t NADM_sounding_capability

      bit 0: Support for Phase-based Normalized Attack Detector Metric when a CS_SYNC with sounding sequence is received

    uint16_t NADM_random_capability

      bit 0: Support for Phase-based Normalized Attack Detector Metric when a CS_SYNC with random sequence is received

    uint8_t cs_sync_phys_supported

      bit 1: LE 2M PHY bit 2: LE 2M 2BT PHY

    uint16_t subfeatures_supported

      bit 1: CS with no transmitter Frequency Actuation Error bit 2: CS Channel Selection Algorithm #3c bit 3: CS phase-based ranging from RTT sounding sequence

    uint16_t T_IP1_times_supported

      bit 0: 10 μs supported bit 1: 20 μs supported bit 2: 30 μs supported bit 3: 40 μs supported bit 4: 50 μs supported bit 5: 60 μs supported bit 6: 80 μs supported

    uint16_t T_IP2_times_supported

      bit 0: 10 μs supported bit 1: 20 μs supported bit 2: 30 μs supported bit 3: 40 μs supported bit 4: 50 μs supported bit 5: 60 μs supported bit 6: 80 μs supported

    uint16_t T_FCS_times_supported

      bit 0: 15 μs supported bit 1: 20 μs supported bit 2: 30 μs supported bit 3: 40 μs supported bit 4: 50 μs supported bit 5: 60 μs supported bit 6: 80 μs supported bit 7: 100 μs supported bit 8: 120 μs supported

    uint16_t T_PM_times_supported

      bit 0: 10 μs supported bit 1: 20 μs supported

    uint8_t T_SW_times_supported

      0x00, 0x01, 0x02, 0x04, or 0x0A: Time in microseconds for the antenna switch period of the CS tones

    uint8_t TX_SNR_capability

      bit 0: 18 dB supported bit 1: 21 dB supported bit 2: 24 dB supported bit 3: 27 dB supported bit 4: 30 dB supported

  struct ble_cs_security_enable
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_SECURITY_ENABLE_CMPL_EVT.

    Public Members

    esp_bt_status_t status

      0x00: Channel sounding security parameters successfully exchanged other: Channel sounding CS security parameter exchange failed

    uint16_t conn_handle

      Connection Handle

  struct ble_cs_set_channel_class
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_SET_CHANNEL_CLASS_CMPL_EVT.

    Public Members

    esp_bt_status_t status

      0x00: Channel sounding set channel classification command successful other: Channel sounding set channel classification command failed

  struct ble_cs_set_default_settings
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_SET_DEFAULT_SETTINGS_EVT.

    Public Members

    esp_bt_status_t status

      0x00: Channel sounding set default settings command successfully completed other: Channel sounding set default settings command failed

    uint16_t conn_handle

      Connection Handle

  struct ble_cs_set_proc_params
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_SET_PROC_PARAMS_CMPL_EVT.

    Public Members

    esp_bt_status_t status

      0x00: Channel sounding set procedure_Parameters command successful other: Channel sounding set procedure_Parameters command failed

    uint16_t conn_handle

      Connection Handle

  struct ble_cs_subevt_result
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_SUBEVENT_RESULT_EVT.

    Public Members

    uint16_t conn_handle

      0x0000 to 0x0EFF: Connection Handle 0x0FFF: CS test

    uint8_t config_id

      CS configuration identifier. Range: 0 to 3

    uint16_t start_acl_conn_event_counter

      Starting ACL connection event counter for the results reported in the event

    uint16_t procedure_counter

      CS procedure count since completion of the Channel Sounding Security Start procedure. Range: 0x0000 to 0xFFFF

    int16_t frequency_compensation

      0xC000: Frequency compensation value is not available, or the role is not initiator other: Frequency compensation value in units of 0.01 ppm (15-bit signed integer). Range: -100 ppm (0x58F0) to +100 ppm (0x2710). Units: 0.01 ppm

    int8_t reference_power_level

      0x7F: Reference power level is not applicable other: Reference power level. Range: -127 to 20. Units: dBm

    uint8_t procedure_done_status

      bit 0 to 3: 0x0 = All results complete for the CS procedure 0x1 = Partial results with more to follow for the CS procedure 0xF = All subsequent CS procedures aborted All other values = Reserved for future use bit 4 to 7: Reserved for future use

    uint8_t subevent_done_status

      bit 0 to 3: 0x0 = All results complete for the CS subevent 0x1 = Partial results with more to follow for the CS subevent 0xF = Current CS subevent aborted All other values = Reserved for future use bit 4 to 7: Reserved for future use

    uint8_t abort_reason

      bit 0 to 3: Indicates the abort reason when Procedure_Done_Status is set to 0xF, otherwise the default value is set to zero. 0x0 = Report with no abort 0x1 = Abort because of local Host or remote request 0x2 = Abort because filtered channel map has less than 15 channels 0x3 = Abort because the channel map update instant has passed 0xF = Abort because of unspecified reasons All other values = Reserved for future use bit 4 to 7: Indicates the abort reason when Subevent_Done_Status is set to 0xF, otherwise the default value is set to zero. 0x0 = Report with no abort 0x1 = Abort because of local Host or remote request 0x2 = Abort because no CS_SYNC (mode-0) received 0x3 = Abort because of scheduling conflicts or limited resources 0xF = Abort because of unspecified reasons All other values = Reserved for future use

    uint8_t num_ant_paths

      0x00: Ignored because phase measurement does not occur during the CS step 0x01 to 0x04: Number of antenna paths used during the phase measurement stage of the CS step

    uint8_t num_steps_reported

      0x00 to 0xA0: Number of steps in the CS subevent for which results are reported

    esp_ble_cs_step_info *step_info

      steps information in the CS subevent

  struct ble_cs_subevt_result_continue
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_SUBEVENT_RESULT_CONTINUE_EVT.

    Public Members

    uint16_t conn_handle

      0x0000 to 0x0EFF: Connection Handle 0x0FFF: CS test

    uint8_t config_id

      CS configuration identifier. Range: 0 to 3

    uint8_t proc_done_status

      bit 0 to 3: 0x0 = All results complete for the CS procedure 0x1 = Partial results with more to follow for the CS procedure 0xF = All subsequent CS procedures aborted All other values = Reserved for future use bit 4 to 7: Reserved for future use

    uint8_t subevt_done_status

      bit 0 to 3: 0x0 = All results complete for the CS subevent 0x1 = Partial results with more to follow for the CS subevent 0xF = Current CS subevent aborted All other values = Reserved for future use bit 4 to 7: Reserved for future use

    uint8_t abort_reason

      bit 0 to 3: Indicates the abort reason when Procedure_Done_Status is set to 0xF, otherwise the default value is set to zero. 0x0 = Report with no abort 0x1 = Abort because of local Host or remote request 0x2 = Abort because filtered channel map has less than 15 channels 0x3 = Abort because the channel map update instant has passed 0xF = Abort because of unspecified reasons All other values = Reserved for future use bit 4 to 7: Indicates the abort reason when Subevent_Done_Status is set to 0xF, otherwise the default value is set to zero. 0x0 = Report with no abort 0x1 = Abort because of local Host or remote request 0x2 = Abort because no CS_SYNC (mode-0) received 0x3 = Abort because of scheduling conflicts or limited resources 0xF = Abort because of unspecified reasons All other values = Reserved for future use

    uint8_t num_ant_paths

      0x00: Ignored because phase measurement does not occur during the CS step 0x01 to 0x04: Number of antenna paths used during the phase measurement stage of the CS step

    uint8_t num_steps_reported

      Number of steps in the CS subevent for which results are reported, Range: 0x00 to 0xA0

    esp_ble_cs_step_info *step_info

      steps information in the CS subevent

  struct ble_cs_write_cached_remote_fae_tab
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_WRITE_CACHED_REMOTE_FAE_TABLE_EVT.

    Public Members

    esp_bt_status_t status

      0x00: Channel sounding write cached remote FAE table command succeeded other: Channel sounding write cached remote FAE table command failed

    uint16_t conn_handle

      Connection Handle

  struct ble_cs_write_cached_remote_supp_caps
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_CS_WRITE_CACHED_REMOTE_SUPP_CAPS_EVT.

    Public Members

    esp_bt_status_t status

      0x00: Channel sounding write cached remote FAE table command succeeded 0x01: Channel sounding write cached remote FAE table command failed

    uint16_t conn_handle

      Connection Handle

  struct ble_default_subrate_evt
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_DEFAULT_SUBRATE_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate setting default subrate command success, status = (controller error code | 0x100) if status is not equal to 0

  struct ble_dtm_state_update_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_DTM_TEST_UPDATE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate DTM operation success status

    esp_ble_dtm_update_evt_t update_evt

      DTM state change event, 0x00: DTM TX start, 0x01: DTM RX start, 0x02:DTM end

    uint16_t num_of_pkt

      number of packets received, only valid if update_evt is DTM_TEST_STOP_EVT and shall be reported as 0 for a transmitter

  struct ble_enable_monitor_adv_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_ENABLE_MONITOR_ADV_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate enable/disable monitor advertising operation success status

  struct ble_enh_read_trans_pwr_level_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_ENH_READ_TRANS_PWR_LEVEL_EVT.

    Public Members

    esp_bt_status_t status

      Indicate enhance reading transmit power level complete status, status = (controller error code | 0x100) if status is not equal to 0

    uint16_t conn_handle

      Connection_Handle

    uint8_t phy

      1M, 2M, Coded S2 or Coded S8 phy 0x01: LE 1M PHY 0x02: LE 2M PHY 0x03: LE Coded PHY with S=8 data coding 0x04: LE Coded PHY with S=2 data coding

    int8_t cur_tx_pwr_level

      Current transmit power level, Range: -127 to 20, Units: dBm

    int8_t max_tx_pwr_level

      Maximum transmit power level, Range: -127 to 20, Units: dBm

  struct ble_ext_adv_data_set_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_EXT_ADV_DATA_SET_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate extend advertising data set status

    uint8_t instance

      extend advertising handle

  struct ble_ext_adv_report_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_EXT_ADV_REPORT_EVT.

    Public Members

    esp_ble_gap_ext_adv_report_t params

      extend advertising report parameters

  struct ble_ext_adv_scan_rsp_set_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_EXT_SCAN_RSP_DATA_SET_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate extend advertising scan response data set status

    uint8_t instance

      extend advertising handle

  struct ble_ext_adv_set_clear_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_EXT_ADV_SET_CLEAR_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate advertising stop operation success status

    uint8_t instance

      extend advertising handle

  struct ble_ext_adv_set_params_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_EXT_ADV_SET_PARAMS_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate extend advertising parameters set status

    uint8_t instance

      extend advertising handle

  struct ble_ext_adv_set_rand_addr_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_EXT_ADV_SET_RAND_ADDR_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate extend advertising random address set status

    uint8_t instance

      extend advertising handle

  struct ble_ext_adv_set_remove_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_EXT_ADV_SET_REMOVE_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate advertising stop operation success status

    uint8_t instance

      extend advertising handle

  struct ble_ext_adv_start_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_EXT_ADV_START_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate advertising start operation success status

    uint8_t instance_num

      extend advertising handle numble

    uint8_t instance[EXT_ADV_NUM_SETS_MAX]

      extend advertising handle list

  struct ble_ext_adv_stop_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_EXT_ADV_STOP_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate advertising stop operation success status

    uint8_t instance_num

      extend advertising handle numble

    uint8_t instance[EXT_ADV_NUM_SETS_MAX]

      extend advertising handle list

  struct ble_ext_conn_params_set_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PREFER_EXT_CONN_PARAMS_SET_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate extend connection parameters set status

  struct ble_ext_scan_start_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_EXT_SCAN_START_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate extend advertising start status

  struct ble_ext_scan_stop_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_EXT_SCAN_STOP_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate extend advertising stop status

  struct ble_get_bond_dev_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_GET_BOND_DEV_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the get bond device operation success status

    uint8_t dev_num

      Indicate the get number device in the bond list

    esp_ble_bond_dev_t *bond_dev

      the pointer to the bond device Structure

  struct ble_get_dev_name_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_GET_DEV_NAME_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the get device name success status

    char *name

      Name of bluetooth device

  struct ble_local_privacy_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_LOCAL_PRIVACY_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the set local privacy operation success status

  struct ble_monitor_adv_report_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_MONITOR_ADV_REPORT_EVT.

    Public Members

    esp_ble_addr_type_t addr_type

      address type

    esp_bd_addr_t addr

      advertiser address

    uint8_t condition

      RSSI threshold condition (e.g. entered/left range)

  struct ble_pa_rsp_data_evt
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_PERIODIC_ADV_RESPONSE_DATA_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic adv response data update success status

    uint16_t sync_handle

      identifying the periodic advertising train

  struct ble_pa_rsp_rpt_evt
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_RESPONSE_REPORT_EVT.

    Public Members

    uint8_t adv_handle

      Used to identify a periodic advertising train

    uint8_t subevt

      The subevent number

    uint8_t tx_status

      0x00 AUX_SYNC_SUBEVENT_IND packet was transmitted. 0x01 AUX_SYNC_SUBEVENT_IND packet was not transmitted.

    uint8_t num_rsp

      Number of responses in event

    esp_ble_pa_rsp_info *pa_rsp_info

      response information

  struct ble_pa_subevt_data_evt
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_PERIODIC_ADV_SUBEVT_DATA_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic adv subevent data update success status

    uint8_t adv_handle

      Used to identify a periodic advertising train

  struct ble_pa_subevt_data_req_evt
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_SUBEVT_DATA_REQUEST_EVT.

    Public Members

    uint8_t adv_handle

      Used to identify a periodic advertising train

    uint8_t subevt_start

      The first subevent that data is requested for.

    uint8_t subevt_data_count

      The number of subevents that data is requested for.

  struct ble_pa_sync_subevt_evt
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_PERIODIC_SYNC_SUBEVT_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic sync subevent update success status

    uint16_t sync_handle

      identifying the periodic advertising train

  struct ble_path_loss_thres_evt
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PATH_LOSS_THRESHOLD_EVT.

    Public Members

    uint16_t conn_handle

      The ACL connection identifier

    uint8_t cur_path_loss

      Current path loss (always zero or positive), Units: dB

    esp_ble_path_loss_zone_t zone_entered

      which zone was entered. If cur_path_loss is set to 0xFF then zone_entered shall be ignored

  struct ble_period_adv_add_dev_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_ADD_DEV_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic advertising device list add status

  struct ble_period_adv_clear_dev_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_CLEAR_DEV_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic advertising device list clean status

  struct ble_period_adv_create_sync_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_CREATE_SYNC_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic advertising create sync status

  struct ble_period_adv_remove_dev_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_REMOVE_DEV_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic advertising device list remove status

  struct ble_period_adv_sync_cancel_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_SYNC_CANCEL_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic advertising sync cancel status

  struct ble_period_adv_sync_terminate_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_SYNC_TERMINATE_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic advertising sync terminate status

  struct ble_periodic_adv_data_set_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_DATA_SET_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic advertising data set status

    uint8_t instance

      extend advertising handle

  struct ble_periodic_adv_recv_enable_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_RECV_ENABLE_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Set periodic advertising receive enable status

  struct ble_periodic_adv_report_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_REPORT_EVT.

    Public Members

    esp_ble_gap_periodic_adv_report_t params

      periodic advertising report parameters

  struct ble_periodic_adv_set_info_trans_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_SET_INFO_TRANS_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Periodic advertising set info transfer status

    esp_bd_addr_t bda

      The remote device address

  struct ble_periodic_adv_set_params_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_SET_PARAMS_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic advertisingparameters set status

    uint8_t instance

      extend advertising handle

  struct ble_periodic_adv_start_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_START_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic advertising start status

    uint8_t instance

      extend advertising handle

  struct ble_periodic_adv_stop_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_STOP_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate periodic advertising stop status

    uint8_t instance

      extend advertising handle

  struct ble_periodic_adv_sync_estab_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_SYNC_ESTAB_EVT.

    Public Members

    esp_bt_status_t status

      periodic advertising sync status

    uint16_t sync_handle

      periodic advertising sync handle

    uint8_t sid

      periodic advertising sid

    esp_ble_addr_type_t adv_addr_type

      periodic advertising address type

    esp_bd_addr_t adv_addr

      periodic advertising address

    esp_ble_gap_phy_t adv_phy

      periodic advertising phy type

    uint16_t period_adv_interval

      periodic advertising interval

    uint8_t adv_clk_accuracy

      periodic advertising clock accuracy

  struct ble_periodic_adv_sync_lost_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_SYNC_LOST_EVT.

    Public Members

    uint16_t sync_handle

      sync handle

  struct ble_periodic_adv_sync_trans_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_SYNC_TRANS_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Periodic advertising sync transfer status

    esp_bd_addr_t bda

      The remote device address

  struct ble_periodic_adv_sync_trans_recv_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PERIODIC_ADV_SYNC_TRANS_RECV_EVT.

    Public Members

    esp_bt_status_t status

      Periodic advertising sync transfer received status

    esp_bd_addr_t bda

      The remote device address

    uint16_t service_data

      The value provided by the peer device

    uint16_t sync_handle

      Periodic advertising sync handle

    uint8_t adv_sid

      Periodic advertising set id

    uint8_t adv_addr_type

      Periodic advertiser address type

    esp_bd_addr_t adv_addr

      Periodic advertiser address

    esp_ble_gap_phy_t adv_phy

      Periodic advertising PHY

    uint16_t adv_interval

      Periodic advertising interval

    uint8_t adv_clk_accuracy

      Periodic advertising clock accuracy

  struct ble_phy_update_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_PHY_UPDATE_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      phy update status

    esp_bd_addr_t bda

      address

    esp_ble_gap_phy_t tx_phy

      tx phy type

    esp_ble_gap_phy_t rx_phy

      rx phy type

  struct ble_pkt_data_length_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_PKT_LENGTH_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the set pkt data length operation success status

    esp_ble_pkt_data_length_params_t params

      pkt data length value

  struct ble_read_ble_channel_map_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_READ_CHANNEL_MAP_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Status of the read channel map operation

    uint8_t channel_map[ESP_GAP_BLE_CHANNELS_LEN]

      The BLE channel map, represented as a 5-byte array

    esp_bd_addr_t remote_addr

      The remote device address

  struct ble_read_monitor_adv_list_size_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_READ_MONITOR_ADV_LIST_SIZE_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate read monitor advertiser list size operation success status

    uint8_t list_size

      Monitor advertiser list capacity

  struct ble_read_phy_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_READ_PHY_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      read phy complete status

    esp_bd_addr_t bda

      read phy address

    esp_ble_gap_phy_t tx_phy

      tx phy type

    esp_ble_gap_phy_t rx_phy

      rx phy type

  struct ble_read_remote_trans_pwr_level_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_READ_REMOTE_TRANS_PWR_LEVEL_EVT.

    Public Members

    esp_bt_status_t status

      Indicate reading remote transmit power level complete status, status = (controller error code | 0x100) if status is not equal to 0

  struct ble_read_rssi_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_READ_RSSI_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the read adv tx power operation success status

    int8_t rssi

      The ble remote device rssi value, the range is from -127 to 20, the unit is dbm, if the RSSI cannot be read, the RSSI metric shall be set to 127.

    esp_bd_addr_t remote_addr

      The remote device address

  struct ble_remove_bond_dev_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_REMOVE_BOND_DEV_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the remove bond device operation success status

    esp_bd_addr_t bd_addr

      The device address which has been remove from the bond list

  struct ble_remove_monitor_adv_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_REMOVE_MONITOR_ADV_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate remove monitor advertiser operation success status

  struct ble_rpa_timeout_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_RPA_TIMEOUT_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the set RPA timeout operation success status

  struct ble_scan_param_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the set scan param operation success status

  struct ble_scan_req_received_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SCAN_REQ_RECEIVED_EVT.

    Public Members

    uint8_t adv_instance

      extend advertising handle

    esp_ble_addr_type_t scan_addr_type

      scanner address type

    esp_bd_addr_t scan_addr

      scanner address

  struct ble_scan_result_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SCAN_RESULT_EVT.

    Public Members

    esp_gap_search_evt_t search_evt

      Search event type

    esp_bd_addr_t bda

      Bluetooth device address which has been searched

    esp_bt_dev_type_t dev_type

      Device type

    esp_ble_addr_type_t ble_addr_type

      Ble device address type

    esp_ble_evt_type_t ble_evt_type

      Ble scan result event type

    int rssi

      Searched device's RSSI

    uint8_t ble_adv[ESP_BLE_ADV_DATA_LEN_MAX + ESP_BLE_SCAN_RSP_DATA_LEN_MAX]

      Received EIR

    int flag

      Advertising data flag bit

    int num_resps

      Scan result number

    uint8_t adv_data_len

      Adv data length

    uint8_t scan_rsp_len

      Scan response length

    uint32_t num_dis

      The number of discard packets

  struct ble_scan_rsp_data_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SCAN_RSP_DATA_SET_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the set scan response data operation success status

  struct ble_scan_rsp_data_raw_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SCAN_RSP_DATA_RAW_SET_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the set raw advertising data operation success status

  struct ble_scan_start_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SCAN_START_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate scan start operation success status

  struct ble_scan_stop_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SCAN_STOP_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate scan stop operation success status

  struct ble_set_channels_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_CHANNELS_EVT.

    Public Members

    esp_bt_status_t stat

      BLE set channel status

  struct ble_set_common_factor_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_COMMON_FACTOR_CMPL_EVT.

    Public Members

    esp_bt_status_t status

      Indicate common factor set operation success status

  struct ble_set_csa_support_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_CSA_SUPPORT_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate CSA support set operation success status

  struct ble_set_ext_scan_params_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_EXT_SCAN_PARAMS_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate extend advertising parameters set status

  struct ble_set_host_feature_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_HOST_FEATURE_CMPL_EVT.

    Public Members

    esp_bt_status_t status

      Indicate host feature update success status

  struct ble_set_past_params_cmpl_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_PAST_PARAMS_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Set periodic advertising sync transfer params status

    esp_bd_addr_t bda

      The remote device address

  struct ble_set_path_loss_rpting_enable
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_PATH_LOSS_RPTING_ENABLE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate setting path loss reporting enable complete status, status = (controller error code | 0x100) if status is not equal to 0

    uint16_t conn_handle

      The ACL connection identifier

  struct ble_set_path_loss_rpting_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_PATH_LOSS_RPTING_PARAMS_EVT.

    Public Members

    esp_bt_status_t status

      Indicate setting path loss reporting paramwters complete status, status = (controller error code | 0x100) if status is not equal to 0

    uint16_t conn_handle

      The ACL connection identifier

  struct ble_set_perf_def_phy_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_PREFERRED_DEFAULT_PHY_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate perf default phy set status

  struct ble_set_perf_phy_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_PREFERRED_PHY_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate perf phy set status

  struct ble_set_privacy_mode_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_PRIVACY_MODE_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate privacy mode set operation success status

  struct ble_set_rand_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_STATIC_RAND_ADDR_EVT.

    Public Members

    esp_bt_status_t status

      Indicate set static rand address operation success status

  struct ble_set_scan_chan_map_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_SCAN_CHAN_MAP_CMPL_EVT.

    Public Members

    esp_bt_status_t status

      Indicate channel map for scanning set operation success status

  struct ble_set_sch_len_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_SCH_LEN_CMPL_EVT.

    Public Members

    esp_bt_status_t status

      Indicate scheduling length set operation success status

  struct ble_set_trans_pwr_rpting_enable
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_TRANS_PWR_RPTING_ENABLE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate setting transmit power reporting enable complete status, status = (controller error code | 0x100) if status is not equal to 0

    uint16_t conn_handle

      The ACL connection identifier

  struct ble_set_vendor_evt_mask_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SET_VENDOR_EVT_MASK_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate set vendor event mask operation success status

  struct ble_subrate_change_evt
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SUBRATE_CHANGE_EVT.

    Public Members

    esp_bt_status_t status

      command succeeded or this event was generated following a request from the peer device. status = (controller error code | 0x100) if status is not equal to 0

    uint16_t conn_handle

      connection handle

    uint16_t subrate_factor

      New subrate factor applied to the specified underlying connection interval, range 0x0001 to 0x01F4

    uint16_t peripheral_latency

      New Peripheral latency for the connection in number of subrated connection events, range: 0x0000 to 0x01F3

    uint16_t continuation_number

      Number of underlying connection events to remain active after a packet containing a Link Layer PDU with a non-zero Length field is sent or received, range: 0x0000 to 0x01F3

    uint16_t supervision_timeout

      New supervision timeout for this connection(Time = N × 10 ms). Range: 0x000A to 0x0C80, Time Range: 100 ms to 32 s

  struct ble_subrate_request_evt
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_SUBRATE_REQUEST_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate subrate request command success, status = (controller error code | 0x100) if status is not equal to 0

  struct ble_trans_power_report_evt
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_TRANS_PWR_RPTING_EVT.

    Public Members

    esp_bt_status_t status

      Indicate esp_ble_gap_read_remote_transmit_power_level() command success, status = (controller error code | 0x100) if status is not equal to 0

    uint16_t conn_handle

      The ACL connection identifier

    uint8_t reason

      indicate why the event was sent and the device whose transmit power level is being reported 0x00: Local transmit power changed 0x01: Remote transmit power changed 0x02: esp_ble_gap_read_remote_transmit_power_level() command completed, In this case, the phy, tx_power_level, tx_power_level_flag and delta parameters shall refer to the remote device

    esp_ble_tx_power_phy_t phy

      1M, 2M, Coded S2 or Coded S8 phy 0x01: LE 1M PHY 0x02: LE 2M PHY 0x03: LE Coded PHY with S=8 data coding 0x04: LE Coded PHY with S=2 data coding

    int8_t tx_power_level

      Transmit power level, range: -127 to 20, units: dBm 0x7E: Remote device is not managing power levels on this PHY 0x7F: Transmit power level is not available

    uint8_t tx_power_level_flag

      whether the transmit power level that is being reported has reached its minimum and/or maximum level

    int8_t delta

      Change in transmit power level (positive indicates increased power, negative indicates decreased power, zero indicates unchanged) Units: dB. 0x7F: Change is not available or is out of range

  struct ble_update_conn_params_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_UPDATE_CONN_PARAMS_EVT.

    Public Members

    esp_bt_status_t status

      Indicate update connection parameters success status

    esp_bd_addr_t bda

      Bluetooth device address

    uint16_t min_int

      Minimum connection interval. If the master initiates the connection parameter update, this value is not applicable for the slave and will be set to zero.

    uint16_t max_int

      Maximum connection interval. If the master initiates the connection parameter update, this value is not applicable for the slave and will be set to zero.

    uint16_t latency

      Slave latency for the connection in number of connection events. Range: 0x0000 to 0x01F3

    uint16_t conn_int

      Current connection interval in milliseconds, calculated as N × 1.25 ms

    uint16_t timeout

      Supervision timeout for the LE Link. Range: 0x000A to 0x0C80. This value is calculated as N × 10 ms

  struct ble_update_duplicate_exceptional_list_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_UPDATE_DUPLICATE_EXCEPTIONAL_LIST_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate update duplicate scan exceptional list operation success status

    uint8_t subcode

      Define in esp_bt_duplicate_exceptional_subcode_type_t

    uint16_t length

      The length of device_info

    esp_duplicate_info_t device_info

      device information, when subcode is ESP_BLE_DUPLICATE_EXCEPTIONAL_LIST_CLEAN, the value is invalid

  struct ble_update_whitelist_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_UPDATE_WHITELIST_COMPLETE_EVT.

    Public Members

    esp_bt_status_t status

      Indicate the add or remove whitelist operation success status

    esp_ble_wl_operation_t wl_operation

      The value is ESP_BLE_WHITELIST_ADD if add address to whitelist operation success, ESP_BLE_WHITELIST_REMOVE if remove address from the whitelist operation success

  struct ble_vendor_hci_event_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_VENDOR_HCI_EVT.

    Public Members

    esp_ble_vendor_evt_t subevt_code

      Subevent code for BLE vendor HCI event

    esp_ble_vendor_evt_param_t param

      Event parameter of BLE vendor HCI subevent

    uint8_t param_len

      The length of the event parameter buffer (for internal use only)

    uint8_t *param_buf

      The pointer of the event parameter buffer (for internal use only)

  struct vendor_cmd_cmpl_evt_param
    #include <esp_gap_ble_api.h>

    ESP_GAP_BLE_VENDOR_CMD_COMPLETE_EVT.

    Public Members

    uint16_t opcode

      vendor hci command opcode

    uint16_t param_len

      The length of parameter buffer

    uint8_t *p_param_buf

      The point of parameter buffer

### Structures

struct esp_ble_vendor_cmd_params_t

  Vendor HCI command parameters.

  Public Members

  uint16_t opcode

    vendor hci command opcode

  uint8_t param_len

    the length of parameter

  uint8_t *p_param_buf

    the point of parameter buffer

struct esp_ble_dtm_tx_t

  DTM TX parameters.

  Public Members

  uint8_t tx_channel

    channel for sending test data, tx_channel = (Frequency -2402)/2, tx_channel range:0x00-0x27, Frequency range: 2402 MHz to 2480 MHz

  uint8_t len_of_data

    length in bytes of payload data in each packet

  esp_ble_dtm_pkt_payload_t pkt_payload

    packet payload type. value range: 0x00-0x07

struct esp_ble_dtm_rx_t

  DTM RX parameters.

  Public Members

  uint8_t rx_channel

    channel for test data reception, rx_channel = (Frequency -2402)/2, tx_channel range:0x00-0x27, Frequency range: 2402 MHz to 2480 MHz

struct esp_ble_adv_params_t

  Advertising parameters.

  Public Members

  uint16_t adv_int_min

    Minimum advertising interval for undirected and low duty cycle directed advertising. Range: 0x0020 to 0x4000 Default: N = 0x0800 (1.28 second) Time = N * 0.625 msec Time Range: 20 ms to 10.24 sec

  uint16_t adv_int_max

    Maximum advertising interval for undirected and low duty cycle directed advertising. Range: 0x0020 to 0x4000 Default: N = 0x0800 (1.28 second) Time = N * 0.625 msec Time Range: 20 ms to 10.24 sec Advertising max interval

  esp_ble_adv_type_t adv_type

    Advertising type

  esp_ble_addr_type_t own_addr_type

    Owner bluetooth device address type

  esp_bd_addr_t peer_addr

    Peer device bluetooth device address

  esp_ble_addr_type_t peer_addr_type

    Peer device bluetooth device address type, only support public address type and random address type

  esp_ble_adv_channel_t channel_map

    Advertising channel map

  esp_ble_adv_filter_t adv_filter_policy

    Advertising filter policy

struct esp_ble_adv_data_t

  Advertising data content, according to "Supplement to the Bluetooth Core Specification".

  Public Members

  bool set_scan_rsp

    Set this advertising data as scan response or not

  bool include_name

    Advertising data include device name or not

  bool include_txpower

    Advertising data include TX power

  int min_interval

    Advertising data show slave preferred connection min interval. The connection interval in the following manner: connIntervalmin = Conn_Interval_Min * 1.25 ms Conn_Interval_Min range: 0x0006 to 0x0C80 Value of 0xFFFF indicates no specific minimum. Values not defined above are reserved for future use.

  int max_interval

    Advertising data show slave preferred connection max interval. The connection interval in the following manner: connIntervalmax = Conn_Interval_Max * 1.25 ms Conn_Interval_Max range: 0x0006 to 0x0C80 Conn_Interval_Max shall be equal to or greater than the Conn_Interval_Min. Value of 0xFFFF indicates no specific maximum. Values not defined above are reserved for future use.

  int appearance

    External appearance of device

  uint16_t manufacturer_len

    Manufacturer data length

  uint8_t *p_manufacturer_data

    Manufacturer data point

  uint16_t service_data_len

    Service data length

  uint8_t *p_service_data

    Service data point

  uint16_t service_uuid_len

    Service uuid length

  uint8_t *p_service_uuid

    Service uuid array point

  uint8_t flag

    Advertising flag of discovery mode, see BLE_ADV_DATA_FLAG detail

struct esp_ble_scan_params_t

  Ble scan parameters.

  Public Members

  esp_ble_scan_type_t scan_type

    Scan type

  esp_ble_addr_type_t own_addr_type

    Owner address type

  esp_ble_scan_filter_t scan_filter_policy

    Scan filter policy

  uint16_t scan_interval

    Scan interval. This is defined as the time interval from when the Controller started its last LE scan until it begins the subsequent LE scan. Range: 0x0004 to 0x4000 Default: 0x0010 (10 ms) Time = N * 0.625 msec Time Range: 2.5 msec to 10.24 seconds

  uint16_t scan_window

    Scan window. The duration of the LE scan. LE_Scan_Window shall be less than or equal to LE_Scan_Interval Range: 0x0004 to 0x4000 Default: 0x0010 (10 ms) Time = N * 0.625 msec Time Range: 2.5 msec to 10240 msec

  esp_ble_scan_duplicate_t scan_duplicate

    The Scan_Duplicates parameter controls whether the Link Layer should filter out duplicate advertising reports (BLE_SCAN_DUPLICATE_ENABLE) to the Host, or if the Link Layer should generate advertising reports for each packet received

struct esp_gap_conn_params_t

  connection parameters information

  Public Members

  uint16_t interval

    connection interval

  uint16_t latency

    Slave latency for the connection in number of connection events. Range: 0x0000 to 0x01F3

  uint16_t timeout

    Supervision timeout for the LE Link. Range: 0x000A to 0x0C80. Mandatory Range: 0x000A to 0x0C80 Time = N * 10 msec Time Range: 100 msec to 32 seconds

struct esp_ble_conn_update_params_t

  Connection update parameters.

  Public Members

  esp_bd_addr_t bda

    Bluetooth device address

  uint16_t min_int

    Min connection interval

  uint16_t max_int

    Max connection interval

  uint16_t latency

    Slave latency for the connection in number of connection events. Range: 0x0000 to 0x01F3

  uint16_t timeout

    Supervision timeout for the LE Link. Range: 0x000A to 0x0C80. Mandatory Range: 0x000A to 0x0C80 Time = N * 10 msec Time Range: 100 msec to 32 seconds

struct esp_ble_pkt_data_length_params_t

  BLE pkt date length keys.

  Public Members

  uint16_t rx_len

    pkt rx data length value

  uint16_t tx_len

    pkt tx data length value

struct esp_ble_penc_keys_t

  BLE encryption keys.

  Public Members

  esp_bt_octet16_t ltk

    The long term key

  esp_bt_octet8_t rand

    The random number

  uint16_t ediv

    The ediv value

  uint8_t sec_level

    The security level of the security link

  uint8_t key_size

    The key size(7~16) of the security link

struct esp_ble_pcsrk_keys_t

  BLE CSRK keys.

  Public Members

  uint32_t counter

    The counter

  esp_bt_octet16_t csrk

    The csrk key

  uint8_t sec_level

    The security level

struct esp_ble_pid_keys_t

  BLE pid keys.

  Public Members

  esp_bt_octet16_t irk

    The irk value

  esp_ble_addr_type_t addr_type

    The address type

  esp_bd_addr_t static_addr

    The static address

struct esp_ble_lenc_keys_t

  BLE Encryption reproduction keys.

  Public Members

  esp_bt_octet16_t ltk

    The long term key

  uint16_t div

    The div value

  uint8_t key_size

    The key size of the security link

  uint8_t sec_level

    The security level of the security link

struct esp_ble_lcsrk_keys

  BLE SRK keys.

  Public Members

  uint32_t counter

    The counter value

  uint16_t div

    The div value

  uint8_t sec_level

    The security level of the security link

  esp_bt_octet16_t csrk

    The csrk key value

struct esp_ble_sec_key_notif_t

  Structure associated with ESP_KEY_NOTIF_EVT.

  Public Members

  esp_bd_addr_t bd_addr

    peer address

  uint32_t passkey

    the numeric value for comparison. If just_works, do not show this number to UI

struct esp_ble_sec_req_t

  Structure of the security request.

  Public Members

  esp_bd_addr_t bd_addr

    peer address

struct esp_ble_bond_key_info_t

  struct type of the bond key information value

  Public Members

  esp_ble_key_mask_t key_mask

    the key mask to indicate witch key is present

  esp_ble_penc_keys_t penc_key

    received peer encryption key

  esp_ble_pcsrk_keys_t pcsrk_key

    received peer device SRK

  esp_ble_pid_keys_t pid_key

    peer device ID key

struct esp_ble_bond_dev_t

  struct type of the bond device value

  Public Members

  esp_bd_addr_t bd_addr

    peer address

  esp_ble_bond_key_info_t bond_key

    the bond key information

  esp_ble_addr_type_t bd_addr_type

    peer address type

struct esp_ble_key_t

  union type of the security key value

  Public Members

  esp_bd_addr_t bd_addr

    peer address

  esp_ble_key_type_t key_type

    key type of the security link

  esp_ble_key_value_t p_key_value

    the pointer to the key value

struct esp_ble_local_id_keys_t

  structure type of the ble local id keys value

  Public Members

  esp_bt_octet16_t ir

    the 16 bits of the ir value

  esp_bt_octet16_t irk

    the 16 bits of the ir key value

  esp_bt_octet16_t dhk

    the 16 bits of the dh key value

struct esp_ble_local_oob_data_t

  structure type of the ble local oob data value

  Public Members

  esp_bt_octet16_t oob_c

    the 128 bits of confirmation value

  esp_bt_octet16_t oob_r

    the 128 bits of randomizer value

struct esp_ble_auth_cmpl_t

  Structure associated with ESP_AUTH_CMPL_EVT.

  Public Members

  esp_bd_addr_t bd_addr

    BD address of peer device

  bool key_present

    True if the link key value is valid; false otherwise

  esp_link_key key

    Link key associated with peer device

  uint8_t key_type

    The type of link key

  bool success

    True if authentication succeeded; false otherwise

  esp_ble_auth_fail_rsn_t fail_reason

    The HCI reason/error code for failure when success is false

  esp_ble_addr_type_t addr_type

    Peer device address type

  esp_bt_dev_type_t dev_type

    Device type

  esp_ble_auth_req_t auth_mode

    Authentication mode

struct esp_ble_gap_ext_adv_params_t

  ext adv parameters

  Public Members

  esp_ble_ext_adv_type_mask_t type

    ext adv type

  uint32_t interval_min

    ext adv minimum interval

  uint32_t interval_max

    ext adv maximum interval

  esp_ble_adv_channel_t channel_map

    ext adv channel map

  esp_ble_addr_type_t own_addr_type

    ext adv own address type

  esp_ble_addr_type_t peer_addr_type

    ext adv peer address type

  esp_bd_addr_t peer_addr

    ext adv peer address

  esp_ble_adv_filter_t filter_policy

    ext adv filter policy

  int8_t tx_power

    ext adv tx power. For this advertising set, priority is higher than `esp_ble_tx_power_set()`, `esp_ble_tx_power_set_enhanced()`, and menuconfig default TX power (`CONFIG_BT_CTRL_DFT_TX_POWER_LEVEL`). The actual applied TX power may be different from the requested value, depending on the Controller TX power granularity/level mechanism. (for example ESP32-C3/ESP32-S3 with 3 dBm step), the actual applied TX power may be rounded down and be 0 to 2 dBm lower than the requested value.)

  esp_ble_gap_pri_phy_t primary_phy

    ext adv primary phy

  uint8_t max_skip

    ext adv maximum skip

  esp_ble_gap_phy_t secondary_phy

    ext adv secondary phy. Note: If the advertiser sends connectable advertising packets on the LE Coded PHY, the peer may then establish the ACL connection on the LE Coded PHY, which will significantly degrade Wi-Fi performance in Bluetooth/Wi-Fi coexistence scenarios because Coded PHY (S=2/S=8) packets occupy the radio for much longer than 1M/2M PHY packets. It is recommended to use the LE 2M PHY (or LE 1M PHY) first, and only use the LE Coded PHY when the long-range capability is really required.

  uint8_t sid

    ext adv sid

  bool scan_req_notif

    ext adv scan request event notify

struct esp_ble_ext_scan_cfg_t

  ext scan config

  Public Members

  esp_ble_scan_type_t scan_type

    ext scan type

  uint16_t scan_interval

    ext scan interval

  uint16_t scan_window

    ext scan window

struct esp_ble_ext_scan_params_t

  ext scan parameters

  Public Members

  esp_ble_addr_type_t own_addr_type

    ext scan own address type

  esp_ble_scan_filter_t filter_policy

    ext scan filter policy

  esp_ble_scan_duplicate_t scan_duplicate

    ext scan duplicate scan

  esp_ble_ext_scan_cfg_mask_t cfg_mask

    ext scan config mask

  esp_ble_ext_scan_cfg_t uncoded_cfg

    ext scan uncoded config parameters

  esp_ble_ext_scan_cfg_t coded_cfg

    ext scan coded config parameters

struct esp_ble_gap_conn_params_t

  create extend connection parameters

  Public Members

  uint16_t scan_interval

    init scan interval

  uint16_t scan_window

    init scan window

  uint16_t interval_min

    minimum interval

  uint16_t interval_max

    maximum interval

  uint16_t latency

    ext scan type

  uint16_t supervision_timeout

    connection supervision timeout

  uint16_t min_ce_len

    minimum ce length

  uint16_t max_ce_len

    maximum ce length

struct esp_ble_gap_ext_adv_t

  extend adv enable parameters

  Public Members

  uint8_t instance

    advertising handle

  int duration

    advertising duration

  int max_events

    maximum number of extended advertising events

struct esp_ble_gap_periodic_adv_params_t

  periodic adv parameters

  Public Members

  uint16_t interval_min

    periodic advertising minimum interval

  uint16_t interval_max

    periodic advertising maximum interval

  uint16_t properties

    periodic advertising properties

struct esp_ble_gap_periodic_adv_sync_params_t

  periodic adv sync parameters

  Public Members

  esp_ble_gap_sync_t filter_policy

    Configures the filter policy for periodic advertising sync: 0: Use Advertising SID, Advertiser Address Type, and Advertiser Address parameters to determine the advertiser to listen to. 1: Use the Periodic Advertiser List to determine the advertiser to listen to.

  uint8_t sid

    SID of the periodic advertising

  esp_ble_addr_type_t addr_type

    Address type of the periodic advertising

  esp_bd_addr_t addr

    Address of the periodic advertising

  uint16_t skip

    Maximum number of periodic advertising events that can be skipped

  uint16_t sync_timeout

    Synchronization timeout

struct esp_ble_gap_ext_adv_report_t

  extend adv report parameters

  Public Members

  esp_ble_gap_adv_type_t event_type

    extend advertising type

  uint8_t addr_type

    extend advertising address type

  esp_bd_addr_t addr

    extend advertising address

  esp_ble_gap_pri_phy_t primary_phy

    extend advertising primary phy

  esp_ble_gap_phy_t secondly_phy

    extend advertising secondary phy

  uint8_t sid

    extend advertising sid

  uint8_t tx_power

    extend advertising tx power

  int8_t rssi

    extend advertising rssi

  uint16_t per_adv_interval

    periodic advertising interval

  uint8_t dir_addr_type

    direct address type

  esp_bd_addr_t dir_addr

    direct address

  esp_ble_gap_ext_adv_data_status_t data_status

    data type

  uint8_t adv_data_len

    extend advertising data length

  uint8_t adv_data[251]

    extend advertising data

struct esp_ble_gap_periodic_adv_report_t

  periodic adv report parameters

  Public Members

  uint16_t sync_handle

    periodic advertising train handle

  uint8_t tx_power

    periodic advertising tx power

  int8_t rssi

    periodic advertising rssi

  esp_ble_gap_ext_adv_data_status_t data_status

    periodic advertising data type

  uint8_t data_length

    periodic advertising data length

  uint8_t data[251]

    periodic advertising data

struct esp_ble_gap_periodic_adv_sync_estab_t

  periodic adv sync establish parameters

  Public Members

  uint8_t status

    periodic advertising sync status

  uint16_t sync_handle

    periodic advertising train handle

  uint8_t sid

    periodic advertising sid

  esp_ble_addr_type_t addr_type

    periodic advertising address type

  esp_bd_addr_t adv_addr

    periodic advertising address

  esp_ble_gap_phy_t adv_phy

    periodic advertising adv phy type

  uint16_t period_adv_interval

    periodic advertising interval

  uint8_t adv_clk_accuracy

    periodic advertising clock accuracy

struct esp_ble_dtm_enh_tx_t

  DTM TX parameters.

  Public Members

  uint8_t tx_channel

    channel for sending test data, tx_channel = (Frequency -2402)/2, tx_channel range:0x00-0x27, Frequency range: 2402 MHz to 2480 MHz

  uint8_t len_of_data

    length in bytes of payload data in each packet

  esp_ble_dtm_pkt_payload_t pkt_payload

    packet payload type. value range: 0x00-0x07

  esp_ble_gap_phy_t phy

    the phy type used by the transmitter, coded phy with S=2:0x04

struct esp_ble_dtm_enh_rx_t

  DTM RX parameters.

  Public Members

  uint8_t rx_channel

    channel for test data reception, rx_channel = (Frequency -2402)/2, tx_channel range:0x00-0x27, Frequency range: 2402 MHz to 2480 MHz

  esp_ble_gap_phy_t phy

    the phy type used by the receiver, 1M phy: 0x01, 2M phy:0x02, coded phy:0x03

  uint8_t modulation_idx

    modulation index, 0x00:standard modulation index, 0x01:stable modulation index

struct esp_ble_gap_past_params_t

  periodic adv sync transfer parameters

  Public Members

  esp_ble_gap_past_mode_t mode

    periodic advertising sync transfer mode

  uint16_t skip

    the number of periodic advertising packets that can be skipped

  uint16_t sync_timeout

    synchronization timeout for the periodic advertising train

  uint8_t cte_type

    periodic advertising sync transfer CET type

struct esp_ble_gap_add_monitor_adv_params_t

  Parameters for adding a device to the LE Monitor Advertisers list.

  Public Members

  esp_ble_addr_type_t addr_type

    Address type of the advertiser

  esp_bd_addr_t addr

    Device address of the advertiser to monitor

  int8_t rssi_low

    Low threshold of RSSI (dBm). Report when RSSI goes at or below this value

  int8_t rssi_high

    High threshold of RSSI (dBm). Report when RSSI goes at or above this value

  uint8_t timeout

    Monitor timeout: 0 = no timeout; 1–0xFF = timeout in seconds

struct esp_ble_gap_remove_monitor_adv_params_t

  Parameters for removing a device from the LE Monitor Advertisers list.

  Public Members

  esp_ble_addr_type_t addr_type

    Address type of the advertiser

  esp_bd_addr_t addr

    Device address of the advertiser to remove from the monitor list

struct esp_ble_path_loss_rpt_params_t

  path loss report parameters

  Public Members

  uint16_t conn_handle

    Connection_Handle

  uint8_t high_threshold

    High threshold for the path loss (dB)

  uint8_t high_hysteresis

    Hysteresis value for the high threshold (dB)

  uint8_t low_threshold

    Low threshold for the path loss (dB)

  uint8_t low_hysteresis

    Hysteresis value for the low threshold (dB)

  uint16_t min_time_spent

    Minimum time in number of connection events to be observed once the path loss crosses the threshold before an event is generated

struct esp_ble_default_subrate_param_t

  Connection subrating default parameters.

  Public Members

  uint16_t subrate_min

    Minimum subrate factor allowed in requests by a Peripheral. Range: 0x0001 to 0x01F4, default: 0x0001

  uint16_t subrate_max

    Maximum subrate factor allowed in requests by a Peripheral. Range: 0x0001 to 0x01F4, default: 0x0001. subrate_max × (max_latency + 1) should not be greater than 500

  uint16_t max_latency

    Maximum Peripheral latency allowed in requests by a Peripheral, in units of subrated connection intervals. Range: 0x0000 to 0x01F3, default: 0x0000

  uint16_t continuation_number

    Minimum number of underlying connection events to remain active after a packet containing a Link Layer PDU with a non-zero Length field is sent or received in requests by a Peripheral. Range: 0x0000 to 0x01F3, default: 0x0000. continuation_number should not greater than or equal to subrate_max

  uint16_t supervision_timeout

    Maximum supervision timeout allowed in requests by a Peripheral (N * 10 ms). Range: 0x000A to 0x0C80, Time Range: 100 ms to 32 s, default: 0x0C80 (32 s)

struct esp_ble_subrate_req_param_t

  Connection subrating request parameters.

  Public Members

  uint16_t conn_handle

    Connection handle of the ACL

  uint16_t subrate_min

    Minimum subrate factor to be applied to the underlying connection interval. Range: 0x0001 to 0x01F4

  uint16_t subrate_max

    Maximum subrate factor to be applied to the underlying connection interval. Range: 0x0001 to 0x01F4

  uint16_t max_latency

    Maximum Peripheral latency for the connection in units of subrated connection intervals. Range: 0x0000 to 0x01F3

  uint16_t continuation_number

    Minimum number of underlying connection events to remain active after a packet containing a Link Layer PDU with a non-zero Length field is sent or received. Range: 0x0000 to 0x01F3

  uint16_t supervision_timeout

    Supervision timeout for this connection (N * 10 ms). Range: 0x000A to 0x0C80, Time Range: 100 ms to 32 s The supervision_timeout, in milliseconds, shall be greater than 2 × current connection interval × subrate_max × (max_latency + 1)

struct esp_ble_subevent_params

  Periodic adv subevent parameters.

  Public Members

  uint8_t subevent

    The subevent index of the data contained in this command. Range: 0x00 to 0x7F

  uint8_t response_slot_start

    The first response slots to be used in this subevent

  uint8_t response_slot_count

    The number of response slots to be used

  uint8_t subevent_data_len

    The number of octets in the Subevent_Data parameter. Range: 0 to 251

  uint8_t *subevent_data

    The advertising data to be transmitted in the subevent of the advertising set

struct esp_ble_per_adv_subevent_data_params

  Periodic adv subevent data parameters.

  Public Members

  uint8_t adv_handle

    Used to identify a periodic advertising train

  uint8_t num_subevents_with_data

    Number of subevent data in the command. Range: 0x0001 to 0x0F

  esp_ble_subevent_params *subevent_params

    Periodic adv subevent parameters

struct esp_ble_per_adv_response_data_params

  Periodic adv response data parameters.

  Public Members

  uint16_t sync_handle

    Sync_Handle identifying the PAwR train

  uint16_t request_event

    The value of eventCounter for the periodic advertising packet that the Host is responding to

  uint8_t request_subevent

    The subevent for the periodic advertising packet that the Host is responding to

  uint8_t response_subevent

    Used to identify the subevent of the PAwR train. Range: 0x00 to 0x7F

  uint8_t response_slot

    Used to identify the response slot of the PAwR train. Range: 0x00 to 0xFF

  uint8_t response_data_len

    The number of octets in the Response_Data parameter. Range: 0 to 251

  uint8_t *response_data

    Response data

struct esp_ble_per_sync_subevent_params

  Periodic sync subevent parameters.

  Public Members

  uint16_t sync_handle

    Sync_Handle identifying the PAwR train

  uint16_t periodic_adv_properties

    Include TxPower in the advertising PDU

  uint8_t num_subevents_to_sync

    Number of subevents. Range: 0x01 to 0x80

  uint8_t *subevent

    The subevent to synchronize with. Range 0x00 to 0x7F

struct esp_ble_pa_rsp_info

  Periodic response information.

  Public Members

  int8_t tx_power

    Range: -127 to +20, Units: dBm 0x7F: Tx Power information not available

  int8_t rssi

    Range: -127 to +20. Units: dBm 0x7F: RSSI is not available

  uint8_t cte_type

    cte type 0x00: AoA Constant Tone Extension 0x01: AoD Constant Tone Extension with 1 µs slots 0x02: AoD Constant Tone Extension with 2 µs slots 0xFF: No Constant Tone Extension

  uint8_t rsp_slot

    The response slot the data was received in.

  uint8_t data_status

    Data status 0x00: Data complete 0x01: Data incomplete, more data to come 0xFF: Failed to receive or listen for an AUX_SYNC_SUBEVENT_RSP PDU

  uint8_t data_len

    Length of the Data field

  uint8_t *data

    Periodic advertising response data formatted as defined in [Vol 3] Part C, Section 11

struct esp_ble_cs_write_cached_remote_supp_caps_params

  CS write cached remote supported capabilities parameters.

  Public Members

  uint16_t conn_handle

    Connection_Handle

  uint8_t num_config_supported

    The number of CS configurations that are supported by the remote Controller. Range: 0x01 to 0x04

  uint16_t max_consecutive_proc_supported

    0x0000: Support for both a fixed number of consecutive CS procedures and for an indefinite number of CS procedures until termination 0x0001 to 0xFFFF: The Maximum number of consecutive CS procedures supported

  uint8_t num_ant_supported

    Number of antennas supported. Range: 0x01 to 0x04

  uint8_t max_ant_paths_supported

    Maximum number of antenna paths supported. Range: 0x01 to 0x04

  bool initiator_role_supported

    Initiator role that are supported by the remote Controller

  bool reflector_role_supported

    Reflector role that are supported by the remote Controller

  uint8_t modes_supported

    The optional CS modes that are supported by the remote Controller bit 0: Mode-3

  esp_ble_cs_rtt_caps_opt_t rtt_capability

    time-of-flight precision requirement

  uint8_t rtt_aa_only_n

    0x00: RTT AA-only not supported. 0x01 to 0xff: Number of CS_SYNC exchanges needed to satisfy the precision requirements

  uint8_t rtt_sounding_n

    0x00: RTT Sounding not supported 0x01 to 0xFF: Number of CS_SYNC exchanges needed to satisfy the precision requirements

  uint8_t rtt_random_payload_n

    0x00: RTT Random Payload not supported 0x01 to 0xff: Number of CS_SYNC exchanges needed to satisfy the time-of-flight precision requirements

  uint16_t NADM_sounding_capability

    Support for Phase-based Normalized Attack Detector Metric when a CS_SYNC with sounding sequence is received

  uint16_t NADM_random_capability

    Support for Phase-based Normalized Attack Detector Metric when a CS_SYNC with random sequence is received

  bool cs_sync_2m_phy_supported

    CS_SYNC 2M phy supported

  bool cs_sync_2m_2bt_phy_supported

    CS_SYNC 2M 2BT phy supported

  uint16_t subfeatures_supported

    bit 1: CS with a Frequency Actuation Error of zero relative to mode-0 transmissions in the reflector role bit 2: CS Channel Selection Algorithm #3c bit 3: CS phase-based ranging from an RTT sounding sequence

  uint16_t T_IP1_times_supported

    bit 0: 10 μs supported bit 1: 20 μs supported bit 2: 30 μs supported bit 3: 40 μs supported bit 4: 50 μs supported bit 5: 60 μs supported bit 6: 80 μs supported

  uint16_t T_IP2_times_supported

    bit 0: 10 μs supported bit 1: 20 μs supported bit 2: 30 μs supported bit 3: 40 μs supported bit 4: 50 μs supported bit 5: 60 μs supported bit 6: 80 μs supported

  uint16_t T_FCS_times_supported

    bit 0: 15 μs supported bit 1: 20 μs supported bit 2: 30 μs supported bit 3: 40 μs supported bit 4: 50 μs supported bit 5: 60 μs supported bit 6: 80 μs supported bit 7: 100 μs supported bit 8: 120 μs supported

  uint16_t T_PM_times_supported

    bit 0: 10 μs supported bit 1: 20 μs supported

  uint8_t T_SW_times_supported

    Time in microseconds for the antenna switch period of the CS tones. Range: 0x00 to 0x04 or 0x0A

  uint8_t TX_SNR_capability

    bit 0: 18 dB supported bit 1: 21 dB supported bit 2: 24 dB supported bit 3: 27 dB supported bit 4: 30 dB supported

struct esp_ble_cs_set_default_settings_params

  CS set default settings parameters.

  Public Members

  uint16_t conn_handle

    Connection_Handle

  bool initiator_role_enable

    Initiator role is enabled

  bool reflector_role_enable

    Reflector role is enabled

  esp_ble_cs_sync_ant_selection_opt_t cs_sync_ant_selection

    0x01 to 0x04: Antenna identifier to be used for CS_SYNC packets by the local Controller 0xFE: Antennas to be used, in repetitive order from 0x01 to 0x04, for CS_SYNC packets by the local Controller 0xFF: Host does not have a recommendation

  int8_t max_tx_power

    The maximum transmit power level to be used for all CS transmissions. Range: -127 to 20. Units: dBm

struct esp_ble_cs_write_cached_remote_fae_table_params

  CS write cached remote Frequency Actuation Error table parameters.

  Public Members

  uint16_t conn_handle

    Connection_Handle

  uint8_t remote_fae_table[72]

    Per-channel mode-0 Frequency Actuation Error table of the local Controller

struct esp_ble_cs_create_config_params

  CS create configuration parameters.

  Public Members

  uint16_t conn_handle

    Connection_Handle

  uint8_t config_id

    CS configuration identifier. Range: 0 to 3

  esp_ble_cs_create_context_opt_t create_context

    0x00: Write CS configuration in local Controller only 0x01: Write CS configuration in both local and remote Controller using Channel Sounding Configuration procedure

  esp_ble_cs_main_mode_opt_t main_mode_type

    0x01: Mode-1 0x02: Mode-2 0x03: Mode-3

  esp_ble_cs_sub_mode_opt_t sub_mode_type

    0x01: Mode-1 0x02: Mode-2 0x03: Mode-3 0xFF: Unused

  uint8_t min_main_mode_steps

    Minimum number of CS main mode steps to be executed before a submode step is executed. Range: 0x02 to 0xFF

  uint8_t max_main_mode_steps

    Maximum number of CS main mode steps to be executed before a submode step is executed. Range: 0x02 to 0xFF

  uint8_t main_mode_repetition

    The number of main mode steps taken from the end of the last CS subevent to be repeated at the beginning of the current CS subevent directly after the last mode-0 step of that event. Range: 0x00 to 0x03

  uint8_t mode_0_steps

    Number of CS mode-0 steps to be included at the beginning of each CS subevent. Range: 0x01 to 0x03

  esp_ble_cs_role_opt_t role

    0x00: Initiator 0x01: Reflector

  esp_ble_cs_rtt_type_opt_t rtt_type

    0x00: RTT AA-only 0x01: RTT with 32-bit sounding sequence 0x02: RTT with 96-bit sounding sequence 0x03: RTT with 32-bit random sequence 0x04: RTT with 64-bit random sequence 0x05: RTT with 96-bit random sequence 0x06: RTT with 128-bit random sequence

  esp_ble_cs_sync_phy_opt_t cs_sync_phy

    0x01: LE 1M PHY 0x02: LE 2M PHY 0x03: LE 2M 2BT PHY

  uint8_t channel_map[ESP_BLE_CS_CHAN_MAP_LEN]

    This parameter contains 80 1-bit fields. The nth such field (in the range 0 to 78) contains the value for the CS channel index n. Channel n is enabled for CS procedure = 1 Channel n is disabled for CS procedure = 0 Channels n = 0, 1, 23, 24, 25, 77, and 78 shall be ignored and shall be set to zero. At least 15 channels shall be enabled. The most significant bit (bit 79) is reserved for future use

  uint8_t channel_map_repetition

    The number of times the map represented by the Channel_Map field is to be cycled through for non-mode-0 steps within a CS procedure. Range: 0x01 to 0xFF

  esp_ble_cs_channel_select_type_opt_t channel_selection_type

    0x00: Use Channel Selection Algorithm #3b for non-mode-0 CS steps 0x01: Use Channel Selection Algorithm #3c for non-mode-0 CS steps

  esp_ble_cs_ch3c_shape_opt_t ch3c_shape

    0x00: Use Hat shape for user-specified channel sequence 0x01: Use X shape for user-specified channel sequence

  uint8_t ch3c_jump

    Number of channels skipped in each rising and falling sequence. Range: 0x02 to 0x08

  uint8_t reserved

    Reserved, shall be set to 0x00

struct esp_ble_cs_remove_config_params

  CS remove configuration parameters.

  Public Members

  uint16_t conn_handle

    Connection_Handle

  uint8_t config_id

    CS configuration identifier. Range: 0 to 3

struct esp_ble_cs_set_channel_class_params

  CS set channel class parameters.

  Public Members

  uint8_t channel_class[10]

    This parameter contains 80 1-bit fields. The nth such field (in the range 0 to 78) contains the value for the CS channel index n. Channel n is enabled for CS procedure = 1 Channel n is disabled for CS procedure = 0 Channels n = 0, 1, 23, 24, 25, 77, and 78 shall be reserved for future use and shall be set to zero. At least 15 channels shall be enabled. The most significant bit (bit 79) is reserved for future use.

struct esp_ble_cs_set_proc_params

  CS set procedure parameters.

  Public Members

  uint16_t conn_handle

    Connection_Handle

  uint8_t config_id

    CS configuration identifier. Range: 0 to 3

  uint16_t max_procedure_len

    Maximum duration for each CS procedure. Range: 0x0001 to 0xFFFF. Time = N × 0.625 ms

  uint16_t min_procedure_interval

    Minimum number of connection events between consecutive CS procedures. Range: 0x0001 to 0xFFFF

  uint16_t max_procedure_interval

    Maximum number of connection events between consecutive CS procedures. Range: 0x0001 to 0xFFFF

  uint16_t max_procedure_count

    0x0000:CS procedures to continue until disabled 0xxxxx: Maximum number of CS procedures to be scheduled

  uint32_t min_subevent_len

    Minimum suggested duration for each CS subevent in microseconds. Range: 1250 μs to 4 s

  uint32_t max_subevent_len

    Maximum suggested duration for each CS subevent in microseconds. Range: 1250 μs to 4 s

  uint8_t tone_ant_config_selection

    Antenna Configuration Index. Range: 0x00 to 0x07

  esp_ble_cs_phy_opt_t phy

    0x01: LE 1M PHY 0x02: LE 2M PHY 0x03: LE Coded PHY with S=8 data coding 0x04: LE Coded PHY with S=2 data coding

  uint8_t tx_power_delta

    0xxx: Transmit power delta, in signed dB, to indicate the recommended difference between the remote device’s power level for the CS tones and RTT packets and the existing power level for the PHY indicated by the PHY parameter 0x80: Host does not have a recommendation for transmit power delta

  esp_ble_cs_preferred_peer_ant_t preferred_peer_antenna

    bit 0: Use first ordered antenna element bit 1: Use second ordered antenna element bit 2: Use third ordered antenna element bit 3: Use fourth ordered antenna element

  esp_ble_cs_snr_control_adjustment_t SNR_control_initiator

    0x00: SNR control adjustment of 18 dB. 0x01: SNR control adjustment of 21 dB. 0x02: SNR control adjustment of 24 dB. 0x03: SNR control adjustment of 27 dB. 0x04: SNR control adjustment of 30 dB. 0xFF: SNR control is not to be applied

  esp_ble_cs_snr_control_adjustment_t SNR_control_reflector

    0x00: SNR control adjustment of 18 dB. 0x01: SNR control adjustment of 21 dB. 0x02: SNR control adjustment of 24 dB. 0x03: SNR control adjustment of 27 dB. 0x04: SNR control adjustment of 30 dB. 0xFF: SNR control is not to be applied.

struct esp_ble_cs_procedure_enable_params

  CS procedure enable parameters.

  Public Members

  uint16_t conn_handle

    Connection_Handle

  uint8_t config_id

    CS configuration identifier. Range: 0 to 3

  esp_ble_cs_procedures_action_t enable

    0x00: CS procedures are to be disabled 0x01: CS procedures are to be enabled

struct esp_ble_cs_step_info

  CS step information.

  Public Members

  uint8_t step_mode

    0x00 to 0x03: Mode type

  uint8_t step_channel

    0x00 to 0x4E: CS channel index

  uint8_t step_data_len

    0x00 to 0xFF: Length of mode- and role-specific information being reported

  uint8_t *data

    Mode- and role-specific information being reported as Mode_Role_Specific_Info object

### Macros

ESP_BLE_ADV_FLAG_LIMIT_DISC

  BLE_ADV_DATA_FLAG data flag bit definition used for advertising data flag.

ESP_BLE_ADV_FLAG_GEN_DISC

ESP_BLE_ADV_FLAG_BREDR_NOT_SPT

ESP_BLE_ADV_FLAG_DMT_CONTROLLER_SPT

ESP_BLE_ADV_FLAG_DMT_HOST_SPT

ESP_BLE_ADV_FLAG_NON_LIMIT_DISC

ESP_LE_KEY_NONE

  relate to BTM_LE_KEY_xxx in stack/btm_api.h

  No encryption key

ESP_LE_KEY_PENC

  encryption key, encryption information of peer device

ESP_LE_KEY_PID

  identity key of the peer device

ESP_LE_KEY_PCSRK

  peer SRK

ESP_LE_KEY_PLK

  Link key

ESP_LE_KEY_LLK

  peer link key

ESP_LE_KEY_LENC

  master role security information:div

ESP_LE_KEY_LID

  master device ID key

ESP_LE_KEY_LCSRK

  local CSRK has been deliver to peer

ESP_LE_AUTH_NO_BOND

  relate to BTM_LE_AUTH_xxx in stack/btm_api.h

  0 no bondingv

ESP_LE_AUTH_BOND

  1 << 0 device in the bonding with peer

ESP_LE_AUTH_REQ_MITM

  1 << 2 man in the middle attack

ESP_LE_AUTH_REQ_BOND_MITM

  0101 banding with man in the middle attack

ESP_LE_AUTH_REQ_SC_ONLY

  1 << 3 secure connection

ESP_LE_AUTH_REQ_SC_BOND

  1001 secure connection with band

ESP_LE_AUTH_REQ_SC_MITM

  1100 secure conn with MITM

ESP_LE_AUTH_REQ_SC_MITM_BOND

  1101 SC with MITM and Bonding

ESP_BLE_ONLY_ACCEPT_SPECIFIED_AUTH_DISABLE

  authentication disable

ESP_BLE_ONLY_ACCEPT_SPECIFIED_AUTH_ENABLE

  authentication enable

ESP_BLE_OOB_DISABLE

  disable the out of bond

ESP_BLE_OOB_ENABLE

  enable the out of bond

ESP_IO_CAP_OUT

  relate to BTM_IO_CAP_xxx in stack/btm_api.h

  DisplayOnly

ESP_IO_CAP_IO

  DisplayYesNo

ESP_IO_CAP_IN

  KeyboardOnly

ESP_IO_CAP_NONE

  NoInputNoOutput

ESP_IO_CAP_KBDISP

  Keyboard display

ESP_BLE_APPEARANCE_UNKNOWN

  relate to BTM_BLE_APPEARANCE_UNKNOWN in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_PHONE

  relate to BTM_BLE_APPEARANCE_GENERIC_PHONE in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_COMPUTER

  relate to BTM_BLE_APPEARANCE_GENERIC_COMPUTER in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_WATCH

  relate to BTM_BLE_APPEARANCE_GENERIC_WATCH in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_SPORTS_WATCH

  relate to BTM_BLE_APPEARANCE_SPORTS_WATCH in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_CLOCK

  relate to BTM_BLE_APPEARANCE_GENERIC_CLOCK in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_DISPLAY

  relate to BTM_BLE_APPEARANCE_GENERIC_DISPLAY in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_REMOTE

  relate to BTM_BLE_APPEARANCE_GENERIC_REMOTE in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_EYEGLASSES

  relate to BTM_BLE_APPEARANCE_GENERIC_EYEGLASSES in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_TAG

  relate to BTM_BLE_APPEARANCE_GENERIC_TAG in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_KEYRING

  relate to BTM_BLE_APPEARANCE_GENERIC_KEYRING in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_MEDIA_PLAYER

  relate to BTM_BLE_APPEARANCE_GENERIC_MEDIA_PLAYER in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_BARCODE_SCANNER

  relate to BTM_BLE_APPEARANCE_GENERIC_BARCODE_SCANNER in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_THERMOMETER

  relate to BTM_BLE_APPEARANCE_GENERIC_THERMOMETER in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_THERMOMETER_EAR

  relate to BTM_BLE_APPEARANCE_THERMOMETER_EAR in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_HEART_RATE

  relate to BTM_BLE_APPEARANCE_GENERIC_HEART_RATE in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_HEART_RATE_BELT

  relate to BTM_BLE_APPEARANCE_HEART_RATE_BELT in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_BLOOD_PRESSURE

  relate to BTM_BLE_APPEARANCE_GENERIC_BLOOD_PRESSURE in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_BLOOD_PRESSURE_ARM

  relate to BTM_BLE_APPEARANCE_BLOOD_PRESSURE_ARM in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_BLOOD_PRESSURE_WRIST

  relate to BTM_BLE_APPEARANCE_BLOOD_PRESSURE_WRIST in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_HID

  relate to BTM_BLE_APPEARANCE_GENERIC_HID in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_HID_KEYBOARD

  relate to BTM_BLE_APPEARANCE_HID_KEYBOARD in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_HID_MOUSE

  relate to BTM_BLE_APPEARANCE_HID_MOUSE in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_HID_JOYSTICK

  relate to BTM_BLE_APPEARANCE_HID_JOYSTICK in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_HID_GAMEPAD

  relate to BTM_BLE_APPEARANCE_HID_GAMEPAD in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_HID_DIGITIZER_TABLET

  relate to BTM_BLE_APPEARANCE_HID_DIGITIZER_TABLET in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_HID_CARD_READER

  relate to BTM_BLE_APPEARANCE_HID_CARD_READER in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_HID_DIGITAL_PEN

  relate to BTM_BLE_APPEARANCE_HID_DIGITAL_PEN in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_HID_BARCODE_SCANNER

  relate to BTM_BLE_APPEARANCE_HID_BARCODE_SCANNER in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_GLUCOSE

  relate to BTM_BLE_APPEARANCE_GENERIC_GLUCOSE in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_WALKING

  relate to BTM_BLE_APPEARANCE_GENERIC_WALKING in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_WALKING_IN_SHOE

  relate to BTM_BLE_APPEARANCE_WALKING_IN_SHOE in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_WALKING_ON_SHOE

  relate to BTM_BLE_APPEARANCE_WALKING_ON_SHOE in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_WALKING_ON_HIP

  relate to BTM_BLE_APPEARANCE_WALKING_ON_HIP in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_CYCLING

  relate to BTM_BLE_APPEARANCE_GENERIC_CYCLING in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_CYCLING_COMPUTER

  relate to BTM_BLE_APPEARANCE_CYCLING_COMPUTER in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_CYCLING_SPEED

  relate to BTM_BLE_APPEARANCE_CYCLING_SPEED in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_CYCLING_CADENCE

  relate to BTM_BLE_APPEARANCE_CYCLING_CADENCE in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_CYCLING_POWER

  relate to BTM_BLE_APPEARANCE_CYCLING_POWER in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_CYCLING_SPEED_CADENCE

  relate to BTM_BLE_APPEARANCE_CYCLING_SPEED_CADENCE in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_STANDALONE_SPEAKER

  relate to BTM_BLE_APPEARANCE_STANDALONE_SPEAKER in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_PULSE_OXIMETER

  relate to BTM_BLE_APPEARANCE_GENERIC_PULSE_OXIMETER in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_PULSE_OXIMETER_FINGERTIP

  relate to BTM_BLE_APPEARANCE_PULSE_OXIMETER_FINGERTIP in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_PULSE_OXIMETER_WRIST

  relate to BTM_BLE_APPEARANCE_PULSE_OXIMETER_WRIST in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_WEIGHT

  relate to BTM_BLE_APPEARANCE_GENERIC_WEIGHT in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_PERSONAL_MOBILITY_DEVICE

  relate to BTM_BLE_APPEARANCE_GENERIC_PERSONAL_MOBILITY_DEVICE in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_POWERED_WHEELCHAIR

  relate to BTM_BLE_APPEARANCE_POWERED_WHEELCHAIR in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_MOBILITY_SCOOTER

  relate to BTM_BLE_APPEARANCE_MOBILITY_SCOOTER in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_CONTINUOUS_GLUCOSE_MONITOR

  relate to BTM_BLE_APPEARANCE_GENERIC_CONTINUOUS_GLUCOSE_MONITOR in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_INSULIN_PUMP

  relate to BTM_BLE_APPEARANCE_GENERIC_INSULIN_PUMP in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_INSULIN_PUMP_DURABLE_PUMP

  relate to BTM_BLE_APPEARANCE_INSULIN_PUMP_DURABLE_PUMP in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_INSULIN_PUMP_PATCH_PUMP

  relate to BTM_BLE_APPEARANCE_INSULIN_PUMP_PATCH_PUMP in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_INSULIN_PEN

  relate to BTM_BLE_APPEARANCE_INSULIN_PEN in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_MEDICATION_DELIVERY

  relate to BTM_BLE_APPEARANCE_GENERIC_MEDICATION_DELIVERY in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_GENERIC_OUTDOOR_SPORTS

  relate to BTM_BLE_APPEARANCE_GENERIC_OUTDOOR_SPORTS in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION

  relate to BTM_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_AND_NAV

  relate to BTM_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_AND_NAV in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_POD

  relate to BTM_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_POD in stack/btm_ble_api.h

ESP_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_POD_AND_NAV

  relate to BTM_BLE_APPEARANCE_OUTDOOR_SPORTS_LOCATION_POD_AND_NAV in stack/btm_ble_api.h

BLE_DTM_PKT_PAYLOAD_0x00

  PRBS9 sequence ‘11111111100000111101...’ (in transmission order) as described in [Vol 6] Part F, Section 4.1.5

BLE_DTM_PKT_PAYLOAD_0x01

  Repeated ‘11110000’ (in transmission order) sequence as described in [Vol 6] Part F, Section 4.1.5

BLE_DTM_PKT_PAYLOAD_0x02

  Repeated ‘10101010’ (in transmission order) sequence as described in [Vol 6] Part F, Section 4.1.5

BLE_DTM_PKT_PAYLOAD_0x03

  PRBS15 sequence as described in [Vol 6] Part F, Section 4.1.5

BLE_DTM_PKT_PAYLOAD_0x04

  Repeated ‘11111111’ (in transmission order) sequence

BLE_DTM_PKT_PAYLOAD_0x05

  Repeated ‘00000000’ (in transmission order) sequence

BLE_DTM_PKT_PAYLOAD_0x06

  Repeated ‘00001111’ (in transmission order) sequence

BLE_DTM_PKT_PAYLOAD_0x07

  Repeated ‘01010101’ (in transmission order) sequence

BLE_DTM_PKT_PAYLOAD_MAX

  0x08 ~ 0xFF, Reserved for future use

ESP_GAP_BLE_CHANNELS_LEN

  channel length

ESP_GAP_BLE_ADD_WHITELIST_COMPLETE_EVT

  This is the old name, just for backwards compatibility.

ESP_BLE_ADV_DATA_LEN_MAX

  Advertising data maximum length.

ESP_BLE_SCAN_RSP_DATA_LEN_MAX

  Scan response data maximum length.

VENDOR_HCI_CMD_MASK

ESP_BLE_GAP_ADV_ITVL_MS(t)

  BLE time interval conversion macros.

  These macros convert time values in milliseconds to BLE interval units.

  - Advertising interval: unit is 0.625ms (range: 20ms to 10240ms)

  - Connection interval: unit is 1.25ms (range: 7.5ms to 4000ms)

  - Scan interval/window: unit is 0.625ms

  - Periodic advertising interval: unit is 1.25ms

  - Supervision timeout: unit is 10ms (range: 100ms to 32000ms)

  备注

  If the input value is not an exact multiple of the unit, the result will be rounded to the nearest value. For example, ESP_BLE_GAP_ADV_ITVL_MS(25) = 40 (25ms / 0.625ms = 40), but ESP_BLE_GAP_ADV_ITVL_MS(25.5) = 40 (rounded). Convert advertising interval from ms to 0.625ms units. If input is not a multiple of 0.625ms, it will be rounded to the nearest value.

ESP_BLE_GAP_SCAN_ITVL_MS(t)

  Convert scan interval from ms to 0.625ms units. If input is not a multiple of 0.625ms, it will be rounded to the nearest value.

ESP_BLE_GAP_SCAN_WIN_MS(t)

  Convert scan window from ms to 0.625ms units. If input is not a multiple of 0.625ms, it will be rounded to the nearest value.

ESP_BLE_GAP_CONN_ITVL_MS(t)

  Convert connection interval from ms to 1.25ms units. If input is not a multiple of 1.25ms, it will be rounded to the nearest value.

ESP_BLE_GAP_PERIODIC_ADV_ITVL_MS(t)

  Convert periodic advertising interval from ms to 1.25ms units. If input is not a multiple of 1.25ms, it will be rounded to the nearest value.

ESP_BLE_GAP_SUPERVISION_TIMEOUT_MS(t)

  Convert supervision timeout from ms to 10ms units. If input is not a multiple of 10ms, it will be rounded to the nearest value.

BLE_BIT(n)

ESP_BLE_GAP_SET_EXT_ADV_PROP_NONCONN_NONSCANNABLE_UNDIRECTED

  Non-Connectable and Non-Scannable Undirected advertising

ESP_BLE_GAP_SET_EXT_ADV_PROP_CONNECTABLE

  Connectable advertising

ESP_BLE_GAP_SET_EXT_ADV_PROP_SCANNABLE

  Scannable advertising

ESP_BLE_GAP_SET_EXT_ADV_PROP_DIRECTED

  Directed advertising

ESP_BLE_GAP_SET_EXT_ADV_PROP_HD_DIRECTED

  High Duty Cycle Directed Connectable advertising (<= 3.75 ms Advertising Interval)

ESP_BLE_GAP_SET_EXT_ADV_PROP_LEGACY

  Use legacy advertising PDUs

ESP_BLE_GAP_SET_EXT_ADV_PROP_ANON_ADV

  Omit advertiser's address from all PDUs ("anonymous advertising")

ESP_BLE_GAP_SET_EXT_ADV_PROP_INCLUDE_TX_PWR

  Include TxPower in the extended header of the advertising PDU

ESP_BLE_GAP_SET_EXT_ADV_PROP_MASK

  Reserved for future use If extended advertising PDU types are being used (bit 4 = 0) then: The advertisement shall not be both connectable and scannable. High duty cycle directed connectable advertising (<= 3.75 ms advertising interval) shall not be used (bit 3 = 0) ADV_IND

ESP_BLE_GAP_SET_EXT_ADV_PROP_LEGACY_IND

ESP_BLE_GAP_SET_EXT_ADV_PROP_LEGACY_LD_DIR

  < ADV_DIRECT_IND (low duty cycle)

ESP_BLE_GAP_SET_EXT_ADV_PROP_LEGACY_HD_DIR

  < ADV_DIRECT_IND (high duty cycle)

ESP_BLE_GAP_SET_EXT_ADV_PROP_LEGACY_SCAN

  < ADV_SCAN_IND

ESP_BLE_GAP_SET_EXT_ADV_PROP_LEGACY_NONCONN

  < ADV_NONCONN_IND

ESP_BLE_GAP_PHY_1M

  Secondery Advertisement PHY is LE1M

ESP_BLE_GAP_PHY_2M

  Secondery Advertisement PHY is LE2M

ESP_BLE_GAP_PHY_CODED

  Secondery Advertisement PHY is LE Coded

ESP_BLE_GAP_NO_PREFER_TRANSMIT_PHY

  No Prefer TX PHY supported by controller

ESP_BLE_GAP_NO_PREFER_RECEIVE_PHY

  No Prefer RX PHY supported by controller

ESP_BLE_GAP_PRI_PHY_1M

  Primary phy only support 1M and LE coded phy.

  Primary Phy is LE1M

ESP_BLE_GAP_PRI_PHY_CODED

  Primary Phy is LE CODED

ESP_BLE_GAP_RPT_PHY_1M

  Advertiser PHY is LE 1M

ESP_BLE_GAP_RPT_PHY_2M

  Advertiser PHY is LE 2M

ESP_BLE_GAP_RPT_PHY_S8

  If the Advertising Coding Selection feature bit is set: Advertising PHY is LE 125K Otherwise: Advertiser PHY is LE Coded

ESP_BLE_GAP_RPT_PHY_S2

  If the Advertising Coding Selection feature bit is set: Advertising PHY is LE 500K Otherwise: Reserved for future use

ESP_BLE_GAP_PHY_1M_PREF_MASK

  The Host prefers use the LE1M transmitter or receiver PHY

ESP_BLE_GAP_PHY_2M_PREF_MASK

  The Host prefers use the LE2M transmitter or receiver PHY

ESP_BLE_GAP_PHY_CODED_PREF_MASK

  The Host prefers use the LE CODED transmitter or receiver PHY

ESP_BLE_GAP_PHY_OPTIONS_NO_PREF

  The Host has no preferred coding when transmitting on the LE Coded PHY

ESP_BLE_GAP_PHY_OPTIONS_PREF_S2_CODING

  The Host prefers that S=2 coding be used when transmitting on the LE Coded PHY

ESP_BLE_GAP_PHY_OPTIONS_PREF_S8_CODING

  The Host prefers that S=8 coding be used when transmitting on the LE Coded PHY

ESP_BLE_GAP_EXT_SCAN_CFG_UNCODE_MASK

  Scan Advertisements on the LE1M PHY

ESP_BLE_GAP_EXT_SCAN_CFG_CODE_MASK

  Scan advertisements on the LE coded PHY

ESP_BLE_GAP_EXT_ADV_DATA_COMPLETE

  Advertising data.

  extended advertising data compete

ESP_BLE_GAP_EXT_ADV_DATA_INCOMPLETE

  extended advertising data incomplete

ESP_BLE_GAP_EXT_ADV_DATA_TRUNCATED

  extended advertising data truncated mode

ESP_BLE_GAP_SYNC_POLICY_BY_ADV_INFO

  Advertising SYNC policy.

  sync policy by advertising info

ESP_BLE_GAP_SYNC_POLICY_BY_PERIODIC_LIST

  periodic advertising sync policy

ESP_BLE_ADV_REPORT_EXT_ADV_IND

  Advertising report.

  advertising report with extended advertising indication type

ESP_BLE_ADV_REPORT_EXT_SCAN_IND

  advertising report with extended scan indication type

ESP_BLE_ADV_REPORT_EXT_DIRECT_ADV

  advertising report with extended direct advertising indication type

ESP_BLE_ADV_REPORT_EXT_SCAN_RSP

  advertising report with extended scan response indication type Bluetooth 5.0, Vol 2, Part E, 7.7.65.13

ESP_BLE_LEGACY_ADV_TYPE_IND

  advertising report with legacy advertising indication type

ESP_BLE_LEGACY_ADV_TYPE_DIRECT_IND

  advertising report with legacy direct indication type

ESP_BLE_LEGACY_ADV_TYPE_SCAN_IND

  advertising report with legacy scan indication type

ESP_BLE_LEGACY_ADV_TYPE_NONCON_IND

  advertising report with legacy non connectable indication type

ESP_BLE_LEGACY_ADV_TYPE_SCAN_RSP_TO_ADV_IND

  advertising report with legacy scan response indication type

ESP_BLE_LEGACY_ADV_TYPE_SCAN_RSP_TO_ADV_SCAN_IND

  advertising report with legacy advertising with scan response indication type

EXT_ADV_TX_PWR_NO_PREFERENCE

  Extend advertising tx power, range: [-127, +126] dBm.

  host has no preference for tx power

EXT_ADV_NUM_SETS_MAX

  max number of advertising sets to enable or disable

  max evt instance num

ESP_BLE_GAP_PAST_MODE_NO_SYNC_EVT

  Periodic advertising sync trans mode.

  No attempt is made to sync and no periodic adv sync transfer received event

ESP_BLE_GAP_PAST_MODE_NO_REPORT_EVT

  An periodic adv sync transfer received event and no periodic adv report events

ESP_BLE_GAP_PAST_MODE_DUP_FILTER_DISABLED

  Periodic adv report events will be enabled with duplicate filtering disabled

ESP_BLE_GAP_PAST_MODE_DUP_FILTER_ENABLED

  Periodic adv report events will be enabled with duplicate filtering enabled

ESP_BLE_VENDOR_SCAN_REQ_RECV_EVT_MASK

  Vendor BLE legacy SCAN_REQ received event mask

ESP_BLE_VENDOR_CHMAP_UPDATE_EVT_MASK

  Vendor BLE channel map update event mask

ESP_BLE_VENDOR_SLEEP_WAKEUP_EVT_MASK

  Vendor BLE sleep wakeup event mask

ESP_BLE_VENDOR_CONN_REQ_RECV_EVT_MASK

  Vendor BLE CONNECT_IND and AUX_CONNECT_REQ received event mask

ESP_BLE_VENDOR_CONN_RSP_RECV_EVT_MASK

  Vendor BLE AUX_CONNECT_RSP received event mask

ESP_BLE_VENDOR_PDU_RECV_EVT

  Vendor BLE specify PDU received event

ESP_BLE_VENDOR_CHAN_MAP_UPDATE_EVT

  Vendor BLE channel map update complete event

ESP_BLE_VENDOR_SLEEP_WAKEUP_EVT

  Vendor BLE sleep wakeup event

ESP_BLE_CS_INITIATOR_ROLE_SUPPORTED

  Initiator role that are supported by the remote Controller

ESP_BLE_CS_REFLECTOR_ROLE_SUPPORTED

  Reflector role that are supported by the remote Controller

ESP_BLE_CS_RTT_CAPABILITY_RTT_AA_ONLY_N_150NS

  The RTT_AA_Only_N field refers to the 150 ns time-of-flight precision requirement

ESP_BLE_CS_RTT_CAPABILITY_RTT_AA_ONLY_N_10NS

  The RTT_AA_Only_N field refers to the 10 ns time-of-flight precision requirement

ESP_BLE_CS_RTT_CAPABILITY_RTT_SOUNDING_N_150NS

  The RTT_Sounding_N field refers to the 150 ns time-of-flight precision requirement

ESP_BLE_CS_RTT_CAPABILITY_RTT_SOUNDING_N_10NS

  The RTT_Sounding_N field refers to the 10 ns time-of-flight precision requirement

ESP_BLE_CS_RTT_CAPABILITY_RTT_RANDOM_PAYLOAD_N_150NS

  The RTT_Random_Payload_N field refers to the 150 ns time-of-flight precision requirement

ESP_BLE_CS_RTT_CAPABILITY_RTT_RANDOM_PAYLOAD_N_10NS

  The RTT_Random_Payload_N field refers to the 10 ns time-of-flight precision requirement

ESP_BLE_CS_SYNC_PHYS_2M_SUPPORTED

  CS_SYNC 2M phy supported

ESP_BLE_CS_SYNC_PHYS_2M_2BT_SUPPORTED

  CS_SYNC 2M 2BT phy supported

ESP_BLE_CS_CHAN_MAP_LEN

  The length of Channel Sounding channel map

ESP_BLE_CS_INITIATOR_ROLE_ENABLED

  Initiator role is enabled

ESP_BLE_CS_REFLECTOR_ROLE_ENABLED

  Reflector role is enabled

ESP_BLE_CS_SYNC_PHY_1M

ESP_BLE_CS_SYNC_PHY_2M

ESP_BLE_CS_SYNC_PHY_2M_2BT

ESP_BLE_CS_RTT_TYPE_RTT_AA_ONLY

ESP_BLE_CS_RTT_TYPE_RTT_WITH_32BIT_SOUNDING_SEQUENCE

ESP_BLE_CS_RTT_TYPE_RTT_WITH_96BIT_SOUNDING_SEQUENCE

ESP_BLE_CS_RTT_TYPE_RTT_WITH_32BIT_RANDOM_SEQUENCE

ESP_BLE_CS_RTT_TYPE_RTT_WITH_64BIT_RANDOM_SEQUENCE

ESP_BLE_CS_RTT_TYPE_RTT_WITH_96BIT_RANDOM_SEQUENCE

ESP_BLE_CS_RTT_TYPE_RTT_WITH_128BIT_RANDOM_SEQUENCE

ESP_BLE_CS_ROLE_INITIATOR

ESP_BLE_CS_ROLE_REFLECTOR

ESP_BLE_CS_MAIN_MODE_TYPE_MODE_1

ESP_BLE_CS_MAIN_MODE_TYPE_MODE_2

ESP_BLE_CS_MAIN_MODE_TYPE_MODE_3

ESP_BLE_CS_SUB_MODE_TYPE_MODE_1

ESP_BLE_CS_SUB_MODE_TYPE_MODE_2

ESP_BLE_CS_SUB_MODE_TYPE_MODE_3

ESP_BLE_CS_SUB_MODE_TYPE_UNUSED

ESP_BLE_CS_CREAT_CONTEXT_IN_LOCAL_CONTROLLER

ESP_BLE_CS_CREAT_CONTEXT_IN_LOCAL_AND_REMOTE_CONTROLLER

ESP_BLE_CS_CAHNNEL_SELECT_TYPE_ALGORITHM_3b

ESP_BLE_CS_CAHNNEL_SELECT_TYPE_ALGORITHM_3C

ESP_BLE_CS_CH3C_USE_HAT_SHAPE

ESP_BLE_CS_CH3C_USE_X_SHAPE

ESP_BLE_CS_PHY_1M

ESP_BLE_CS_PHY_2M

ESP_BLE_CS_PHY_S8

ESP_BLE_CS_PHY_S2

ESP_BLE_CS_PREFERRED_FIRST_ORDER_ANT

ESP_BLE_CS_PREFERRED_SECOND_ORDER_ANT

ESP_BLE_CS_PREFERRED_THIRD_ORDER_ANT

ESP_BLE_CS_PREFERRED_FOURTH_ORDER_ANT

ESP_BLE_CS_SNR_CONTROL_ADIJUSTMENT_18DB

ESP_BLE_CS_SNR_CONTROL_ADIJUSTMENT_21DB

ESP_BLE_CS_SNR_CONTROL_ADIJUSTMENT_24DB

ESP_BLE_CS_SNR_CONTROL_ADIJUSTMENT_27DB

ESP_BLE_CS_SNR_CONTROL_ADIJUSTMENT_30DB

ESP_BLE_CS_SNR_CONTROL_NOT_APPLIED

ESP_BLE_CS_PROCEDURES_DISABLE

ESP_BLE_CS_PROCEDURES_ENABLE

### Type Definitions

typedef uint8_t esp_ble_key_type_t

typedef uint8_t esp_ble_auth_req_t

  combination of the above bit pattern

typedef uint8_t esp_ble_io_cap_t

  combination of the io capability

typedef uint8_t esp_ble_dtm_pkt_payload_t

typedef uint8_t esp_gap_ble_channels[ESP_GAP_BLE_CHANNELS_LEN]

typedef uint8_t esp_duplicate_info_t[ESP_BD_ADDR_LEN]

typedef uint16_t esp_ble_ext_adv_type_mask_t

typedef uint8_t esp_ble_gap_phy_t

typedef uint8_t esp_ble_gap_all_phys_t

typedef uint8_t esp_ble_gap_pri_phy_t

typedef uint8_t esp_ble_gap_rpt_phy_t

typedef uint8_t esp_ble_gap_phy_mask_t

typedef uint16_t esp_ble_gap_prefer_phy_options_t

typedef uint8_t esp_ble_ext_scan_cfg_mask_t

typedef uint8_t esp_ble_gap_ext_adv_data_status_t

typedef uint8_t esp_ble_gap_sync_t

typedef uint8_t esp_ble_gap_adv_type_t

typedef uint8_t esp_ble_gap_past_mode_t

typedef uint32_t esp_ble_vendor_evt_mask_t

typedef uint8_t esp_ble_vendor_evt_t

typedef uint8_t esp_ble_cs_rtt_caps_opt_t

typedef uint8_t esp_ble_cs_sync_phy_opt_t

typedef uint8_t esp_ble_cs_rtt_type_opt_t

typedef uint8_t esp_ble_cs_role_opt_t

typedef uint8_t esp_ble_cs_main_mode_opt_t

typedef uint8_t esp_ble_cs_sub_mode_opt_t

typedef uint8_t esp_ble_cs_create_context_opt_t

typedef uint8_t esp_ble_cs_channel_select_type_opt_t

typedef uint8_t esp_ble_cs_ch3c_shape_opt_t

typedef uint8_t esp_ble_cs_phy_opt_t

typedef uint8_t esp_ble_cs_preferred_peer_ant_t

typedef uint8_t esp_ble_cs_snr_control_adjustment_t

typedef uint8_t esp_ble_cs_procedures_action_t

typedef void (*esp_gap_ble_cb_t)(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param)

  GAP callback function type.

  Param event:

    : Event type

  Param param:

    : Point to callback parameter, currently is union type

### Enumerations

enum esp_gap_ble_cb_event_t

  GAP BLE callback event type.

  Values:

  enumerator ESP_GAP_BLE_ADV_DATA_SET_COMPLETE_EVT

    When advertising data set complete, the event comes

  enumerator ESP_GAP_BLE_SCAN_RSP_DATA_SET_COMPLETE_EVT

    When scan response data set complete, the event comes

  enumerator ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT

    When scan parameters set complete, the event comes

  enumerator ESP_GAP_BLE_SCAN_RESULT_EVT

    When one scan result ready, the event comes each time

  enumerator ESP_GAP_BLE_ADV_DATA_RAW_SET_COMPLETE_EVT

    When raw advertising data set complete, the event comes

  enumerator ESP_GAP_BLE_SCAN_RSP_DATA_RAW_SET_COMPLETE_EVT

    When raw scan response data set complete, the event comes

  enumerator ESP_GAP_BLE_ADV_START_COMPLETE_EVT

    When start advertising complete, the event comes

  enumerator ESP_GAP_BLE_SCAN_START_COMPLETE_EVT

    When start scan complete, the event comes

  enumerator ESP_GAP_BLE_AUTH_CMPL_EVT

    Authentication complete indication.

  enumerator ESP_GAP_BLE_KEY_EVT

    BLE key event for peer device keys

  enumerator ESP_GAP_BLE_SEC_REQ_EVT

    BLE security request

  enumerator ESP_GAP_BLE_PASSKEY_NOTIF_EVT

    passkey notification event

  enumerator ESP_GAP_BLE_PASSKEY_REQ_EVT

    passkey request event

  enumerator ESP_GAP_BLE_OOB_REQ_EVT

    OOB request event

  enumerator ESP_GAP_BLE_LOCAL_IR_EVT

    BLE local IR (identity Root 128-bit random static value used to generate Long Term Key) event

  enumerator ESP_GAP_BLE_LOCAL_ER_EVT

    BLE local ER (Encryption Root value used to generate identity resolving key) event

  enumerator ESP_GAP_BLE_NC_REQ_EVT

    Numeric Comparison request event

  enumerator ESP_GAP_BLE_ADV_STOP_COMPLETE_EVT

    When stop adv complete, the event comes

  enumerator ESP_GAP_BLE_SCAN_STOP_COMPLETE_EVT

    When stop scan complete, the event comes

  enumerator ESP_GAP_BLE_SET_STATIC_RAND_ADDR_EVT

    When set the static rand address complete, the event comes

  enumerator ESP_GAP_BLE_UPDATE_CONN_PARAMS_EVT

    When update connection parameters complete, the event comes

  enumerator ESP_GAP_BLE_SET_PKT_LENGTH_COMPLETE_EVT

    When set pkt length complete, the event comes

  enumerator ESP_GAP_BLE_SET_LOCAL_PRIVACY_COMPLETE_EVT

    When Enable/disable privacy on the local device complete, the event comes

  enumerator ESP_GAP_BLE_REMOVE_BOND_DEV_COMPLETE_EVT

    When remove the bond device complete, the event comes

  enumerator ESP_GAP_BLE_CLEAR_BOND_DEV_COMPLETE_EVT

    When clear the bond device clear complete, the event comes

  enumerator ESP_GAP_BLE_GET_BOND_DEV_COMPLETE_EVT

    When get the bond device list complete, the event comes

  enumerator ESP_GAP_BLE_READ_RSSI_COMPLETE_EVT

    When read the rssi complete, the event comes

  enumerator ESP_GAP_BLE_UPDATE_WHITELIST_COMPLETE_EVT

    When add or remove whitelist complete, the event comes

  enumerator ESP_GAP_BLE_UPDATE_DUPLICATE_EXCEPTIONAL_LIST_COMPLETE_EVT

    When update duplicate exceptional list complete, the event comes

  enumerator ESP_GAP_BLE_SET_CHANNELS_EVT

    When setting BLE channels complete, the event comes

  enumerator ESP_GAP_BLE_READ_PHY_COMPLETE_EVT

    when reading phy complete, this event comes

  enumerator ESP_GAP_BLE_SET_PREFERRED_DEFAULT_PHY_COMPLETE_EVT

    when preferred default phy complete, this event comes

  enumerator ESP_GAP_BLE_SET_PREFERRED_PHY_COMPLETE_EVT

    when preferred phy complete , this event comes

  enumerator ESP_GAP_BLE_EXT_ADV_SET_RAND_ADDR_COMPLETE_EVT

    when extended set random address complete, the event comes

  enumerator ESP_GAP_BLE_EXT_ADV_SET_PARAMS_COMPLETE_EVT

    when extended advertising parameter complete, the event comes

  enumerator ESP_GAP_BLE_EXT_ADV_DATA_SET_COMPLETE_EVT

    when extended advertising data complete, the event comes

  enumerator ESP_GAP_BLE_EXT_SCAN_RSP_DATA_SET_COMPLETE_EVT

    when extended scan response data complete, the event comes

  enumerator ESP_GAP_BLE_EXT_ADV_START_COMPLETE_EVT

    when extended advertising start complete, the event comes

  enumerator ESP_GAP_BLE_EXT_ADV_STOP_COMPLETE_EVT

    when extended advertising stop complete, the event comes

  enumerator ESP_GAP_BLE_EXT_ADV_SET_REMOVE_COMPLETE_EVT

    when extended advertising set remove complete, the event comes

  enumerator ESP_GAP_BLE_EXT_ADV_SET_CLEAR_COMPLETE_EVT

    when extended advertising set clear complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_SET_PARAMS_COMPLETE_EVT

    when periodic advertising parameter complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_DATA_SET_COMPLETE_EVT

    when periodic advertising data complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_START_COMPLETE_EVT

    when periodic advertising start complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_STOP_COMPLETE_EVT

    when periodic advertising stop complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_CREATE_SYNC_COMPLETE_EVT

    when periodic advertising create sync complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_SYNC_CANCEL_COMPLETE_EVT

    when extended advertising sync cancel complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_SYNC_TERMINATE_COMPLETE_EVT

    when extended advertising sync terminate complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_ADD_DEV_COMPLETE_EVT

    when extended advertising add device complete , the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_REMOVE_DEV_COMPLETE_EVT

    when extended advertising remove device complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_CLEAR_DEV_COMPLETE_EVT

    when extended advertising clear device, the event comes

  enumerator ESP_GAP_BLE_SET_EXT_SCAN_PARAMS_COMPLETE_EVT

    when extended scan parameter complete, the event comes

  enumerator ESP_GAP_BLE_EXT_SCAN_START_COMPLETE_EVT

    when extended scan start complete, the event comes

  enumerator ESP_GAP_BLE_EXT_SCAN_STOP_COMPLETE_EVT

    when extended scan stop complete, the event comes

  enumerator ESP_GAP_BLE_PREFER_EXT_CONN_PARAMS_SET_COMPLETE_EVT

    when extended prefer connection parameter set complete, the event comes

  enumerator ESP_GAP_BLE_PHY_UPDATE_COMPLETE_EVT

    when ble phy update complete, the event comes

  enumerator ESP_GAP_BLE_EXT_ADV_REPORT_EVT

    when extended advertising report complete, the event comes

  enumerator ESP_GAP_BLE_SCAN_TIMEOUT_EVT

    when scan timeout complete, the event comes

  enumerator ESP_GAP_BLE_ADV_TERMINATED_EVT

    when advertising terminate data complete, the event comes

  enumerator ESP_GAP_BLE_SCAN_REQ_RECEIVED_EVT

    when scan req received complete, the event comes

  enumerator ESP_GAP_BLE_CHANNEL_SELECT_ALGORITHM_EVT

    when channel select algorithm complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_REPORT_EVT

    when periodic report advertising complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_SYNC_LOST_EVT

    when periodic advertising sync lost complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_SYNC_ESTAB_EVT

    when periodic advertising sync establish complete, the event comes

  enumerator ESP_GAP_BLE_SC_OOB_REQ_EVT

    Secure Connection OOB request event

  enumerator ESP_GAP_BLE_SC_CR_LOC_OOB_EVT

    Secure Connection create OOB data complete event

  enumerator ESP_GAP_BLE_GET_DEV_NAME_COMPLETE_EVT

    When getting BT device name complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_RECV_ENABLE_COMPLETE_EVT

    when set periodic advertising receive enable complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_SYNC_TRANS_COMPLETE_EVT

    when periodic advertising sync transfer complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_SET_INFO_TRANS_COMPLETE_EVT

    when periodic advertising set info transfer complete, the event comes

  enumerator ESP_GAP_BLE_SET_PAST_PARAMS_COMPLETE_EVT

    when set periodic advertising sync transfer params complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_SYNC_TRANS_RECV_EVT

    when periodic advertising sync transfer received, the event comes

  enumerator ESP_GAP_BLE_DTM_TEST_UPDATE_EVT

    when direct test mode state changes, the event comes

  enumerator ESP_GAP_BLE_ADV_CLEAR_COMPLETE_EVT

    When clear advertising complete, the event comes

  enumerator ESP_GAP_BLE_SET_RPA_TIMEOUT_COMPLETE_EVT

    When set the Resolvable Private Address (RPA) timeout completes, the event comes

  enumerator ESP_GAP_BLE_ADD_DEV_TO_RESOLVING_LIST_COMPLETE_EVT

    when add a device to the resolving list completes, the event comes

  enumerator ESP_GAP_BLE_VENDOR_CMD_COMPLETE_EVT

    When vendor hci command complete, the event comes

  enumerator ESP_GAP_BLE_SET_PRIVACY_MODE_COMPLETE_EVT

    When set privacy mode complete, the event comes

  enumerator ESP_GAP_BLE_SET_CSA_SUPPORT_COMPLETE_EVT

    When set CSA support complete, the event comes

  enumerator ESP_GAP_BLE_SET_VENDOR_EVT_MASK_COMPLETE_EVT

    When set vendor event mask complete, the event comes

  enumerator ESP_GAP_BLE_VENDOR_HCI_EVT

    When BLE vendor HCI event received, the event comes

  enumerator ESP_GAP_BLE_ENH_READ_TRANS_PWR_LEVEL_EVT

    When reading the current and maximum transmit power levels of the local Controller complete, the event comes

  enumerator ESP_GAP_BLE_READ_REMOTE_TRANS_PWR_LEVEL_EVT

    When reading the transmit power level used by the remote Controller on the ACL connection complete, the event comes

  enumerator ESP_GAP_BLE_SET_PATH_LOSS_RPTING_PARAMS_EVT

    when set the path loss threshold reporting parameters complete, the event comes

  enumerator ESP_GAP_BLE_SET_PATH_LOSS_RPTING_ENABLE_EVT

    when enable or disable path loss reporting complete, the event comes

  enumerator ESP_GAP_BLE_SET_TRANS_PWR_RPTING_ENABLE_EVT

    when enable or disable the reporting to the local Host of transmit power level changes complete, the event comes

  enumerator ESP_GAP_BLE_PATH_LOSS_THRESHOLD_EVT

    when receive a path loss threshold crossing, the event comes

  enumerator ESP_GAP_BLE_TRANS_PWR_RPTING_EVT

    when receive a transmit power level report, the event comes

  enumerator ESP_GAP_BLE_SET_DEFAULT_SUBRATE_COMPLETE_EVT

    when set default subrate complete, the event comes

  enumerator ESP_GAP_BLE_SUBRATE_REQUEST_COMPLETE_EVT

    when subrate request command complete, the event comes

  enumerator ESP_GAP_BLE_SUBRATE_CHANGE_EVT

    when Connection Subrate Update procedure has completed and some parameters of the specified connection have changed, the event comes

  enumerator ESP_GAP_BLE_SET_HOST_FEATURE_CMPL_EVT

    When host feature set complete, the event comes

  enumerator ESP_GAP_BLE_READ_CHANNEL_MAP_COMPLETE_EVT

    When BLE channel map result is received, the event comes

  enumerator ESP_GAP_BLE_SET_COMMON_FACTOR_CMPL_EVT

    When set the common factor complete, the event comes

  enumerator ESP_GAP_BLE_SET_SCH_LEN_CMPL_EVT

    When set the scheduling length complete, the event comes

  enumerator ESP_GAP_BLE_SET_SCAN_CHAN_MAP_CMPL_EVT

    When set the channel map for scanning complete, the event comes

  enumerator ESP_GAP_BLE_SET_PERIODIC_ADV_SUBEVT_DATA_EVT

    When BLE update periodic adv subevent data complete, the event comes

  enumerator ESP_GAP_BLE_SET_PERIODIC_ADV_RESPONSE_DATA_EVT

    When BLE update periodic adv response data complete, the event comes

  enumerator ESP_GAP_BLE_SET_PERIODIC_SYNC_SUBEVT_EVT

    When BLE update periodic sync subevent complete, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_SUBEVT_DATA_REQUEST_EVT

    When Controller is ready to transmit one or more subevents and is requesting the advertising data for these subevents, the event comes

  enumerator ESP_GAP_BLE_PERIODIC_ADV_RESPONSE_REPORT_EVT

    When one or more devices have responded to a periodic advertising subevent during a PAwR train, the event comes

  enumerator ESP_GAP_BLE_CS_READ_LOCAL_SUPP_CAPS_EVT

    When CS read local supported capabilities complete, the event comes

  enumerator ESP_GAP_BLE_CS_WRITE_CACHED_REMOTE_SUPP_CAPS_EVT

    When CS write cached remote supported capabilities complete, the event comes

  enumerator ESP_GAP_BLE_CS_SET_DEFAULT_SETTINGS_EVT

    When CS set default settings complete, the event comes

  enumerator ESP_GAP_BLE_CS_WRITE_CACHED_REMOTE_FAE_TABLE_EVT

    When CS write cached remote FAE table complete, the event comes

  enumerator ESP_GAP_BLE_CS_READ_REMOTE_SUPP_CAPS_CMPL_EVT

    When CS read remote supported capabilities complete, the event comes

  enumerator ESP_GAP_BLE_CS_SET_CHANNEL_CLASS_CMPL_EVT

    When CS set channel classification complete, the event comes

  enumerator ESP_GAP_BLE_CS_SET_PROC_PARAMS_CMPL_EVT

    When CS set procedure parameters complete, the event comes

  enumerator ESP_GAP_BLE_CS_PROC_ENABLE_CMPL_EVT

    When CS procedure enable complete, the event comes

  enumerator ESP_GAP_BLE_CS_READ_REMOTE_FAE_TABLE_CMPL_EVT

    When CS read remote FAE table complete, the event comes

  enumerator ESP_GAP_BLE_CS_SECURITY_ENABLE_CMPL_EVT

    When CS security enable complete, the event comes

  enumerator ESP_GAP_BLE_CS_CONFIG_CMPL_EVT

    When CS has completed the Channel Sounding Configuration procedure, the event comes

  enumerator ESP_GAP_BLE_CS_SUBEVENT_RESULT_EVT

    When CS has results to report for a CS subevent during the CS procedure, the event comes

  enumerator ESP_GAP_BLE_CS_SUBEVENT_RESULT_CONTINUE_EVT

    When CS has completed a new CS subevent measurement, the event comes

  enumerator ESP_GAP_BLE_MONITOR_ADV_REPORT_EVT

    When LE monitor advertisement report (RSSI threshold etc), the event comes

  enumerator ESP_GAP_BLE_ADD_MONITOR_ADV_COMPLETE_EVT

    When add monitor advertiser complete, the event comes

  enumerator ESP_GAP_BLE_REMOVE_MONITOR_ADV_COMPLETE_EVT

    When remove monitor advertiser complete, the event comes

  enumerator ESP_GAP_BLE_CLEAR_MONITOR_ADV_COMPLETE_EVT

    When clear monitor advertiser list complete, the event comes

  enumerator ESP_GAP_BLE_READ_MONITOR_ADV_LIST_SIZE_COMPLETE_EVT

    When read monitor advertiser list size complete, the event comes

  enumerator ESP_GAP_BLE_ENABLE_MONITOR_ADV_COMPLETE_EVT

    When enable/disable monitor advertising complete, the event comes

  enumerator ESP_GAP_BLE_EVT_MAX

    when maximum advertising event complete, the event comes

enum esp_ble_adv_data_type

  The type of advertising data(not adv_type)

  Values:

  enumerator ESP_BLE_AD_TYPE_FLAG
  enumerator ESP_BLE_AD_TYPE_16SRV_PART
  enumerator ESP_BLE_AD_TYPE_16SRV_CMPL
  enumerator ESP_BLE_AD_TYPE_32SRV_PART
  enumerator ESP_BLE_AD_TYPE_32SRV_CMPL
  enumerator ESP_BLE_AD_TYPE_128SRV_PART
  enumerator ESP_BLE_AD_TYPE_128SRV_CMPL
  enumerator ESP_BLE_AD_TYPE_NAME_SHORT
  enumerator ESP_BLE_AD_TYPE_NAME_CMPL
  enumerator ESP_BLE_AD_TYPE_TX_PWR
  enumerator ESP_BLE_AD_TYPE_DEV_CLASS
  enumerator ESP_BLE_AD_TYPE_SM_TK
  enumerator ESP_BLE_AD_TYPE_SM_OOB_FLAG
  enumerator ESP_BLE_AD_TYPE_INT_RANGE
  enumerator ESP_BLE_AD_TYPE_SOL_SRV_UUID
  enumerator ESP_BLE_AD_TYPE_128SOL_SRV_UUID
  enumerator ESP_BLE_AD_TYPE_SERVICE_DATA
  enumerator ESP_BLE_AD_TYPE_PUBLIC_TARGET
  enumerator ESP_BLE_AD_TYPE_RANDOM_TARGET
  enumerator ESP_BLE_AD_TYPE_APPEARANCE
  enumerator ESP_BLE_AD_TYPE_ADV_INT
  enumerator ESP_BLE_AD_TYPE_LE_DEV_ADDR
  enumerator ESP_BLE_AD_TYPE_LE_ROLE
  enumerator ESP_BLE_AD_TYPE_SPAIR_C256
  enumerator ESP_BLE_AD_TYPE_SPAIR_R256
  enumerator ESP_BLE_AD_TYPE_32SOL_SRV_UUID
  enumerator ESP_BLE_AD_TYPE_32SERVICE_DATA
  enumerator ESP_BLE_AD_TYPE_128SERVICE_DATA
  enumerator ESP_BLE_AD_TYPE_LE_SECURE_CONFIRM
  enumerator ESP_BLE_AD_TYPE_LE_SECURE_RANDOM
  enumerator ESP_BLE_AD_TYPE_URI
  enumerator ESP_BLE_AD_TYPE_INDOOR_POSITION
  enumerator ESP_BLE_AD_TYPE_TRANS_DISC_DATA
  enumerator ESP_BLE_AD_TYPE_LE_SUPPORT_FEATURE
  enumerator ESP_BLE_AD_TYPE_CHAN_MAP_UPDATE
  enumerator ESP_BLE_AD_MANUFACTURER_SPECIFIC_TYPE

enum esp_ble_adv_type_t

  Advertising mode.

  Values:

  enumerator ADV_TYPE_IND
  enumerator ADV_TYPE_DIRECT_IND_HIGH
  enumerator ADV_TYPE_SCAN_IND
  enumerator ADV_TYPE_NONCONN_IND
  enumerator ADV_TYPE_DIRECT_IND_LOW

enum esp_ble_adv_channel_t

  Advertising channel mask.

  Values:

  enumerator ADV_CHNL_37
  enumerator ADV_CHNL_38
  enumerator ADV_CHNL_39
  enumerator ADV_CHNL_ALL

enum esp_ble_adv_filter_t

  Values:

  enumerator ADV_FILTER_ALLOW_SCAN_ANY_CON_ANY

    Allow both scan and connection requests from anyone.

  enumerator ADV_FILTER_ALLOW_SCAN_WLST_CON_ANY

    Allow both scan req from White List devices only and connection req from anyone.

  enumerator ADV_FILTER_ALLOW_SCAN_ANY_CON_WLST

    Allow both scan req from anyone and connection req from White List devices only.

  enumerator ADV_FILTER_ALLOW_SCAN_WLST_CON_WLST

    Allow scan and connection requests from White List devices only.

enum esp_ble_sec_act_t

  Values:

  enumerator ESP_BLE_SEC_ENCRYPT

    relate to BTA_DM_BLE_SEC_ENCRYPT in bta/bta_api.h. If the device has already bonded, the stack will used Long Term Key (LTK) to encrypt with the remote device directly. Else if the device hasn't bonded, the stack will used the default authentication request used the esp_ble_gap_set_security_param function set by the user.

  enumerator ESP_BLE_SEC_ENCRYPT_NO_MITM

    relate to BTA_DM_BLE_SEC_ENCRYPT_NO_MITM in bta/bta_api.h. If the device has been already bonded, the stack will check the LTK (Long Term Key) Whether the authentication request has been met, and if met, use the LTK to encrypt with the remote device directly, else re-pair with the remote device. Else if the device hasn't been bonded, the stack will use NO MITM authentication request in the current link instead of using the authreq in the esp_ble_gap_set_security_param function set by the user.

  enumerator ESP_BLE_SEC_ENCRYPT_MITM

    relate to BTA_DM_BLE_SEC_ENCRYPT_MITM in bta/bta_api.h. If the device has been already bonded, the stack will check the LTK (Long Term Key) whether the authentication request has been met, and if met, use the LTK to encrypt with the remote device directly, else re-pair with the remote device. Else if the device hasn't been bonded, the stack will use MITM authentication request in the current link instead of using the authreq in the esp_ble_gap_set_security_param function set by the user.

enum esp_ble_sm_param_t

  Values:

  enumerator ESP_BLE_SM_PASSKEY

    Authentication requirements of local device

  enumerator ESP_BLE_SM_AUTHEN_REQ_MODE

    The IO capability of local device

  enumerator ESP_BLE_SM_IOCAP_MODE

    Initiator Key Distribution/Generation

  enumerator ESP_BLE_SM_SET_INIT_KEY

    Responder Key Distribution/Generation

  enumerator ESP_BLE_SM_SET_RSP_KEY

    Maximum Encryption key size to support

  enumerator ESP_BLE_SM_MAX_KEY_SIZE

    Minimum Encryption key size requirement from Peer

  enumerator ESP_BLE_SM_MIN_KEY_SIZE

    Set static Passkey

  enumerator ESP_BLE_SM_SET_STATIC_PASSKEY

    Reset static Passkey

  enumerator ESP_BLE_SM_CLEAR_STATIC_PASSKEY

    Accept only specified SMP Authentication requirement

  enumerator ESP_BLE_SM_ONLY_ACCEPT_SPECIFIED_SEC_AUTH

    Enable/Disable OOB support

  enumerator ESP_BLE_SM_OOB_SUPPORT

    Appl encryption key size

  enumerator ESP_BLE_APP_ENC_KEY_SIZE

    authentication max param

  enumerator ESP_BLE_SM_MAX_PARAM

enum esp_ble_dtm_update_evt_t

  Values:

  enumerator DTM_TX_START_EVT

    DTM TX start event.

  enumerator DTM_RX_START_EVT

    DTM RX start event.

  enumerator DTM_TEST_STOP_EVT

    DTM test end event.

enum esp_ble_scan_type_t

  Ble scan type.

  Values:

  enumerator BLE_SCAN_TYPE_PASSIVE

    Passive scan

  enumerator BLE_SCAN_TYPE_ACTIVE

    Active scan

enum esp_ble_scan_filter_t

  Ble scan filter type.

  Values:

  enumerator BLE_SCAN_FILTER_ALLOW_ALL

    Accept all :

    1. advertisement packets except directed advertising packets not addressed to this device (default).

  enumerator BLE_SCAN_FILTER_ALLOW_ONLY_WLST

    Accept only :

    1. advertisement packets from devices where the advertiser’s address is in the White list.

    2. Directed advertising packets which are not addressed for this device shall be ignored.

  enumerator BLE_SCAN_FILTER_ALLOW_UND_RPA_DIR

    Accept all :

    1. undirected advertisement packets, and

    2. directed advertising packets where the initiator address is a resolvable private address, and

    3. directed advertising packets addressed to this device.

  enumerator BLE_SCAN_FILTER_ALLOW_WLIST_RPA_DIR

    Accept all :

    1. advertisement packets from devices where the advertiser’s address is in the White list, and

    2. directed advertising packets where the initiator address is a resolvable private address, and

    3. directed advertising packets addressed to this device.

enum esp_ble_scan_duplicate_t

  Ble scan duplicate type.

  Values:

  enumerator BLE_SCAN_DUPLICATE_DISABLE

    the Link Layer should generate advertising reports to the host for each packet received

  enumerator BLE_SCAN_DUPLICATE_ENABLE

    the Link Layer should filter out duplicate advertising reports to the Host

  enumerator BLE_SCAN_DUPLICATE_ENABLE_RESET

    Duplicate filtering enabled, reset for each scan period, only supported in BLE 5.0.

  enumerator BLE_SCAN_DUPLICATE_MAX

    Reserved for future use.

enum esp_ble_auth_fail_rsn_t

  Definition of the authentication failed reason.

  Values:

  enumerator ESP_AUTH_SMP_PASSKEY_FAIL

    The user input of passkey failed

  enumerator ESP_AUTH_SMP_OOB_FAIL

    The OOB data is not available

  enumerator ESP_AUTH_SMP_PAIR_AUTH_FAIL

    The authentication requirements cannot be met

  enumerator ESP_AUTH_SMP_CONFIRM_VALUE_FAIL

    The confirm value does not match the calculated comparison value

  enumerator ESP_AUTH_SMP_PAIR_NOT_SUPPORT

    Pairing is not supported by the device

  enumerator ESP_AUTH_SMP_ENC_KEY_SIZE

    The resultant encryption key size is not long enough

  enumerator ESP_AUTH_SMP_INVALID_CMD

    The SMP command received is not supported by this device

  enumerator ESP_AUTH_SMP_UNKNOWN_ERR

    Pairing failed due to an unspecified reason

  enumerator ESP_AUTH_SMP_REPEATED_ATTEMPT

    Pairing or authentication procedure is disallowed

  enumerator ESP_AUTH_SMP_INVALID_PARAMETERS

    The command length is invalid or that a parameter is outside the specified range

  enumerator ESP_AUTH_SMP_DHKEY_CHK_FAIL

    The DHKey Check value received doesn’t match the one calculated by the local device

  enumerator ESP_AUTH_SMP_NUM_COMP_FAIL

    The confirm values in the numeric comparison protocol do not match

  enumerator ESP_AUTH_SMP_BR_PARING_IN_PROGR

    Pairing Request sent over the BR/EDR transport is in progress

  enumerator ESP_AUTH_SMP_XTRANS_DERIVE_NOT_ALLOW

    The BR/EDR Link Key or BLE LTK cannot be used to derive

  enumerator ESP_AUTH_SMP_INTERNAL_ERR

    Internal error in pairing procedure

  enumerator ESP_AUTH_SMP_UNKNOWN_IO

    Unknown IO capability, unable to decide association model

  enumerator ESP_AUTH_SMP_INIT_FAIL

    SMP pairing initiation failed

  enumerator ESP_AUTH_SMP_CONFIRM_FAIL

    The confirm value does not match

  enumerator ESP_AUTH_SMP_BUSY

    Pending security request on going

  enumerator ESP_AUTH_SMP_ENC_FAIL

    The Controller failed to start encryption

  enumerator ESP_AUTH_SMP_STARTED

    SMP pairing process started

  enumerator ESP_AUTH_SMP_RSP_TIMEOUT

    Security Manager timeout due to no SMP command being received

  enumerator ESP_AUTH_SMP_DIV_NOT_AVAIL

    Encrypted Diversifier value not available

  enumerator ESP_AUTH_SMP_UNSPEC_ERR

    Unspecified failed reason

  enumerator ESP_AUTH_SMP_CONN_TOUT

    Pairing process failed due to connection timeout

enum esp_gap_search_evt_t

  Sub Event of ESP_GAP_BLE_SCAN_RESULT_EVT.

  Values:

  enumerator ESP_GAP_SEARCH_INQ_RES_EVT

    Inquiry result for a peer device.

  enumerator ESP_GAP_SEARCH_INQ_CMPL_EVT

    Inquiry complete.

  enumerator ESP_GAP_SEARCH_DISC_RES_EVT

    Discovery result for a peer device.

  enumerator ESP_GAP_SEARCH_DISC_BLE_RES_EVT

    Discovery result for BLE GATT based service on a peer device.

  enumerator ESP_GAP_SEARCH_DISC_CMPL_EVT

    Discovery complete.

  enumerator ESP_GAP_SEARCH_DI_DISC_CMPL_EVT

    Discovery complete.

  enumerator ESP_GAP_SEARCH_SEARCH_CANCEL_CMPL_EVT

    Search cancelled

  enumerator ESP_GAP_SEARCH_INQ_DISCARD_NUM_EVT

    The number of pkt discarded by flow control

enum esp_ble_evt_type_t

  Ble scan result event type, to indicate the result is scan response or advertising data or other.

  Values:

  enumerator ESP_BLE_EVT_CONN_ADV

    Connectable undirected advertising (ADV_IND)

  enumerator ESP_BLE_EVT_CONN_DIR_ADV

    Connectable directed advertising (ADV_DIRECT_IND)

  enumerator ESP_BLE_EVT_DISC_ADV

    Scannable undirected advertising (ADV_SCAN_IND)

  enumerator ESP_BLE_EVT_NON_CONN_ADV

    Non connectable undirected advertising (ADV_NONCONN_IND)

  enumerator ESP_BLE_EVT_SCAN_RSP

    Scan Response (SCAN_RSP)

enum esp_ble_wl_operation_t

  Values:

  enumerator ESP_BLE_WHITELIST_REMOVE

    remove mac from whitelist

  enumerator ESP_BLE_WHITELIST_ADD

    add address to whitelist

  enumerator ESP_BLE_WHITELIST_CLEAR

    clear all device in whitelist

enum esp_bt_duplicate_exceptional_subcode_type_t

  Values:

  enumerator ESP_BLE_DUPLICATE_EXCEPTIONAL_LIST_ADD

    Add device info into duplicate scan exceptional list

  enumerator ESP_BLE_DUPLICATE_EXCEPTIONAL_LIST_REMOVE

    Remove device info from duplicate scan exceptional list

  enumerator ESP_BLE_DUPLICATE_EXCEPTIONAL_LIST_CLEAN

    Clean duplicate scan exceptional list

enum esp_ble_duplicate_exceptional_info_type_t

  Values:

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_INFO_ADV_ADDR

    BLE advertising address , device info will be added into ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_ADDR_LIST

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_INFO_MESH_LINK_ID

    BLE mesh link ID, it is for BLE mesh, device info will be added into ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_MESH_LINK_ID_LIST

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_INFO_MESH_BEACON_TYPE

    BLE mesh beacon AD type, the format is | Len | 0x2B | Beacon Type | Beacon Data |

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_INFO_MESH_PROV_SRV_ADV

    BLE mesh provisioning service uuid, the format is | 0x02 | 0x01 | flags | 0x03 | 0x03 | 0x1827 | .... |`

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_INFO_MESH_PROXY_SRV_ADV

    BLE mesh adv with proxy service uuid, the format is | 0x02 | 0x01 | flags | 0x03 | 0x03 | 0x1828 | .... |`

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_INFO_MESH_PROXY_SOLIC_ADV

    BLE mesh adv with proxy service uuid, the format is | 0x02 | 0x01 | flags | 0x03 | 0x03 | 0x1859 | .... |`

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_INFO_MESH_URI_ADV

    BLE mesh URI adv, the format is ...| Len | 0x24 | data |...

enum esp_duplicate_scan_exceptional_list_type_t

  Values:

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_ADDR_LIST

    duplicate scan exceptional addr list

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_MESH_LINK_ID_LIST

    duplicate scan exceptional mesh link ID list

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_MESH_BEACON_TYPE_LIST

    duplicate scan exceptional mesh beacon type list

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_MESH_PROV_SRV_ADV_LIST

    duplicate scan exceptional mesh adv with provisioning service uuid

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_MESH_PROXY_SRV_ADV_LIST

    duplicate scan exceptional mesh adv with proxy service uuid

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_MESH_PROXY_SOLIC_ADV_LIST

    duplicate scan exceptional mesh adv with proxy solicitation PDU uuid

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_MESH_URI_ADV_LIST

    duplicate scan exceptional URI list

  enumerator ESP_BLE_DUPLICATE_SCAN_EXCEPTIONAL_ALL_LIST

    duplicate scan exceptional all list

enum esp_ble_privacy_mode_t

  Values:

  enumerator ESP_BLE_NETWORK_PRIVACY_MODE

    Network Privacy Mode for peer device (default)

  enumerator ESP_BLE_DEVICE_PRIVACY_MODE

    Device Privacy Mode for peer device

enum esp_ble_vendor_pdu_t

  Values:

  enumerator ESP_BLE_VENDOR_PDU_SCAN_REQ

    SCAN_REQ PDU type

  enumerator ESP_BLE_VENDOR_PDU_CONN_REQ

    CONNECT_IND and AUX_CONNECT_REQ PDU type

  enumerator ESP_BLE_VENDOR_PDU_CONN_RSP

    AUX_CONNECT_RSP PDU type

enum esp_ble_tx_power_phy_t

  Values:

  enumerator ESP_BLE_CONN_TX_POWER_PHY_NONE

    No PHY is set, should not be used LE 1M PHY

  enumerator ESP_BLE_CONN_TX_POWER_PHY_1M

    LE 2M PHY

  enumerator ESP_BLE_CONN_TX_POWER_PHY_2M

    LE Coded PHY using S=8 coding

  enumerator ESP_BLE_CONN_TX_POWER_PHY_CODED_S8

    LE Coded PHY using S=2 coding

  enumerator ESP_BLE_CONN_TX_POWER_PHY_CODED_S2

enum esp_ble_path_loss_zone_t

  Values:

  enumerator ESP_BLE_CONN_PATH_LOSS_ZONE_ENTERED_LOW

    Low zone entered Middle zone entered

  enumerator ESP_BLE_CONN_PATH_LOSS_ZONE_ENTERED_MIDDLE

    High zone entered

  enumerator ESP_BLE_CONN_PATH_LOSS_ZONE_ENTERED_HIGH

enum esp_ble_cs_sync_ant_selection_opt_t

  CS sync antenna selection options.

  Values:

  enumerator ESP_BLE_CS_ANT_SELECTION_OPT_ONE

    Use antenna identifier 1 for CS_SYNC packets by the local Controller

  enumerator ESP_BLE_CS_ANT_SELECTION_OPT_TWO

    Use antenna identifier 2 for CS_SYNC packets by the local Controller

  enumerator ESP_BLE_CS_ANT_SELECTION_OPT_THREE

    Use antenna identifier 3 for CS_SYNC packets by the local Controller

  enumerator ESP_BLE_CS_ANT_SELECTION_OPT_FOUR

    Use antenna identifier 4 for CS_SYNC packets by the local Controller

  enumerator ESP_BLE_CS_ANT_SELECTION_OPT_REPETITIVE

    Use antennas in repetitive order from 1 to 4 for CS_SYNC packets by the local Controller

  enumerator ESP_BLE_CS_ANT_SELECTION_OPT_NO_RECOMMENDATION

    No recommendation for local controller antenna selection by the local Controller

此文档对您有帮助吗？

- 反馈已收到，谢谢！
- 如果您有其他意见，欢迎填写乐鑫文档反馈表。

- 我们重视您的反馈。
- 您可以填写乐鑫文档反馈表告诉我们如何改进该文档。