esphome::api::UpdateEntity Class Reference

Handle to a Update entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::UpdateEntity:

Collaboration diagram for esphome::api::UpdateEntity:

Public Member Functions
std::optional< UpdateInfo >	info () const
std::optional< UpdateState >	state () const
std::string	device_class () const
bool	missing_state () const
bool	in_progress () const
bool	has_progress () const
float	progress () const
std::string	current_version () const
std::string	latest_version () const
std::string	title () const
std::string	release_summary () const
std::string	release_url () const
void	command (UpdateControl c) const
	Send a fully-specified command (its key is set automatically).
void	install () const
void	check () const
Public Member Functions inherited from esphome::api::TypedEntity< UpdateEntity >
std::string	icon () const
bool	disabled_by_default () const
EntityCategory	entity_category () const
std::uint32_t	device_id () const
	Entity (Client &client, const std::uint32_t key, std::string object_id, std::string name)
Public Member Functions inherited from esphome::api::Entity
	Entity (Client &client, const std::uint32_t key, std::string object_id, std::string name)
std::uint32_t	key () const noexcept
const std::string &	object_id () const noexcept
const std::string &	name () const noexcept

Static Public Member Functions
static constexpr EntityType	type ()

Additional Inherited Members
Protected Attributes inherited from esphome::api::Entity
Client *	client_
std::uint32_t	key_
std::string	object_id_
std::string	name_

Detailed Description

Handle to a Update entity.

Member Function Documentation

check()

void esphome::api::UpdateEntity::check ( ) const

inline

command()

void esphome::api::UpdateEntity::command ( UpdateControl  c ) const

inline

Send a fully-specified command (its key is set automatically).

current_version()

std::string esphome::api::UpdateEntity::current_version ( ) const

inline

device_class()

std::string esphome::api::UpdateEntity::device_class ( ) const

inline

has_progress()

bool esphome::api::UpdateEntity::has_progress ( ) const

inline

in_progress()

bool esphome::api::UpdateEntity::in_progress ( ) const

inline

info()

std::optional< UpdateInfo > esphome::api::UpdateEntity::info ( ) const

inline

install()

void esphome::api::UpdateEntity::install ( ) const

inline

latest_version()

std::string esphome::api::UpdateEntity::latest_version ( ) const

inline

missing_state()

bool esphome::api::UpdateEntity::missing_state ( ) const

inline

progress()

float esphome::api::UpdateEntity::progress ( ) const

inline

release_summary()

std::string esphome::api::UpdateEntity::release_summary ( ) const

inline

release_url()

std::string esphome::api::UpdateEntity::release_url ( ) const

inline

state()

std::optional< UpdateState > esphome::api::UpdateEntity::state ( ) const

inline

title()

std::string esphome::api::UpdateEntity::title ( ) const

inline

type()

static constexpr EntityType esphome::api::UpdateEntity::type ( )

inlinestaticconstexpr

---

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

• include/esphome/api/model/entity_handles.hpp