Chapter 2. API Reference
Public Members
esp_err_t (*get_prop_values)(size_t props_count, const esp_local_ctrl_prop_t props[],
esp_local_ctrl_prop_val_t prop_values[], void *usr_ctx)
Handler function to be implemented for retrieving current values of properties.
Note If any of the properties have fixed sizes, the size field of corresponding element in prop_values
need to be set
Return Returning different error codes will convey the corresponding protocol level errors to the client
:
• ESP_OK : Success
• ESP_ERR_INVALID_ARG : InvalidArgument
• ESP_ERR_INVALID_STATE : InvalidProto
• All other error codes : InternalError
Parameters
• [in] props_count: Total elements in the props array
• [in] props: Array of properties, the current values for which have been requested by the
client
• [out] prop_values: Array of empty property values, the elements of which need to be
populated with the current values of those properties specified by props argument
• [in] usr_ctx: This provides value of the usr_ctx field of
esp_local_ctrl_handlers_t structure
esp_err_t (*set_prop_values)(size_t props_count, const esp_local_ctrl_prop_t props[], const
esp_local_ctrl_prop_val_t prop_values[], void *usr_ctx)
Handler function to be implemented for changing values of properties.
Note If any of the properties have variable sizes, the size field of the corresponding element in
prop_values must be checked explicitly before making any assumptions on the size.
Return Returning different error codes will convey the corresponding protocol level errors to the client
:
• ESP_OK : Success
• ESP_ERR_INVALID_ARG : InvalidArgument
• ESP_ERR_INVALID_STATE : InvalidProto
• All other error codes : InternalError
Parameters
• [in] props_count: Total elements in the props array
• [in] props: Array of properties, the values for which the client requests to change
• [in] prop_values: Array of property values, the elements of which need to be used for
updating those properties specified by props argument
• [in] usr_ctx: This provides value of the usr_ctx field of
esp_local_ctrl_handlers_t structure
void *usr_ctx
Context pointer to be passed to above handler functions upon invocation. This is different from the
property level context, as this is valid throughout the lifetime of the esp_local_ctrl service, and
freed only when the service is stopped.
void (*usr_ctx_free_fn)(void *usr_ctx)
Pointer to function which will be internally invoked on usr_ctx for freeing the context resources when
esp_local_ctrl_stop() is called.
struct esp_local_ctrl_proto_sec_cfg
Protocom security configs
Public Members
esp_local_ctrl_proto_sec_t version
This sets protocom security version, sec0/sec1 or custom If custom, user must provide handle via
proto_sec_custom_handle below
Espressif Systems 606
Submit Document Feedback
Release v4.4
To Next Page
Loading...