#include <globals_component.h>
Inheritance diagram for esphome::globals::GlobalsComponent< T >:
Public Types | |
| using | value_type = T |
Public Member Functions | |
| GlobalsComponent ()=default | |
| GlobalsComponent (T initial_value) | |
| GlobalsComponent (std::array< typename std::remove_extent< T >::type, std::extent< T >::value > initial_value) | |
| T & | value () |
| void | setup () override |
 Public Member Functions inherited from esphome::Component | |
| virtual void | loop () |
| This method will be called repeatedly. More... | |
| virtual void | dump_config () |
| virtual float | get_setup_priority () const |
| priority of setup(). More... | |
| 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 () const |
| bool | is_ready () const |
| 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 | |
| T | value_ {} |
| 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
template<typename T>
class esphome::globals::GlobalsComponent< T >
Definition at line 11 of file globals_component.h.
Member Typedef Documentation
◆ value_type
template<typename T>
| using esphome::globals::GlobalsComponent< T >::value_type = T |
Definition at line 13 of file globals_component.h.
Constructor & Destructor Documentation
◆ GlobalsComponent() [1/3]
template<typename T>
|
explicitdefault |
◆ GlobalsComponent() [2/3]
template<typename T>
|
inlineexplicit |
Definition at line 15 of file globals_component.h.
◆ GlobalsComponent() [3/3]
template<typename T>
|
inlineexplicit |
Definition at line 16 of file globals_component.h.
Member Function Documentation
◆ setup()
template<typename T>
|
inlineoverridevirtual |
Reimplemented from esphome::Component.
Definition at line 21 of file globals_component.h.
◆ value()
template<typename T>
|
inline |
Definition at line 20 of file globals_component.h.
Field Documentation
◆ value_
template<typename T>
|
protected |
Definition at line 24 of file globals_component.h.
The documentation for this class was generated from the following file:
- /opt/build/esphome/esphome/components/globals/globals_component.h
