Chapter 2. API Reference
Public Members
esp_err_t (*prov_start)(protocomm_t *pc, void *config)
Function which is to be called by the manager when it is to start the provisioning service associated with
a protocomm instance and a scheme specific configuration
esp_err_t (*prov_stop)(protocomm_t *pc)
Function which is to be called by the manager to stop the provisioning service previously associated with
a protocomm instance
void *(*new_config)(void)
Function which is to be called by the manager to generate a new configuration for the provisioning service,
that is to be passed to prov_start()
void (*delete_config)(void *config)
Function which is to be called by the manager to delete a configuration generated using new_config()
esp_err_t (*set_config_service)(void *config, const char *service_name, const char *ser-
vice_key)
Function which is to be called by the manager to set the service name and key values in the configuration
structure
esp_err_t (*set_config_endpoint)(void *config, const char *endpoint_name, uint16_t uuid)
Function which is to be called by the manager to set a protocomm endpoint with an identifying name and
UUID in the configuration structure
wifi_mode_t wifi_mode
Sets mode of operation of Wi-Fi during provisioning This is set to :
• WIFI_MODE_APSTA for SoftAP transport
• WIFI_MODE_STA for BLE transport
struct wifi_prov_mgr_config_t
Structure for specifying the manager configuration.
Public Members
wifi_prov_scheme_t scheme
Provisioning scheme to use. Following schemes are already available:
• wifi_prov_scheme_ble : for provisioning over BLE transport + GATT server
• wifi_prov_scheme_softap : for provisioning over SoftAP transport + HTTP server + mDNS (op-
tional)
• wifi_prov_scheme_console : for provisioning over Serial UART transport + Console (for debugging)
wifi_prov_event_handler_t scheme_event_handler
Event handler required by the scheme for incorporating scheme specific behavior while provi-
sioning manager is running. Various options may be provided by the scheme for setting this
field. Use WIFI_PROV_EVENT_HANDLER_NONE when not used. When using scheme
wifi_prov_scheme_ble, the following options are available:
• WIFI_PROV_SCHEME_BLE_EVENT_HANDLER_FREE_BTDM
• WIFI_PROV_SCHEME_BLE_EVENT_HANDLER_FREE_BLE
• WIFI_PROV_SCHEME_BLE_EVENT_HANDLER_FREE_BT
wifi_prov_event_handler_t app_event_handler
Event handler that can be set for the purpose of incorporating application specific behavior. Use
WIFI_PROV_EVENT_HANDLER_NONE when not used.
Macros
WIFI_PROV_EVENT_HANDLER_NONE
Event handler can be set to none if not used.
Espressif Systems 690
Submit Document Feedback
Release v4.4
To Next Page
Loading...