Inheritance diagram for LibXR::ESP32WifiClient:

Collaboration diagram for LibXR::ESP32WifiClient:

[legend]

Public Member Functions
WifiError	Enable () override
	启用 WiFi 模块 / Enable the WiFi module

WifiError	Disable () override
	禁用 WiFi 模块 / Disable the WiFi module

WifiError	Connect (const Config &config) override
	连接到 WiFi 网络 / Connect to a WiFi network

WifiError	Disconnect () override
	断开当前 WiFi 连接 / Disconnect from the current WiFi connection

bool	IsConnected () const override
	检查是否已连接 / Check if currently connected

const char *	GetIPAddress () const override
	获取当前 IP 地址 / Get the current IP address

WifiError	Scan (std::vector< ScanResult > &results) override
	扫描可用 WiFi 网络 / Scan for available WiFi networks

int	GetRSSI () const override
	获取当前 WiFi 信号强度 / Get the current WiFi signal strength

Static Private Member Functions
static void	EventHandler (void arg, esp_event_base_t event_base, int32_t event_id, void event_data)

Private Attributes
bool	enabled_ = false

bool	connected_ = false

bool	got_ip_ = false

char	ip_str_ [IP4ADDR_STRLEN_MAX] = {}

LibXR::Semaphore	semaphore_

Static Private Attributes
static bool	is_initialized_ = false

static esp_netif_t *	netif_ = nullptr

Additional Inherited Members
Public Types inherited from LibXR::WifiClient
enum class	WifiError { NONE , ALREADY_ENABLED , NOT_ENABLED , CONNECTION_TIMEOUT , AUTHENTICATION_FAILED , DHCP_FAILED , SSID_NOT_FOUND , INVALID_CONFIG , HARDWARE_FAILURE , SCAN_FAILED , UNKNOWN }
	WiFi 错误码枚举 / Enumeration of WiFi error codes. More...

enum class	Security { OPEN , WPA2_PSK , WPA2_ENTERPRISE , UNKNOWN }
	WiFi 安全类型 / WiFi security types. More...

using	WifiCallback = LibXR::Callback< WifiError >
	WiFi 状态回调 / Callback type for WiFi status.

Detailed Description

Definition at line 11 of file esp_wifi_client.hpp.

Constructor & Destructor Documentation

◆ ESP32WifiClient()

LibXR::ESP32WifiClient::ESP32WifiClient ( )

Definition at line 15 of file esp_wifi_client.cpp.

{
  if (!is_initialized_)
  {
    esp_netif_init();
    esp_event_loop_create_default();
    netif_ = esp_netif_create_default_wifi_sta();
 
    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
    esp_wifi_init(&cfg);
 
    is_initialized_ = true;
  }
}

◆ ~ESP32WifiClient()

LibXR::ESP32WifiClient::~ESP32WifiClient ( )

override

Definition at line 30 of file esp_wifi_client.cpp.

{
  if (enabled_)
  {
    Disable();
  }
}

Member Function Documentation

◆ Connect()

WifiClient::WifiError LibXR::ESP32WifiClient::Connect ( const Config & config )

overridevirtual

连接到 WiFi 网络 / Connect to a WiFi network

Parameters

config 配置参数 / Configuration parameters

Implements LibXR::WifiClient.

Definition at line 64 of file esp_wifi_client.cpp.

{
  if (!enabled_) return WifiError::NOT_ENABLED;
 
  wifi_config_t wifi_config{};
  std::strncpy(reinterpret_cast<char*>(wifi_config.sta.ssid), config.ssid.c_str(),
               sizeof(wifi_config.sta.ssid));
  std::strncpy(reinterpret_cast<char*>(wifi_config.sta.password), config.password.c_str(),
               sizeof(wifi_config.sta.password));
  esp_wifi_set_config(WIFI_IF_STA, &wifi_config);
  esp_wifi_connect();
 
  while (semaphore_.Wait(0) == ErrorCode::OK)
  {
  }
 
  semaphore_.Wait();
  if (!connected_)
  {
    return WifiError::CONNECTION_TIMEOUT;
  }
 
  semaphore_.Wait();
  if (!got_ip_)
  {
    return WifiError::DHCP_FAILED;
  }
 
  return WifiError::NONE;
}

◆ Disable()

WifiClient::WifiError LibXR::ESP32WifiClient::Disable ( )

overridevirtual

禁用 WiFi 模块 / Disable the WiFi module

Implements LibXR::WifiClient.

Definition at line 54 of file esp_wifi_client.cpp.

{
  if (!enabled_) return WifiError::NOT_ENABLED;
 
  esp_wifi_stop();
  enabled_ = false;
  connected_ = false;
  return WifiError::NONE;
}

◆ Disconnect()

WifiClient::WifiError LibXR::ESP32WifiClient::Disconnect ( )

overridevirtual

断开当前 WiFi 连接 / Disconnect from the current WiFi connection

Implements LibXR::WifiClient.

Definition at line 95 of file esp_wifi_client.cpp.

{
  if (!enabled_)
  {
    return WifiError::NOT_ENABLED;
  }
  if (!connected_)
  {
    return WifiError::NONE;
  }
  while (semaphore_.Wait(0) == ErrorCode::OK)
  {
  }
  esp_wifi_disconnect();
  semaphore_.Wait();
  return WifiError::NONE;
}

◆ Enable()

WifiClient::WifiError LibXR::ESP32WifiClient::Enable ( )

overridevirtual

启用 WiFi 模块 / Enable the WiFi module

Implements LibXR::WifiClient.

Definition at line 38 of file esp_wifi_client.cpp.

{
  if (enabled_) return WifiError::ALREADY_ENABLED;
 
  esp_wifi_set_mode(WIFI_MODE_STA);
  esp_wifi_start();
  enabled_ = true;
 
  esp_event_handler_register(WIFI_EVENT, WIFI_EVENT_STA_CONNECTED, &EventHandler, this);
  esp_event_handler_register(WIFI_EVENT, WIFI_EVENT_STA_DISCONNECTED, &EventHandler,
                             this);
  esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &EventHandler, this);
  esp_event_handler_register(IP_EVENT, IP_EVENT_STA_LOST_IP, &EventHandler, this);
  return WifiError::NONE;
}

◆ EventHandler()

void LibXR::ESP32WifiClient::EventHandler	(	void *	arg,
		esp_event_base_t	event_base,
		int32_t	event_id,
		void *	event_data
	)

staticprivate

Definition at line 149 of file esp_wifi_client.cpp.

{
  auto* self = static_cast<ESP32WifiClient*>(arg);
 
  if (event_base == WIFI_EVENT)
  {
    switch (event_id)
    {
      case WIFI_EVENT_STA_CONNECTED:
        self->connected_ = true;
        self->semaphore_.Post();
        break;
      case WIFI_EVENT_STA_DISCONNECTED:
        self->connected_ = false;
        self->semaphore_.Post();
        break;
      default:
        break;
    }
  }
 
  if (event_base == IP_EVENT)
  {
    switch (event_id)
    {
      case IP_EVENT_STA_GOT_IP:
      {
        ip_event_got_ip_t* event = reinterpret_cast<ip_event_got_ip_t*>(event_data);
        self->got_ip_ = true;
        esp_ip4addr_ntoa(&event->ip_info.ip, self->ip_str_, sizeof(self->ip_str_));
        self->semaphore_.Post();
        break;
      }
      case IP_EVENT_STA_LOST_IP:
      {
        self->got_ip_ = false;
        break;
      }
    }
  }
}

◆ GetIPAddress()

const char * LibXR::ESP32WifiClient::GetIPAddress ( ) const

overridevirtual

获取当前 IP 地址 / Get the current IP address

Returns: IP 字符串 / IP address string

Implements LibXR::WifiClient.

Definition at line 115 of file esp_wifi_client.cpp.

115{ return ip_str_; }

◆ GetRSSI()

int LibXR::ESP32WifiClient::GetRSSI ( ) const

overridevirtual

获取当前 WiFi 信号强度 / Get the current WiFi signal strength

Returns: int

Implements LibXR::WifiClient.

Definition at line 192 of file esp_wifi_client.cpp.

{
  if (!connected_) return -127;
 
  wifi_ap_record_t ap_info;
  if (esp_wifi_sta_get_ap_info(&ap_info) == ESP_OK)
  {
    return ap_info.rssi;
  }
  return -127;
}

◆ IsConnected()

bool LibXR::ESP32WifiClient::IsConnected ( ) const

overridevirtual

检查是否已连接 / Check if currently connected

Returns: true 表示已连接 / true if connected

Implements LibXR::WifiClient.

Definition at line 113 of file esp_wifi_client.cpp.

113{ return connected_; }

◆ Scan()

WifiClient::WifiError LibXR::ESP32WifiClient::Scan ( std::vector< ScanResult > & results )

overridevirtual

扫描可用 WiFi 网络 / Scan for available WiFi networks

Parameters

results 扫描结果列表 / Output list of scan results

Implements LibXR::WifiClient.

Definition at line 117 of file esp_wifi_client.cpp.

{
  wifi_scan_config_t scan_config = {};
  if (esp_wifi_scan_start(&scan_config, true) != ESP_OK)
  {
    return WifiError::SCAN_FAILED;
  }
 
  uint16_t ap_num = 0;
  esp_wifi_scan_get_ap_num(&ap_num);
 
  std::vector<wifi_ap_record_t> ap_records(ap_num);
  if (esp_wifi_scan_get_ap_records(&ap_num, ap_records.data()) != ESP_OK)
  {
    return WifiError::SCAN_FAILED;
  }
 
  results.clear();
  for (const auto& record : ap_records)
  {
    ScanResult r;
    r.ssid = reinterpret_cast<const char*>(record.ssid);
    r.rssi = record.rssi;
    r.security = (record.authmode == WIFI_AUTH_OPEN)       ? Security::OPEN
                 : (record.authmode == WIFI_AUTH_WPA2_PSK) ? Security::WPA2_PSK
                                                           : Security::UNKNOWN;
    results.push_back(r);
  }
 
  return WifiError::NONE;
}

Field Documentation

◆ connected_

bool LibXR::ESP32WifiClient::connected_ = false

private

Definition at line 34 of file esp_wifi_client.hpp.

◆ enabled_

bool LibXR::ESP32WifiClient::enabled_ = false

private

Definition at line 33 of file esp_wifi_client.hpp.

◆ got_ip_

bool LibXR::ESP32WifiClient::got_ip_ = false

private

Definition at line 35 of file esp_wifi_client.hpp.

◆ ip_str_

char LibXR::ESP32WifiClient::ip_str_[IP4ADDR_STRLEN_MAX] = {}

private

Definition at line 36 of file esp_wifi_client.hpp.

36{};

◆ is_initialized_

bool LibXR::ESP32WifiClient::is_initialized_ = false

inlinestaticprivate

Definition at line 30 of file esp_wifi_client.hpp.

◆ netif_

esp_netif_t* LibXR::ESP32WifiClient::netif_ = nullptr

inlinestaticprivate

Definition at line 31 of file esp_wifi_client.hpp.

◆ semaphore_

LibXR::Semaphore LibXR::ESP32WifiClient::semaphore_

private

Definition at line 38 of file esp_wifi_client.hpp.

The documentation for this class was generated from the following files:

driver/esp/esp_wifi_client.hpp
driver/esp/esp_wifi_client.cpp

Public Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ESP32WifiClient()

◆ ~ESP32WifiClient()

Member Function Documentation

◆ Connect()

◆ Disable()

◆ Disconnect()

◆ Enable()

◆ EventHandler()

◆ GetIPAddress()

◆ GetRSSI()

◆ IsConnected()

◆ Scan()

Field Documentation

◆ connected_

◆ enabled_

◆ got_ip_

◆ ip_str_

◆ is_initialized_

◆ netif_

◆ semaphore_