data stringlengths 512 2.99k |
|---|
When the operation is complete, the callback function will be called with ESP_HIDD_CLOSE_EVT.
Note
The disconnect operation will not remove the virtually cabled device. If the connect request from the different HID Host, it will reject the request.
- Returns
ESP_OK: success
other: failed
-
-
esp_err_t esp_bt_hid_devi... |
[in] type of report
id -- [in] report id as defined by descriptor
len -- [in] length of report
data -- [in] report data
-
- Returns
ESP_OK: success
other: failed
-
-
esp_err_t esp_bt_hid_device_report_error(esp_hidd_handshake_error_t error)
Sends HID Handshake with error info for invalid set_report to the currently con... |
Classic Bluetooth® L2CAP API
Application Example
Check bluetooth/bluedroid/classic_bt folder in ESP-IDF examples, which contains the following application:
This is a BT_L2CAP demo. This demo can connect, send and receive L2CAP data bluetooth/bluedroid/classic_bt/bt_l2cap_client, bluetooth/bluedroid/classic_bt/bt_l2cap_... |
[in] Remote device bluetooth device address.
-
- Returns
ESP_OK: success
other: failed
-
-
esp_err_t esp_bt_l2cap_start_srv(esp_bt_l2cap_cntl_flags_t cntl_flag, uint16_t local_psm)
This function create a L2CAP server and starts listening for an L2CAP connection request from a remote Bluetooth device. When the server is... |
This function stops all L2CAP servers. The operation will close all active L2CAP connection first, then the callback function will be called with ESP_BT_L2CAP_CLOSE_EVT, and the number of ESP_BT_L2CAP_CLOSE_EVT is equal to the number of connection. When the operation is completed, the callback is called with ESP_BT_L2C... |
This function must be called after esp_bt_l2cap_init() successful and before esp_bt_l2cap_deinit().
- Returns
ESP_OK: success
other: failed
-
Unions
-
union esp_bt_l2cap_cb_param_t
- #include <esp_l2cap_bt_api.h>
L2CAP callback parameters union.
Public Members
-
struct esp_bt_l2cap_cb_param_t::l2cap_init_evt_param in... |
No security
-
-
ESP_BT_L2CAP_SEC_AUTHORIZE
Authorization required
-
ESP_BT_L2CAP_SEC_AUTHENTICATE
Authentication required
-
ESP_BT_L2CAP_SEC_ENCRYPT
Encryption required
Type Definitions
-
typedef uint32_t esp_bt_l2cap_cntl_flags_t
-
typedef void (*esp_bt_l2cap_cb_t)(esp_bt_l2cap_cb_event_t event, esp_bt_l2cap_cb_param_... |
API Reference
Header File
This header file can be included with:
#include "esp_sdp_api.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depends on
bt, add the following to your CMakeLists.txt:
REQUIRES bt
or
PRIV_REQUIRES bt
Functions
-
esp_err_t esp_sdp_register_call... |
This function should be called after esp_bluedroid_enable() completes successfully.
- Returns
ESP_OK: success
other: failed
-
-
esp_err_t esp_sdp_deinit(void)
This function is called to de-initialize SDP module. The operation will remove all SDP records, then the callback function will be called with ESP_SDP_REMOVE_R... |
For compatible of API, retain this argument. This mode must be equal as the mode in "cfg" of esp_bt_controller_init().
- Returns
ESP_OK - success, other - failed
-
esp_err_t esp_bt_controller_disable(void)
Disable BT controller.
- Returns
ESP_OK - success, other - failed
-
esp_bt_controller_status_t esp_bt_controller_g... |
In case of NimBLE host, to release BSS and data memory to heap, the mode needs to be set to ESP_BT_MODE_BTDM as controller is dual mode.
- Parameters
mode -- : the mode whose memory is to be released
- Returns
ESP_OK - success, other - failed
-
esp_err_t esp_bt_sleep_enable(void)
enable bluetooth to enter modem sleep
N... |
UART number
-
uint32_t hci_uart_baudrate
If use UART1/2 as HCI IO interface, indicate UART baudrate
-
uint8_t scan_duplicate_mode
scan duplicate mode
-
uint8_t scan_duplicate_type
scan duplicate type
-
uint16_t normal_adv_size
Normal adv size for scan duplicate
-
uint16_t mesh_adv_size
Mesh adv size for scan duplicat... |
Values:
-
enumerator ESP_BLE_SCA_500PPM
BLE SCA at 500ppm
-
enumerator ESP_BLE_SCA_250PPM
BLE SCA at 250ppm
-
enumerator ESP_BLE_SCA_150PPM
BLE SCA at 150ppm
-
enumerator ESP_BLE_SCA_100PPM
BLE SCA at 100ppm
-
enumerator ESP_BLE_SCA_75PPM
BLE SCA at 75ppm
-
enumerator ESP_BLE_SCA_50PPM
BLE SCA at 50ppm
-
enumerator ESP... |
if each connection's TX power is not set, it will use this default value. if neither in scan mode nor in adv mode, it will use this default value. If none of power type is set, system will use ESP_PWR_LVL_P3 as default for ADV/SCAN/CONN0-9.
Values:
-
enumerator ESP_BLE_PWR_TYPE_CONN_HDL0
For connection handle 0
-
enum... |
Event parameter of ESP_BLE_MESH_PROXY_CLIENT_SEND_SOLIC_PDU_COMP_EVT
-
struct esp_ble_mesh_prov_cb_param_t::ble_mesh_model_sub_group_addr_comp_param model_sub_group_addr_comp
Event parameters of ESP_BLE_MESH_MODEL_SUBSCRIBE_GROUP_ADDR_COMP_EVT
-
struct esp_ble_mesh_prov_cb_param_t::ble_mesh_model_unsub_group_addr_comp_... |
send_ttl
TTL, or ESP_BLE_MESH_TTL_DEFAULT for default TTL.
-
uint8_t send_cred
Security credentials used for sending the message
-
uint8_t send_tag
Tag used for sending the message.
-
esp_ble_mesh_model_t *model
Model corresponding to the message, no need to be initialized before sending message
-
bool srv_send
Indicat... |
The maximum length of a BLE Mesh message, including Opcode, Payload and TransMIC Length of a short Mesh MIC.
-
ESP_BLE_MESH_MIC_SHORT
Length of a long Mesh MIC.
-
ESP_BLE_MESH_MIC_LONG
The maximum length of a BLE Mesh provisioned node name
-
ESP_BLE_MESH_NODE_NAME_MAX_LEN
The maximum length of a BLE Mesh unprovisioned ... |
int_ms -- Interval steps in milliseconds. Must be greater than 0 and a multiple of 10.
-
- Returns
BLE Mesh transmit value that can be used e.g. for the default values of the Configuration Model data.
-
ESP_BLE_MESH_GET_TRANSMIT_COUNT(transmit)
Decode transmit count from a transmit value.
- Parameters
transmit -- Encod... |
net_idx -- [in] NetKey Index.
app_idx -- [in] AppKey Index.
-
- Returns
ESP_OK on success or error code otherwise.
-
esp_err_t esp_ble_mesh_node_bind_app_key_to_local_model(uint16_t element_addr, uint16_t company_id, uint16_t model_id, uint16_t app_idx)
This function is called by Node to bind AppKey to model locally.
... |
data -- [in] Parameters of Access Payload (exclude the message opcode) to be sent.
-
- Returns
ESP_OK on success or error code otherwise.
-
esp_err_t esp_ble_mesh_client_model_send_msg(esp_ble_mesh_model_t *model, esp_ble_mesh_msg_ctx_t *ctx, uint32_t opcode, uint16_t length, uint8_t *data, int32_t msg_timeout, bool ne... |
[in] TRUE if the opcode requires the peer device to reply, FALSE otherwise.
device_role -- [in] Role of the device (Node/Provisioner) that sends the message.
-
- Returns
ESP_OK on success or error code otherwise.
-
esp_err_t esp_ble_mesh_model_publish(esp_ble_mesh_model_t *model, uint32_t opcode, uint16_t length, uint8... |
[in] Role of the device (node/provisioner) publishing the message of the type esp_ble_mesh_dev_role_t.
-
- Returns
ESP_OK on success or error code otherwise.
-
esp_err_t esp_ble_mesh_server_model_update_state(esp_ble_mesh_model_t *model, esp_ble_mesh_server_state_type_t type, esp_ble_mesh_server_state_value_t *value)
U... |
*data, uint16_t length)
This function is called to store the Composition Data of the node.
- Parameters
unicast_addr -- [in] Element address of the node
data -- [in] Pointer of Composition Data
length -- [in] Length of Composition Data
-
- Returns
ESP_OK on success or error code otherwise.
-
esp_ble_mesh_node_t *esp_bl... |
This function is called to delete the provisioned node information with the node device uuid.
- Parameters
uuid -- [in] Device UUID of the node
- Returns
ESP_OK on success or error code otherwise.
-
esp_err_t esp_ble_mesh_provisioner_delete_node_with_addr(uint16_t unicast_addr)
This function is called to delete the pro... |
If set to NULL, app_key will be generated internally. net_idx: Should be an existing one. app_idx: If it is going to be generated internally, it should be set to 0xFFFF, and the new app_idx will be reported via an event.
- Parameters
app_key -- [in] The app key to be set for the local BLE Mesh stack.
net_idx -- [in] Th... |
If going to bind app_key with local vendor model, company_id should be set to 0xFFFF.
- Parameters
element_addr -- [in] Provisioner local element address
app_idx -- [in] Provisioner local appkey index
model_id -- [in] Provisioner local model id
company_id -- [in] Provisioner local company id
-
- Returns
ESP_OK on succe... |
Before closing the nvs namespace, it must be open.
When the function is invoked, the Provisioner functionality will be disabled firstly, and: a) If the "erase" flag is set to false, the mesh information will be cleaned (e.g. removing NetKey, AppKey, nodes, etc) from the mesh stack. b) If the "erase" flag is set to tru... |
Before closing the nvs namespace, it must be open.
When the function is invoked, the Provisioner functionality will be disabled firstly, and: a) If the "erase" flag is set to false, the mesh information will be cleaned (e.g. removing NetKey, AppKey, nodes, etc) from the mesh stack. b) If the "erase" flag is set to tr... |
[in] Indicate if erasing mesh information.
-
- Returns
ESP_OK on success or error code otherwise.
-
-
esp_err_t esp_ble_mesh_provisioner_delete_settings_with_index(uint8_t index)
This function is called by Provisioner to erase the mesh information and settings user id from a nvs namespace.
Note
When this function i... |
[in] Application key index.
-
- Returns
Application key on success, or NULL on failure.
Type Definitions
-
typedef void (*esp_ble_mesh_model_cb_t)(esp_ble_mesh_model_cb_event_t event, esp_ble_mesh_model_cb_param_t *param)
: event, event code of user-defined model events; param, parameters of user-defined model events
... |
Note
PB-ADV: send unprovisioned device beacon. PB-GATT: send connectable advertising packets.
- Parameters
bearers -- Bit-wise OR of provisioning bearers.
- Returns
ESP_OK on success or error code otherwise.
-
esp_err_t esp_ble_mesh_node_prov_disable(esp_ble_mesh_prov_bearer_t bearers)
Disable specific provisioning bea... |
In order to avoid suffering brute-forcing attack (CVE-2020-26559). The Bluetooth SIG recommends that potentially vulnerable mesh provisioners use an out-of-band mechanism to exchange the public keys. So as an unprovisioned device, it should use this function to input the Public Key exchanged through the out-of-band mec... |
In order to avoid suffering brute-forcing attack (CVE-2020-26559). The Bluetooth SIG recommends that potentially vulnerable mesh provisioners use an out-of-band mechanism to exchange the public keys.
- Parameters
link_idx -- [in] The provisioning link index
pub_key_x -- [in] Unprovisioned device's Public Key X
pub_key_... |
[in] The provisioning link index.
-
- Returns
ESP_OK on success or error code otherwise.
-
esp_err_t esp_ble_mesh_provisioner_prov_enable(esp_ble_mesh_prov_bearer_t bearers)
Enable one or more provisioning bearers.
Note
PB-ADV: Enable BLE scan. PB-GATT: Initialize corresponding BLE Mesh Proxy info.
- Parameters
bearer... |
Currently address type only supports public address and static random address.
Bearer must be equal to ESP_BLE_MESH_PROV_ADV or ESP_BLE_MESH_PROV_GATT, since Provisioner will start to provision a device immediately once this function is invoked. And the input bearer must be identical with the one within the parameters... |
This header file can be included with:
#include "esp_ble_mesh_proxy_api.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depends on
bt, add the following to your CMakeLists.txt:
REQUIRES bt
or
PRIV_REQUIRES bt
Functions
-
esp_err_t esp_ble_mesh_proxy_identity_enable(v... |
NetKey Index related with Network ID in the Mesh Proxy advertising packet.
-
- Returns
ESP_OK on success or error code otherwise.
-
esp_err_t esp_ble_mesh_proxy_client_disconnect(uint8_t conn_handle)
Proxy Client terminates a connection with the Proxy Server.
- Parameters
conn_handle -- [in] Proxy connection handle.
-... |
[in] Number of the filter address.
-
- Returns
ESP_OK on success or error code otherwise.
-
esp_err_t esp_ble_mesh_proxy_client_directed_proxy_set(uint8_t conn_handle, uint16_t net_idx, uint8_t use_directed)
Proxy Client sets whether or not the Directed Proxy Server uses directed forwarding for Directed Proxy Client me... |
Configuration Client/Server Models
Header File
components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_config_model_api.h
This header file can be included with:
#include "esp_ble_mesh_config_model_api.h"
This header file is a part of the API provided by the
btcomponent. To declare that your component depends on
bt, ... |
Public Members
-
esp_ble_mesh_cfg_model_pub_get_t model_pub_get
For ESP_BLE_MESH_MODEL_OP_MODEL_PUB_GET.
-
esp_ble_mesh_cfg_composition_data_get_t comp_data_get
For ESP_BLE_MESH_MODEL_OP_COMPOSITION_DATA_GET.
-
esp_ble_mesh_cfg_sig_model_sub_get_t sig_model_sub_get
For ESP_BLE_MESH_MODEL_OP_SIG_MODEL_SUB_GET
-
esp_bl... |
For ESP_BLE_MESH_MODEL_OP_BEACON_SET ESP_BLE_MESH_MODEL_OP_DEFAULT_TTL_SET ESP_BLE_MESH_MODEL_OP_GATT_PROXY_SET ESP_BLE_MESH_MODEL_OP_RELAY_SET ESP_BLE_MESH_MODEL_OP_MODEL_PUB_SET ESP_BLE_MESH_MODEL_OP_MODEL_SUB_ADD ESP_BLE_MESH_MODEL_OP_MODEL_SUB_VIRTUAL_ADDR_ADD ESP_BLE_MESH_MODEL_OP_MODEL_SUB_DELETE ESP_BLE_MESH_MOD... |
Public Members
-
esp_ble_mesh_health_fault_get_t fault_get
For ESP_BLE_MESH_MODEL_OP_HEALTH_FAULT_GET.
- esp_ble_mesh_health_fault_get_t fault_get
-
union esp_ble_mesh_health_client_set_state_t
- #include <esp_ble_mesh_health_model_api.h>
For ESP_BLE_MESH_MODEL_OP_HEALTH_FAULT_CLEAR ESP_BLE_MESH_MODEL_OP_HEALTH_FAULT_C... |
Public Members
-
esp_ble_mesh_health_attention_set_t attention_set
For ESP_BLE_MESH_MODEL_OP_ATTENTION_SET or ESP_BLE_MESH_MODEL_OP_ATTENTION_SET_UNACK.
-
esp_ble_mesh_health_period_set_t period_set
For ESP_BLE_MESH_MODEL_OP_HEALTH_PERIOD_SET or ESP_BLE_MESH_MODEL_OP_HEALTH_PERIOD_SET_UNACK.
-
esp_ble_mesh_health_fault... |
The health current status value
-
esp_ble_mesh_health_fault_status_cb_t fault_status
The health fault status value
-
esp_ble_mesh_health_period_status_cb_t period_status
The health period status value
-
esp_ble_mesh_health_attention_status_cb_t attention_status
The health attention status value
- esp_ble_mesh_health_c... |
0x80 ~ 0xFF: Vendor Specific Warning/Error.
-
ESP_BLE_MESH_BATTERY_LOW_WARNING
-
ESP_BLE_MESH_BATTERY_LOW_ERROR
-
ESP_BLE_MESH_SUPPLY_VOLTAGE_TOO_LOW_WARNING
-
ESP_BLE_MESH_SUPPLY_VOLTAGE_TOO_LOW_ERROR
-
ESP_BLE_MESH_SUPPLY_VOLTAGE_TOO_HIGH_WARNING
-
ESP_BLE_MESH_SUPPLY_VOLTAGE_TOO_HIGH_ERROR
-
ESP_BLE_MESH_POWER_SUPPL... |
esp_ble_mesh_register_generic_server_callback(esp_ble_mesh_generic_server_cb_t callback)
Register BLE Mesh Generic Server Model callback.
- Parameters
callback -- [in] Pointer to the callback function.
- Returns
ESP_OK on success or error code otherwise.
Unions
-
union esp_ble_mesh_generic_client_get_state_t
- #includ... |
onoff_set
For ESP_BLE_MESH_MODEL_OP_GEN_ONOFF_SET & ESP_BLE_MESH_MODEL_OP_GEN_ONOFF_SET_UNACK
-
esp_ble_mesh_gen_level_set_t level_set
For ESP_BLE_MESH_MODEL_OP_GEN_LEVEL_SET & ESP_BLE_MESH_MODEL_OP_GEN_LEVEL_SET_UNACK
-
esp_ble_mesh_gen_delta_set_t delta_set
For ESP_BLE_MESH_MODEL_OP_GEN_DELTA_SET & ESP_BLE_MESH_MODE... |
onoff_set
-
union esp_ble_mesh_gen_client_status_cb_t
- #include <esp_ble_mesh_generic_model_api.h>
Generic Client Model received message union.
Public Members
-
esp_ble_mesh_gen_onoff_status_cb_t onoff_status
For ESP_BLE_MESH_MODEL_OP_GEN_ONOFF_STATUS
-
esp_ble_mesh_gen_level_status_cb_t level_status
For ESP_BLE_M... |
The Generic Power OnOff Server model extends the Generic OnOff Server model. When this model is present on an element, the corresponding Generic Power OnOff Setup Server model shall also be present.
This model may be used to represent a variety of devices that do not fit any of the model descriptions that have been d... |
The Generic Power OnOff Setup Server model extends the Generic Power OnOff Server model and the Generic Default Transition Time Server model.
This model shall support model subscription.
- Parameters
srv_pub -- Pointer to the unique struct esp_ble_mesh_model_pub_t.
srv_data -- Pointer to the unique struct esp_ble_... |
The Generic Power Level Server model extends the Generic Power OnOff Server model and the Generic Level Server model. When this model is present on an Element, the corresponding Generic Power Level Setup Server model shall also be present.
This model shall support model publication and model subscription.
- Paramete... |
The Generic Power Level Setup Server model extends the Generic Power Level Server model and the Generic Power OnOff Setup Server model.
This model shall support model subscription.
- Parameters
srv_pub -- Pointer to the unique struct esp_ble_mesh_model_pub_t.
srv_data -- Pointer to the unique struct esp_ble_mesh_g... |
The Generic Battery Server Model is a root model.
This model shall support model publication and model subscription.
The model may be used to represent an element that is powered by a battery.
- Parameters
srv_pub -- Pointer to the unique struct esp_ble_mesh_model_pub_t.
srv_data -- Pointer to the unique struct esp_... |
The Generic Location Server model is a root model. When this model is present on an Element, the corresponding Generic Location Setup Server model shall also be present.
This model shall support model publication and model subscription.
The model may be used to represent an element that knows its location (global or ... |
The Generic User Property Server model is a root model.
This model shall support model publication and model subscription.
- Parameters
srv_pub -- Pointer to the unique struct esp_ble_mesh_model_pub_t.
srv_data -- Pointer to the unique struct esp_ble_mesh_gen_user_prop_srv_t.
-
- Returns
New Generic User Property Se... |
Public Members
-
esp_ble_mesh_sensor_descriptor_get_t descriptor_get
For ESP_BLE_MESH_MODEL_OP_SENSOR_DESCRIPTOR_GET
-
esp_ble_mesh_sensor_cadence_get_t cadence_get
For ESP_BLE_MESH_MODEL_OP_SENSOR_CADENCE_GET
-
esp_ble_mesh_sensor_settings_get_t settings_get
For ESP_BLE_MESH_MODEL_OP_SENSOR_SETTINGS_GET
-
esp_ble_m... |
-
esp_ble_mesh_sensor_client_status_cb_t status_cb
The sensor status message callback values
- int error_code
-
struct esp_ble_mesh_sensor_descriptor_t
Parameters of Sensor Descriptor state
Public Members
-
uint32_t positive_tolerance
The value of Sensor Positive Tolerance field
-
uint32_t negative_tolerance
The valu... |
The Sensor Server model is a root model. When this model is present on an element, the corresponding Sensor Setup Server model shall also be present.
This model shall support model publication and model subscription.
- Parameters
srv_pub -- Pointer to the unique struct esp_ble_mesh_model_pub_t.
srv_data -- Pointer... |
srv_data -- Pointer to the unique struct esp_ble_mesh_sensor_setup_srv_t.
-
- Returns
New Sensor Setup Server Model instance.
-
-
ESP_BLE_MESH_INVALID_SENSOR_PROPERTY_ID
Invalid Sensor Property ID
-
ESP_BLE_MESH_SENSOR_PROPERTY_ID_LEN
Length of Sensor Property ID
-
ESP_BLE_MESH_SENSOR_DESCRIPTOR_LEN
Length of Sensor De... |
Note
Multiple sensor data may be concatenated. Make sure the _data pointer is updated before getting the format of the corresponding sensor data.
- Parameters
_data -- Pointer to the start of the sensor data.
-
- Returns
Format of the sensor data.
-
ESP_BLE_MESH_GET_SENSOR_DATA_LENGTH(_data, _fmt)
Get length of the sen... |
The Format field is 0b1 and indicates Format B is used.
The Length field is a 1-based uint7 value (valid range 0x0–0x7F, representing range of 1–127). The value 0x7F represents a length of zero.
The Property ID is a 16-bit bit field representing a Property ID.
This format may be used for Property Values not longe... |
time_set
For ESP_BLE_MESH_MODEL_OP_TIME_SET
-
esp_ble_mesh_time_zone_set_t time_zone_set
For ESP_BLE_MESH_MODEL_OP_TIME_ZONE_SET
-
esp_ble_mesh_tai_utc_delta_set_t tai_utc_delta_set
For ESP_BLE_MESH_MODEL_OP_TAI_UTC_DELTA_SET
-
esp_ble_mesh_time_role_set_t time_role_set
For ESP_BLE_MESH_MODEL_OP_TIME_ROLE_SET
-
esp_... |
Public Members
-
esp_ble_mesh_time_status_cb_t time_status
For ESP_BLE_MESH_MODEL_OP_TIME_STATUS
-
esp_ble_mesh_time_zone_status_cb_t time_zone_status
For ESP_BLE_MESH_MODEL_OP_TIME_ZONE_STATUS
-
esp_ble_mesh_tai_utc_delta_status_cb_t tai_utc_delta_status
For ESP_BLE_MESH_MODEL_OP_TAI_UTC_DELTA_STATUS
-
esp_ble_mesh... |
The Time Server model is a root model. When this model is present on an Element, the corresponding Time Setup Server model shall also be present.
This model shall support model publication and model subscription.
- Parameters
srv_pub -- Pointer to the unique struct esp_ble_mesh_model_pub_t.
srv_data -- Pointer to th... |
The Scene Server model is a root model. When this model is present on an Element, the corresponding Scene Setup Server model shall also be present.
This model shall support model publication and model subscription.
The model may be present only on the Primary element of a node.
- Parameters
srv_pub -- Pointer to th... |
The Scene Setup Server model extends the Scene Server model and the Generic Default Transition Time Server model.
This model shall support model subscription.
The model may be present only on the Primary element of a node.
- Parameters
srv_pub -- Pointer to the unique struct esp_ble_mesh_model_pub_t.
srv_data -- ... |
The Scheduler Server model extends the Scene Server model. When this model is present on an Element, the corresponding Scheduler Setup Server model shall also be present.
This model shall support model publication and model subscription.
The model may be present only on the Primary element of a node.
The model re... |
The Scheduler Setup Server model extends the Scheduler Server and the Scene Setup Server models.
This model shall support model subscription.
The model may be present only on the Primary element of a node.
- Parameters
srv_pub -- Pointer to the unique struct esp_ble_mesh_model_pub_t.
srv_data -- Pointer to the un... |
Time Scene Client Model callback function type
- Param event
Event type
- Param param
Pointer to callback parameter
-
typedef void (*esp_ble_mesh_time_scene_server_cb_t)(esp_ble_mesh_time_scene_server_cb_event_t event, esp_ble_mesh_time_scene_server_cb_param_t *param)
Bluetooth Mesh Time and Scenes Server Model functio... |
ESP_BLE_MESH_TIME_SCENE_SERVER_STATE_CHANGE_EVT
When get_auto_rsp is set to ESP_BLE_MESH_SERVER_AUTO_RSP, no event will be callback to the application layer when Time Scene Get messages are received.
When set_auto_rsp is set to ESP_BLE_MESH_SERVER_AUTO_RSP, this event will be callback to the application layer when Ti... |
ESP_BLE_MESH_TIME_SCENE_SERVER_STATE_CHANGE_EVT
Lighting Client/Server Models
Header File
components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_lighting_model_api.h
This header file can be included with:
#include "esp_ble_mesh_lighting_model_api.h"
This header file is a part of the API provided by the
btcomponent.... |
Shall not be set to NULL.
-
- Returns
ESP_OK on success or error code otherwise.
-
esp_err_t esp_ble_mesh_register_lighting_server_callback(esp_ble_mesh_lighting_server_cb_t callback)
Register BLE Mesh Lighting Server Model callback.
- Parameters
callback -- [in] Pointer to the callback function.
- Returns
ESP_OK on ... |
Public Members
-
esp_ble_mesh_light_lightness_status_cb_t lightness_status
For ESP_BLE_MESH_MODEL_OP_LIGHT_LIGHTNESS_STATUS
-
esp_ble_mesh_light_lightness_linear_status_cb_t lightness_linear_status
For ESP_BLE_MESH_MODEL_OP_LIGHT_LIGHTNESS_LINEAR_STATUS
-
esp_ble_mesh_light_lightness_last_status_cb_t lightness_last_sta... |
Initialized internally.
-
esp_ble_mesh_server_rsp_ctrl_t rsp_ctrl
Response control of the server model received messages
-
esp_ble_mesh_light_xyl_state_t *state
Parameters of the Light xyL state
-
esp_ble_mesh_last_msg_info_t last
Parameters of the last received set message
-
esp_ble_mesh_state_transition_t transition
... |
The Light Lightness Server model extends the Generic Power OnOff Server model and the Generic Level Server model. When this model is present on an Element, the corresponding Light Lightness Setup Server model shall also be present.
This model shall support model publication and model subscription.
- Parameters
srv_p... |
The Light CTL Server model extends the Light Lightness Server model. When this model is present on an Element, the corresponding Light CTL Temperature Server model and the corresponding Light CTL Setup Server model shall also be present.
This model shall support model publication and model subscription.
The model r... |
The Light HSL Server model extends the Light Lightness Server model. When this model is present on an Element, the corresponding Light HSL Hue Server model and the corresponding Light HSL Saturation Server model and the corresponding Light HSL Setup Server model shall also be present.
This model shall support model p... |
The Light HSL Hue Server model extends the Generic Level Server model. This model is associated with the Light HSL Server model.
This model shall support model publication and model subscription.
- Parameters
srv_pub -- Pointer to the unique struct esp_ble_mesh_model_pub_t.
srv_data -- Pointer to the unique struct... |
The Light HSL Saturation Server model extends the Generic Level Server model. This model is associated with the Light HSL Server model.
This model shall support model publication and model subscription.
- Parameters
srv_pub -- Pointer to the unique struct esp_ble_mesh_model_pub_t.
srv_data -- Pointer to the unique... |
The Light xyL Server model extends the Light Lightness Server model. When this model is present on an Element, the corresponding Light xyL Setup Server model shall also be present.
This model shall support model publication and model subscription.
- Parameters
srv_pub -- Pointer to the unique struct esp_ble_mesh_mod... |
The Light LC (Lightness Control) Server model extends the Light Lightness Server model and the Generic OnOff Server model. When this model is present on an Element, the corresponding Light LC Setup Server model shall also be present.
This model shall support model publication and model subscription.
This model may ... |
The Light LC (Lightness Control) Setup model extends the Light LC Server model.
This model shall support model publication and model subscription.
This model may be used to configure setup parameters for the Light LC Server model.
- Parameters
srv_pub -- Pointer to the unique struct esp_ble_mesh_model_pub_t.
srv_... |
Lighting Server Model callback function type
- Param event
Event type
- Param param
Pointer to callback parameter
Enumerations
-
enum esp_ble_mesh_light_client_cb_event_t
This enum value is the event of Lighting Client Model
Values:
-
enumerator ESP_BLE_MESH_LIGHT_CLIENT_GET_STATE_EVT
-
enumerator ESP_BLE_MESH_LIGHT_CL... |
esp_ble_mesh_register_rpr_client_callback(esp_ble_mesh_rpr_client_cb_t callback)
Register BLE Mesh Remote Provisioning Client model callback.
- Parameters
callback -- [in] Pointer to the callback function.
- Returns
ESP_OK on success or error code otherwise.
-
esp_err_t esp_ble_mesh_rpr_client_send(esp_ble_mesh_client_... |
For ESP_BLE_MESH_MODEL_OP_BRIDGED_SUBNETS_GET
-
esp_ble_mesh_bridging_table_get_t bridging_table_get
For ESP_BLE_MESH_MODEL_OP_BRIDGING_TABLE_GET
-
esp_ble_mesh_subnet_bridge_set_t subnet_bridge_set
For ESP_BLE_MESH_MODEL_OP_SUBNET_BRIDGE_SET
-
esp_ble_mesh_bridging_table_add_t bridging_table_add
For ESP_BLE_MESH_MOD... |
Private Beacon Set
-
esp_ble_mesh_state_change_priv_gatt_proxy_set_t priv_gatt_proxy_set
Private GATT Proxy Set
-
esp_ble_mesh_state_change_priv_node_id_set_t priv_node_id_set
Private Node Identity Set
- esp_ble_mesh_state_change_priv_beacon_set_t priv_beacon_set
-
union esp_ble_mesh_prb_server_cb_value_t
- #include <e... |
Proxy state
- uint8_t private_gatt_proxy
-
struct esp_ble_mesh_priv_node_id_get_t
Parameter of Private node identity Get
Public Members
-
uint16_t net_idx
Index of the NetKey
- uint16_t net_idx
-
struct esp_ble_mesh_priv_node_id_set_t
Parameter of Private node identity Set
-
struct esp_ble_mesh_priv_beacon_status_cb_t
... |
Error Codes Reference
This section lists various error code constants defined in ESP-IDF.
For general information about error codes in ESP-IDF, see Error Handling.
ESP_FAIL (-1): Generic esp_err_t code indicating failure
ESP_OK (0): esp_err_t value indicating success (no error)
ESP_ERR_NO_MEM (0x101): Out of memory
E... |
ESP_ERR_NVS_KEY_TOO_LONG (0x1109): Key name is too long
ESP_ERR_NVS_PAGE_FULL (0x110a): Internal error; never returned by nvs API functions
ESP_ERR_NVS_INVALID_STATE (0x110b): NVS is in an inconsistent state due to a previous error. Call nvs_flash_init and nvs_open again, then retry.
ESP_ERR_NVS_INVALID_LENGTH (0x110c... |
ESP_ERR_ULP_BASE (0x1200): Offset for ULP-related error codes
ESP_ERR_ULP_SIZE_TOO_BIG (0x1201): Program doesn't fit into RTC memory reserved for the ULP
ESP_ERR_ULP_INVALID_LOAD_ADDR (0x1202): Load address is outside of RTC memory reserved for the ULP
ESP_ERR_ULP_DUPLICATE_LABEL (0x1203): More than one label with the ... |
ESP_ERR_IMAGE_BASE (0x2000)
ESP_ERR_IMAGE_FLASH_FAIL (0x2001)
ESP_ERR_IMAGE_INVALID (0x2002)
ESP_ERR_WIFI_BASE (0x3000): Starting number of WiFi error codes
ESP_ERR_WIFI_NOT_INIT (0x3001): WiFi driver was not installed by esp_wifi_init
ESP_ERR_WIFI_NOT_STARTED (0x3002): WiFi driver was not started by esp_wifi_start
ES... |
ESP-NOW
Overview
ESP-NOW is a kind of connectionless Wi-Fi communication protocol that is defined by Espressif. In ESP-NOW, application data is encapsulated in a vendor-specific action frame and then transmitted from one Wi-Fi device to another without connection.
CTR with CBC-MAC Protocol (CCMP) is used to protect t... |
The format of the vendor-specific action frame is as follows:
------------------------------------------------------------------------------------------------------------
| MAC Header | Category Code | Organization Identifier | Random Values | Vendor Specific Content | FCS |
--------------------------------------------... |
Vendor Specific Content: The Vendor Specific Content contains vendor-specific fields as follows:
-------------------------------------------------------------------------------
| Element ID | Length | Organization Identifier | Type | Version | Body |
---------------------------------------------------------------------... |
When
esp_now_deinit() is called, all of the information of paired devices are deleted.
Add Paired Device
Call
esp_now_add_peer() to add the device to the paired device list before you send data to this device. If security is enabled, the LMK must be set. You can send ESP-NOW data via both the Station and the SoftAP i... |
It will return ESP_NOW_SEND_SUCCESS in sending callback function if the data is received successfully on the MAC layer. Otherwise, it will return ESP_NOW_SEND_FAIL. Several reasons can lead to ESP-NOW fails to send data. For example, the destination device does not exist; the channels of the devices are not the same; t... |
The default value is the maximum, which allowing RX all the time.
If Power-saving is needed for ESP-NOW, call
esp_wifi_connectionless_module_set_wake_interval() to configure Interval as well.
Please refer to connectionless module power save to get more detail.
Application Examples
Example of sending and receiving E... |
If peer_addr is not NULL, send data to the peer whose MAC address matches peer_addr
- Attention
2. If peer_addr is NULL, send data to all of the peers that are added to the peer list
- Attention
3. The maximum length of data must be less than ESP_NOW_MAX_DATA_LEN
- Attention
4. The buffer pointed to by data argument do... |
Delete a peer from peer list.
- Parameters
peer_addr -- peer MAC address
- Returns
ESP_OK : succeed
ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
ESP_ERR_ESPNOW_ARG : invalid argument
ESP_ERR_ESPNOW_NOT_FOUND : peer is not found
-
-
esp_err_t esp_now_mod_peer(const esp_now_peer_info_t *peer)
Modify a peer.
- Par... |
Phy rate to be configured.
-
- Returns
ESP_OK: succeed
others: failed
-
-
esp_err_t esp_now_set_peer_rate_config(const uint8_t *peer_addr, esp_now_rate_config_t *config)
Set ESPNOW rate config for each peer.
- Attention
1. This API should be called after esp_wifi_start() and esp_now_init().
- Parameters
peer_addr -- p... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.