ESPHome 2026.2.1
Loading...
Searching...
No Matches
esphome::wifi::WiFiAP Class Reference

#include <wifi_component.h>

Public Member Functions

void set_ssid (const std::string &ssid)
 
void set_ssid (const char *ssid)
 
void set_ssid (StringRef ssid)
 
void set_bssid (const bssid_t &bssid)
 
void clear_bssid ()
 
void set_password (const std::string &password)
 
void set_password (const char *password)
 
void set_password (StringRef password)
 
void set_eap (optional< EAPAuth > eap_auth)
 
void set_channel (uint8_t channel)
 
void clear_channel ()
 
void set_priority (int8_t priority)
 
void set_manual_ip (optional< ManualIP > manual_ip)
 
void set_hidden (bool hidden)
 
StringRef get_ssid () const
 
StringRef get_password () const
 
const bssid_tget_bssid () const
 
bool has_bssid () const
 
const optional< EAPAuth > & get_eap () const
 
uint8_t get_channel () const
 
bool has_channel () const
 
int8_t get_priority () const
 
const optional< ManualIP > & get_manual_ip () const
 
bool get_hidden () const
 

Protected Attributes

CompactString ssid_
 
CompactString password_
 
optional< EAPAutheap_
 
optional< ManualIPmanual_ip_
 
bssid_t bssid_ {}
 
uint8_t channel_ {0}
 
int8_t priority_ {0}
 
bool hidden_ {false}
 

Detailed Description

Definition at line 223 of file wifi_component.h.

Member Function Documentation

◆ clear_bssid()

void esphome::wifi::WiFiAP::clear_bssid ( )

Definition at line 2171 of file wifi_component.cpp.

◆ clear_channel()

void esphome::wifi::WiFiAP::clear_channel ( )

Definition at line 2180 of file wifi_component.cpp.

◆ get_bssid()

const bssid_t & esphome::wifi::WiFiAP::get_bssid ( ) const

Definition at line 2185 of file wifi_component.cpp.

◆ get_channel()

uint8_t esphome::wifi::WiFiAP::get_channel ( ) const

Definition at line 2190 of file wifi_component.cpp.

◆ get_eap()

const optional< EAPAuth > & esphome::wifi::WiFiAP::get_eap ( ) const

Definition at line 2188 of file wifi_component.cpp.

◆ get_hidden()

bool esphome::wifi::WiFiAP::get_hidden ( ) const

Definition at line 2195 of file wifi_component.cpp.

◆ get_manual_ip()

const optional< ManualIP > & esphome::wifi::WiFiAP::get_manual_ip ( ) const

Definition at line 2193 of file wifi_component.cpp.

◆ get_password()

StringRef esphome::wifi::WiFiAP::get_password ( ) const
inline

Definition at line 247 of file wifi_component.h.

◆ get_priority()

int8_t esphome::wifi::WiFiAP::get_priority ( ) const
inline

Definition at line 255 of file wifi_component.h.

◆ get_ssid()

StringRef esphome::wifi::WiFiAP::get_ssid ( ) const
inline

Definition at line 246 of file wifi_component.h.

◆ has_bssid()

bool esphome::wifi::WiFiAP::has_bssid ( ) const

Definition at line 2186 of file wifi_component.cpp.

◆ has_channel()

bool esphome::wifi::WiFiAP::has_channel ( ) const

Definition at line 2191 of file wifi_component.cpp.

◆ set_bssid()

void esphome::wifi::WiFiAP::set_bssid ( const bssid_t & bssid)

Definition at line 2170 of file wifi_component.cpp.

◆ set_channel()

void esphome::wifi::WiFiAP::set_channel ( uint8_t channel)

Definition at line 2179 of file wifi_component.cpp.

◆ set_eap()

void esphome::wifi::WiFiAP::set_eap ( optional< EAPAuth > eap_auth)

Definition at line 2177 of file wifi_component.cpp.

◆ set_hidden()

void esphome::wifi::WiFiAP::set_hidden ( bool hidden)

Definition at line 2184 of file wifi_component.cpp.

◆ set_manual_ip()

void esphome::wifi::WiFiAP::set_manual_ip ( optional< ManualIP > manual_ip)

Definition at line 2182 of file wifi_component.cpp.

◆ set_password() [1/3]

void esphome::wifi::WiFiAP::set_password ( const char * password)

Definition at line 2175 of file wifi_component.cpp.

◆ set_password() [2/3]

void esphome::wifi::WiFiAP::set_password ( const std::string & password)

Definition at line 2172 of file wifi_component.cpp.

◆ set_password() [3/3]

void esphome::wifi::WiFiAP::set_password ( StringRef password)
inline

Definition at line 235 of file wifi_component.h.

◆ set_priority()

void esphome::wifi::WiFiAP::set_priority ( int8_t priority)
inline

Definition at line 241 of file wifi_component.h.

◆ set_ssid() [1/3]

void esphome::wifi::WiFiAP::set_ssid ( const char * ssid)

Definition at line 2169 of file wifi_component.cpp.

◆ set_ssid() [2/3]

void esphome::wifi::WiFiAP::set_ssid ( const std::string & ssid)

Definition at line 2168 of file wifi_component.cpp.

◆ set_ssid() [3/3]

void esphome::wifi::WiFiAP::set_ssid ( StringRef ssid)
inline

Definition at line 230 of file wifi_component.h.

Field Documentation

◆ bssid_

bssid_t esphome::wifi::WiFiAP::bssid_ {}
protected

Definition at line 271 of file wifi_component.h.

◆ channel_

uint8_t esphome::wifi::WiFiAP::channel_ {0}
protected

Definition at line 272 of file wifi_component.h.

◆ eap_

optional<EAPAuth> esphome::wifi::WiFiAP::eap_
protected

Definition at line 265 of file wifi_component.h.

◆ hidden_

bool esphome::wifi::WiFiAP::hidden_ {false}
protected

Definition at line 274 of file wifi_component.h.

◆ manual_ip_

optional<ManualIP> esphome::wifi::WiFiAP::manual_ip_
protected

Definition at line 268 of file wifi_component.h.

◆ password_

CompactString esphome::wifi::WiFiAP::password_
protected

Definition at line 263 of file wifi_component.h.

◆ priority_

int8_t esphome::wifi::WiFiAP::priority_ {0}
protected

Definition at line 273 of file wifi_component.h.

◆ ssid_

CompactString esphome::wifi::WiFiAP::ssid_
protected

Definition at line 262 of file wifi_component.h.


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