ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::climate::ClimateTraits Class Reference

#include <climate_traits.h>

Public Member Functions

 ClimateTraits ()
 
uint32_t get_feature_flags () const
 Get/set feature flags (see ClimateFeatures enum in climate_mode.h)
 
void add_feature_flags (uint32_t feature_flags)
 
void clear_feature_flags (uint32_t feature_flags)
 
bool has_feature_flags (uint32_t feature_flags) const
 
void set_feature_flags (uint32_t feature_flags)
 
void set_supported_modes (ClimateModeMask modes)
 
void add_supported_mode (ClimateMode mode)
 
bool supports_mode (ClimateMode mode) const
 
const ClimateModeMask & get_supported_modes () const
 
void set_supported_fan_modes (ClimateFanModeMask modes)
 
void add_supported_fan_mode (ClimateFanMode mode)
 
bool supports_fan_mode (ClimateFanMode fan_mode) const
 
bool get_supports_fan_modes () const
 
const ClimateFanModeMask & get_supported_fan_modes () const
 
const ClimateCustomModes & get_supported_custom_fan_modes () const
 Empty when the climate has no custom fan modes. Set them on the Climate entity.
 
bool supports_custom_fan_mode (const char *custom_fan_mode) const
 
bool supports_custom_fan_mode (const std::string &custom_fan_mode) const
 
void set_supported_presets (ClimatePresetMask presets)
 
void add_supported_preset (ClimatePreset preset)
 
bool supports_preset (ClimatePreset preset) const
 
bool get_supports_presets () const
 
const ClimatePresetMask & get_supported_presets () const
 
const ClimateCustomModes & get_supported_custom_presets () const
 Empty when the climate has no custom presets. Set them on the Climate entity.
 
bool supports_custom_preset (const char *custom_preset) const
 
bool supports_custom_preset (const std::string &custom_preset) const
 
void set_supported_swing_modes (ClimateSwingModeMask modes)
 
void add_supported_swing_mode (ClimateSwingMode mode)
 
bool supports_swing_mode (ClimateSwingMode swing_mode) const
 
bool get_supports_swing_modes () const
 
const ClimateSwingModeMask & get_supported_swing_modes () 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_target_temperature_step () const
 
float get_visual_current_temperature_step () const
 
void set_visual_target_temperature_step (float temperature_step)
 
void set_visual_current_temperature_step (float temperature_step)
 
void set_visual_temperature_step (float temperature_step)
 
int8_t get_target_temperature_accuracy_decimals () const
 
int8_t get_current_temperature_accuracy_decimals () const
 
float get_visual_min_humidity () const
 
void set_visual_min_humidity (float visual_min_humidity)
 
float get_visual_max_humidity () const
 
void set_visual_max_humidity (float visual_max_humidity)
 
TemperatureUnit get_temperature_unit () const
 
void set_temperature_unit (TemperatureUnit unit)
 

Protected Member Functions

void set_mode_support_ (climate::ClimateMode mode, bool supported)
 
void set_fan_mode_support_ (climate::ClimateFanMode mode, bool supported)
 
void set_swing_mode_support_ (climate::ClimateSwingMode mode, bool supported)
 
void set_supported_custom_fan_modes_ (const ClimateCustomModes *modes)
 Set custom mode pointers (only Climate::get_traits() should call these).
 
void set_supported_custom_presets_ (const ClimateCustomModes *presets)
 

Protected Attributes

uint32_t feature_flags_ {0}
 
float visual_min_temperature_ {10}
 
float visual_max_temperature_ {30}
 
float visual_target_temperature_step_ {0.1}
 
float visual_current_temperature_step_ {0.1}
 
float visual_min_humidity_ {30}
 
float visual_max_humidity_ {99}
 
climate::ClimateModeMask supported_modes_ {climate::CLIMATE_MODE_OFF}
 
climate::ClimateFanModeMask supported_fan_modes_
 
climate::ClimateSwingModeMask supported_swing_modes_
 
climate::ClimatePresetMask supported_presets_
 
TemperatureUnit temperature_unit_ {TemperatureUnit::CELSIUS}
 
const ClimateCustomModes * supported_custom_fan_modes_ {nullptr}
 Owned by the Climate entity; get_traits() wires these pointers.
 
const ClimateCustomModes * supported_custom_presets_ {nullptr}
 

Detailed Description

Definition at line 76 of file climate_traits.h.

Constructor & Destructor Documentation

◆ ClimateTraits()

esphome::climate::ClimateTraits::ClimateTraits ( )
default

Member Function Documentation

◆ add_feature_flags()

void esphome::climate::ClimateTraits::add_feature_flags ( uint32_t feature_flags)
inline

Definition at line 86 of file climate_traits.h.

◆ add_supported_fan_mode()

void esphome::climate::ClimateTraits::add_supported_fan_mode ( ClimateFanMode mode)
inline

Definition at line 97 of file climate_traits.h.

◆ add_supported_mode()

void esphome::climate::ClimateTraits::add_supported_mode ( ClimateMode mode)
inline

Definition at line 92 of file climate_traits.h.

◆ add_supported_preset()

void esphome::climate::ClimateTraits::add_supported_preset ( ClimatePreset preset)
inline

Definition at line 117 of file climate_traits.h.

◆ add_supported_swing_mode()

void esphome::climate::ClimateTraits::add_supported_swing_mode ( ClimateSwingMode mode)
inline

Definition at line 132 of file climate_traits.h.

◆ clear_feature_flags()

void esphome::climate::ClimateTraits::clear_feature_flags ( uint32_t feature_flags)
inline

Definition at line 87 of file climate_traits.h.

◆ get_current_temperature_accuracy_decimals()

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

Definition at line 21 of file climate_traits.cpp.

◆ get_feature_flags()

uint32_t esphome::climate::ClimateTraits::get_feature_flags ( ) const
inline

Get/set feature flags (see ClimateFeatures enum in climate_mode.h)

Definition at line 85 of file climate_traits.h.

◆ get_supported_custom_fan_modes()

const ClimateCustomModes & esphome::climate::ClimateTraits::get_supported_custom_fan_modes ( ) const

Empty when the climate has no custom fan modes. Set them on the Climate entity.

Definition at line 9 of file climate_traits.cpp.

◆ get_supported_custom_presets()

const ClimateCustomModes & esphome::climate::ClimateTraits::get_supported_custom_presets ( ) const

Empty when the climate has no custom presets. Set them on the Climate entity.

Definition at line 13 of file climate_traits.cpp.

◆ get_supported_fan_modes()

const ClimateFanModeMask & esphome::climate::ClimateTraits::get_supported_fan_modes ( ) const
inline

Definition at line 105 of file climate_traits.h.

◆ get_supported_modes()

const ClimateModeMask & esphome::climate::ClimateTraits::get_supported_modes ( ) const
inline

Definition at line 94 of file climate_traits.h.

◆ get_supported_presets()

const ClimatePresetMask & esphome::climate::ClimateTraits::get_supported_presets ( ) const
inline

Definition at line 120 of file climate_traits.h.

◆ get_supported_swing_modes()

const ClimateSwingModeMask & esphome::climate::ClimateTraits::get_supported_swing_modes ( ) const
inline

Definition at line 135 of file climate_traits.h.

◆ get_supports_fan_modes()

bool esphome::climate::ClimateTraits::get_supports_fan_modes ( ) const
inline

Definition at line 99 of file climate_traits.h.

◆ get_supports_presets()

bool esphome::climate::ClimateTraits::get_supports_presets ( ) const
inline

Definition at line 119 of file climate_traits.h.

◆ get_supports_swing_modes()

bool esphome::climate::ClimateTraits::get_supports_swing_modes ( ) const
inline

Definition at line 134 of file climate_traits.h.

◆ get_target_temperature_accuracy_decimals()

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

Definition at line 17 of file climate_traits.cpp.

◆ get_temperature_unit()

TemperatureUnit esphome::climate::ClimateTraits::get_temperature_unit ( ) const
inline

Definition at line 165 of file climate_traits.h.

◆ get_visual_current_temperature_step()

float esphome::climate::ClimateTraits::get_visual_current_temperature_step ( ) const
inline

Definition at line 146 of file climate_traits.h.

◆ get_visual_max_humidity()

float esphome::climate::ClimateTraits::get_visual_max_humidity ( ) const
inline

Definition at line 162 of file climate_traits.h.

◆ get_visual_max_temperature()

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

Definition at line 141 of file climate_traits.h.

◆ get_visual_min_humidity()

float esphome::climate::ClimateTraits::get_visual_min_humidity ( ) const
inline

Definition at line 160 of file climate_traits.h.

◆ get_visual_min_temperature()

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

Definition at line 137 of file climate_traits.h.

◆ get_visual_target_temperature_step()

float esphome::climate::ClimateTraits::get_visual_target_temperature_step ( ) const
inline

Definition at line 145 of file climate_traits.h.

◆ has_feature_flags()

bool esphome::climate::ClimateTraits::has_feature_flags ( uint32_t feature_flags) const
inline

Definition at line 88 of file climate_traits.h.

◆ set_fan_mode_support_()

void esphome::climate::ClimateTraits::set_fan_mode_support_ ( climate::ClimateFanMode mode,
bool supported )
inlineprotected

Definition at line 176 of file climate_traits.h.

◆ set_feature_flags()

void esphome::climate::ClimateTraits::set_feature_flags ( uint32_t feature_flags)
inline

Definition at line 89 of file climate_traits.h.

◆ set_mode_support_()

void esphome::climate::ClimateTraits::set_mode_support_ ( climate::ClimateMode mode,
bool supported )
inlineprotected

Definition at line 169 of file climate_traits.h.

◆ set_supported_custom_fan_modes_()

void esphome::climate::ClimateTraits::set_supported_custom_fan_modes_ ( const ClimateCustomModes * modes)
inlineprotected

Set custom mode pointers (only Climate::get_traits() should call these).

Definition at line 192 of file climate_traits.h.

◆ set_supported_custom_presets_()

void esphome::climate::ClimateTraits::set_supported_custom_presets_ ( const ClimateCustomModes * presets)
inlineprotected

Definition at line 193 of file climate_traits.h.

◆ set_supported_fan_modes()

void esphome::climate::ClimateTraits::set_supported_fan_modes ( ClimateFanModeMask modes)
inline

Definition at line 96 of file climate_traits.h.

◆ set_supported_modes()

void esphome::climate::ClimateTraits::set_supported_modes ( ClimateModeMask modes)
inline

Definition at line 91 of file climate_traits.h.

◆ set_supported_presets()

void esphome::climate::ClimateTraits::set_supported_presets ( ClimatePresetMask presets)
inline

Definition at line 116 of file climate_traits.h.

◆ set_supported_swing_modes()

void esphome::climate::ClimateTraits::set_supported_swing_modes ( ClimateSwingModeMask modes)
inline

Definition at line 131 of file climate_traits.h.

◆ set_swing_mode_support_()

void esphome::climate::ClimateTraits::set_swing_mode_support_ ( climate::ClimateSwingMode mode,
bool supported )
inlineprotected

Definition at line 183 of file climate_traits.h.

◆ set_temperature_unit()

void esphome::climate::ClimateTraits::set_temperature_unit ( TemperatureUnit unit)
inline

Definition at line 166 of file climate_traits.h.

◆ set_visual_current_temperature_step()

void esphome::climate::ClimateTraits::set_visual_current_temperature_step ( float temperature_step)
inline

Definition at line 150 of file climate_traits.h.

◆ set_visual_max_humidity()

void esphome::climate::ClimateTraits::set_visual_max_humidity ( float visual_max_humidity)
inline

Definition at line 163 of file climate_traits.h.

◆ set_visual_max_temperature()

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

Definition at line 142 of file climate_traits.h.

◆ set_visual_min_humidity()

void esphome::climate::ClimateTraits::set_visual_min_humidity ( float visual_min_humidity)
inline

Definition at line 161 of file climate_traits.h.

◆ set_visual_min_temperature()

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

Definition at line 138 of file climate_traits.h.

◆ set_visual_target_temperature_step()

void esphome::climate::ClimateTraits::set_visual_target_temperature_step ( float temperature_step)
inline

Definition at line 147 of file climate_traits.h.

◆ set_visual_temperature_step()

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

Definition at line 153 of file climate_traits.h.

◆ supports_custom_fan_mode() [1/2]

bool esphome::climate::ClimateTraits::supports_custom_fan_mode ( const char * custom_fan_mode) const
inline

Definition at line 109 of file climate_traits.h.

◆ supports_custom_fan_mode() [2/2]

bool esphome::climate::ClimateTraits::supports_custom_fan_mode ( const std::string & custom_fan_mode) const
inline

Definition at line 112 of file climate_traits.h.

◆ supports_custom_preset() [1/2]

bool esphome::climate::ClimateTraits::supports_custom_preset ( const char * custom_preset) const
inline

Definition at line 124 of file climate_traits.h.

◆ supports_custom_preset() [2/2]

bool esphome::climate::ClimateTraits::supports_custom_preset ( const std::string & custom_preset) const
inline

Definition at line 127 of file climate_traits.h.

◆ supports_fan_mode()

bool esphome::climate::ClimateTraits::supports_fan_mode ( ClimateFanMode fan_mode) const
inline

Definition at line 98 of file climate_traits.h.

◆ supports_mode()

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

Definition at line 93 of file climate_traits.h.

◆ supports_preset()

bool esphome::climate::ClimateTraits::supports_preset ( ClimatePreset preset) const
inline

Definition at line 118 of file climate_traits.h.

◆ supports_swing_mode()

bool esphome::climate::ClimateTraits::supports_swing_mode ( ClimateSwingMode swing_mode) const
inline

Definition at line 133 of file climate_traits.h.

Field Documentation

◆ feature_flags_

uint32_t esphome::climate::ClimateTraits::feature_flags_ {0}
protected

Definition at line 195 of file climate_traits.h.

◆ supported_custom_fan_modes_

const ClimateCustomModes* esphome::climate::ClimateTraits::supported_custom_fan_modes_ {nullptr}
protected

Owned by the Climate entity; get_traits() wires these pointers.

Definition at line 210 of file climate_traits.h.

◆ supported_custom_presets_

const ClimateCustomModes* esphome::climate::ClimateTraits::supported_custom_presets_ {nullptr}
protected

Definition at line 211 of file climate_traits.h.

◆ supported_fan_modes_

climate::ClimateFanModeMask esphome::climate::ClimateTraits::supported_fan_modes_
protected

Definition at line 204 of file climate_traits.h.

◆ supported_modes_

climate::ClimateModeMask esphome::climate::ClimateTraits::supported_modes_ {climate::CLIMATE_MODE_OFF}
protected

Definition at line 203 of file climate_traits.h.

◆ supported_presets_

climate::ClimatePresetMask esphome::climate::ClimateTraits::supported_presets_
protected

Definition at line 206 of file climate_traits.h.

◆ supported_swing_modes_

climate::ClimateSwingModeMask esphome::climate::ClimateTraits::supported_swing_modes_
protected

Definition at line 205 of file climate_traits.h.

◆ temperature_unit_

TemperatureUnit esphome::climate::ClimateTraits::temperature_unit_ {TemperatureUnit::CELSIUS}
protected

Definition at line 207 of file climate_traits.h.

◆ visual_current_temperature_step_

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

Definition at line 199 of file climate_traits.h.

◆ visual_max_humidity_

float esphome::climate::ClimateTraits::visual_max_humidity_ {99}
protected

Definition at line 201 of file climate_traits.h.

◆ visual_max_temperature_

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

Definition at line 197 of file climate_traits.h.

◆ visual_min_humidity_

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

Definition at line 200 of file climate_traits.h.

◆ visual_min_temperature_

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

Definition at line 196 of file climate_traits.h.

◆ visual_target_temperature_step_

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

Definition at line 198 of file climate_traits.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.12.0