esphome::api::WaterHeaterEntity Class Reference

Handle to a WaterHeater entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::WaterHeaterEntity:

Collaboration diagram for esphome::api::WaterHeaterEntity:

Public Member Functions
std::optional< WaterHeaterInfo >	info () const
std::optional< WaterHeaterState >	state () const
float	min_temperature () const
float	max_temperature () const
float	target_temperature_step () const
std::vector< WaterHeaterMode >	supported_modes () const
std::uint32_t	supported_features () const
TemperatureUnit	temperature_unit () const
float	current_temperature () const
float	target_temperature () const
WaterHeaterMode	mode () const
float	target_temperature_low () const
float	target_temperature_high () const
void	command (WaterHeaterCommand c) const
	Send a fully-specified command (its key is set automatically).
Public Member Functions inherited from esphome::api::TypedEntity< WaterHeaterEntity >
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 WaterHeater entity.

Member Function Documentation

command()

void esphome::api::WaterHeaterEntity::command ( WaterHeaterCommand  c ) const

inline

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

current_temperature()

float esphome::api::WaterHeaterEntity::current_temperature ( ) const

inline

info()

std::optional< WaterHeaterInfo > esphome::api::WaterHeaterEntity::info ( ) const

inline

max_temperature()

float esphome::api::WaterHeaterEntity::max_temperature ( ) const

inline

min_temperature()

float esphome::api::WaterHeaterEntity::min_temperature ( ) const

inline

mode()

WaterHeaterMode esphome::api::WaterHeaterEntity::mode ( ) const

inline

state()

std::optional< WaterHeaterState > esphome::api::WaterHeaterEntity::state ( ) const

inline

supported_features()

std::uint32_t esphome::api::WaterHeaterEntity::supported_features ( ) const

inline

supported_modes()

std::vector< WaterHeaterMode > esphome::api::WaterHeaterEntity::supported_modes ( ) const

inline

target_temperature()

float esphome::api::WaterHeaterEntity::target_temperature ( ) const

inline

target_temperature_high()

float esphome::api::WaterHeaterEntity::target_temperature_high ( ) const

inline

target_temperature_low()

float esphome::api::WaterHeaterEntity::target_temperature_low ( ) const

inline

target_temperature_step()

float esphome::api::WaterHeaterEntity::target_temperature_step ( ) const

inline

temperature_unit()

TemperatureUnit esphome::api::WaterHeaterEntity::temperature_unit ( ) const

inline

type()

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

inlinestaticconstexpr

---

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

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