#include <update_entity.h>
Inheritance diagram for esphome::update::UpdateEntity:
Public Member Functions | |
| bool | has_state () const |
| void | publish_state () |
| void | perform () |
| virtual void | perform (bool force)=0 |
| virtual void | check ()=0 |
| void | add_on_state_callback (std::function< void()> &&callback) |
 Public Member Functions inherited from esphome::EntityBase | |
| const StringRef & | get_name () const |
| void | set_name (const char *name) |
| bool | has_own_name () const |
| std::string | get_object_id () const |
| void | set_object_id (const char *object_id) |
| uint32_t | get_object_id_hash () |
| bool | is_internal () const |
| void | set_internal (bool internal) |
| bool | is_disabled_by_default () const |
| void | set_disabled_by_default (bool disabled_by_default) |
| EntityCategory | get_entity_category () const |
| void | set_entity_category (EntityCategory entity_category) |
| std::string | get_icon () const |
| void | set_icon (const char *icon) |
| Public Member Functions inherited from esphome::EntityBase_DeviceClass | |
| std::string | get_device_class () |
| Get the device class, using the manual override if set. More... | |
| void | set_device_class (const char *device_class) |
| Manually set the device class. More... | |
Data Fields | |
| const UpdateInfo & | update_info = update_info_ |
| const UpdateState & | state = state_ |
Protected Attributes | |
| UpdateState | state_ {UPDATE_STATE_UNKNOWN} |
| UpdateInfo | update_info_ |
| bool | has_state_ {false} |
| CallbackManager< void()> | state_callback_ {} |
| Protected Attributes inherited from esphome::EntityBase | |
| StringRef | name_ |
| const char * | object_id_c_str_ {nullptr} |
| const char * | icon_c_str_ {nullptr} |
| uint32_t | object_id_hash_ |
| bool | has_own_name_ {false} |
| bool | internal_ {false} |
| bool | disabled_by_default_ {false} |
| EntityCategory | entity_category_ {ENTITY_CATEGORY_NONE} |
| Protected Attributes inherited from esphome::EntityBase_DeviceClass | |
| const char * | device_class_ {nullptr} |
| Device class override. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from esphome::EntityBase | |
| virtual uint32_t | hash_base () |
| The hash_base() function has been deprecated. More... | |
| void | calc_object_id_ () |
Detailed Description
Definition at line 29 of file update_entity.h.
Member Function Documentation
◆ add_on_state_callback()
|
inline |
Definition at line 42 of file update_entity.h.
◆ check()
|
pure virtual |
Implemented in esphome::http_request::HttpRequestUpdate.
◆ has_state()
|
inline |
Definition at line 31 of file update_entity.h.
◆ perform() [1/2]
|
inline |
Definition at line 35 of file update_entity.h.
◆ perform() [2/2]
|
pure virtual |
Implemented in esphome::http_request::HttpRequestUpdate.
◆ publish_state()
| void esphome::update::UpdateEntity::publish_state | ( | ) |
Definition at line 10 of file update_entity.cpp.
Field Documentation
◆ has_state_
|
protected |
Definition at line 47 of file update_entity.h.
◆ state
| const UpdateState& esphome::update::UpdateEntity::state = state_ |
Definition at line 40 of file update_entity.h.
◆ state_
|
protected |
Definition at line 45 of file update_entity.h.
◆ state_callback_
|
protected |
Definition at line 49 of file update_entity.h.
◆ update_info
| const UpdateInfo& esphome::update::UpdateEntity::update_info = update_info_ |
Definition at line 39 of file update_entity.h.
◆ update_info_
|
protected |
Definition at line 46 of file update_entity.h.
The documentation for this class was generated from the following files:
- /opt/build/esphome/esphome/components/update/update_entity.h
- /opt/build/esphome/esphome/components/update/update_entity.cpp
