Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
esp_wifi_mesh_config Struct Reference

Runtime-configurable mesh credentials and tree limits. More...

#include <zephyr/drivers/wifi/esp_wifi/esp_wifi_mesh.h>

Data Fields

char ssid [33]
 Router SSID: the upstream Wi-Fi network the root associates to for external network access.
char password [64]
 Router password.
char mesh_password [64]
 Mesh softAP password securing the inter-node mesh links.
uint8_t channel
 Mesh channel: 0 lets the mesh select it by scanning (required when the router channel is unknown); 1-13 pins a fixed channel, which must then match on every node.
uint8_t mesh_id [6]
 6-byte mesh network identifier.
enum wifi_security_type authmode
 Mesh softAP authentication mode.
uint8_t num_layers
 Tree depth (layers) to use for this mesh.
uint8_t max_connections
 Per-node direct child fan-out to use for this mesh.

Detailed Description

Runtime-configurable mesh credentials and tree limits.

Read by esp_wifi_mesh_start() in place of the driver's Kconfig defaults. Set this before calling esp_wifi_mesh_start(); the mesh stack has no runtime reconfiguration or teardown, so changes after start have no effect.

Field Documentation

◆ authmode

enum wifi_security_type esp_wifi_mesh_config::authmode

Mesh softAP authentication mode.

◆ channel

uint8_t esp_wifi_mesh_config::channel

Mesh channel: 0 lets the mesh select it by scanning (required when the router channel is unknown); 1-13 pins a fixed channel, which must then match on every node.

◆ max_connections

uint8_t esp_wifi_mesh_config::max_connections

Per-node direct child fan-out to use for this mesh.

Must be at least 1 and no greater than the compiled-in CONFIG_WIFI_ESP32_MESH_MAX_CONNECTIONS, which sizes the routing-table buffers at build time.

◆ mesh_id

uint8_t esp_wifi_mesh_config::mesh_id[6]

6-byte mesh network identifier.

Nodes only join a mesh advertising the same ID, so every node in one network must use the same value.

◆ mesh_password

char esp_wifi_mesh_config::mesh_password[64]

Mesh softAP password securing the inter-node mesh links.

Must be empty (for WIFI_SECURITY_TYPE_NONE) or 8..63 characters, and identical on every node in the mesh.

◆ num_layers

uint8_t esp_wifi_mesh_config::num_layers

Tree depth (layers) to use for this mesh.

Must be at least 1 and no greater than the compiled-in CONFIG_WIFI_ESP32_MESH_MAX_LAYER, which sizes the routing-table buffers at build time.

◆ password

char esp_wifi_mesh_config::password[64]

Router password.

NUL-terminated, up to 63 characters; empty for an open router.

◆ ssid

char esp_wifi_mesh_config::ssid[33]

Router SSID: the upstream Wi-Fi network the root associates to for external network access.

Empty forms a router-less fixed-root mesh (see esp_wifi_mesh_start()). NUL-terminated, up to 32 characters.


The documentation for this struct was generated from the following file: