Symbols ![]()
loading...
Files ![]()
loading (1/5)...
esp_mesh_recv_toDS() function
Receive a packet targeted to external IP network - Root uses this API to receive packets destined to external IP network - Root forwards the received packets to the final destination via socket. - If no socket connection is ready to send out the received packets and this esp_mesh_recv_toDS() hasn't been called by applications, packets from the whole mesh network will be pending in toDS queue. Use esp_mesh_get_rx_pending() to check the number of packets available in the queue waiting to be received by applications in case of running out of memory in the root. Using esp_mesh_set_xon_qsize() users may configure the RX queue size, default:32. If this size is too large, and esp_mesh_recv_toDS() isn't called in time, there is a risk that a great deal of memory is occupied by the pending packets. If this size is too small, it will impact the efficiency on upstream. How to decide this value depends on the specific application scenarios. @attention This API is only called by the root. flag could be MESH_DATA_TODS.
Syntax
esp_err_t esp_mesh_recv_toDS(mesh_addr_t *from,
mesh_addr_t *to,
mesh_data_t *data,
int timeout_ms,
int *flag,
mesh_opt_t opt[],
int opt_count);
Return value
- ESP_OK - ESP_ERR_MESH_ARGUMENT - ESP_ERR_MESH_NOT_START - ESP_ERR_MESH_TIMEOUT - ESP_ERR_MESH_DISCARD - ESP_ERR_MESH_RECV_RELEASE
Related Functions
Found 14 other functions taking a ![]()
mesh_addr_t
argument:
Function
Description
Send a packet over the mesh network - Send a packet to any device in the mesh network. - Send a packet to external IP network. @attention This API is not reentrant. Generally, we suggest esp_mesh_recv_toDS() is called after a connection with IP network is created. Thus data outgoing to external IP network via socket is just from reading esp_mesh_recv_toDS() which avoids unnecessary memory copy.
Get mesh network ID
Get routing table of this device's sub-network (including itself)
Receive a packet targeted to self over the mesh network @attention Mesh RX queue should be checked regularly to avoid running out of memory. - Use esp_mesh_get_rx_pending() to check the number of packets available in the queue waiting to be received by applications. flag could be MESH_DATA_FROMDS or MESH_DATA_TODS.
Get the parent BSSID @attention This API shall be called after having received the event MESH_EVENT_PARENT_CONNECTED.
Set a specified parent for the device @attention This API can be called at any time after mesh is configured.
Set mesh network ID @attention This API is used to dynamically modify the mesh network ID.
Return the number of packets could be accepted from the specified address
Set group ID addresses
Delete group ID addresses
Get group ID addresses
Check whether the specified group address is my group
Get the number of nodes in the subnet of a specific child
Get nodes in the subnet of a specific child
References
Code
Location