ESPHome  2021.9.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::climate::ClimateCall Class Reference

This class is used to encode all control actions on a climate device. More...

#include <climate.h>

Public Member Functions

 ClimateCall (Climate *parent)
 
ClimateCallset_mode (ClimateMode mode)
 Set the mode of the climate device. More...
 
ClimateCallset_mode (optional< ClimateMode > mode)
 Set the mode of the climate device. More...
 
ClimateCallset_mode (const std::string &mode)
 Set the mode of the climate device based on a string. More...
 
ClimateCallset_target_temperature (float target_temperature)
 Set the target temperature of the climate device. More...
 
ClimateCallset_target_temperature (optional< float > target_temperature)
 Set the target temperature of the climate device. More...
 
ClimateCallset_target_temperature_low (float target_temperature_low)
 Set the low point target temperature of the climate device. More...
 
ClimateCallset_target_temperature_low (optional< float > target_temperature_low)
 Set the low point target temperature of the climate device. More...
 
ClimateCallset_target_temperature_high (float target_temperature_high)
 Set the high point target temperature of the climate device. More...
 
ClimateCallset_target_temperature_high (optional< float > target_temperature_high)
 Set the high point target temperature of the climate device. More...
 
 ESPDEPRECATED ("set_away() is deprecated, please use .set_preset(CLIMATE_PRESET_AWAY) instead", "v1.20") ClimateCall &set_away(bool away)
 
 ESPDEPRECATED ("set_away() is deprecated, please use .set_preset(CLIMATE_PRESET_AWAY) instead", "v1.20") ClimateCall &set_away(optional< bool > away)
 
ClimateCallset_fan_mode (ClimateFanMode fan_mode)
 Set the fan mode of the climate device. More...
 
ClimateCallset_fan_mode (optional< ClimateFanMode > fan_mode)
 Set the fan mode of the climate device. More...
 
ClimateCallset_fan_mode (const std::string &fan_mode)
 Set the fan mode of the climate device based on a string. More...
 
ClimateCallset_fan_mode (optional< std::string > fan_mode)
 Set the fan mode of the climate device based on a string. More...
 
ClimateCallset_swing_mode (ClimateSwingMode swing_mode)
 Set the swing mode of the climate device. More...
 
ClimateCallset_swing_mode (optional< ClimateSwingMode > swing_mode)
 Set the swing mode of the climate device. More...
 
ClimateCallset_swing_mode (const std::string &swing_mode)
 Set the swing mode of the climate device based on a string. More...
 
ClimateCallset_preset (ClimatePreset preset)
 Set the preset of the climate device. More...
 
ClimateCallset_preset (optional< ClimatePreset > preset)
 Set the preset of the climate device. More...
 
ClimateCallset_preset (const std::string &preset)
 Set the preset of the climate device based on a string. More...
 
ClimateCallset_preset (optional< std::string > preset)
 Set the preset of the climate device based on a string. More...
 
void perform ()
 
const optional< ClimateMode > & get_mode () const
 
const optional< float > & get_target_temperature () const
 
const optional< float > & get_target_temperature_low () const
 
const optional< float > & get_target_temperature_high () const
 
 ESPDEPRECATED ("get_away() is deprecated, please use .get_preset() instead", "v1.20") optional< bool > get_away() const
 
const optional< ClimateFanMode > & get_fan_mode () const
 
const optional< ClimateSwingMode > & get_swing_mode () const
 
const optional< std::string > & get_custom_fan_mode () const
 
const optional< ClimatePreset > & get_preset () const
 
const optional< std::string > & get_custom_preset () const
 

Protected Member Functions

void validate_ ()
 

Protected Attributes

Climate *const parent_
 
optional< ClimateModemode_
 
optional< float > target_temperature_
 
optional< float > target_temperature_low_
 
optional< float > target_temperature_high_
 
optional< ClimateFanModefan_mode_
 
optional< ClimateSwingModeswing_mode_
 
optional< std::string > custom_fan_mode_
 
optional< ClimatePresetpreset_
 
optional< std::string > custom_preset_
 

Detailed Description

This class is used to encode all control actions on a climate device.

It is supposed to be used by all code that wishes to control a climate device (mqtt, api, lambda etc). Create an instance of this class by calling id(climate_device).make_call();. Then set all attributes with the set_x methods. Finally, to apply the changes call .perform();.

The integration that implements the climate device receives this instance with the control method. It should check all the properties it implements and apply them as needed. It should do so by getting all properties it controls with the getter methods in this class. If the optional value is set (check with .has_value()) that means the user wants to control this property. Get the value of the optional with the star operator (*call.get_mode()) and apply it.

Definition at line 32 of file climate.h.

Constructor & Destructor Documentation

◆ ClimateCall()

esphome::climate::ClimateCall::ClimateCall ( Climate parent)
inlineexplicit

Definition at line 34 of file climate.h.

Member Function Documentation

◆ ESPDEPRECATED() [1/3]

esphome::climate::ClimateCall::ESPDEPRECATED ( "set_away() is  deprecated,
please use .set_preset(CLIMATE_PRESET_AWAY) instead"  ,
"v1.20"   
) &

◆ ESPDEPRECATED() [2/3]

esphome::climate::ClimateCall::ESPDEPRECATED ( "set_away() is  deprecated,
please use .set_preset(CLIMATE_PRESET_AWAY) instead"  ,
"v1.20"   
) &

◆ ESPDEPRECATED() [3/3]

esphome::climate::ClimateCall::ESPDEPRECATED ( "get_away() is  deprecated,
please use .get_preset() instead"  ,
"v1.20"   
) const

◆ get_custom_fan_mode()

const optional< std::string > & esphome::climate::ClimateCall::get_custom_fan_mode ( ) const

Definition at line 267 of file climate.cpp.

◆ get_custom_preset()

const optional< std::string > & esphome::climate::ClimateCall::get_custom_preset ( ) const

Definition at line 269 of file climate.cpp.

◆ get_fan_mode()

const optional< ClimateFanMode > & esphome::climate::ClimateCall::get_fan_mode ( ) const

Definition at line 266 of file climate.cpp.

◆ get_mode()

const optional< ClimateMode > & esphome::climate::ClimateCall::get_mode ( ) const

Definition at line 257 of file climate.cpp.

◆ get_preset()

const optional< ClimatePreset > & esphome::climate::ClimateCall::get_preset ( ) const

Definition at line 268 of file climate.cpp.

◆ get_swing_mode()

const optional< ClimateSwingMode > & esphome::climate::ClimateCall::get_swing_mode ( ) const

Definition at line 270 of file climate.cpp.

◆ get_target_temperature()

const optional< float > & esphome::climate::ClimateCall::get_target_temperature ( ) const

Definition at line 258 of file climate.cpp.

◆ get_target_temperature_high()

const optional< float > & esphome::climate::ClimateCall::get_target_temperature_high ( ) const

Definition at line 260 of file climate.cpp.

◆ get_target_temperature_low()

const optional< float > & esphome::climate::ClimateCall::get_target_temperature_low ( ) const

Definition at line 259 of file climate.cpp.

◆ perform()

void esphome::climate::ClimateCall::perform ( )

Definition at line 8 of file climate.cpp.

◆ set_fan_mode() [1/4]

ClimateCall & esphome::climate::ClimateCall::set_fan_mode ( ClimateFanMode  fan_mode)

Set the fan mode of the climate device.

Definition at line 150 of file climate.cpp.

◆ set_fan_mode() [2/4]

ClimateCall & esphome::climate::ClimateCall::set_fan_mode ( optional< ClimateFanMode fan_mode)

Set the fan mode of the climate device.

Definition at line 296 of file climate.cpp.

◆ set_fan_mode() [3/4]

ClimateCall & esphome::climate::ClimateCall::set_fan_mode ( const std::string &  fan_mode)

Set the fan mode of the climate device based on a string.

Definition at line 155 of file climate.cpp.

◆ set_fan_mode() [4/4]

ClimateCall & esphome::climate::ClimateCall::set_fan_mode ( optional< std::string >  fan_mode)

Set the fan mode of the climate device based on a string.

Definition at line 184 of file climate.cpp.

◆ set_mode() [1/3]

ClimateCall & esphome::climate::ClimateCall::set_mode ( ClimateMode  mode)

Set the mode of the climate device.

Definition at line 126 of file climate.cpp.

◆ set_mode() [2/3]

ClimateCall & esphome::climate::ClimateCall::set_mode ( optional< ClimateMode mode)

Set the mode of the climate device.

Definition at line 292 of file climate.cpp.

◆ set_mode() [3/3]

ClimateCall & esphome::climate::ClimateCall::set_mode ( const std::string &  mode)

Set the mode of the climate device based on a string.

Definition at line 130 of file climate.cpp.

◆ set_preset() [1/4]

ClimateCall & esphome::climate::ClimateCall::set_preset ( ClimatePreset  preset)

Set the preset of the climate device.

Definition at line 190 of file climate.cpp.

◆ set_preset() [2/4]

ClimateCall & esphome::climate::ClimateCall::set_preset ( optional< ClimatePreset preset)

Set the preset of the climate device.

Definition at line 301 of file climate.cpp.

◆ set_preset() [3/4]

ClimateCall & esphome::climate::ClimateCall::set_preset ( const std::string &  preset)

Set the preset of the climate device based on a string.

Definition at line 195 of file climate.cpp.

◆ set_preset() [4/4]

ClimateCall & esphome::climate::ClimateCall::set_preset ( optional< std::string >  preset)

Set the preset of the climate device based on a string.

Definition at line 220 of file climate.cpp.

◆ set_swing_mode() [1/3]

ClimateCall & esphome::climate::ClimateCall::set_swing_mode ( ClimateSwingMode  swing_mode)

Set the swing mode of the climate device.

Definition at line 226 of file climate.cpp.

◆ set_swing_mode() [2/3]

ClimateCall & esphome::climate::ClimateCall::set_swing_mode ( optional< ClimateSwingMode swing_mode)

Set the swing mode of the climate device.

Definition at line 306 of file climate.cpp.

◆ set_swing_mode() [3/3]

ClimateCall & esphome::climate::ClimateCall::set_swing_mode ( const std::string &  swing_mode)

Set the swing mode of the climate device based on a string.

Definition at line 230 of file climate.cpp.

◆ set_target_temperature() [1/2]

ClimateCall & esphome::climate::ClimateCall::set_target_temperature ( float  target_temperature)

Set the target temperature of the climate device.

Definition at line 245 of file climate.cpp.

◆ set_target_temperature() [2/2]

ClimateCall & esphome::climate::ClimateCall::set_target_temperature ( optional< float >  target_temperature)

Set the target temperature of the climate device.

Definition at line 288 of file climate.cpp.

◆ set_target_temperature_high() [1/2]

ClimateCall & esphome::climate::ClimateCall::set_target_temperature_high ( float  target_temperature_high)

Set the high point target temperature of the climate device.

For climate devices with two point target temperature control

Definition at line 253 of file climate.cpp.

◆ set_target_temperature_high() [2/2]

ClimateCall & esphome::climate::ClimateCall::set_target_temperature_high ( optional< float >  target_temperature_high)

Set the high point target temperature of the climate device.

For climate devices with two point target temperature control

Definition at line 280 of file climate.cpp.

◆ set_target_temperature_low() [1/2]

ClimateCall & esphome::climate::ClimateCall::set_target_temperature_low ( float  target_temperature_low)

Set the low point target temperature of the climate device.

For climate devices with two point target temperature control

Definition at line 249 of file climate.cpp.

◆ set_target_temperature_low() [2/2]

ClimateCall & esphome::climate::ClimateCall::set_target_temperature_low ( optional< float >  target_temperature_low)

Set the low point target temperature of the climate device.

For climate devices with two point target temperature control

Definition at line 284 of file climate.cpp.

◆ validate_()

void esphome::climate::ClimateCall::validate_ ( )
protected

Definition at line 48 of file climate.cpp.

Field Documentation

◆ custom_fan_mode_

optional<std::string> esphome::climate::ClimateCall::custom_fan_mode_
protected

Definition at line 117 of file climate.h.

◆ custom_preset_

optional<std::string> esphome::climate::ClimateCall::custom_preset_
protected

Definition at line 119 of file climate.h.

◆ fan_mode_

optional<ClimateFanMode> esphome::climate::ClimateCall::fan_mode_
protected

Definition at line 115 of file climate.h.

◆ mode_

optional<ClimateMode> esphome::climate::ClimateCall::mode_
protected

Definition at line 111 of file climate.h.

◆ parent_

Climate* const esphome::climate::ClimateCall::parent_
protected

Definition at line 110 of file climate.h.

◆ preset_

optional<ClimatePreset> esphome::climate::ClimateCall::preset_
protected

Definition at line 118 of file climate.h.

◆ swing_mode_

optional<ClimateSwingMode> esphome::climate::ClimateCall::swing_mode_
protected

Definition at line 116 of file climate.h.

◆ target_temperature_

optional<float> esphome::climate::ClimateCall::target_temperature_
protected

Definition at line 112 of file climate.h.

◆ target_temperature_high_

optional<float> esphome::climate::ClimateCall::target_temperature_high_
protected

Definition at line 114 of file climate.h.

◆ target_temperature_low_

optional<float> esphome::climate::ClimateCall::target_temperature_low_
protected

Definition at line 113 of file climate.h.


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