ESPHome
2022.12.8
|
This class is used to encode all control actions on a climate device. More...
#include <climate.h>
Public Member Functions | |
ClimateCall (Climate *parent) | |
ClimateCall & | set_mode (ClimateMode mode) |
Set the mode of the climate device. More... | |
ClimateCall & | set_mode (optional< ClimateMode > mode) |
Set the mode of the climate device. More... | |
ClimateCall & | set_mode (const std::string &mode) |
Set the mode of the climate device based on a string. More... | |
ClimateCall & | set_target_temperature (float target_temperature) |
Set the target temperature of the climate device. More... | |
ClimateCall & | set_target_temperature (optional< float > target_temperature) |
Set the target temperature of the climate device. More... | |
ClimateCall & | set_target_temperature_low (float target_temperature_low) |
Set the low point target temperature of the climate device. More... | |
ClimateCall & | set_target_temperature_low (optional< float > target_temperature_low) |
Set the low point target temperature of the climate device. More... | |
ClimateCall & | set_target_temperature_high (float target_temperature_high) |
Set the high point target temperature of the climate device. More... | |
ClimateCall & | set_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) | |
ClimateCall & | set_fan_mode (ClimateFanMode fan_mode) |
Set the fan mode of the climate device. More... | |
ClimateCall & | set_fan_mode (optional< ClimateFanMode > fan_mode) |
Set the fan mode of the climate device. More... | |
ClimateCall & | set_fan_mode (const std::string &fan_mode) |
Set the fan mode of the climate device based on a string. More... | |
ClimateCall & | set_fan_mode (optional< std::string > fan_mode) |
Set the fan mode of the climate device based on a string. More... | |
ClimateCall & | set_swing_mode (ClimateSwingMode swing_mode) |
Set the swing mode of the climate device. More... | |
ClimateCall & | set_swing_mode (optional< ClimateSwingMode > swing_mode) |
Set the swing mode of the climate device. More... | |
ClimateCall & | set_swing_mode (const std::string &swing_mode) |
Set the swing mode of the climate device based on a string. More... | |
ClimateCall & | set_preset (ClimatePreset preset) |
Set the preset of the climate device. More... | |
ClimateCall & | set_preset (optional< ClimatePreset > preset) |
Set the preset of the climate device. More... | |
ClimateCall & | set_preset (const std::string &preset) |
Set the preset of the climate device based on a string. More... | |
ClimateCall & | set_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< ClimateMode > | mode_ |
optional< float > | target_temperature_ |
optional< float > | target_temperature_low_ |
optional< float > | target_temperature_high_ |
optional< ClimateFanMode > | fan_mode_ |
optional< ClimateSwingMode > | swing_mode_ |
optional< std::string > | custom_fan_mode_ |
optional< ClimatePreset > | preset_ |
optional< std::string > | custom_preset_ |
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.
|
inlineexplicit |
esphome::climate::ClimateCall::ESPDEPRECATED | ( | "set_away() is | deprecated, |
please use .set_preset(CLIMATE_PRESET_AWAY) instead" | , | ||
"v1.20" | |||
) | & |
esphome::climate::ClimateCall::ESPDEPRECATED | ( | "set_away() is | deprecated, |
please use .set_preset(CLIMATE_PRESET_AWAY) instead" | , | ||
"v1.20" | |||
) | & |
esphome::climate::ClimateCall::ESPDEPRECATED | ( | "get_away() is | deprecated, |
please use .get_preset() instead" | , | ||
"v1.20" | |||
) | const |
const optional< std::string > & esphome::climate::ClimateCall::get_custom_fan_mode | ( | ) | const |
Definition at line 270 of file climate.cpp.
const optional< std::string > & esphome::climate::ClimateCall::get_custom_preset | ( | ) | const |
Definition at line 272 of file climate.cpp.
const optional< ClimateFanMode > & esphome::climate::ClimateCall::get_fan_mode | ( | ) | const |
Definition at line 269 of file climate.cpp.
const optional< ClimateMode > & esphome::climate::ClimateCall::get_mode | ( | ) | const |
Definition at line 260 of file climate.cpp.
const optional< ClimatePreset > & esphome::climate::ClimateCall::get_preset | ( | ) | const |
Definition at line 271 of file climate.cpp.
const optional< ClimateSwingMode > & esphome::climate::ClimateCall::get_swing_mode | ( | ) | const |
Definition at line 273 of file climate.cpp.
const optional< float > & esphome::climate::ClimateCall::get_target_temperature | ( | ) | const |
Definition at line 261 of file climate.cpp.
const optional< float > & esphome::climate::ClimateCall::get_target_temperature_high | ( | ) | const |
Definition at line 263 of file climate.cpp.
const optional< float > & esphome::climate::ClimateCall::get_target_temperature_low | ( | ) | const |
Definition at line 262 of file climate.cpp.
void esphome::climate::ClimateCall::perform | ( | ) |
Definition at line 9 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_fan_mode | ( | ClimateFanMode | fan_mode | ) |
Set the fan mode of the climate device.
Definition at line 153 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_fan_mode | ( | optional< ClimateFanMode > | fan_mode | ) |
Set the fan mode of the climate device.
Definition at line 299 of file climate.cpp.
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 158 of file climate.cpp.
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 187 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_mode | ( | ClimateMode | mode | ) |
Set the mode of the climate device.
Definition at line 129 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_mode | ( | optional< ClimateMode > | mode | ) |
Set the mode of the climate device.
Definition at line 295 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_mode | ( | const std::string & | mode | ) |
Set the mode of the climate device based on a string.
Definition at line 133 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_preset | ( | ClimatePreset | preset | ) |
Set the preset of the climate device.
Definition at line 193 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_preset | ( | optional< ClimatePreset > | preset | ) |
Set the preset of the climate device.
Definition at line 304 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_preset | ( | const std::string & | preset | ) |
Set the preset of the climate device based on a string.
Definition at line 198 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_preset | ( | optional< std::string > | preset | ) |
Set the preset of the climate device based on a string.
Definition at line 223 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_swing_mode | ( | ClimateSwingMode | swing_mode | ) |
Set the swing mode of the climate device.
Definition at line 229 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_swing_mode | ( | optional< ClimateSwingMode > | swing_mode | ) |
Set the swing mode of the climate device.
Definition at line 309 of file climate.cpp.
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 233 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_target_temperature | ( | float | target_temperature | ) |
Set the target temperature of the climate device.
Definition at line 248 of file climate.cpp.
ClimateCall & esphome::climate::ClimateCall::set_target_temperature | ( | optional< float > | target_temperature | ) |
Set the target temperature of the climate device.
Definition at line 291 of file climate.cpp.
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 256 of file climate.cpp.
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 283 of file climate.cpp.
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 252 of file climate.cpp.
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 287 of file climate.cpp.
|
protected |
Definition at line 49 of file climate.cpp.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |