ESPHome  1.14.3
Public Member Functions | Protected Attributes
esphome::climate::ClimateTraits Class Reference

This class contains all static data for climate devices. More...

#include <climate_traits.h>

Public Member Functions

bool get_supports_current_temperature () const
 
void set_supports_current_temperature (bool supports_current_temperature)
 
bool get_supports_two_point_target_temperature () const
 
void set_supports_two_point_target_temperature (bool supports_two_point_target_temperature)
 
void set_supports_auto_mode (bool supports_auto_mode)
 
void set_supports_cool_mode (bool supports_cool_mode)
 
void set_supports_heat_mode (bool supports_heat_mode)
 
void set_supports_away (bool supports_away)
 
bool get_supports_away () const
 
void set_supports_action (bool supports_action)
 
bool get_supports_action () const
 
bool supports_mode (ClimateMode mode) const
 
float get_visual_min_temperature () const
 
void set_visual_min_temperature (float visual_min_temperature)
 
float get_visual_max_temperature () const
 
void set_visual_max_temperature (float visual_max_temperature)
 
float get_visual_temperature_step () const
 
int8_t get_temperature_accuracy_decimals () const
 
void set_visual_temperature_step (float temperature_step)
 

Protected Attributes

bool supports_current_temperature_ {false}
 
bool supports_two_point_target_temperature_ {false}
 
bool supports_auto_mode_ {false}
 
bool supports_cool_mode_ {false}
 
bool supports_heat_mode_ {false}
 
bool supports_away_ {false}
 
bool supports_action_ {false}
 
float visual_min_temperature_ {10}
 
float visual_max_temperature_ {30}
 
float visual_temperature_step_ {0.1}
 

Detailed Description

This class contains all static data for climate devices.

All climate devices must support these features:

All other properties and modes are optional and the integration must mark each of them as supported by setting the appropriate flag here.

This class also contains static data for the climate device display:

Definition at line 35 of file climate_traits.h.

Member Function Documentation

◆ get_supports_action()

bool esphome::climate::ClimateTraits::get_supports_action ( ) const

Definition at line 56 of file climate_traits.cpp.

◆ get_supports_away()

bool esphome::climate::ClimateTraits::get_supports_away ( ) const

Definition at line 55 of file climate_traits.cpp.

◆ get_supports_current_temperature()

bool esphome::climate::ClimateTraits::get_supports_current_temperature ( ) const

Definition at line 21 of file climate_traits.cpp.

◆ get_supports_two_point_target_temperature()

bool esphome::climate::ClimateTraits::get_supports_two_point_target_temperature ( ) const

Definition at line 25 of file climate_traits.cpp.

◆ get_temperature_accuracy_decimals()

int8_t esphome::climate::ClimateTraits::get_temperature_accuracy_decimals ( ) const

Definition at line 43 of file climate_traits.cpp.

◆ get_visual_max_temperature()

float esphome::climate::ClimateTraits::get_visual_max_temperature ( ) const

Definition at line 38 of file climate_traits.cpp.

◆ get_visual_min_temperature()

float esphome::climate::ClimateTraits::get_visual_min_temperature ( ) const

Definition at line 34 of file climate_traits.cpp.

◆ get_visual_temperature_step()

float esphome::climate::ClimateTraits::get_visual_temperature_step ( ) const

Definition at line 42 of file climate_traits.cpp.

◆ set_supports_action()

void esphome::climate::ClimateTraits::set_supports_action ( bool  supports_action)

Definition at line 33 of file climate_traits.cpp.

◆ set_supports_auto_mode()

void esphome::climate::ClimateTraits::set_supports_auto_mode ( bool  supports_auto_mode)

Definition at line 29 of file climate_traits.cpp.

◆ set_supports_away()

void esphome::climate::ClimateTraits::set_supports_away ( bool  supports_away)

Definition at line 32 of file climate_traits.cpp.

◆ set_supports_cool_mode()

void esphome::climate::ClimateTraits::set_supports_cool_mode ( bool  supports_cool_mode)

Definition at line 30 of file climate_traits.cpp.

◆ set_supports_current_temperature()

void esphome::climate::ClimateTraits::set_supports_current_temperature ( bool  supports_current_temperature)

Definition at line 22 of file climate_traits.cpp.

◆ set_supports_heat_mode()

void esphome::climate::ClimateTraits::set_supports_heat_mode ( bool  supports_heat_mode)

Definition at line 31 of file climate_traits.cpp.

◆ set_supports_two_point_target_temperature()

void esphome::climate::ClimateTraits::set_supports_two_point_target_temperature ( bool  supports_two_point_target_temperature)

Definition at line 26 of file climate_traits.cpp.

◆ set_visual_max_temperature()

void esphome::climate::ClimateTraits::set_visual_max_temperature ( float  visual_max_temperature)

Definition at line 39 of file climate_traits.cpp.

◆ set_visual_min_temperature()

void esphome::climate::ClimateTraits::set_visual_min_temperature ( float  visual_min_temperature)

Definition at line 35 of file climate_traits.cpp.

◆ set_visual_temperature_step()

void esphome::climate::ClimateTraits::set_visual_temperature_step ( float  temperature_step)

Definition at line 54 of file climate_traits.cpp.

◆ supports_mode()

bool esphome::climate::ClimateTraits::supports_mode ( ClimateMode  mode) const

Definition at line 7 of file climate_traits.cpp.

Field Documentation

◆ supports_action_

bool esphome::climate::ClimateTraits::supports_action_ {false}
protected

Definition at line 65 of file climate_traits.h.

◆ supports_auto_mode_

bool esphome::climate::ClimateTraits::supports_auto_mode_ {false}
protected

Definition at line 61 of file climate_traits.h.

◆ supports_away_

bool esphome::climate::ClimateTraits::supports_away_ {false}
protected

Definition at line 64 of file climate_traits.h.

◆ supports_cool_mode_

bool esphome::climate::ClimateTraits::supports_cool_mode_ {false}
protected

Definition at line 62 of file climate_traits.h.

◆ supports_current_temperature_

bool esphome::climate::ClimateTraits::supports_current_temperature_ {false}
protected

Definition at line 59 of file climate_traits.h.

◆ supports_heat_mode_

bool esphome::climate::ClimateTraits::supports_heat_mode_ {false}
protected

Definition at line 63 of file climate_traits.h.

◆ supports_two_point_target_temperature_

bool esphome::climate::ClimateTraits::supports_two_point_target_temperature_ {false}
protected

Definition at line 60 of file climate_traits.h.

◆ visual_max_temperature_

float esphome::climate::ClimateTraits::visual_max_temperature_ {30}
protected

Definition at line 68 of file climate_traits.h.

◆ visual_min_temperature_

float esphome::climate::ClimateTraits::visual_min_temperature_ {10}
protected

Definition at line 67 of file climate_traits.h.

◆ visual_temperature_step_

float esphome::climate::ClimateTraits::visual_temperature_step_ {0.1}
protected

Definition at line 69 of file climate_traits.h.


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