esphome::api::ValveEntity Class Reference

Handle to a Valve entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::ValveEntity:

Collaboration diagram for esphome::api::ValveEntity:

Public Member Functions
std::optional< ValveInfo >	info () const
std::optional< ValveState >	state () const
std::string	device_class () const
bool	assumed_state () const
bool	supports_position () const
bool	supports_stop () const
float	position () const
ValveOperation	current_operation () const
void	command (ValveCommand c) const
	Send a fully-specified command (its key is set automatically).
void	open () const
void	close () const
void	stop () const
Public Member Functions inherited from esphome::api::TypedEntity< ValveEntity >
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 Valve entity.

Member Function Documentation

assumed_state()

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

inline

close()

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

inline

command()

void esphome::api::ValveEntity::command ( ValveCommand  c ) const

inline

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

current_operation()

ValveOperation esphome::api::ValveEntity::current_operation ( ) const

inline

device_class()

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

inline

info()

std::optional< ValveInfo > esphome::api::ValveEntity::info ( ) const

inline

open()

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

inline

position()

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

inline

state()

std::optional< ValveState > esphome::api::ValveEntity::state ( ) const

inline

stop()

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

inline

supports_position()

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

inline

supports_stop()

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

inline

type()

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

inlinestaticconstexpr

---

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

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