esphome::api::ClimateEntity Class Reference

Handle to a Climate entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::ClimateEntity:

Collaboration diagram for esphome::api::ClimateEntity:

Public Member Functions
std::optional< ClimateInfo >	info () const
std::optional< ClimateState >	state () const
std::vector< ClimateMode >	supported_modes () const
float	visual_min_temperature () const
float	visual_max_temperature () const
float	visual_target_temperature_step () const
std::vector< ClimateFanMode >	supported_fan_modes () const
std::vector< ClimateSwingMode >	supported_swing_modes () const
std::vector< std::string >	supported_custom_fan_modes () const
std::vector< ClimatePreset >	supported_presets () const
std::vector< std::string >	supported_custom_presets () const
float	visual_current_temperature_step () const
float	visual_min_humidity () const
float	visual_max_humidity () const
std::uint32_t	feature_flags () const
TemperatureUnit	temperature_unit () const
ClimateMode	mode () const
float	current_temperature () const
float	target_temperature () const
float	target_temperature_low () const
float	target_temperature_high () const
ClimateAction	action () const
ClimateFanMode	fan_mode () const
ClimateSwingMode	swing_mode () const
std::string	custom_fan_mode () const
ClimatePreset	preset () const
std::string	custom_preset () const
float	current_humidity () const
float	target_humidity () const
void	command (ClimateCommand c) const
	Send a fully-specified command (its key is set automatically).
void	set_mode (ClimateMode m) const
void	set_target_temperature (float t) const
Public Member Functions inherited from esphome::api::TypedEntity< ClimateEntity >
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 Climate entity.

Member Function Documentation

action()

ClimateAction esphome::api::ClimateEntity::action ( ) const

inline

command()

void esphome::api::ClimateEntity::command ( ClimateCommand  c ) const

inline

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

current_humidity()

float esphome::api::ClimateEntity::current_humidity ( ) const

inline

current_temperature()

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

inline

custom_fan_mode()

std::string esphome::api::ClimateEntity::custom_fan_mode ( ) const

inline

custom_preset()

std::string esphome::api::ClimateEntity::custom_preset ( ) const

inline

fan_mode()

ClimateFanMode esphome::api::ClimateEntity::fan_mode ( ) const

inline

feature_flags()

std::uint32_t esphome::api::ClimateEntity::feature_flags ( ) const

inline

info()

std::optional< ClimateInfo > esphome::api::ClimateEntity::info ( ) const

inline

mode()

ClimateMode esphome::api::ClimateEntity::mode ( ) const

inline

preset()

ClimatePreset esphome::api::ClimateEntity::preset ( ) const

inline

set_mode()

void esphome::api::ClimateEntity::set_mode ( ClimateMode  m ) const

inline

set_target_temperature()

void esphome::api::ClimateEntity::set_target_temperature ( float  t ) const

inline

state()

std::optional< ClimateState > esphome::api::ClimateEntity::state ( ) const

inline

supported_custom_fan_modes()

std::vector< std::string > esphome::api::ClimateEntity::supported_custom_fan_modes ( ) const

inline

supported_custom_presets()

std::vector< std::string > esphome::api::ClimateEntity::supported_custom_presets ( ) const

inline

supported_fan_modes()

std::vector< ClimateFanMode > esphome::api::ClimateEntity::supported_fan_modes ( ) const

inline

supported_modes()

std::vector< ClimateMode > esphome::api::ClimateEntity::supported_modes ( ) const

inline

supported_presets()

std::vector< ClimatePreset > esphome::api::ClimateEntity::supported_presets ( ) const

inline

supported_swing_modes()

std::vector< ClimateSwingMode > esphome::api::ClimateEntity::supported_swing_modes ( ) const

inline

swing_mode()

ClimateSwingMode esphome::api::ClimateEntity::swing_mode ( ) const

inline

target_humidity()

float esphome::api::ClimateEntity::target_humidity ( ) const

inline

target_temperature()

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

inline

target_temperature_high()

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

inline

target_temperature_low()

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

inline

temperature_unit()

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

inline

type()

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

inlinestaticconstexpr

visual_current_temperature_step()

float esphome::api::ClimateEntity::visual_current_temperature_step ( ) const

inline

visual_max_humidity()

float esphome::api::ClimateEntity::visual_max_humidity ( ) const

inline

visual_max_temperature()

float esphome::api::ClimateEntity::visual_max_temperature ( ) const

inline

visual_min_humidity()

float esphome::api::ClimateEntity::visual_min_humidity ( ) const

inline

visual_min_temperature()

float esphome::api::ClimateEntity::visual_min_temperature ( ) const

inline

visual_target_temperature_step()

float esphome::api::ClimateEntity::visual_target_temperature_step ( ) const

inline

---

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

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