#include <captive_portal.h>
Inheritance diagram for esphome::captive_portal::CaptivePortal:
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_config (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 () |
| bool | is_ready () |
| virtual bool | can_proceed () |
| bool | status_has_warning () const |
| bool | status_has_error () const |
| void | status_set_warning (const char *message="unspecified") |
| void | status_set_error (const char *message="unspecified") |
| 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::WebServerBase * | base_ |
| 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(uint8_t)> &&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(uint8_t)> &&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 83 of file captive_portal.cpp.
Member Function Documentation
◆ canHandle()
|
inlineoverride |
Definition at line 39 of file captive_portal.h.
◆ dump_config()
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 88 of file captive_portal.cpp.
◆ end()
|
inline |
Definition at line 30 of file captive_portal.h.
◆ get_setup_priority()
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 84 of file captive_portal.cpp.
◆ handle_config()
| void esphome::captive_portal::CaptivePortal::handle_config | ( | AsyncWebServerRequest * | request | ) |
Definition at line 12 of file captive_portal.cpp.
◆ handle_wifisave()
| void esphome::captive_portal::CaptivePortal::handle_wifisave | ( | AsyncWebServerRequest * | request | ) |
Definition at line 28 of file captive_portal.cpp.
◆ handleRequest()
|
override |
Definition at line 68 of file captive_portal.cpp.
◆ is_active()
|
inline |
Definition at line 29 of file captive_portal.h.
◆ loop()
|
inlineoverridevirtual |
Reimplemented from esphome::Component.
Definition at line 22 of file captive_portal.h.
◆ setup()
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 39 of file captive_portal.cpp.
◆ start()
| void esphome::captive_portal::CaptivePortal::start | ( | ) |
Definition at line 40 of file captive_portal.cpp.
Field Documentation
◆ active_
|
protected |
Definition at line 64 of file captive_portal.h.
◆ base_
|
protected |
Definition at line 62 of file captive_portal.h.
◆ dns_server_
|
protected |
Definition at line 66 of file captive_portal.h.
◆ initialized_
|
protected |
Definition at line 63 of file captive_portal.h.
The documentation for this class was generated from the following files:
- /opt/build/esphome/esphome/components/captive_portal/captive_portal.h
- /opt/build/esphome/esphome/components/captive_portal/captive_portal.cpp
