Chapter 2. API Reference
unsigned task_priority
Priority of server task
struct protocomm_httpd_config_t
Config parameters for protocomm HTTP server.
Public Members
bool ext_handle_provided
Flag to indicate of an external HTTP Server Handle has been provided. In such as case, protocomm will
use the same HTTP Server and not start a new one internally.
protocomm_httpd_config_data_t data
Protocomm HTTPD Configuration Data
Macros
PROTOCOMM_HTTPD_DEFAULT_CONFIG()
Header File
• components/protocomm/include/transports/protocomm_ble.h
Functions
esp_err_t protocomm_ble_start(protocomm_t *pc, const protocomm_ble_config_t *config)
Start Bluetooth Low Energy based transport layer for provisioning.
Initialize and start required BLE service for provisioning. This includes the initialization for characteris-
tics/service for BLE.
Return
• ESP_OK : Success
• ESP_FAIL : Simple BLE start error
• ESP_ERR_NO_MEM : Error allocating memory for internal resources
• ESP_ERR_INVALID_STATE : Error in ble config
• ESP_ERR_INVALID_ARG : Null arguments
Parameters
• [in] pc: Protocomm instance pointer obtained from protocomm_new()
• [in] config: Pointer to config structure for initializing BLE
esp_err_t protocomm_ble_stop(protocomm_t *pc)
Stop Bluetooth Low Energy based transport layer for provisioning.
Stops service/task responsible for BLE based interactions for provisioning
Note You might want to optionally reclaim memory from Bluetooth. Refer to the documentation of
esp_bt_mem_release in that case.
Return
• ESP_OK : Success
• ESP_FAIL : Simple BLE stop error
• ESP_ERR_INVALID_ARG : Null / incorrect protocomm instance
Parameters
• [in] pc: Same protocomm instance that was passed to protocomm_ble_start()
Structures
struct name_uuid
This structure maps handler required by protocomm layer to UUIDs which are used to uniquely identify BLE
characteristics from a smartphone or a similar client device.
Espressif Systems 673
Submit Document Feedback
Release v4.4
To Next Page
Loading...