HF Interface Wrapper 0.1.0-dev
Embedded C++ hardware abstraction layer
Loading...
Searching...
No Matches
EspTypes_WiFi.h File Reference

ESP32 WiFi type definitions for hardware abstraction. More...

#include "EspTypes_Base.h"
#include "esp_event.h"
#include "esp_mesh.h"
#include "esp_netif.h"
#include "esp_smartconfig.h"
#include "esp_wifi.h"
#include "esp_wifi_types.h"
#include "lwip/ip_addr.h"
Include dependency graph for EspTypes_WiFi.h:

Go to the source code of this file.

Classes

struct  HfEspWifiStats
 ESP32-specific WiFi statistics structure. More...
 
struct  HfEspWifiCalibration
 ESP32-specific WiFi calibration data. More...
 
struct  HfEspWifiPerformanceConfig
 ESP32-specific WiFi performance configuration. More...
 

Enumerations

enum class  hf_esp_wifi_auth_mode_t : uint8_t {
  OPEN = WIFI_AUTH_OPEN , WEP = WIFI_AUTH_WEP , WPA_PSK = WIFI_AUTH_WPA_PSK , WPA2_PSK = WIFI_AUTH_WPA2_PSK ,
  WPA_WPA2_PSK = WIFI_AUTH_WPA_WPA2_PSK , WPA2_ENTERPRISE = WIFI_AUTH_WPA2_ENTERPRISE , WPA3_PSK = WIFI_AUTH_WPA3_PSK , WPA2_WPA3_PSK = WIFI_AUTH_WPA2_WPA3_PSK ,
  WAPI_PSK = WIFI_AUTH_WAPI_PSK
}
 ESP32-specific WiFi authentication mode mapping. More...
 
enum class  hf_esp_wifi_mode_t : uint8_t { NULL_MODE = WIFI_MODE_NULL , STA = WIFI_MODE_STA , AP = WIFI_MODE_AP , APSTA = WIFI_MODE_APSTA }
 ESP32-specific WiFi mode mapping. More...
 
enum class  hf_esp_wifi_power_save_t : uint8_t { NONE = WIFI_PS_NONE , MIN_MODEM = WIFI_PS_MIN_MODEM , MAX_MODEM = WIFI_PS_MAX_MODEM }
 ESP32-specific WiFi power save mode mapping. More...
 
enum class  hf_esp_wifi_bandwidth_t : uint8_t { HT20 = WIFI_BW_HT20 , HT40 = WIFI_BW_HT40 }
 ESP32-specific WiFi bandwidth mapping. More...
 
enum class  hf_esp_wifi_sort_method_t : uint8_t { SIGNAL = WIFI_CONNECT_AP_BY_SIGNAL , SECURITY = WIFI_CONNECT_AP_BY_SECURITY }
 ESP32-specific WiFi sort method. More...
 
enum class  hf_esp_wifi_scan_method_t : uint8_t { FAST = WIFI_FAST_SCAN , ALL_CHANNEL = WIFI_ALL_CHANNEL_SCAN }
 ESP32-specific WiFi scan method. More...
 

Variables

static constexpr size_t HF_ESP_WIFI_SSID_MAX_LEN = 32
 Maximum WiFi SSID length.
 
static constexpr size_t HF_ESP_WIFI_PASSWORD_MAX_LEN = 64
 Maximum WiFi password length.
 
static constexpr uint16_t HF_ESP_WIFI_SCAN_MAX_RESULTS = 20
 Maximum number of WiFi scan results.
 
static constexpr hf_timeout_ms_t HF_ESP_WIFI_CONNECT_TIMEOUT_DEFAULT = 10000
 Default WiFi connection timeout.
 
static constexpr hf_timeout_ms_t HF_ESP_WIFI_SCAN_TIMEOUT_DEFAULT = 5000
 Default WiFi scan timeout.
 
static constexpr uint16_t HF_ESP_WIFI_BEACON_INTERVAL_DEFAULT = 100
 Default AP beacon interval.
 
static constexpr uint8_t HF_ESP_WIFI_MAX_CONNECTIONS_DEFAULT = 4
 Default AP maximum connections.
 
static constexpr uint8_t HF_ESP_WIFI_CHANNEL_MIN = 1
 WiFi channel range.
 
static constexpr uint8_t HF_ESP_WIFI_CHANNEL_MAX = 14
 
static constexpr uint8_t HF_ESP_WIFI_TX_POWER_MIN = 0
 WiFi TX power range (dBm)
 
static constexpr uint8_t HF_ESP_WIFI_TX_POWER_MAX = 20
 

Detailed Description

ESP32 WiFi type definitions for hardware abstraction.

This header defines the ESP32-specific types, constants, and utility functions for WiFi operations. It provides a clean interface between the generic WiFi base class and ESP-IDF specific implementations.

Author
Nebiyu Tadesse
Date
2025
Note
This file should be included by ESP32 WiFi implementation files.
All definitions are specific to ESP32 with ESP-IDF v5.5+.

Enumeration Type Documentation

◆ hf_esp_wifi_auth_mode_t

enum class hf_esp_wifi_auth_mode_t : uint8_t
strong

ESP32-specific WiFi authentication mode mapping.

Enumerator
OPEN 

Open authentication

WEP 

WEP authentication

WPA_PSK 

WPA-PSK authentication

WPA2_PSK 

WPA2-PSK authentication

WPA_WPA2_PSK 

WPA/WPA2-PSK authentication

WPA2_ENTERPRISE 

WPA2-Enterprise authentication

WPA3_PSK 

WPA3-PSK authentication

WPA2_WPA3_PSK 

WPA2/WPA3-PSK authentication

WAPI_PSK 

WAPI-PSK authentication

◆ hf_esp_wifi_bandwidth_t

enum class hf_esp_wifi_bandwidth_t : uint8_t
strong

ESP32-specific WiFi bandwidth mapping.

Enumerator
HT20 

20MHz bandwidth

HT40 

40MHz bandwidth

◆ hf_esp_wifi_mode_t

enum class hf_esp_wifi_mode_t : uint8_t
strong

ESP32-specific WiFi mode mapping.

Enumerator
NULL_MODE 

WiFi disabled

STA 

Station mode

AP 

Access Point mode

APSTA 

Station + AP mode

◆ hf_esp_wifi_power_save_t

enum class hf_esp_wifi_power_save_t : uint8_t
strong

ESP32-specific WiFi power save mode mapping.

Enumerator
NONE 

No power save

MIN_MODEM 

Minimum modem power save

MAX_MODEM 

Maximum modem power save

◆ hf_esp_wifi_scan_method_t

enum class hf_esp_wifi_scan_method_t : uint8_t
strong

ESP32-specific WiFi scan method.

Enumerator
FAST 

Fast scan method

ALL_CHANNEL 

All channel scan method

◆ hf_esp_wifi_sort_method_t

enum class hf_esp_wifi_sort_method_t : uint8_t
strong

ESP32-specific WiFi sort method.

Enumerator
SIGNAL 

Sort by signal strength

SECURITY 

Sort by security level

Variable Documentation

◆ HF_ESP_WIFI_BEACON_INTERVAL_DEFAULT

constexpr uint16_t HF_ESP_WIFI_BEACON_INTERVAL_DEFAULT = 100
staticconstexpr

Default AP beacon interval.

◆ HF_ESP_WIFI_CHANNEL_MAX

constexpr uint8_t HF_ESP_WIFI_CHANNEL_MAX = 14
staticconstexpr

◆ HF_ESP_WIFI_CHANNEL_MIN

constexpr uint8_t HF_ESP_WIFI_CHANNEL_MIN = 1
staticconstexpr

WiFi channel range.

◆ HF_ESP_WIFI_CONNECT_TIMEOUT_DEFAULT

constexpr hf_timeout_ms_t HF_ESP_WIFI_CONNECT_TIMEOUT_DEFAULT = 10000
staticconstexpr

Default WiFi connection timeout.

◆ HF_ESP_WIFI_MAX_CONNECTIONS_DEFAULT

constexpr uint8_t HF_ESP_WIFI_MAX_CONNECTIONS_DEFAULT = 4
staticconstexpr

Default AP maximum connections.

◆ HF_ESP_WIFI_PASSWORD_MAX_LEN

constexpr size_t HF_ESP_WIFI_PASSWORD_MAX_LEN = 64
staticconstexpr

Maximum WiFi password length.

◆ HF_ESP_WIFI_SCAN_MAX_RESULTS

constexpr uint16_t HF_ESP_WIFI_SCAN_MAX_RESULTS = 20
staticconstexpr

Maximum number of WiFi scan results.

◆ HF_ESP_WIFI_SCAN_TIMEOUT_DEFAULT

constexpr hf_timeout_ms_t HF_ESP_WIFI_SCAN_TIMEOUT_DEFAULT = 5000
staticconstexpr

Default WiFi scan timeout.

◆ HF_ESP_WIFI_SSID_MAX_LEN

constexpr size_t HF_ESP_WIFI_SSID_MAX_LEN = 32
staticconstexpr

Maximum WiFi SSID length.

◆ HF_ESP_WIFI_TX_POWER_MAX

constexpr uint8_t HF_ESP_WIFI_TX_POWER_MAX = 20
staticconstexpr

◆ HF_ESP_WIFI_TX_POWER_MIN

constexpr uint8_t HF_ESP_WIFI_TX_POWER_MIN = 0
staticconstexpr

WiFi TX power range (dBm)