Chapter 2. API Reference
void *custom_handle
Custom security handle if security is set custom via proto_sec above This handle must follow pro-
tocomm_security_t signature
void *pop
Proof of possession to be used for local control. Could be NULL.
struct esp_local_ctrl_config
Configuration structure to pass to esp_local_ctrl_start()
Public Members
const esp_local_ctrl_transport_t *transport
Transport layer over which service will be provided
esp_local_ctrl_transport_config_t transport_config
Transport layer over which service will be provided
esp_local_ctrl_proto_sec_cfg_t proto_sec
Security version and POP
esp_local_ctrl_handlers_t handlers
Register handlers for responding to get/set requests on properties
size_t max_properties
This limits the number of properties that are available at a time
Macros
ESP_LOCAL_CTRL_TRANSPORT_BLE
ESP_LOCAL_CTRL_TRANSPORT_HTTPD
Type Definitions
typedef struct esp_local_ctrl_prop esp_local_ctrl_prop_t
Property description data structure, which is to be populated and passed to the
esp_local_ctrl_add_property() function.
Once a property is added, its structure is available for read-only access inside get_prop_values() and
set_prop_values() handlers.
typedef struct esp_local_ctrl_prop_val esp_local_ctrl_prop_val_t
Property value data structure. This gets passed to the get_prop_values() and set_prop_values()
handlers for the purpose of retrieving or setting the present value of a property.
typedef struct esp_local_ctrl_handlers esp_local_ctrl_handlers_t
Handlers for receiving and responding to local control commands for getting and setting properties.
typedef struct esp_local_ctrl_transport esp_local_ctrl_transport_t
Transport mode (BLE / HTTPD) over which the service will be provided.
This is forward declaration of a private structure, implemented internally by esp_local_ctrl.
typedef struct protocomm_ble_config esp_local_ctrl_transport_config_ble_t
Configuration for transport mode BLE.
This is a forward declaration for protocomm_ble_config_t. To use this, application must set CON-
FIG_BT_BLUEDROID_ENABLED and include protocomm_ble.h.
typedef struct httpd_ssl_config esp_local_ctrl_transport_config_httpd_t
Configuration for transport mode HTTPD.
This is a forward declaration for httpd_ssl_config_t. To use this, application must set CON-
FIG_ESP_HTTPS_SERVER_ENABLE and include esp_https_server.h
Espressif Systems 607
Submit Document Feedback
Release v4.4
To Next Page
Loading...