Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
esp_wifi_mesh.h File Reference

ESP32 Wi-Fi mesh public API. More...

#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
#include <zephyr/net/net_if.h>
#include <zephyr/net/net_ip.h>

Go to the source code of this file.

Data Structures

struct  esp_wifi_mesh_event_info
 Information delivered with a mesh event. More...
struct  esp_wifi_mesh_status
 Current mesh status snapshot. More...
struct  esp_wifi_mesh_addr
 A mesh node address (a 6-byte MAC). More...

Typedefs

typedef void(* esp_wifi_mesh_event_cb_t) (enum esp_wifi_mesh_event event, const struct esp_wifi_mesh_event_info *info)
 Application mesh event callback.

Enumerations

enum  esp_wifi_mesh_event {
  ESP_WIFI_MESH_EVENT_STARTED , ESP_WIFI_MESH_EVENT_STOPPED , ESP_WIFI_MESH_EVENT_PARENT_CONNECTED , ESP_WIFI_MESH_EVENT_PARENT_DISCONNECTED ,
  ESP_WIFI_MESH_EVENT_CHILD_CONNECTED , ESP_WIFI_MESH_EVENT_CHILD_DISCONNECTED , ESP_WIFI_MESH_EVENT_NO_PARENT_FOUND , ESP_WIFI_MESH_EVENT_FIND_NETWORK ,
  ESP_WIFI_MESH_EVENT_ROUTING_TABLE_CHANGE , ESP_WIFI_MESH_EVENT_TODS_REACHABLE , ESP_WIFI_MESH_EVENT_TODS_UNREACHABLE
}
 Wi-Fi mesh events delivered to the application callback. More...

Functions

void esp_wifi_mesh_event_cb_register (esp_wifi_mesh_event_cb_t cb)
 Register the application mesh event callback.
int esp_wifi_mesh_start (void)
 Start the Wi-Fi mesh stack.
int esp_wifi_mesh_send (const uint8_t *data, size_t len)
 Send a data buffer over the mesh.
int esp_wifi_mesh_recv (uint8_t *data, size_t *len, int timeout_ms)
 Receive a data buffer from the mesh.
void esp_wifi_mesh_get_status (struct esp_wifi_mesh_status *status)
 Read the current mesh status.
int esp_wifi_mesh_get_routing_table (struct esp_wifi_mesh_addr *macs, size_t max, size_t *count)
 Read the mesh routing table node addresses.
void esp_wifi_mesh_set_tods_reachable (bool reachable)
 Announce the root external-network (toDS) reachability to the mesh.
void esp_wifi_mesh_bind_sta_rx (void)
 Deliver root station uplink frames to the station interface.
struct net_ifesp_wifi_mesh_netif_get (void)
 Get the Ethernet-over-mesh network interface.

Detailed Description

ESP32 Wi-Fi mesh public API.

Zephyr-native interface to the ESP Wi-Fi mesh stack: mesh bring-up, the application event callback, the raw send/receive path, and status and routing-table queries. It hides the vendor mesh headers so applications depend only on this API.