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_t &	get_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 160 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 800 of file wifi_component.cpp.

Member Function Documentation

get_bssid()

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

(

)

const

Definition at line 847 of file wifi_component.cpp.

get_channel()

uint8_t esphome::wifi::WiFiScanResult::get_channel

(

)

const

Definition at line 849 of file wifi_component.cpp.

get_is_hidden()

bool esphome::wifi::WiFiScanResult::get_is_hidden

(

)

const

Definition at line 852 of file wifi_component.cpp.

get_matches()

bool esphome::wifi::WiFiScanResult::get_matches

(

)

const

Definition at line 845 of file wifi_component.cpp.

get_priority()

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

inline

Definition at line 174 of file wifi_component.h.

get_rssi()

int8_t esphome::wifi::WiFiScanResult::get_rssi

(

)

const

Definition at line 850 of file wifi_component.cpp.

get_ssid()

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

(

)

const

Definition at line 848 of file wifi_component.cpp.

get_with_auth()

bool esphome::wifi::WiFiScanResult::get_with_auth

(

)

const

Definition at line 851 of file wifi_component.cpp.

matches()

bool esphome::wifi::WiFiScanResult::matches

(

const WiFiAP &

config

)

Definition at line 808 of file wifi_component.cpp.

operator==()

bool esphome::wifi::WiFiScanResult::operator==

(

const WiFiScanResult &

rhs

)

const

Definition at line 854 of file wifi_component.cpp.

set_matches()

void esphome::wifi::WiFiScanResult::set_matches

(

bool

matches

)

Definition at line 846 of file wifi_component.cpp.

set_priority()

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

inline

Definition at line 175 of file wifi_component.h.

Field Documentation

bssid_

bssid_t esphome::wifi::WiFiScanResult::bssid_

protected

Definition at line 181 of file wifi_component.h.

channel_

uint8_t esphome::wifi::WiFiScanResult::channel_

protected

Definition at line 183 of file wifi_component.h.

is_hidden_

bool esphome::wifi::WiFiScanResult::is_hidden_

protected

Definition at line 186 of file wifi_component.h.

matches_

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

protected

Definition at line 180 of file wifi_component.h.

priority_

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

protected

Definition at line 187 of file wifi_component.h.

rssi_

int8_t esphome::wifi::WiFiScanResult::rssi_

protected

Definition at line 184 of file wifi_component.h.

ssid_

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

protected

Definition at line 182 of file wifi_component.h.

with_auth_

bool esphome::wifi::WiFiScanResult::with_auth_

protected

Definition at line 185 of file wifi_component.h.

---

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

• /opt/build/esphome/esphome/components/wifi/wifi_component.h
• /opt/build/esphome/esphome/components/wifi/wifi_component.cpp