Chapter 2. API Reference
Header File
• components/wifi_provisioning/include/wifi_provisioning/scheme_ble.h
Functions
void wifi_prov_scheme_ble_event_cb_free_btdm(void *user_data, wifi_prov_cb_event_t
event, void *event_data)
void wifi_prov_scheme_ble_event_cb_free_ble(void *user_data, wifi_prov_cb_event_t event,
void *event_data)
void wifi_prov_scheme_ble_event_cb_free_bt(void *user_data, wifi_prov_cb_event_t event,
void *event_data)
esp_err_t wifi_prov_scheme_ble_set_service_uuid(uint8_t *uuid128)
Set the 128 bit GATT service UUID used for provisioning.
This API is used to override the default 128 bit provisioning service UUID, which is 0000ffff-0000-1000-
8000-00805f9b34fb.
This must be called before starting provisioning, i.e. before making a call to
wifi_prov_mgr_start_provisioning(), otherwise the default UUID will be used.
Note The data being pointed to by the argument must be valid atleast till provisioning is started. Upon start,
the manager will store an internal copy of this UUID, and this data can be freed or invalidated afterwords.
Return
• ESP_OK : Success
• ESP_ERR_INVALID_ARG : Null argument
Parameters
• [in] uuid128: A custom 128 bit UUID
esp_err_t wifi_prov_scheme_ble_set_mfg_data(uint8_t *mfg_data, ssize_t mfg_data_len)
Set manufacturer specific data in scan response.
This must be called before starting provisioning, i.e. before making a call to
wifi_prov_mgr_start_provisioning().
Note It is important to understand that length of custom manufacturer data should be within limits. The
manufacturer data goes into scan response along with BLE device name. By default, BLE device name
length is of 11 Bytes, however it can vary as per application use case. So, one has to honour the scan
response data size limits i.e. (mfg_data_len + 2) < 31 - (device_name_length + 2 ). If the mfg_data
length exceeds this limit, the length will be truncated.
Return
• ESP_OK : Success
• ESP_ERR_INVALID_ARG : Null argument
Parameters
• [in] mfg_data: Custom manufacturer data
• [in] mfg_data_len: Manufacturer data length
Macros
WIFI_PROV_SCHEME_BLE_EVENT_HANDLER_FREE_BTDM
WIFI_PROV_SCHEME_BLE_EVENT_HANDLER_FREE_BLE
WIFI_PROV_SCHEME_BLE_EVENT_HANDLER_FREE_BT
Header File
• components/wifi_provisioning/include/wifi_provisioning/scheme_softap.h
Functions
Espressif Systems 692
Submit Document Feedback
Release v4.4
To Next Page
Loading...