ESPHome  2022.1.2
Public Member Functions | Protected Attributes
esphome::captive_portal::CaptivePortal Class Reference

#include <captive_portal.h>

Inheritance diagram for esphome::captive_portal::CaptivePortal:
esphome::Component

Public Member Functions

 CaptivePortal (web_server_base::WebServerBase *base)
 
void setup () override
 
void dump_config () override
 
void loop () override
 
float get_setup_priority () const override
 
void start ()
 
bool is_active () const
 
void end ()
 
bool canHandle (AsyncWebServerRequest *request) override
 
void handle_index (AsyncWebServerRequest *request)
 
void handle_wifisave (AsyncWebServerRequest *request)
 
void handleRequest (AsyncWebServerRequest *req) override
 
- Public Member Functions inherited from esphome::Component
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Attributes

web_server_base::WebServerBasebase_
 
bool initialized_ {false}
 
bool active_ {false}
 
std::unique_ptr< DNSServer > dns_server_ {nullptr}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ = nullptr
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Detailed Description

Definition at line 16 of file captive_portal.h.

Constructor & Destructor Documentation

◆ CaptivePortal()

esphome::captive_portal::CaptivePortal::CaptivePortal ( web_server_base::WebServerBase base)

Definition at line 139 of file captive_portal.cpp.

Member Function Documentation

◆ canHandle()

bool esphome::captive_portal::CaptivePortal::canHandle ( AsyncWebServerRequest *  request)
inlineoverride

Definition at line 35 of file captive_portal.h.

◆ dump_config()

void esphome::captive_portal::CaptivePortal::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 144 of file captive_portal.cpp.

◆ end()

void esphome::captive_portal::CaptivePortal::end ( )
inline

Definition at line 28 of file captive_portal.h.

◆ get_setup_priority()

float esphome::captive_portal::CaptivePortal::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 140 of file captive_portal.cpp.

◆ handle_index()

void esphome::captive_portal::CaptivePortal::handle_index ( AsyncWebServerRequest *  request)

Definition at line 13 of file captive_portal.cpp.

◆ handle_wifisave()

void esphome::captive_portal::CaptivePortal::handle_wifisave ( AsyncWebServerRequest *  request)

Definition at line 63 of file captive_portal.cpp.

◆ handleRequest()

void esphome::captive_portal::CaptivePortal::handleRequest ( AsyncWebServerRequest *  req)
override

Definition at line 106 of file captive_portal.cpp.

◆ is_active()

bool esphome::captive_portal::CaptivePortal::is_active ( ) const
inline

Definition at line 27 of file captive_portal.h.

◆ loop()

void esphome::captive_portal::CaptivePortal::loop ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 21 of file captive_portal.h.

◆ setup()

void esphome::captive_portal::CaptivePortal::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 74 of file captive_portal.cpp.

◆ start()

void esphome::captive_portal::CaptivePortal::start ( )

Definition at line 75 of file captive_portal.cpp.

Field Documentation

◆ active_

bool esphome::captive_portal::CaptivePortal::active_ {false}
protected

Definition at line 70 of file captive_portal.h.

◆ base_

web_server_base::WebServerBase* esphome::captive_portal::CaptivePortal::base_
protected

Definition at line 68 of file captive_portal.h.

◆ dns_server_

std::unique_ptr<DNSServer> esphome::captive_portal::CaptivePortal::dns_server_ {nullptr}
protected

Definition at line 71 of file captive_portal.h.

◆ initialized_

bool esphome::captive_portal::CaptivePortal::initialized_ {false}
protected

Definition at line 69 of file captive_portal.h.


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