DIY QlockTwo
Perfect DIY version of famous QlockTwo Classic with ESP8266
WifiModule Class Reference

Handling connection to Wifi and setting up Wifi credentials by creating an Access Point. More...

#include <WifiModule.h>

Public Member Functions

 WifiModule (String _deviceName)
 
 ~WifiModule ()
 
void setup (void(*configModeCallback)(WiFiManager *myWiFiManager), void(*saveConfig)(void))
 Setup WifiManger. More...
 
bool isConnected ()
 Check if Wifi is connected. More...
 
bool connect ()
 Try to connect to presaved Wifi, otherwise go into AP mode. More...
 
void reset ()
 Delete saved Wifi network credentials. More...
 
SimpleTime getEnableTime ()
 Return EnableTime from set Parameters. More...
 
SimpleTime getDisableTime ()
 Return DisableTime from set Parameters. More...
 

Private Attributes

String deviceName
 
WiFiManager wifiManager
 
WiFiManagerParameter parameterEnableTime = WiFiManagerParameter("enable_time", "Enable Time (HH:MM)", "", 6)
 
WiFiManagerParameter parameterDisableTime = WiFiManagerParameter("disable_time", "Disable Time (HH:MM)", "", 6)
 

Detailed Description

Handling connection to Wifi and setting up Wifi credentials by creating an Access Point.

Definition at line 23 of file WifiModule.h.

Constructor & Destructor Documentation

◆ WifiModule()

WifiModule::WifiModule ( String  _deviceName)

Definition at line 11 of file WifiModule.cpp.

◆ ~WifiModule()

WifiModule::~WifiModule ( )

Definition at line 13 of file WifiModule.cpp.

Member Function Documentation

◆ connect()

bool WifiModule::connect ( )

Try to connect to presaved Wifi, otherwise go into AP mode.

Restarts ESP on failure.

Returns
Success

Definition at line 45 of file WifiModule.cpp.

◆ getDisableTime()

SimpleTime WifiModule::getDisableTime ( )

Return DisableTime from set Parameters.

Returns
DisableTime

Definition at line 81 of file WifiModule.cpp.

◆ getEnableTime()

SimpleTime WifiModule::getEnableTime ( )

Return EnableTime from set Parameters.

Returns
EnableTime

Definition at line 73 of file WifiModule.cpp.

◆ isConnected()

bool WifiModule::isConnected ( )

Check if Wifi is connected.

Returns
true on connected

Definition at line 37 of file WifiModule.cpp.

◆ reset()

void WifiModule::reset ( )

Delete saved Wifi network credentials.

Definition at line 64 of file WifiModule.cpp.

◆ setup()

void WifiModule::setup ( void(*)(WiFiManager *myWiFiManager)  configModeCallback,
void(*)(void)  saveConfig 
)

Setup WifiManger.

Parameters
configModeCallbackGets called when WiFiManager enters configuration mode.
saveConfigGets called when WifiManager when custom parameters have been set AND a connection has been established.

Definition at line 20 of file WifiModule.cpp.

Member Data Documentation

◆ deviceName

String WifiModule::deviceName
private

Definition at line 25 of file WifiModule.h.

◆ parameterDisableTime

WiFiManagerParameter WifiModule::parameterDisableTime = WiFiManagerParameter("disable_time", "Disable Time (HH:MM)", "", 6)
private

Definition at line 29 of file WifiModule.h.

◆ parameterEnableTime

WiFiManagerParameter WifiModule::parameterEnableTime = WiFiManagerParameter("enable_time", "Enable Time (HH:MM)", "", 6)
private

Definition at line 28 of file WifiModule.h.

◆ wifiManager

WiFiManager WifiModule::wifiManager
private

Definition at line 26 of file WifiModule.h.


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