roo_wifi
API Documentation for roo_wifi
Loading...
Searching...
No Matches
Public Member Functions
roo_wifi::Esp32ArduinoInterface Class Reference

ESP32 Arduino Wi-Fi interface implementation. More...

#include <esp32_arduino_interface.h>

Inheritance diagram for roo_wifi::Esp32ArduinoInterface:
[legend]
Collaboration diagram for roo_wifi::Esp32ArduinoInterface:
[legend]

Public Member Functions

 Esp32ArduinoInterface ()
 
 ~Esp32ArduinoInterface ()
 
void begin ()
 Initializes the underlying Wi-Fi stack and registers callbacks.
 
bool getApInfo (NetworkDetails *info) const override
 Returns current AP information; false if not connected.
 
bool startScan () override
 Starts a scan.
 
bool scanCompleted () const override
 Returns true if the scan has completed.
 
bool getScanResults (std::vector< NetworkDetails > *list, int max_count) const override
 Returns scan results, up to max_count entries.
 
void disconnect () override
 Disconnects from the current network.
 
bool connect (const std::string &ssid, const std::string &passwd) override
 Connects to the specified SSID/password.
 
ConnectionStatus getStatus () override
 Returns the current connection status.
 
void addEventListener (EventListener *listener) override
 Registers an interface event listener.
 
void removeEventListener (EventListener *listener) override
 Unregisters an interface event listener.
 
- Public Member Functions inherited from roo_wifi::Interface
virtual ~Interface ()
 Virtual destructor.
 

Additional Inherited Members

- Public Types inherited from roo_wifi::Interface
enum  EventType {
  EV_UNKNOWN = 0 , EV_SCAN_COMPLETED = 1 , EV_CONNECTED = 2 , EV_GOT_IP = 3 ,
  EV_DISCONNECTED = 4 , EV_CONNECTION_FAILED = 5 , EV_CONNECTION_LOST = 6
}
 Interface event types. More...
 

Detailed Description

ESP32 Arduino Wi-Fi interface implementation.

Definition at line 30 of file esp32_arduino_interface.h.

Constructor & Destructor Documentation

◆ Esp32ArduinoInterface()

roo_wifi::Esp32ArduinoInterface::Esp32ArduinoInterface ( )

Definition at line 71 of file esp32_arduino_interface.cpp.

◆ ~Esp32ArduinoInterface()

roo_wifi::Esp32ArduinoInterface::~Esp32ArduinoInterface ( )

Definition at line 77 of file esp32_arduino_interface.cpp.

Member Function Documentation

◆ addEventListener()

void roo_wifi::Esp32ArduinoInterface::addEventListener ( EventListener *  listener)
overridevirtual

Registers an interface event listener.

Implements roo_wifi::Interface.

Definition at line 166 of file esp32_arduino_interface.cpp.

◆ begin()

void roo_wifi::Esp32ArduinoInterface::begin ( )

Initializes the underlying Wi-Fi stack and registers callbacks.

Definition at line 81 of file esp32_arduino_interface.cpp.

◆ connect()

bool roo_wifi::Esp32ArduinoInterface::connect ( const std::string &  ssid,
const std::string &  passwd 
)
overridevirtual

Connects to the specified SSID/password.

Implements roo_wifi::Interface.

Definition at line 156 of file esp32_arduino_interface.cpp.

◆ disconnect()

void roo_wifi::Esp32ArduinoInterface::disconnect ( )
overridevirtual

Disconnects from the current network.

Implements roo_wifi::Interface.

Definition at line 154 of file esp32_arduino_interface.cpp.

◆ getApInfo()

bool roo_wifi::Esp32ArduinoInterface::getApInfo ( NetworkDetails *  info) const
overridevirtual

Returns current AP information; false if not connected.

Implements roo_wifi::Interface.

Definition at line 96 of file esp32_arduino_interface.cpp.

References roo_wifi::NetworkDetails::authmode, roo_wifi::NetworkDetails::bssid, roo_wifi::NetworkDetails::group_cipher, roo_wifi::NetworkDetails::pairwise_cipher, roo_wifi::NetworkDetails::primary, roo_wifi::NetworkDetails::rssi, roo_wifi::NetworkDetails::ssid, roo_wifi::NetworkDetails::status, roo_wifi::NetworkDetails::supports_wps, roo_wifi::NetworkDetails::use_11b, roo_wifi::NetworkDetails::use_11g, roo_wifi::NetworkDetails::use_11n, roo_wifi::WIFI_AUTH_UNKNOWN, and roo_wifi::WIFI_CIPHER_TYPE_UNKNOWN.

◆ getScanResults()

bool roo_wifi::Esp32ArduinoInterface::getScanResults ( std::vector< NetworkDetails > *  list,
int  max_count 
) const
overridevirtual

Returns scan results, up to max_count entries.

Implements roo_wifi::Interface.

Definition at line 127 of file esp32_arduino_interface.cpp.

References roo_wifi::NetworkDetails::authmode, roo_wifi::NetworkDetails::group_cipher, roo_wifi::NetworkDetails::pairwise_cipher, roo_wifi::NetworkDetails::primary, roo_wifi::NetworkDetails::rssi, roo_wifi::NetworkDetails::ssid, roo_wifi::NetworkDetails::supports_wps, roo_wifi::NetworkDetails::use_11b, roo_wifi::NetworkDetails::use_11g, roo_wifi::NetworkDetails::use_11n, and roo_wifi::WIFI_CIPHER_TYPE_UNKNOWN.

◆ getStatus()

ConnectionStatus roo_wifi::Esp32ArduinoInterface::getStatus ( )
overridevirtual

Returns the current connection status.

Implements roo_wifi::Interface.

Definition at line 162 of file esp32_arduino_interface.cpp.

◆ removeEventListener()

void roo_wifi::Esp32ArduinoInterface::removeEventListener ( EventListener *  listener)
overridevirtual

Unregisters an interface event listener.

Implements roo_wifi::Interface.

Definition at line 170 of file esp32_arduino_interface.cpp.

◆ scanCompleted()

bool roo_wifi::Esp32ArduinoInterface::scanCompleted ( ) const
overridevirtual

Returns true if the scan has completed.

Implements roo_wifi::Interface.

Definition at line 122 of file esp32_arduino_interface.cpp.

◆ startScan()

bool roo_wifi::Esp32ArduinoInterface::startScan ( )
overridevirtual

Starts a scan.

Implements roo_wifi::Interface.

Definition at line 117 of file esp32_arduino_interface.cpp.

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