esphome::update::UpdateEntity Class Reference

#include <update_entity.h>

Inheritance diagram for esphome::update::UpdateEntity:

Public Member Functions
void	publish_state ()
void	perform ()
virtual void	perform (bool force)=0
virtual void	check ()=0
void	add_on_state_callback (std::function< void()> &&callback)
Trigger< const UpdateInfo & > *	get_update_available_trigger ()
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)
uint32_t	get_device_id () const
void	set_device (Device *device)
bool	has_state () const
void	set_has_state (bool state)
Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string	get_device_class ()
	Get the device class, using the manual override if set.
void	set_device_class (const char *device_class)
	Manually set the device class.

Data Fields
const UpdateInfo &	update_info = update_info_
const UpdateState &	state = state_

Protected Attributes
UpdateState	state_ {UPDATE_STATE_UNKNOWN}
UpdateInfo	update_info_
CallbackManager< void()>	state_callback_ {}
std::unique_ptr< Trigger< const UpdateInfo & > >	update_available_trigger_ {nullptr}
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_ {}
Device *	device_ {}
struct esphome::EntityBase::EntityFlags	flags_
Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char *	device_class_ {nullptr}
	Device class override.

Additional Inherited Members
Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t	hash_base ()
	The hash_base() function has been deprecated.
void	calc_object_id_ ()

Detailed Description

Definition at line 30 of file update_entity.h.

Member Function Documentation

add_on_state_callback()

void esphome::update::UpdateEntity::add_on_state_callback ( std::function< void()> && callback )

inline

Definition at line 41 of file update_entity.h.

check()

virtual void esphome::update::UpdateEntity::check ( )

pure virtual

Implemented in esphome::http_request::HttpRequestUpdate.

get_update_available_trigger()

Trigger< const UpdateInfo & > * esphome::update::UpdateEntity::get_update_available_trigger ( )

inline

Definition at line 42 of file update_entity.h.

perform() [1/2]

void esphome::update::UpdateEntity::perform ( )

inline

Definition at line 34 of file update_entity.h.

perform() [2/2]

virtual void esphome::update::UpdateEntity::perform ( bool force )

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

state

const UpdateState& esphome::update::UpdateEntity::state = state_

Definition at line 39 of file update_entity.h.

state_

UpdateState esphome::update::UpdateEntity::state_ {UPDATE_STATE_UNKNOWN}

protected

Definition at line 50 of file update_entity.h.

state_callback_

CallbackManager<void()> esphome::update::UpdateEntity::state_callback_ {}

protected

Definition at line 53 of file update_entity.h.

update_available_trigger_

std::unique_ptr<Trigger<const UpdateInfo &> > esphome::update::UpdateEntity::update_available_trigger_ {nullptr}

protected

Definition at line 54 of file update_entity.h.

update_info

const UpdateInfo& esphome::update::UpdateEntity::update_info = update_info_

Definition at line 38 of file update_entity.h.

update_info_

UpdateInfo esphome::update::UpdateEntity::update_info_

protected

Definition at line 51 of file update_entity.h.

---

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

• esphome/components/update/update_entity.h
• esphome/components/update/update_entity.cpp