ESPHome  2024.5.3
Public Member Functions | Protected Attributes
esphome::wifi::WiFiScanResult Class Reference

#include <wifi_component.h>

Public Member Functions

 WiFiScanResult (const bssid_t &bssid, std::string ssid, uint8_t channel, int8_t rssi, bool with_auth, bool is_hidden)
 
bool matches (const WiFiAP &config)
 
bool get_matches () const
 
void set_matches (bool matches)
 
const bssid_tget_bssid () const
 
const std::string & get_ssid () const
 
uint8_t get_channel () const
 
int8_t get_rssi () const
 
bool get_with_auth () const
 
bool get_is_hidden () const
 
float get_priority () const
 
void set_priority (float priority)
 
bool operator== (const WiFiScanResult &rhs) const
 

Protected Attributes

bool matches_ {false}
 
bssid_t bssid_
 
std::string ssid_
 
uint8_t channel_
 
int8_t rssi_
 
bool with_auth_
 
bool is_hidden_
 
float priority_ {0.0f}
 

Detailed Description

Definition at line 147 of file wifi_component.h.

Constructor & Destructor Documentation

◆ WiFiScanResult()

esphome::wifi::WiFiScanResult::WiFiScanResult ( const bssid_t bssid,
std::string  ssid,
uint8_t  channel,
int8_t  rssi,
bool  with_auth,
bool  is_hidden 
)

Definition at line 780 of file wifi_component.cpp.

Member Function Documentation

◆ get_bssid()

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

Definition at line 827 of file wifi_component.cpp.

◆ get_channel()

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

Definition at line 829 of file wifi_component.cpp.

◆ get_is_hidden()

bool esphome::wifi::WiFiScanResult::get_is_hidden ( ) const

Definition at line 832 of file wifi_component.cpp.

◆ get_matches()

bool esphome::wifi::WiFiScanResult::get_matches ( ) const

Definition at line 825 of file wifi_component.cpp.

◆ get_priority()

float esphome::wifi::WiFiScanResult::get_priority ( ) const
inline

Definition at line 161 of file wifi_component.h.

◆ get_rssi()

int8_t esphome::wifi::WiFiScanResult::get_rssi ( ) const

Definition at line 830 of file wifi_component.cpp.

◆ get_ssid()

const std::string & esphome::wifi::WiFiScanResult::get_ssid ( ) const

Definition at line 828 of file wifi_component.cpp.

◆ get_with_auth()

bool esphome::wifi::WiFiScanResult::get_with_auth ( ) const

Definition at line 831 of file wifi_component.cpp.

◆ matches()

bool esphome::wifi::WiFiScanResult::matches ( const WiFiAP config)

Definition at line 788 of file wifi_component.cpp.

◆ operator==()

bool esphome::wifi::WiFiScanResult::operator== ( const WiFiScanResult rhs) const

Definition at line 834 of file wifi_component.cpp.

◆ set_matches()

void esphome::wifi::WiFiScanResult::set_matches ( bool  matches)

Definition at line 826 of file wifi_component.cpp.

◆ set_priority()

void esphome::wifi::WiFiScanResult::set_priority ( float  priority)
inline

Definition at line 162 of file wifi_component.h.

Field Documentation

◆ bssid_

bssid_t esphome::wifi::WiFiScanResult::bssid_
protected

Definition at line 168 of file wifi_component.h.

◆ channel_

uint8_t esphome::wifi::WiFiScanResult::channel_
protected

Definition at line 170 of file wifi_component.h.

◆ is_hidden_

bool esphome::wifi::WiFiScanResult::is_hidden_
protected

Definition at line 173 of file wifi_component.h.

◆ matches_

bool esphome::wifi::WiFiScanResult::matches_ {false}
protected

Definition at line 167 of file wifi_component.h.

◆ priority_

float esphome::wifi::WiFiScanResult::priority_ {0.0f}
protected

Definition at line 174 of file wifi_component.h.

◆ rssi_

int8_t esphome::wifi::WiFiScanResult::rssi_
protected

Definition at line 171 of file wifi_component.h.

◆ ssid_

std::string esphome::wifi::WiFiScanResult::ssid_
protected

Definition at line 169 of file wifi_component.h.

◆ with_auth_

bool esphome::wifi::WiFiScanResult::with_auth_
protected

Definition at line 172 of file wifi_component.h.


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