esphome::api::CoverEntity Class Reference

Handle to a Cover entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::CoverEntity:

Collaboration diagram for esphome::api::CoverEntity:

Public Member Functions
std::optional< CoverInfo >	info () const
std::optional< CoverState >	state () const
bool	assumed_state () const
bool	supports_position () const
bool	supports_tilt () const
std::string	device_class () const
bool	supports_stop () const
float	position () const
float	tilt () const
CoverOperation	current_operation () const
void	command (CoverCommand c) const
	Send a fully-specified command (its key is set automatically).
void	open () const
void	close () const
void	stop () const
void	set_position (float p) const
Public Member Functions inherited from esphome::api::TypedEntity< CoverEntity >
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 Cover entity.

Member Function Documentation

assumed_state()

bool esphome::api::CoverEntity::assumed_state ( ) const

inline

close()

void esphome::api::CoverEntity::close ( ) const

inline

command()

void esphome::api::CoverEntity::command ( CoverCommand  c ) const

inline

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

current_operation()

CoverOperation esphome::api::CoverEntity::current_operation ( ) const

inline

device_class()

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

inline

info()

std::optional< CoverInfo > esphome::api::CoverEntity::info ( ) const

inline

open()

void esphome::api::CoverEntity::open ( ) const

inline

position()

float esphome::api::CoverEntity::position ( ) const

inline

set_position()

void esphome::api::CoverEntity::set_position ( float  p ) const

inline

state()

std::optional< CoverState > esphome::api::CoverEntity::state ( ) const

inline

stop()

void esphome::api::CoverEntity::stop ( ) const

inline

supports_position()

bool esphome::api::CoverEntity::supports_position ( ) const

inline

supports_stop()

bool esphome::api::CoverEntity::supports_stop ( ) const

inline

supports_tilt()

bool esphome::api::CoverEntity::supports_tilt ( ) const

inline

tilt()

float esphome::api::CoverEntity::tilt ( ) const

inline

type()

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

inlinestaticconstexpr

---

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

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