Home-IoT/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2024-11-10 09:17:46 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Rework climate traits (#1941)

Browse source 
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Otto Winter 2021-06-21 21:17:01 +02:00 committed by Jesse Hills
parent e20ec00071
commit d4eb0f1655
No known key found for this signature in database
GPG key ID: BEAAE804EFD8E83A
24 changed files with 393 additions and 546 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
esphome/components/api/api.proto
View file

@ -710,11 +710,11 @@ enum ClimateAction {
CLIMATE_ACTION_FAN = 6; CLIMATE_ACTION_FAN = 6;
} }
enum ClimatePreset { enum ClimatePreset {
CLIMATE_PRESET_ECO = 0; CLIMATE_PRESET_HOME = 0;
CLIMATE_PRESET_AWAY = 1; CLIMATE_PRESET_AWAY = 1;
CLIMATE_PRESET_BOOST = 2; CLIMATE_PRESET_BOOST = 2;
CLIMATE_PRESET_COMFORT = 3; CLIMATE_PRESET_COMFORT = 3;
CLIMATE_PRESET_HOME = 4; CLIMATE_PRESET_ECO = 4;
CLIMATE_PRESET_SLEEP = 5; CLIMATE_PRESET_SLEEP = 5;
CLIMATE_PRESET_ACTIVITY = 6; CLIMATE_PRESET_ACTIVITY = 6;
} }
@ -734,7 +734,9 @@ message ListEntitiesClimateResponse {
float visual_min_temperature = 8; float visual_min_temperature = 8;
float visual_max_temperature = 9; float visual_max_temperature = 9;
float visual_temperature_step = 10; float visual_temperature_step = 10;
bool supports_away = 11; // for older peer versions - in new system this
// is if CLIMATE_PRESET_AWAY exists is supported_presets
bool legacy_supports_away = 11;
bool supports_action = 12; bool supports_action = 12;
repeated ClimateFanMode supported_fan_modes = 13; repeated ClimateFanMode supported_fan_modes = 13;
repeated ClimateSwingMode supported_swing_modes = 14; repeated ClimateSwingMode supported_swing_modes = 14;
@ -754,7 +756,8 @@ message ClimateStateResponse {
float target_temperature = 4; float target_temperature = 4;
float target_temperature_low = 5; float target_temperature_low = 5;
float target_temperature_high = 6; float target_temperature_high = 6;
bool away = 7; // For older peers, equal to preset == CLIMATE_PRESET_AWAY
bool legacy_away = 7;
ClimateAction action = 8; ClimateAction action = 8;
ClimateFanMode fan_mode = 9; ClimateFanMode fan_mode = 9;
ClimateSwingMode swing_mode = 10; ClimateSwingMode swing_mode = 10;
@ -777,8 +780,9 @@ message ClimateCommandRequest {
float target_temperature_low = 7; float target_temperature_low = 7;
bool has_target_temperature_high = 8; bool has_target_temperature_high = 8;
float target_temperature_high = 9; float target_temperature_high = 9;
bool has_away = 10; // legacy, for older peers, newer ones should use CLIMATE_PRESET_AWAY in preset
bool away = 11; bool has_legacy_away = 10;
bool legacy_away = 11;
bool has_fan_mode = 12; bool has_fan_mode = 12;
ClimateFanMode fan_mode = 13; ClimateFanMode fan_mode = 13;
bool has_swing_mode = 14; bool has_swing_mode = 14;

52
esphome/components/api/api_connection.cpp
View file

@ -475,14 +475,14 @@ bool APIConnection::send_climate_state(climate::Climate *climate) {
} else { } else {
resp.target_temperature = climate->target_temperature; resp.target_temperature = climate->target_temperature;
} }
if (traits.get_supports_away())
resp.away = climate->away;
if (traits.get_supports_fan_modes() && climate->fan_mode.has_value()) if (traits.get_supports_fan_modes() && climate->fan_mode.has_value())
resp.fan_mode = static_cast<enums::ClimateFanMode>(climate->fan_mode.value()); resp.fan_mode = static_cast<enums::ClimateFanMode>(climate->fan_mode.value());
if (!traits.get_supported_custom_fan_modes().empty() && climate->custom_fan_mode.has_value()) if (!traits.get_supported_custom_fan_modes().empty() && climate->custom_fan_mode.has_value())
resp.custom_fan_mode = climate->custom_fan_mode.value(); resp.custom_fan_mode = climate->custom_fan_mode.value();
if (traits.get_supports_presets() && climate->preset.has_value()) if (traits.get_supports_presets() && climate->preset.has_value()) {
resp.preset = static_cast<enums::ClimatePreset>(climate->preset.value()); resp.preset = static_cast<enums::ClimatePreset>(climate->preset.value());
resp.legacy_away = resp.preset == enums::CLIMATE_PRESET_AWAY;
}
if (!traits.get_supported_custom_presets().empty() && climate->custom_preset.has_value()) if (!traits.get_supported_custom_presets().empty() && climate->custom_preset.has_value())
resp.custom_preset = climate->custom_preset.value(); resp.custom_preset = climate->custom_preset.value();
if (traits.get_supports_swing_modes()) if (traits.get_supports_swing_modes())
@ -498,40 +498,26 @@ bool APIConnection::send_climate_info(climate::Climate *climate) {
msg.unique_id = get_default_unique_id("climate", climate); msg.unique_id = get_default_unique_id("climate", climate);
msg.supports_current_temperature = traits.get_supports_current_temperature(); msg.supports_current_temperature = traits.get_supports_current_temperature();
msg.supports_two_point_target_temperature = traits.get_supports_two_point_target_temperature(); msg.supports_two_point_target_temperature = traits.get_supports_two_point_target_temperature();
for (auto mode :
{climate::CLIMATE_MODE_AUTO, climate::CLIMATE_MODE_OFF, climate::CLIMATE_MODE_COOL, climate::CLIMATE_MODE_HEAT, for (auto mode : traits.get_supported_modes())
climate::CLIMATE_MODE_DRY, climate::CLIMATE_MODE_FAN_ONLY, climate::CLIMATE_MODE_HEAT_COOL}) { msg.supported_modes.push_back(static_cast<enums::ClimateMode>(mode));
if (traits.supports_mode(mode))
msg.supported_modes.push_back(static_cast<enums::ClimateMode>(mode));
}
msg.visual_min_temperature = traits.get_visual_min_temperature(); msg.visual_min_temperature = traits.get_visual_min_temperature();
msg.visual_max_temperature = traits.get_visual_max_temperature(); msg.visual_max_temperature = traits.get_visual_max_temperature();
msg.visual_temperature_step = traits.get_visual_temperature_step(); msg.visual_temperature_step = traits.get_visual_temperature_step();
msg.supports_away = traits.get_supports_away(); msg.legacy_supports_away = traits.supports_preset(climate::CLIMATE_PRESET_AWAY);
msg.supports_action = traits.get_supports_action(); msg.supports_action = traits.get_supports_action();
for (auto fan_mode : {climate::CLIMATE_FAN_ON, climate::CLIMATE_FAN_OFF, climate::CLIMATE_FAN_AUTO,
climate::CLIMATE_FAN_LOW, climate::CLIMATE_FAN_MEDIUM, climate::CLIMATE_FAN_HIGH, for (auto fan_mode : traits.get_supported_fan_modes())
climate::CLIMATE_FAN_MIDDLE, climate::CLIMATE_FAN_FOCUS, climate::CLIMATE_FAN_DIFFUSE}) { msg.supported_fan_modes.push_back(static_cast<enums::ClimateFanMode>(fan_mode));
if (traits.supports_fan_mode(fan_mode)) for (auto const &custom_fan_mode : traits.get_supported_custom_fan_modes())
msg.supported_fan_modes.push_back(static_cast<enums::ClimateFanMode>(fan_mode));
}
for (auto const &custom_fan_mode : traits.get_supported_custom_fan_modes()) {
msg.supported_custom_fan_modes.push_back(custom_fan_mode); msg.supported_custom_fan_modes.push_back(custom_fan_mode);
} for (auto preset : traits.get_supported_presets())
for (auto preset : {climate::CLIMATE_PRESET_ECO, climate::CLIMATE_PRESET_AWAY, climate::CLIMATE_PRESET_BOOST, msg.supported_presets.push_back(static_cast<enums::ClimatePreset>(preset));
climate::CLIMATE_PRESET_COMFORT, climate::CLIMATE_PRESET_HOME, climate::CLIMATE_PRESET_SLEEP, for (auto const &custom_preset : traits.get_supported_custom_presets())
climate::CLIMATE_PRESET_ACTIVITY}) {
if (traits.supports_preset(preset))
msg.supported_presets.push_back(static_cast<enums::ClimatePreset>(preset));
}
for (auto const &custom_preset : traits.get_supported_custom_presets()) {
msg.supported_custom_presets.push_back(custom_preset); msg.supported_custom_presets.push_back(custom_preset);
} for (auto swing_mode : traits.get_supported_swing_modes())
for (auto swing_mode : {climate::CLIMATE_SWING_OFF, climate::CLIMATE_SWING_BOTH, climate::CLIMATE_SWING_VERTICAL, msg.supported_swing_modes.push_back(static_cast<enums::ClimateSwingMode>(swing_mode));
climate::CLIMATE_SWING_HORIZONTAL}) {
if (traits.supports_swing_mode(swing_mode))
msg.supported_swing_modes.push_back(static_cast<enums::ClimateSwingMode>(swing_mode));
}
return this->send_list_entities_climate_response(msg); return this->send_list_entities_climate_response(msg);
} }
void APIConnection::climate_command(const ClimateCommandRequest &msg) { void APIConnection::climate_command(const ClimateCommandRequest &msg) {
@ -548,8 +534,8 @@ void APIConnection::climate_command(const ClimateCommandRequest &msg) {
call.set_target_temperature_low(msg.target_temperature_low); call.set_target_temperature_low(msg.target_temperature_low);
if (msg.has_target_temperature_high) if (msg.has_target_temperature_high)
call.set_target_temperature_high(msg.target_temperature_high); call.set_target_temperature_high(msg.target_temperature_high);
if (msg.has_away) if (msg.has_legacy_away)
call.set_away(msg.away); call.set_preset(msg.legacy_away ? climate::CLIMATE_PRESET_AWAY : climate::CLIMATE_PRESET_HOME);
if (msg.has_fan_mode) if (msg.has_fan_mode)
call.set_fan_mode(static_cast<climate::ClimateFanMode>(msg.fan_mode)); call.set_fan_mode(static_cast<climate::ClimateFanMode>(msg.fan_mode));
if (msg.has_custom_fan_mode) if (msg.has_custom_fan_mode)

40
esphome/components/api/api_pb2.cpp
View file

@ -192,16 +192,16 @@ template<> const char *proto_enum_to_string<enums::ClimateAction>(enums::Climate
} }
template<> const char *proto_enum_to_string<enums::ClimatePreset>(enums::ClimatePreset value) { template<> const char *proto_enum_to_string<enums::ClimatePreset>(enums::ClimatePreset value) {
switch (value) { switch (value) {
case enums::CLIMATE_PRESET_ECO: case enums::CLIMATE_PRESET_HOME:
return "CLIMATE_PRESET_ECO"; return "CLIMATE_PRESET_HOME";
case enums::CLIMATE_PRESET_AWAY: case enums::CLIMATE_PRESET_AWAY:
return "CLIMATE_PRESET_AWAY"; return "CLIMATE_PRESET_AWAY";
case enums::CLIMATE_PRESET_BOOST: case enums::CLIMATE_PRESET_BOOST:
return "CLIMATE_PRESET_BOOST"; return "CLIMATE_PRESET_BOOST";
case enums::CLIMATE_PRESET_COMFORT: case enums::CLIMATE_PRESET_COMFORT:
return "CLIMATE_PRESET_COMFORT"; return "CLIMATE_PRESET_COMFORT";
case enums::CLIMATE_PRESET_HOME: case enums::CLIMATE_PRESET_ECO:
return "CLIMATE_PRESET_HOME"; return "CLIMATE_PRESET_ECO";
case enums::CLIMATE_PRESET_SLEEP: case enums::CLIMATE_PRESET_SLEEP:
return "CLIMATE_PRESET_SLEEP"; return "CLIMATE_PRESET_SLEEP";
case enums::CLIMATE_PRESET_ACTIVITY: case enums::CLIMATE_PRESET_ACTIVITY:
@ -2672,7 +2672,7 @@ bool ListEntitiesClimateResponse::decode_varint(uint32_t field_id, ProtoVarInt v
return true; return true;
} }
case 11: { case 11: {
this->supports_away = value.as_bool(); this->legacy_supports_away = value.as_bool();
return true; return true;
} }
case 12: { case 12: {
@ -2756,7 +2756,7 @@ void ListEntitiesClimateResponse::encode(ProtoWriteBuffer buffer) const {
buffer.encode_float(8, this->visual_min_temperature); buffer.encode_float(8, this->visual_min_temperature);
buffer.encode_float(9, this->visual_max_temperature); buffer.encode_float(9, this->visual_max_temperature);
buffer.encode_float(10, this->visual_temperature_step); buffer.encode_float(10, this->visual_temperature_step);
buffer.encode_bool(11, this->supports_away); buffer.encode_bool(11, this->legacy_supports_away);
buffer.encode_bool(12, this->supports_action); buffer.encode_bool(12, this->supports_action);
for (auto &it : this->supported_fan_modes) { for (auto &it : this->supported_fan_modes) {
buffer.encode_enum<enums::ClimateFanMode>(13, it, true); buffer.encode_enum<enums::ClimateFanMode>(13, it, true);
@ -2823,8 +2823,8 @@ void ListEntitiesClimateResponse::dump_to(std::string &out) const {
out.append(buffer); out.append(buffer);
out.append("\n"); out.append("\n");
out.append(" supports_away: "); out.append(" legacy_supports_away: ");
out.append(YESNO(this->supports_away)); out.append(YESNO(this->legacy_supports_away));
out.append("\n"); out.append("\n");
out.append(" supports_action: "); out.append(" supports_action: ");
@ -2869,7 +2869,7 @@ bool ClimateStateResponse::decode_varint(uint32_t field_id, ProtoVarInt value) {
return true; return true;
} }
case 7: { case 7: {
this->away = value.as_bool(); this->legacy_away = value.as_bool();
return true; return true;
} }
case 8: { case 8: {
@ -2939,7 +2939,7 @@ void ClimateStateResponse::encode(ProtoWriteBuffer buffer) const {
buffer.encode_float(4, this->target_temperature); buffer.encode_float(4, this->target_temperature);
buffer.encode_float(5, this->target_temperature_low); buffer.encode_float(5, this->target_temperature_low);
buffer.encode_float(6, this->target_temperature_high); buffer.encode_float(6, this->target_temperature_high);
buffer.encode_bool(7, this->away); buffer.encode_bool(7, this->legacy_away);
buffer.encode_enum<enums::ClimateAction>(8, this->action); buffer.encode_enum<enums::ClimateAction>(8, this->action);
buffer.encode_enum<enums::ClimateFanMode>(9, this->fan_mode); buffer.encode_enum<enums::ClimateFanMode>(9, this->fan_mode);
buffer.encode_enum<enums::ClimateSwingMode>(10, this->swing_mode); buffer.encode_enum<enums::ClimateSwingMode>(10, this->swing_mode);
@ -2979,8 +2979,8 @@ void ClimateStateResponse::dump_to(std::string &out) const {
out.append(buffer); out.append(buffer);
out.append("\n"); out.append("\n");
out.append(" away: "); out.append(" legacy_away: ");
out.append(YESNO(this->away)); out.append(YESNO(this->legacy_away));
out.append("\n"); out.append("\n");
out.append(" action: "); out.append(" action: ");
@ -3031,11 +3031,11 @@ bool ClimateCommandRequest::decode_varint(uint32_t field_id, ProtoVarInt value)
return true; return true;
} }
case 10: { case 10: {
this->has_away = value.as_bool(); this->has_legacy_away = value.as_bool();
return true; return true;
} }
case 11: { case 11: {
this->away = value.as_bool(); this->legacy_away = value.as_bool();
return true; return true;
} }
case 12: { case 12: {
@ -3120,8 +3120,8 @@ void ClimateCommandRequest::encode(ProtoWriteBuffer buffer) const {
buffer.encode_float(7, this->target_temperature_low); buffer.encode_float(7, this->target_temperature_low);
buffer.encode_bool(8, this->has_target_temperature_high); buffer.encode_bool(8, this->has_target_temperature_high);
buffer.encode_float(9, this->target_temperature_high); buffer.encode_float(9, this->target_temperature_high);
buffer.encode_bool(10, this->has_away); buffer.encode_bool(10, this->has_legacy_away);
buffer.encode_bool(11, this->away); buffer.encode_bool(11, this->legacy_away);
buffer.encode_bool(12, this->has_fan_mode); buffer.encode_bool(12, this->has_fan_mode);
buffer.encode_enum<enums::ClimateFanMode>(13, this->fan_mode); buffer.encode_enum<enums::ClimateFanMode>(13, this->fan_mode);
buffer.encode_bool(14, this->has_swing_mode); buffer.encode_bool(14, this->has_swing_mode);
@ -3176,12 +3176,12 @@ void ClimateCommandRequest::dump_to(std::string &out) const {
out.append(buffer); out.append(buffer);
out.append("\n"); out.append("\n");
out.append(" has_away: "); out.append(" has_legacy_away: ");
out.append(YESNO(this->has_away)); out.append(YESNO(this->has_legacy_away));
out.append("\n"); out.append("\n");
out.append(" away: "); out.append(" legacy_away: ");
out.append(YESNO(this->away)); out.append(YESNO(this->legacy_away));
out.append("\n"); out.append("\n");
out.append(" has_fan_mode: "); out.append(" has_fan_mode: ");

12
esphome/components/api/api_pb2.h
View file

@ -90,11 +90,11 @@ enum ClimateAction : uint32_t {
CLIMATE_ACTION_FAN = 6, CLIMATE_ACTION_FAN = 6,
}; };
enum ClimatePreset : uint32_t { enum ClimatePreset : uint32_t {
CLIMATE_PRESET_ECO = 0, CLIMATE_PRESET_HOME = 0,
CLIMATE_PRESET_AWAY = 1, CLIMATE_PRESET_AWAY = 1,
CLIMATE_PRESET_BOOST = 2, CLIMATE_PRESET_BOOST = 2,
CLIMATE_PRESET_COMFORT = 3, CLIMATE_PRESET_COMFORT = 3,
CLIMATE_PRESET_HOME = 4, CLIMATE_PRESET_ECO = 4,
CLIMATE_PRESET_SLEEP = 5, CLIMATE_PRESET_SLEEP = 5,
CLIMATE_PRESET_ACTIVITY = 6, CLIMATE_PRESET_ACTIVITY = 6,
}; };
@ -709,7 +709,7 @@ class ListEntitiesClimateResponse : public ProtoMessage {
float visual_min_temperature{0.0f}; float visual_min_temperature{0.0f};
float visual_max_temperature{0.0f}; float visual_max_temperature{0.0f};
float visual_temperature_step{0.0f}; float visual_temperature_step{0.0f};
bool supports_away{false}; bool legacy_supports_away{false};
bool supports_action{false}; bool supports_action{false};
std::vector<enums::ClimateFanMode> supported_fan_modes{}; std::vector<enums::ClimateFanMode> supported_fan_modes{};
std::vector<enums::ClimateSwingMode> supported_swing_modes{}; std::vector<enums::ClimateSwingMode> supported_swing_modes{};
@ -732,7 +732,7 @@ class ClimateStateResponse : public ProtoMessage {
float target_temperature{0.0f}; float target_temperature{0.0f};
float target_temperature_low{0.0f}; float target_temperature_low{0.0f};
float target_temperature_high{0.0f}; float target_temperature_high{0.0f};
bool away{false}; bool legacy_away{false};
enums::ClimateAction action{}; enums::ClimateAction action{};
enums::ClimateFanMode fan_mode{}; enums::ClimateFanMode fan_mode{};
enums::ClimateSwingMode swing_mode{}; enums::ClimateSwingMode swing_mode{};
@ -758,8 +758,8 @@ class ClimateCommandRequest : public ProtoMessage {
float target_temperature_low{0.0f}; float target_temperature_low{0.0f};
bool has_target_temperature_high{false}; bool has_target_temperature_high{false};
float target_temperature_high{0.0f}; float target_temperature_high{0.0f};
bool has_away{false}; bool has_legacy_away{false};
bool away{false}; bool legacy_away{false};
bool has_fan_mode{false}; bool has_fan_mode{false};
enums::ClimateFanMode fan_mode{}; enums::ClimateFanMode fan_mode{};
bool has_swing_mode{false}; bool has_swing_mode{false};

23
esphome/components/bang_bang/bang_bang_climate.cpp
View file

@ -32,8 +32,8 @@ void BangBangClimate::control(const climate::ClimateCall &call) {
this->target_temperature_low = *call.get_target_temperature_low(); this->target_temperature_low = *call.get_target_temperature_low();
if (call.get_target_temperature_high().has_value()) if (call.get_target_temperature_high().has_value())
this->target_temperature_high = *call.get_target_temperature_high(); this->target_temperature_high = *call.get_target_temperature_high();
if (call.get_away().has_value()) if (call.get_preset().has_value())
this->change_away_(*call.get_away()); this->change_away_(*call.get_preset() == climate::CLIMATE_PRESET_AWAY);
this->compute_state_(); this->compute_state_();
this->publish_state(); this->publish_state();
@ -41,11 +41,20 @@ void BangBangClimate::control(const climate::ClimateCall &call) {
climate::ClimateTraits BangBangClimate::traits() { climate::ClimateTraits BangBangClimate::traits() {
auto traits = climate::ClimateTraits(); auto traits = climate::ClimateTraits();
traits.set_supports_current_temperature(true); traits.set_supports_current_temperature(true);
traits.set_supports_heat_cool_mode(true); traits.set_supported_modes({
traits.set_supports_cool_mode(this->supports_cool_); climate::CLIMATE_MODE_OFF,
traits.set_supports_heat_mode(this->supports_heat_); climate::CLIMATE_MODE_HEAT_COOL,
});
if (supports_cool_)
traits.add_supported_mode(climate::CLIMATE_MODE_COOL);
if (supports_heat_)
traits.add_supported_mode(climate::CLIMATE_MODE_HEAT);
traits.set_supports_two_point_target_temperature(true); traits.set_supports_two_point_target_temperature(true);
traits.set_supports_away(this->supports_away_); if (supports_away_)
traits.set_supported_presets({
climate::CLIMATE_PRESET_HOME,
climate::CLIMATE_PRESET_AWAY,
});
traits.set_supports_action(true); traits.set_supports_action(true);
return traits; return traits;
} }
@ -140,7 +149,7 @@ void BangBangClimate::change_away_(bool away) {
this->target_temperature_low = this->away_config_.default_temperature_low; this->target_temperature_low = this->away_config_.default_temperature_low;
this->target_temperature_high = this->away_config_.default_temperature_high; this->target_temperature_high = this->away_config_.default_temperature_high;
} }
this->away = away; this->preset = away ? climate::CLIMATE_PRESET_AWAY : climate::CLIMATE_PRESET_HOME;
} }
void BangBangClimate::set_normal_config(const BangBangClimateTargetTempConfig &normal_config) { void BangBangClimate::set_normal_config(const BangBangClimateTargetTempConfig &normal_config) {
this->normal_config_ = normal_config; this->normal_config_ = normal_config;

4
esphome/components/climate/automation.h
View file

@ -27,7 +27,9 @@ template<typename... Ts> class ControlAction : public Action<Ts...> {
call.set_target_temperature(this->target_temperature_.optional_value(x...)); call.set_target_temperature(this->target_temperature_.optional_value(x...));
call.set_target_temperature_low(this->target_temperature_low_.optional_value(x...)); call.set_target_temperature_low(this->target_temperature_low_.optional_value(x...));
call.set_target_temperature_high(this->target_temperature_high_.optional_value(x...)); call.set_target_temperature_high(this->target_temperature_high_.optional_value(x...));
call.set_away(this->away_.optional_value(x...)); if (away_.has_value()) {
call.set_preset(away_.value(x...) ? CLIMATE_PRESET_AWAY : CLIMATE_PRESET_HOME);
}
call.set_fan_mode(this->fan_mode_.optional_value(x...)); call.set_fan_mode(this->fan_mode_.optional_value(x...));
call.set_fan_mode(this->custom_fan_mode_.optional_value(x...)); call.set_fan_mode(this->custom_fan_mode_.optional_value(x...));
call.set_preset(this->preset_.optional_value(x...)); call.set_preset(this->preset_.optional_value(x...));

74
esphome/components/climate/climate.cpp
View file

@ -43,9 +43,6 @@ void ClimateCall::perform() {
if (this->target_temperature_high_.has_value()) { if (this->target_temperature_high_.has_value()) {
ESP_LOGD(TAG, " Target Temperature High: %.2f", *this->target_temperature_high_); ESP_LOGD(TAG, " Target Temperature High: %.2f", *this->target_temperature_high_);
} }
if (this->away_.has_value()) {
ESP_LOGD(TAG, " Away Mode: %s", ONOFF(*this->away_));
}
this->parent_->control(*this); this->parent_->control(*this);
} }
void ClimateCall::validate_() { void ClimateCall::validate_() {
@ -125,12 +122,6 @@ void ClimateCall::validate_() {
this->target_temperature_high_.reset(); this->target_temperature_high_.reset();
} }
} }
if (this->away_.has_value()) {
if (!traits.get_supports_away()) {
ESP_LOGW(TAG, " Cannot set away mode for this device!");
this->away_.reset();
}
}
} }
ClimateCall &ClimateCall::set_mode(ClimateMode mode) { ClimateCall &ClimateCall::set_mode(ClimateMode mode) {
this->mode_ = mode; this->mode_ = mode;
@ -181,8 +172,7 @@ ClimateCall &ClimateCall::set_fan_mode(const std::string &fan_mode) {
} else if (str_equals_case_insensitive(fan_mode, "DIFFUSE")) { } else if (str_equals_case_insensitive(fan_mode, "DIFFUSE")) {
this->set_fan_mode(CLIMATE_FAN_DIFFUSE); this->set_fan_mode(CLIMATE_FAN_DIFFUSE);
} else { } else {
auto custom_fan_modes = this->parent_->get_traits().get_supported_custom_fan_modes(); if (this->parent_->get_traits().supports_custom_fan_mode(fan_mode)) {
if (std::find(custom_fan_modes.begin(), custom_fan_modes.end(), fan_mode) != custom_fan_modes.end()) {
this->custom_fan_mode_ = fan_mode; this->custom_fan_mode_ = fan_mode;
this->fan_mode_.reset(); this->fan_mode_.reset();
} else { } else {
@ -218,8 +208,7 @@ ClimateCall &ClimateCall::set_preset(const std::string &preset) {
} else if (str_equals_case_insensitive(preset, "ACTIVITY")) { } else if (str_equals_case_insensitive(preset, "ACTIVITY")) {
this->set_preset(CLIMATE_PRESET_ACTIVITY); this->set_preset(CLIMATE_PRESET_ACTIVITY);
} else { } else {
auto custom_presets = this->parent_->get_traits().get_supported_custom_presets(); if (this->parent_->get_traits().supports_custom_preset(preset)) {
if (std::find(custom_presets.begin(), custom_presets.end(), preset) != custom_presets.end()) {
this->custom_preset_ = preset; this->custom_preset_ = preset;
this->preset_.reset(); this->preset_.reset();
} else { } else {
@ -269,18 +258,23 @@ const optional<ClimateMode> &ClimateCall::get_mode() const { return this->mode_;
const optional<float> &ClimateCall::get_target_temperature() const { return this->target_temperature_; } const optional<float> &ClimateCall::get_target_temperature() const { return this->target_temperature_; }
const optional<float> &ClimateCall::get_target_temperature_low() const { return this->target_temperature_low_; } const optional<float> &ClimateCall::get_target_temperature_low() const { return this->target_temperature_low_; }
const optional<float> &ClimateCall::get_target_temperature_high() const { return this->target_temperature_high_; } const optional<float> &ClimateCall::get_target_temperature_high() const { return this->target_temperature_high_; }
const optional<bool> &ClimateCall::get_away() const { return this->away_; } optional<bool> ClimateCall::get_away() const {
if (!this->preset_.has_value())
return {};
return *this->preset_ == ClimatePreset::CLIMATE_PRESET_AWAY;
}
const optional<ClimateFanMode> &ClimateCall::get_fan_mode() const { return this->fan_mode_; } const optional<ClimateFanMode> &ClimateCall::get_fan_mode() const { return this->fan_mode_; }
const optional<std::string> &ClimateCall::get_custom_fan_mode() const { return this->custom_fan_mode_; } const optional<std::string> &ClimateCall::get_custom_fan_mode() const { return this->custom_fan_mode_; }
const optional<ClimatePreset> &ClimateCall::get_preset() const { return this->preset_; } const optional<ClimatePreset> &ClimateCall::get_preset() const { return this->preset_; }
const optional<std::string> &ClimateCall::get_custom_preset() const { return this->custom_preset_; } const optional<std::string> &ClimateCall::get_custom_preset() const { return this->custom_preset_; }
const optional<ClimateSwingMode> &ClimateCall::get_swing_mode() const { return this->swing_mode_; } const optional<ClimateSwingMode> &ClimateCall::get_swing_mode() const { return this->swing_mode_; }
ClimateCall &ClimateCall::set_away(bool away) { ClimateCall &ClimateCall::set_away(bool away) {
this->away_ = away; this->preset_ = away ? CLIMATE_PRESET_AWAY : CLIMATE_PRESET_HOME;
return *this; return *this;
} }
ClimateCall &ClimateCall::set_away(optional<bool> away) { ClimateCall &ClimateCall::set_away(optional<bool> away) {
this->away_ = away; if (away.has_value())
this->preset_ = *away ? CLIMATE_PRESET_AWAY : CLIMATE_PRESET_HOME;
return *this; return *this;
} }
ClimateCall &ClimateCall::set_target_temperature_high(optional<float> target_temperature_high) { ClimateCall &ClimateCall::set_target_temperature_high(optional<float> target_temperature_high) {
@ -338,20 +332,17 @@ void Climate::save_state_() {
} else { } else {
state.target_temperature = this->target_temperature; state.target_temperature = this->target_temperature;
} }
if (traits.get_supports_away()) {
state.away = this->away;
}
if (traits.get_supports_fan_modes() && fan_mode.has_value()) { if (traits.get_supports_fan_modes() && fan_mode.has_value()) {
state.uses_custom_fan_mode = false; state.uses_custom_fan_mode = false;
state.fan_mode = this->fan_mode.value(); state.fan_mode = this->fan_mode.value();
} }
if (!traits.get_supported_custom_fan_modes().empty() && custom_fan_mode.has_value()) { if (!traits.get_supported_custom_fan_modes().empty() && custom_fan_mode.has_value()) {
state.uses_custom_fan_mode = true; state.uses_custom_fan_mode = true;
auto &custom_fan_modes = traits.get_supported_custom_fan_modes(); const auto &supported = traits.get_supported_custom_fan_modes();
auto it = std::find(custom_fan_modes.begin(), custom_fan_modes.end(), this->custom_fan_mode.value()); std::vector<std::string> vec{supported.begin(), supported.end()};
// only set custom fan mode if value exists, otherwise leave it as is auto it = std::find(vec.begin(), vec.end(), custom_fan_mode);
if (it != custom_fan_modes.cend()) { if (it != vec.end()) {
state.custom_fan_mode = std::distance(custom_fan_modes.begin(), it); state.custom_fan_mode = std::distance(vec.begin(), it);
} }
} }
if (traits.get_supports_presets() && preset.has_value()) { if (traits.get_supports_presets() && preset.has_value()) {
@ -360,11 +351,12 @@ void Climate::save_state_() {
} }
if (!traits.get_supported_custom_presets().empty() && custom_preset.has_value()) { if (!traits.get_supported_custom_presets().empty() && custom_preset.has_value()) {
state.uses_custom_preset = true; state.uses_custom_preset = true;
auto custom_presets = traits.get_supported_custom_presets(); const auto &supported = traits.get_supported_custom_presets();
auto it = std::find(custom_presets.begin(), custom_presets.end(), this->custom_preset.value()); std::vector<std::string> vec{supported.begin(), supported.end()};
auto it = std::find(vec.begin(), vec.end(), custom_preset);
// only set custom preset if value exists, otherwise leave it as is // only set custom preset if value exists, otherwise leave it as is
if (it != custom_presets.cend()) { if (it != vec.cend()) {
state.custom_preset = std::distance(custom_presets.begin(), it); state.custom_preset = std::distance(vec.begin(), it);
} }
} }
if (traits.get_supports_swing_modes()) { if (traits.get_supports_swing_modes()) {
@ -405,9 +397,6 @@ void Climate::publish_state() {
} else { } else {
ESP_LOGD(TAG, " Target Temperature: %.2f°C", this->target_temperature); ESP_LOGD(TAG, " Target Temperature: %.2f°C", this->target_temperature);
} }
if (traits.get_supports_away()) {
ESP_LOGD(TAG, " Away: %s", ONOFF(this->away));
}
// Send state to frontend // Send state to frontend
this->state_callback_.call(); this->state_callback_.call();
@ -453,9 +442,6 @@ ClimateCall ClimateDeviceRestoreState::to_call(Climate *climate) {
} else { } else {
call.set_target_temperature(this->target_temperature); call.set_target_temperature(this->target_temperature);
} }
if (traits.get_supports_away()) {
call.set_away(this->away);
}
if (traits.get_supports_fan_modes() || !traits.get_supported_custom_fan_modes().empty()) { if (traits.get_supports_fan_modes() || !traits.get_supported_custom_fan_modes().empty()) {
call.set_fan_mode(this->fan_mode); call.set_fan_mode(this->fan_mode);
} }
@ -476,23 +462,27 @@ void ClimateDeviceRestoreState::apply(Climate *climate) {
} else { } else {
climate->target_temperature = this->target_temperature; climate->target_temperature = this->target_temperature;
} }
if (traits.get_supports_away()) {
climate->away = this->away;
}
if (traits.get_supports_fan_modes() && !this->uses_custom_fan_mode) { if (traits.get_supports_fan_modes() && !this->uses_custom_fan_mode) {
climate->fan_mode = this->fan_mode; climate->fan_mode = this->fan_mode;
} }
if (!traits.get_supported_custom_fan_modes().empty() && this->uses_custom_fan_mode) { if (!traits.get_supported_custom_fan_modes().empty() && this->uses_custom_fan_mode) {
climate->custom_fan_mode = traits.get_supported_custom_fan_modes()[this->custom_fan_mode]; // std::set has consistent order (lexicographic for strings), so this is ok
const auto &modes = traits.get_supported_custom_fan_modes();
std::vector<std::string> modes_vec{modes.begin(), modes.end()};
if (custom_fan_mode < modes_vec.size()) {
climate->custom_fan_mode = modes_vec[this->custom_fan_mode];
}
} }
if (traits.get_supports_presets() && !this->uses_custom_preset) { if (traits.get_supports_presets() && !this->uses_custom_preset) {
climate->preset = this->preset; climate->preset = this->preset;
} }
if (!traits.get_supported_custom_presets().empty() && this->uses_custom_preset) {
climate->custom_preset = traits.get_supported_custom_presets()[this->custom_preset];
}
if (!traits.get_supported_custom_presets().empty() && uses_custom_preset) { if (!traits.get_supported_custom_presets().empty() && uses_custom_preset) {
climate->custom_preset = traits.get_supported_custom_presets()[this->preset]; // std::set has consistent order (lexicographic for strings), so this is ok
const auto &presets = traits.get_supported_custom_presets();
std::vector<std::string> presets_vec{presets.begin(), presets.end()};
if (custom_preset < presets_vec.size()) {
climate->custom_preset = presets_vec[this->custom_preset];
}
} }
if (traits.get_supports_swing_modes()) { if (traits.get_supports_swing_modes()) {
climate->swing_mode = this->swing_mode; climate->swing_mode = this->swing_mode;

8
esphome/components/climate/climate.h
View file

@ -63,7 +63,9 @@ class ClimateCall {
* For climate devices with two point target temperature control * For climate devices with two point target temperature control
*/ */
ClimateCall &set_target_temperature_high(optional<float> target_temperature_high); ClimateCall &set_target_temperature_high(optional<float> target_temperature_high);
ESPDEPRECATED("set_away() is deprecated, please use .set_preset(CLIMATE_PRESET_AWAY) instead")
ClimateCall &set_away(bool away); ClimateCall &set_away(bool away);
ESPDEPRECATED("set_away() is deprecated, please use .set_preset(CLIMATE_PRESET_AWAY) instead")
ClimateCall &set_away(optional<bool> away); ClimateCall &set_away(optional<bool> away);
/// Set the fan mode of the climate device. /// Set the fan mode of the climate device.
ClimateCall &set_fan_mode(ClimateFanMode fan_mode); ClimateCall &set_fan_mode(ClimateFanMode fan_mode);
@ -94,7 +96,8 @@ class ClimateCall {
const optional<float> &get_target_temperature() const; const optional<float> &get_target_temperature() const;
const optional<float> &get_target_temperature_low() const; const optional<float> &get_target_temperature_low() const;
const optional<float> &get_target_temperature_high() const; const optional<float> &get_target_temperature_high() const;
const optional<bool> &get_away() const; ESPDEPRECATED("get_away() is deprecated, please use .get_preset() instead")
optional<bool> get_away() const;
const optional<ClimateFanMode> &get_fan_mode() const; const optional<ClimateFanMode> &get_fan_mode() const;
const optional<ClimateSwingMode> &get_swing_mode() const; const optional<ClimateSwingMode> &get_swing_mode() const;
const optional<std::string> &get_custom_fan_mode() const; const optional<std::string> &get_custom_fan_mode() const;
@ -109,7 +112,6 @@ class ClimateCall {
optional<float> target_temperature_; optional<float> target_temperature_;
optional<float> target_temperature_low_; optional<float> target_temperature_low_;
optional<float> target_temperature_high_; optional<float> target_temperature_high_;
optional<bool> away_;
optional<ClimateFanMode> fan_mode_; optional<ClimateFanMode> fan_mode_;
optional<ClimateSwingMode> swing_mode_; optional<ClimateSwingMode> swing_mode_;
optional<std::string> custom_fan_mode_; optional<std::string> custom_fan_mode_;
@ -120,7 +122,6 @@ class ClimateCall {
/// Struct used to save the state of the climate device in restore memory. /// Struct used to save the state of the climate device in restore memory.
struct ClimateDeviceRestoreState { struct ClimateDeviceRestoreState {
ClimateMode mode; ClimateMode mode;
bool away;
bool uses_custom_fan_mode{false}; bool uses_custom_fan_mode{false};
union { union {
ClimateFanMode fan_mode; ClimateFanMode fan_mode;
@ -191,6 +192,7 @@ class Climate : public Nameable {
* Away allows climate devices to have two different target temperature configs: * Away allows climate devices to have two different target temperature configs:
* one for normal mode and one for away mode. * one for normal mode and one for away mode.
*/ */
ESPDEPRECATED("away is deprecated, use preset instead")
bool away{false}; bool away{false};
/// The active fan mode of the climate device. /// The active fan mode of the climate device.

4
esphome/components/climate/climate_mode.cpp
View file

@ -84,6 +84,8 @@ const char *climate_swing_mode_to_string(ClimateSwingMode swing_mode) {
const char *climate_preset_to_string(ClimatePreset preset) { const char *climate_preset_to_string(ClimatePreset preset) {
switch (preset) { switch (preset) {
case climate::CLIMATE_PRESET_HOME:
return "HOME";
case climate::CLIMATE_PRESET_ECO: case climate::CLIMATE_PRESET_ECO:
return "ECO"; return "ECO";
case climate::CLIMATE_PRESET_AWAY: case climate::CLIMATE_PRESET_AWAY:
@ -92,8 +94,6 @@ const char *climate_preset_to_string(ClimatePreset preset) {
return "BOOST"; return "BOOST";
case climate::CLIMATE_PRESET_COMFORT: case climate::CLIMATE_PRESET_COMFORT:
return "COMFORT"; return "COMFORT";
case climate::CLIMATE_PRESET_HOME:
return "HOME";
case climate::CLIMATE_PRESET_SLEEP: case climate::CLIMATE_PRESET_SLEEP:
return "SLEEP"; return "SLEEP";
case climate::CLIMATE_PRESET_ACTIVITY: case climate::CLIMATE_PRESET_ACTIVITY:

9
esphome/components/climate/climate_mode.h
View file

@ -39,7 +39,6 @@ enum ClimateAction : uint8_t {
CLIMATE_ACTION_FAN = 6, CLIMATE_ACTION_FAN = 6,
}; };
/// Enum for all modes a climate fan can be in
enum ClimateFanMode : uint8_t { enum ClimateFanMode : uint8_t {
/// The fan mode is set to On /// The fan mode is set to On
CLIMATE_FAN_ON = 0, CLIMATE_FAN_ON = 0,
@ -75,16 +74,16 @@ enum ClimateSwingMode : uint8_t {
/// Enum for all modes a climate swing can be in /// Enum for all modes a climate swing can be in
enum ClimatePreset : uint8_t { enum ClimatePreset : uint8_t {
/// Preset is set to ECO /// Preset is set to HOME
CLIMATE_PRESET_ECO = 0, CLIMATE_PRESET_HOME = 0,
/// Preset is set to AWAY /// Preset is set to AWAY
CLIMATE_PRESET_AWAY = 1, CLIMATE_PRESET_AWAY = 1,
/// Preset is set to BOOST /// Preset is set to BOOST
CLIMATE_PRESET_BOOST = 2, CLIMATE_PRESET_BOOST = 2,
/// Preset is set to COMFORT /// Preset is set to COMFORT
CLIMATE_PRESET_COMFORT = 3, CLIMATE_PRESET_COMFORT = 3,
/// Preset is set to HOME /// Preset is set to ECO
CLIMATE_PRESET_HOME = 4, CLIMATE_PRESET_ECO = 4,
/// Preset is set to SLEEP /// Preset is set to SLEEP
CLIMATE_PRESET_SLEEP = 5, CLIMATE_PRESET_SLEEP = 5,
/// Preset is set to ACTIVITY /// Preset is set to ACTIVITY

203
esphome/components/climate/climate_traits.cpp
View file

@ -4,55 +4,6 @@
namespace esphome { namespace esphome {
namespace climate { namespace climate {
bool ClimateTraits::supports_mode(ClimateMode mode) const {
switch (mode) {
case CLIMATE_MODE_OFF:
return true;
case CLIMATE_MODE_HEAT_COOL:
return this->supports_heat_cool_mode_;
case CLIMATE_MODE_AUTO:
return this->supports_auto_mode_;
case CLIMATE_MODE_COOL:
return this->supports_cool_mode_;
case CLIMATE_MODE_HEAT:
return this->supports_heat_mode_;
case CLIMATE_MODE_FAN_ONLY:
return this->supports_fan_only_mode_;
case CLIMATE_MODE_DRY:
return this->supports_dry_mode_;
default:
return false;
}
}
bool ClimateTraits::get_supports_current_temperature() const { return supports_current_temperature_; }
void ClimateTraits::set_supports_current_temperature(bool supports_current_temperature) {
supports_current_temperature_ = supports_current_temperature;
}
bool ClimateTraits::get_supports_two_point_target_temperature() const { return supports_two_point_target_temperature_; }
void ClimateTraits::set_supports_two_point_target_temperature(bool supports_two_point_target_temperature) {
supports_two_point_target_temperature_ = supports_two_point_target_temperature;
}
void ClimateTraits::set_supports_auto_mode(bool supports_auto_mode) { supports_auto_mode_ = supports_auto_mode; }
void ClimateTraits::set_supports_heat_cool_mode(bool supports_heat_cool_mode) {
supports_heat_cool_mode_ = supports_heat_cool_mode;
}
void ClimateTraits::set_supports_cool_mode(bool supports_cool_mode) { supports_cool_mode_ = supports_cool_mode; }
void ClimateTraits::set_supports_heat_mode(bool supports_heat_mode) { supports_heat_mode_ = supports_heat_mode; }
void ClimateTraits::set_supports_fan_only_mode(bool supports_fan_only_mode) {
supports_fan_only_mode_ = supports_fan_only_mode;
}
void ClimateTraits::set_supports_dry_mode(bool supports_dry_mode) { supports_dry_mode_ = supports_dry_mode; }
void ClimateTraits::set_supports_away(bool supports_away) { supports_away_ = supports_away; }
void ClimateTraits::set_supports_action(bool supports_action) { supports_action_ = supports_action; }
float ClimateTraits::get_visual_min_temperature() const { return visual_min_temperature_; }
void ClimateTraits::set_visual_min_temperature(float visual_min_temperature) {
visual_min_temperature_ = visual_min_temperature;
}
float ClimateTraits::get_visual_max_temperature() const { return visual_max_temperature_; }
void ClimateTraits::set_visual_max_temperature(float visual_max_temperature) {
visual_max_temperature_ = visual_max_temperature;
}
float ClimateTraits::get_visual_temperature_step() const { return visual_temperature_step_; }
int8_t ClimateTraits::get_temperature_accuracy_decimals() const { int8_t ClimateTraits::get_temperature_accuracy_decimals() const {
// use printf %g to find number of digits based on temperature step // use printf %g to find number of digits based on temperature step
char buf[32]; char buf[32];
@ -64,160 +15,6 @@ int8_t ClimateTraits::get_temperature_accuracy_decimals() const {
return str.length() - dot_pos - 1; return str.length() - dot_pos - 1;
} }
void ClimateTraits::set_visual_temperature_step(float temperature_step) { visual_temperature_step_ = temperature_step; }
bool ClimateTraits::get_supports_away() const { return supports_away_; }
bool ClimateTraits::get_supports_action() const { return supports_action_; }
void ClimateTraits::set_supports_fan_mode_on(bool supports_fan_mode_on) {
this->supports_fan_mode_on_ = supports_fan_mode_on;
}
void ClimateTraits::set_supports_fan_mode_off(bool supports_fan_mode_off) {
this->supports_fan_mode_off_ = supports_fan_mode_off;
}
void ClimateTraits::set_supports_fan_mode_auto(bool supports_fan_mode_auto) {
this->supports_fan_mode_auto_ = supports_fan_mode_auto;
}
void ClimateTraits::set_supports_fan_mode_low(bool supports_fan_mode_low) {
this->supports_fan_mode_low_ = supports_fan_mode_low;
}
void ClimateTraits::set_supports_fan_mode_medium(bool supports_fan_mode_medium) {
this->supports_fan_mode_medium_ = supports_fan_mode_medium;
}
void ClimateTraits::set_supports_fan_mode_high(bool supports_fan_mode_high) {
this->supports_fan_mode_high_ = supports_fan_mode_high;
}
void ClimateTraits::set_supports_fan_mode_middle(bool supports_fan_mode_middle) {
this->supports_fan_mode_middle_ = supports_fan_mode_middle;
}
void ClimateTraits::set_supports_fan_mode_focus(bool supports_fan_mode_focus) {
this->supports_fan_mode_focus_ = supports_fan_mode_focus;
}
void ClimateTraits::set_supports_fan_mode_diffuse(bool supports_fan_mode_diffuse) {
this->supports_fan_mode_diffuse_ = supports_fan_mode_diffuse;
}
bool ClimateTraits::supports_fan_mode(ClimateFanMode fan_mode) const {
switch (fan_mode) {
case climate::CLIMATE_FAN_ON:
return this->supports_fan_mode_on_;
case climate::CLIMATE_FAN_OFF:
return this->supports_fan_mode_off_;
case climate::CLIMATE_FAN_AUTO:
return this->supports_fan_mode_auto_;
case climate::CLIMATE_FAN_LOW:
return this->supports_fan_mode_low_;
case climate::CLIMATE_FAN_MEDIUM:
return this->supports_fan_mode_medium_;
case climate::CLIMATE_FAN_HIGH:
return this->supports_fan_mode_high_;
case climate::CLIMATE_FAN_MIDDLE:
return this->supports_fan_mode_middle_;
case climate::CLIMATE_FAN_FOCUS:
return this->supports_fan_mode_focus_;
case climate::CLIMATE_FAN_DIFFUSE:
return this->supports_fan_mode_diffuse_;
default:
return false;
}
}
bool ClimateTraits::get_supports_fan_modes() const {
return this->supports_fan_mode_on_ || this->supports_fan_mode_off_ || this->supports_fan_mode_auto_ ||
this->supports_fan_mode_low_ || this->supports_fan_mode_medium_ || this->supports_fan_mode_high_ ||
this->supports_fan_mode_middle_ || this->supports_fan_mode_focus_ || this->supports_fan_mode_diffuse_;
}
void ClimateTraits::set_supported_custom_fan_modes(std::vector<std::string> &supported_custom_fan_modes) {
this->supported_custom_fan_modes_ = supported_custom_fan_modes;
}
const std::vector<std::string> ClimateTraits::get_supported_custom_fan_modes() const {
return this->supported_custom_fan_modes_;
}
bool ClimateTraits::supports_custom_fan_mode(std::string &custom_fan_mode) const {
return std::count(this->supported_custom_fan_modes_.begin(), this->supported_custom_fan_modes_.end(),
custom_fan_mode);
}
bool ClimateTraits::supports_preset(ClimatePreset preset) const {
switch (preset) {
case climate::CLIMATE_PRESET_ECO:
return this->supports_preset_eco_;
case climate::CLIMATE_PRESET_AWAY:
return this->supports_preset_away_;
case climate::CLIMATE_PRESET_BOOST:
return this->supports_preset_boost_;
case climate::CLIMATE_PRESET_COMFORT:
return this->supports_preset_comfort_;
case climate::CLIMATE_PRESET_HOME:
return this->supports_preset_home_;
case climate::CLIMATE_PRESET_SLEEP:
return this->supports_preset_sleep_;
case climate::CLIMATE_PRESET_ACTIVITY:
return this->supports_preset_activity_;
default:
return false;
}
}
void ClimateTraits::set_supports_preset_eco(bool supports_preset_eco) {
this->supports_preset_eco_ = supports_preset_eco;
}
void ClimateTraits::set_supports_preset_away(bool supports_preset_away) {
this->supports_preset_away_ = supports_preset_away;
}
void ClimateTraits::set_supports_preset_boost(bool supports_preset_boost) {
this->supports_preset_boost_ = supports_preset_boost;
}
void ClimateTraits::set_supports_preset_comfort(bool supports_preset_comfort) {
this->supports_preset_comfort_ = supports_preset_comfort;
}
void ClimateTraits::set_supports_preset_home(bool supports_preset_home) {
this->supports_preset_home_ = supports_preset_home;
}
void ClimateTraits::set_supports_preset_sleep(bool supports_preset_sleep) {
this->supports_preset_sleep_ = supports_preset_sleep;
}
void ClimateTraits::set_supports_preset_activity(bool supports_preset_activity) {
this->supports_preset_activity_ = supports_preset_activity;
}
bool ClimateTraits::get_supports_presets() const {
return this->supports_preset_eco_ || this->supports_preset_away_ || this->supports_preset_boost_ ||
this->supports_preset_comfort_ || this->supports_preset_home_ || this->supports_preset_sleep_ ||
this->supports_preset_activity_;
}
void ClimateTraits::set_supported_custom_presets(std::vector<std::string> &supported_custom_presets) {
this->supported_custom_presets_ = supported_custom_presets;
}
const std::vector<std::string> ClimateTraits::get_supported_custom_presets() const {
return this->supported_custom_presets_;
}
bool ClimateTraits::supports_custom_preset(std::string &custom_preset) const {
return std::count(this->supported_custom_presets_.begin(), this->supported_custom_presets_.end(), custom_preset);
}
void ClimateTraits::set_supports_swing_mode_off(bool supports_swing_mode_off) {
this->supports_swing_mode_off_ = supports_swing_mode_off;
}
void ClimateTraits::set_supports_swing_mode_both(bool supports_swing_mode_both) {
this->supports_swing_mode_both_ = supports_swing_mode_both;
}
void ClimateTraits::set_supports_swing_mode_vertical(bool supports_swing_mode_vertical) {
this->supports_swing_mode_vertical_ = supports_swing_mode_vertical;
}
void ClimateTraits::set_supports_swing_mode_horizontal(bool supports_swing_mode_horizontal) {
this->supports_swing_mode_horizontal_ = supports_swing_mode_horizontal;
}
bool ClimateTraits::supports_swing_mode(ClimateSwingMode swing_mode) const {
switch (swing_mode) {
case climate::CLIMATE_SWING_OFF:
return this->supports_swing_mode_off_;
case climate::CLIMATE_SWING_BOTH:
return this->supports_swing_mode_both_;
case climate::CLIMATE_SWING_VERTICAL:
return this->supports_swing_mode_vertical_;
case climate::CLIMATE_SWING_HORIZONTAL:
return this->supports_swing_mode_horizontal_;
default:
return false;
}
}
bool ClimateTraits::get_supports_swing_modes() const {
return this->supports_swing_mode_off_ || this->supports_swing_mode_both_ || supports_swing_mode_vertical_ ||
supports_swing_mode_horizontal_;
}
} // namespace climate } // namespace climate
} // namespace esphome } // namespace esphome

219
esphome/components/climate/climate_traits.h
View file

@ -2,6 +2,7 @@
#include "esphome/core/helpers.h" #include "esphome/core/helpers.h"
#include "climate_mode.h" #include "climate_mode.h"
#include <set>
namespace esphome { namespace esphome {
namespace climate { namespace climate {
@ -24,8 +25,6 @@ namespace climate {
* - heat mode (increases current temperature) * - heat mode (increases current temperature)
* - dry mode (removes humidity from air) * - dry mode (removes humidity from air)
* - fan mode (only turns on fan) * - fan mode (only turns on fan)
* - supports away - away mode means that the climate device supports two different
* target temperature settings: one target temp setting for "away" mode and one for non-away mode.
* - supports action - if the climate device supports reporting the active * - supports action - if the climate device supports reporting the active
* current action of the device with the action property. * current action of the device with the action property.
* - supports fan modes - optionally, if it has a fan which can be configured in different ways: * - supports fan modes - optionally, if it has a fan which can be configured in different ways:
@ -41,95 +40,147 @@ namespace climate {
*/ */
class ClimateTraits { class ClimateTraits {
public: public:
bool get_supports_current_temperature() const; bool get_supports_current_temperature() const { return supports_current_temperature_; }
void set_supports_current_temperature(bool supports_current_temperature); void set_supports_current_temperature(bool supports_current_temperature) {
bool get_supports_two_point_target_temperature() const; supports_current_temperature_ = supports_current_temperature;
void set_supports_two_point_target_temperature(bool supports_two_point_target_temperature); }
void set_supports_auto_mode(bool supports_auto_mode); bool get_supports_two_point_target_temperature() const { return supports_two_point_target_temperature_; }
void set_supports_heat_cool_mode(bool supports_heat_cool_mode); void set_supports_two_point_target_temperature(bool supports_two_point_target_temperature) {
void set_supports_cool_mode(bool supports_cool_mode); supports_two_point_target_temperature_ = supports_two_point_target_temperature;
void set_supports_heat_mode(bool supports_heat_mode); }
void set_supports_fan_only_mode(bool supports_fan_only_mode); void set_supported_modes(std::set<ClimateMode> modes) { supported_modes_ = std::move(modes); }
void set_supports_dry_mode(bool supports_dry_mode); void add_supported_mode(ClimateMode mode) { supported_modes_.insert(mode); }
void set_supports_away(bool supports_away); ESPDEPRECATED("This method is deprecated, use set_supported_modes() instead")
bool get_supports_away() const; void set_supports_auto_mode(bool supports_auto_mode) { set_mode_support_(CLIMATE_MODE_AUTO, supports_auto_mode); }
void set_supports_action(bool supports_action); ESPDEPRECATED("This method is deprecated, use set_supported_modes() instead")
bool get_supports_action() const; void set_supports_cool_mode(bool supports_cool_mode) { set_mode_support_(CLIMATE_MODE_COOL, supports_cool_mode); }
bool supports_mode(ClimateMode mode) const; ESPDEPRECATED("This method is deprecated, use set_supported_modes() instead")
void set_supports_fan_mode_on(bool supports_fan_mode_on); void set_supports_heat_mode(bool supports_heat_mode) { set_mode_support_(CLIMATE_MODE_HEAT, supports_heat_mode); }
void set_supports_fan_mode_off(bool supports_fan_mode_off); ESPDEPRECATED("This method is deprecated, use set_supported_modes() instead")
void set_supports_fan_mode_auto(bool supports_fan_mode_auto); void set_supports_heat_cool_mode(bool supported) { set_mode_support_(CLIMATE_MODE_HEAT_COOL, supported); }
void set_supports_fan_mode_low(bool supports_fan_mode_low); ESPDEPRECATED("This method is deprecated, use set_supported_modes() instead")
void set_supports_fan_mode_medium(bool supports_fan_mode_medium); void set_supports_fan_only_mode(bool supports_fan_only_mode) {
void set_supports_fan_mode_high(bool supports_fan_mode_high); set_mode_support_(CLIMATE_MODE_FAN_ONLY, supports_fan_only_mode);
void set_supports_fan_mode_middle(bool supports_fan_mode_middle); }
void set_supports_fan_mode_focus(bool supports_fan_mode_focus); ESPDEPRECATED("This method is deprecated, use set_supported_modes() instead")
void set_supports_fan_mode_diffuse(bool supports_fan_mode_diffuse); void set_supports_dry_mode(bool supports_dry_mode) { set_mode_support_(CLIMATE_MODE_DRY, supports_dry_mode); }
bool supports_fan_mode(ClimateFanMode fan_mode) const; bool supports_mode(ClimateMode mode) const { return supported_modes_.count(mode); }
bool get_supports_fan_modes() const; const std::set<ClimateMode> get_supported_modes() const { return supported_modes_; }
void set_supported_custom_fan_modes(std::vector<std::string> &supported_custom_fan_modes);
const std::vector<std::string> get_supported_custom_fan_modes() const;
bool supports_custom_fan_mode(std::string &custom_fan_mode) const;
bool supports_preset(ClimatePreset preset) const;
void set_supports_preset_eco(bool supports_preset_eco);
void set_supports_preset_away(bool supports_preset_away);
void set_supports_preset_boost(bool supports_preset_boost);
void set_supports_preset_comfort(bool supports_preset_comfort);
void set_supports_preset_home(bool supports_preset_home);
void set_supports_preset_sleep(bool supports_preset_sleep);
void set_supports_preset_activity(bool supports_preset_activity);
bool get_supports_presets() const;
void set_supported_custom_presets(std::vector<std::string> &supported_custom_presets);
const std::vector<std::string> get_supported_custom_presets() const;
bool supports_custom_preset(std::string &custom_preset) const;
void set_supports_swing_mode_off(bool supports_swing_mode_off);
void set_supports_swing_mode_both(bool supports_swing_mode_both);
void set_supports_swing_mode_vertical(bool supports_swing_mode_vertical);
void set_supports_swing_mode_horizontal(bool supports_swing_mode_horizontal);
bool supports_swing_mode(ClimateSwingMode swing_mode) const;
bool get_supports_swing_modes() const;
float get_visual_min_temperature() const; void set_supports_action(bool supports_action) { supports_action_ = supports_action; }
void set_visual_min_temperature(float visual_min_temperature); bool get_supports_action() const { return supports_action_; }
float get_visual_max_temperature() const;
void set_visual_max_temperature(float visual_max_temperature); void set_supported_fan_modes(std::set<ClimateFanMode> modes) { supported_fan_modes_ = std::move(modes); }
float get_visual_temperature_step() const; void add_supported_fan_mode(ClimateFanMode mode) { supported_fan_modes_.insert(mode); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_fan_mode_on(bool supported) { set_fan_mode_support_(CLIMATE_FAN_ON, supported); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_fan_mode_off(bool supported) { set_fan_mode_support_(CLIMATE_FAN_OFF, supported); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_fan_mode_auto(bool supported) { set_fan_mode_support_(CLIMATE_FAN_AUTO, supported); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_fan_mode_low(bool supported) { set_fan_mode_support_(CLIMATE_FAN_LOW, supported); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_fan_mode_medium(bool supported) { set_fan_mode_support_(CLIMATE_FAN_MEDIUM, supported); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_fan_mode_high(bool supported) { set_fan_mode_support_(CLIMATE_FAN_HIGH, supported); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_fan_mode_middle(bool supported) { set_fan_mode_support_(CLIMATE_FAN_MIDDLE, supported); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_fan_mode_focus(bool supported) { set_fan_mode_support_(CLIMATE_FAN_FOCUS, supported); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_fan_mode_diffuse(bool supported) { set_fan_mode_support_(CLIMATE_FAN_DIFFUSE, supported); }
bool supports_fan_mode(ClimateFanMode fan_mode) const { return supported_fan_modes_.count(fan_mode); }
bool get_supports_fan_modes() const { return !supported_fan_modes_.empty(); }
const std::set<ClimateFanMode> get_supported_fan_modes() const { return supported_fan_modes_; }
void set_supported_custom_fan_modes(std::set<std::string> supported_custom_fan_modes) {
supported_custom_fan_modes_ = std::move(supported_custom_fan_modes);
}
const std::set<std::string> &get_supported_custom_fan_modes() const { return supported_custom_fan_modes_; }
bool supports_custom_fan_mode(const std::string &custom_fan_mode) const {
return supported_custom_fan_modes_.count(custom_fan_mode);
}
void set_supported_presets(std::set<ClimatePreset> presets) { supported_presets_ = std::move(presets); }
void add_supported_preset(ClimatePreset preset) { supported_presets_.insert(preset); }
bool supports_preset(ClimatePreset preset) const { return supported_presets_.count(preset); }
bool get_supports_presets() const { return !supported_presets_.empty(); }
const std::set<climate::ClimatePreset> &get_supported_presets() const { return supported_presets_; }
void set_supported_custom_presets(std::set<std::string> supported_custom_presets) {
supported_custom_presets_ = std::move(supported_custom_presets);
}
const std::set<std::string> &get_supported_custom_presets() const { return supported_custom_presets_; }
bool supports_custom_preset(const std::string &custom_preset) const {
return supported_custom_presets_.count(custom_preset);
}
ESPDEPRECATED("This method is deprecated, use set_supported_presets() instead")
void set_supports_away(bool supports) {
if (supports) {
supported_presets_.insert(CLIMATE_PRESET_AWAY);
supported_presets_.insert(CLIMATE_PRESET_HOME);
}
}
ESPDEPRECATED("This method is deprecated, use supports_preset() instead")
bool get_supports_away() const { return supports_preset(CLIMATE_PRESET_AWAY); }
void set_supported_swing_modes(std::set<ClimateSwingMode> modes) { supported_swing_modes_ = std::move(modes); }
void add_supported_swing_mode(ClimateSwingMode mode) { supported_swing_modes_.insert(mode); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_swing_mode_off(bool supported) { set_swing_mode_support_(CLIMATE_SWING_OFF, supported); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_swing_mode_both(bool supported) { set_swing_mode_support_(CLIMATE_SWING_BOTH, supported); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_swing_mode_vertical(bool supported) { set_swing_mode_support_(CLIMATE_SWING_VERTICAL, supported); }
ESPDEPRECATED("This method is deprecated, use set_supported_fan_modes() instead")
void set_supports_swing_mode_horizontal(bool supported) {
set_swing_mode_support_(CLIMATE_SWING_HORIZONTAL, supported);
}
bool supports_swing_mode(ClimateSwingMode swing_mode) const { return supported_swing_modes_.count(swing_mode); }
bool get_supports_swing_modes() const { return !supported_swing_modes_.empty(); }
const std::set<ClimateSwingMode> get_supported_swing_modes() { return supported_swing_modes_; }
float get_visual_min_temperature() const { return visual_min_temperature_; }
void set_visual_min_temperature(float visual_min_temperature) { visual_min_temperature_ = visual_min_temperature; }
float get_visual_max_temperature() const { return visual_max_temperature_; }
void set_visual_max_temperature(float visual_max_temperature) { visual_max_temperature_ = visual_max_temperature; }
float get_visual_temperature_step() const { return visual_temperature_step_; }
int8_t get_temperature_accuracy_decimals() const; int8_t get_temperature_accuracy_decimals() const;
void set_visual_temperature_step(float temperature_step); void set_visual_temperature_step(float temperature_step) { visual_temperature_step_ = temperature_step; }
protected: protected:
void set_mode_support_(climate::ClimateMode mode, bool supported) {
if (supported) {
supported_modes_.insert(mode);
} else {
supported_modes_.erase(mode);
}
}
void set_fan_mode_support_(climate::ClimateFanMode mode, bool supported) {
if (supported) {
supported_fan_modes_.insert(mode);
} else {
supported_fan_modes_.erase(mode);
}
}
void set_swing_mode_support_(climate::ClimateSwingMode mode, bool supported) {
if (supported) {
supported_swing_modes_.insert(mode);
} else {
supported_swing_modes_.erase(mode);
}
}
bool supports_current_temperature_{false}; bool supports_current_temperature_{false};
bool supports_two_point_target_temperature_{false}; bool supports_two_point_target_temperature_{false};
bool supports_auto_mode_{false}; std::set<climate::ClimateMode> supported_modes_ = {climate::CLIMATE_MODE_OFF};
bool supports_heat_cool_mode_{false};
bool supports_cool_mode_{false};
bool supports_heat_mode_{false};
bool supports_fan_only_mode_{false};
bool supports_dry_mode_{false};
bool supports_away_{false};
bool supports_action_{false}; bool supports_action_{false};
bool supports_fan_mode_on_{false}; std::set<climate::ClimateFanMode> supported_fan_modes_;
bool supports_fan_mode_off_{false}; std::set<climate::ClimateSwingMode> supported_swing_modes_;
bool supports_fan_mode_auto_{false}; std::set<climate::ClimatePreset> supported_presets_;
bool supports_fan_mode_low_{false}; std::set<std::string> supported_custom_fan_modes_;
bool supports_fan_mode_medium_{false}; std::set<std::string> supported_custom_presets_;
bool supports_fan_mode_high_{false};
bool supports_fan_mode_middle_{false};
bool supports_fan_mode_focus_{false};
bool supports_fan_mode_diffuse_{false};
bool supports_swing_mode_off_{false};
bool supports_swing_mode_both_{false};
bool supports_swing_mode_vertical_{false};
bool supports_swing_mode_horizontal_{false};
bool supports_preset_eco_{false};
bool supports_preset_away_{false};
bool supports_preset_boost_{false};
bool supports_preset_comfort_{false};
bool supports_preset_home_{false};
bool supports_preset_sleep_{false};
bool supports_preset_activity_{false};
std::vector<std::string> supported_custom_fan_modes_;
std::vector<std::string> supported_custom_presets_;
float visual_min_temperature_{10}; float visual_min_temperature_{10};
float visual_max_temperature_{30}; float visual_max_temperature_{30};

65
esphome/components/climate_ir/climate_ir.cpp
View file

@ -9,63 +9,22 @@ static const char *TAG = "climate_ir";
climate::ClimateTraits ClimateIR::traits() { climate::ClimateTraits ClimateIR::traits() {
auto traits = climate::ClimateTraits(); auto traits = climate::ClimateTraits();
traits.set_supports_current_temperature(this->sensor_ != nullptr); traits.set_supports_current_temperature(this->sensor_ != nullptr);
traits.set_supports_heat_cool_mode(true); traits.set_supported_modes({climate::CLIMATE_MODE_OFF, climate::CLIMATE_MODE_HEAT_COOL});
traits.set_supports_cool_mode(this->supports_cool_); if (supports_cool_)
traits.set_supports_heat_mode(this->supports_heat_); traits.add_supported_mode(climate::CLIMATE_MODE_COOL);
traits.set_supports_dry_mode(this->supports_dry_); if (supports_heat_)
traits.set_supports_fan_only_mode(this->supports_fan_only_); traits.add_supported_mode(climate::CLIMATE_MODE_HEAT);
if (supports_dry_)
traits.add_supported_mode(climate::CLIMATE_MODE_DRY);
if (supports_fan_only_)
traits.add_supported_mode(climate::CLIMATE_MODE_FAN_ONLY);
traits.set_supports_two_point_target_temperature(false); traits.set_supports_two_point_target_temperature(false);
traits.set_supports_away(false);
traits.set_visual_min_temperature(this->minimum_temperature_); traits.set_visual_min_temperature(this->minimum_temperature_);
traits.set_visual_max_temperature(this->maximum_temperature_); traits.set_visual_max_temperature(this->maximum_temperature_);
traits.set_visual_temperature_step(this->temperature_step_); traits.set_visual_temperature_step(this->temperature_step_);
for (auto fan_mode : this->fan_modes_) { traits.set_supported_fan_modes(fan_modes_);
switch (fan_mode) { traits.set_supported_swing_modes(swing_modes_);
case climate::CLIMATE_FAN_AUTO:
traits.set_supports_fan_mode_auto(true);
break;
case climate::CLIMATE_FAN_DIFFUSE:
traits.set_supports_fan_mode_diffuse(true);
break;
case climate::CLIMATE_FAN_FOCUS:
traits.set_supports_fan_mode_focus(true);
break;
case climate::CLIMATE_FAN_HIGH:
traits.set_supports_fan_mode_high(true);
break;
case climate::CLIMATE_FAN_LOW:
traits.set_supports_fan_mode_low(true);
break;
case climate::CLIMATE_FAN_MEDIUM:
traits.set_supports_fan_mode_medium(true);
break;
case climate::CLIMATE_FAN_MIDDLE:
traits.set_supports_fan_mode_middle(true);
break;
case climate::CLIMATE_FAN_OFF:
traits.set_supports_fan_mode_off(true);
break;
case climate::CLIMATE_FAN_ON:
traits.set_supports_fan_mode_on(true);
break;
}
}
for (auto swing_mode : this->swing_modes_) {
switch (swing_mode) {
case climate::CLIMATE_SWING_OFF:
traits.set_supports_swing_mode_off(true);
break;
case climate::CLIMATE_SWING_BOTH:
traits.set_supports_swing_mode_both(true);
break;
case climate::CLIMATE_SWING_VERTICAL:
traits.set_supports_swing_mode_vertical(true);
break;
case climate::CLIMATE_SWING_HORIZONTAL:
traits.set_supports_swing_mode_horizontal(true);
break;
}
}
return traits; return traits;
} }

9
esphome/components/climate_ir/climate_ir.h
View file

@ -19,9 +19,8 @@ namespace climate_ir {
class ClimateIR : public climate::Climate, public Component, public remote_base::RemoteReceiverListener { class ClimateIR : public climate::Climate, public Component, public remote_base::RemoteReceiverListener {
public: public:
ClimateIR(float minimum_temperature, float maximum_temperature, float temperature_step = 1.0f, ClimateIR(float minimum_temperature, float maximum_temperature, float temperature_step = 1.0f,
bool supports_dry = false, bool supports_fan_only = false, bool supports_dry = false, bool supports_fan_only = false, std::set<climate::ClimateFanMode> fan_modes = {},
std::vector<climate::ClimateFanMode> fan_modes = {}, std::set<climate::ClimateSwingMode> swing_modes = {}) {
std::vector<climate::ClimateSwingMode> swing_modes = {}) {
this->minimum_temperature_ = minimum_temperature; this->minimum_temperature_ = minimum_temperature;
this->maximum_temperature_ = maximum_temperature; this->maximum_temperature_ = maximum_temperature;
this->temperature_step_ = temperature_step; this->temperature_step_ = temperature_step;
@ -58,8 +57,8 @@ class ClimateIR : public climate::Climate, public Component, public remote_base:
bool supports_heat_{true}; bool supports_heat_{true};
bool supports_dry_{false}; bool supports_dry_{false};
bool supports_fan_only_{false}; bool supports_fan_only_{false};
std::vector<climate::ClimateFanMode> fan_modes_ = {}; std::set<climate::ClimateFanMode> fan_modes_ = {};
std::vector<climate::ClimateSwingMode> swing_modes_ = {}; std::set<climate::ClimateSwingMode> swing_modes_ = {};
remote_transmitter::RemoteTransmitterComponent *transmitter_; remote_transmitter::RemoteTransmitterComponent *transmitter_;
sensor::Sensor *sensor_{nullptr}; sensor::Sensor *sensor_{nullptr};

11
esphome/components/daikin/daikin.h
View file

@ -43,12 +43,11 @@ const uint8_t DAIKIN_STATE_FRAME_SIZE = 19;
class DaikinClimate : public climate_ir::ClimateIR { class DaikinClimate : public climate_ir::ClimateIR {
public: public:
DaikinClimate() DaikinClimate()
: climate_ir::ClimateIR( : climate_ir::ClimateIR(DAIKIN_TEMP_MIN, DAIKIN_TEMP_MAX, 1.0f, true, true,
DAIKIN_TEMP_MIN, DAIKIN_TEMP_MAX, 1.0f, true, true, {climate::CLIMATE_FAN_AUTO, climate::CLIMATE_FAN_LOW, climate::CLIMATE_FAN_MEDIUM,
std::vector<climate::ClimateFanMode>{climate::CLIMATE_FAN_AUTO, climate::CLIMATE_FAN_LOW, climate::CLIMATE_FAN_HIGH},
climate::CLIMATE_FAN_MEDIUM, climate::CLIMATE_FAN_HIGH}, {climate::CLIMATE_SWING_OFF, climate::CLIMATE_SWING_VERTICAL,
std::vector<climate::ClimateSwingMode>{climate::CLIMATE_SWING_OFF, climate::CLIMATE_SWING_VERTICAL, climate::CLIMATE_SWING_HORIZONTAL, climate::CLIMATE_SWING_BOTH}) {}
climate::CLIMATE_SWING_HORIZONTAL, climate::CLIMATE_SWING_BOTH}) {}
protected: protected:
// Transmit via IR the state of this climate controller. // Transmit via IR the state of this climate controller.

9
esphome/components/hitachi_ac344/hitachi_ac344.h
View file

@ -79,11 +79,10 @@ const uint16_t HITACHI_AC344_BITS = HITACHI_AC344_STATE_LENGTH * 8;
class HitachiClimate : public climate_ir::ClimateIR { class HitachiClimate : public climate_ir::ClimateIR {
public: public:
HitachiClimate() HitachiClimate()
: climate_ir::ClimateIR( : climate_ir::ClimateIR(HITACHI_AC344_TEMP_MIN, HITACHI_AC344_TEMP_MAX, 1.0F, true, true,
HITACHI_AC344_TEMP_MIN, HITACHI_AC344_TEMP_MAX, 1.0F, true, true, {climate::CLIMATE_FAN_AUTO, climate::CLIMATE_FAN_LOW, climate::CLIMATE_FAN_MEDIUM,
std::vector<climate::ClimateFanMode>{climate::CLIMATE_FAN_AUTO, climate::CLIMATE_FAN_LOW, climate::CLIMATE_FAN_HIGH},
climate::CLIMATE_FAN_MEDIUM, climate::CLIMATE_FAN_HIGH}, {climate::CLIMATE_SWING_OFF, climate::CLIMATE_SWING_HORIZONTAL}) {}
std::vector<climate::ClimateSwingMode>{climate::CLIMATE_SWING_OFF, climate::CLIMATE_SWING_HORIZONTAL}) {}
protected: protected:
uint8_t remote_state_[HITACHI_AC344_STATE_LENGTH]{0x01, 0x10, 0x00, 0x40, 0x00, 0xFF, 0x00, 0xCC, 0x00, 0x00, 0x00, uint8_t remote_state_[HITACHI_AC344_STATE_LENGTH]{0x01, 0x10, 0x00, 0x40, 0x00, 0xFF, 0x00, 0xCC, 0x00, 0x00, 0x00,

48
esphome/components/midea_ac/midea_climate.cpp
View file

@ -167,24 +167,38 @@ climate::ClimateTraits MideaAC::traits() {
traits.set_visual_min_temperature(17); traits.set_visual_min_temperature(17);
traits.set_visual_max_temperature(30); traits.set_visual_max_temperature(30);
traits.set_visual_temperature_step(0.5); traits.set_visual_temperature_step(0.5);
traits.set_supports_heat_cool_mode(true); traits.set_supported_modes({
traits.set_supports_cool_mode(true); climate::CLIMATE_MODE_OFF,
traits.set_supports_dry_mode(true); climate::CLIMATE_MODE_HEAT_COOL,
traits.set_supports_heat_mode(true); climate::CLIMATE_MODE_COOL,
traits.set_supports_fan_only_mode(true); climate::CLIMATE_MODE_DRY,
traits.set_supports_fan_mode_auto(true); climate::CLIMATE_MODE_HEAT,
traits.set_supports_fan_mode_low(true); climate::CLIMATE_MODE_FAN_ONLY,
traits.set_supports_fan_mode_medium(true); });
traits.set_supports_fan_mode_high(true); traits.set_supported_fan_modes({
climate::CLIMATE_FAN_AUTO,
climate::CLIMATE_FAN_LOW,
climate::CLIMATE_FAN_MEDIUM,
climate::CLIMATE_FAN_HIGH,
});
traits.set_supported_custom_fan_modes(this->traits_custom_fan_modes_); traits.set_supported_custom_fan_modes(this->traits_custom_fan_modes_);
traits.set_supports_swing_mode_off(true); traits.set_supported_swing_modes({
traits.set_supports_swing_mode_vertical(true); climate::CLIMATE_SWING_OFF,
traits.set_supports_swing_mode_horizontal(this->traits_swing_horizontal_); climate::CLIMATE_SWING_VERTICAL,
traits.set_supports_swing_mode_both(this->traits_swing_both_); });
traits.set_supports_preset_home(true); if (traits_swing_horizontal_)
traits.set_supports_preset_eco(this->traits_preset_eco_); traits.add_supported_swing_mode(climate::CLIMATE_SWING_HORIZONTAL);
traits.set_supports_preset_sleep(this->traits_preset_sleep_); if (traits_swing_both_)
traits.set_supports_preset_boost(this->traits_preset_boost_); traits.add_supported_swing_mode(climate::CLIMATE_SWING_BOTH);
traits.set_supported_presets({
climate::CLIMATE_PRESET_HOME,
});
if (traits_preset_eco_)
traits.add_supported_preset(climate::CLIMATE_PRESET_ECO);
if (traits_preset_sleep_)
traits.add_supported_preset(climate::CLIMATE_PRESET_SLEEP);
if (traits_preset_boost_)
traits.add_supported_preset(climate::CLIMATE_PRESET_BOOST);
traits.set_supported_custom_presets(this->traits_custom_presets_); traits.set_supported_custom_presets(this->traits_custom_presets_);
traits.set_supports_current_temperature(true); traits.set_supports_current_temperature(true);
return traits; return traits;

18
esphome/components/midea_ac/midea_climate.h
View file

@ -1,9 +1,9 @@
#pragma once #pragma once
#include "esphome/core/component.h"
#include "esphome/components/sensor/sensor.h"
#include "esphome/components/midea_dongle/midea_dongle.h"
#include "esphome/components/climate/climate.h" #include "esphome/components/climate/climate.h"
#include "esphome/components/midea_dongle/midea_dongle.h"
#include "esphome/components/sensor/sensor.h"
#include "esphome/core/component.h"
#include "midea_frame.h" #include "midea_frame.h"
namespace esphome { namespace esphome {
@ -26,10 +26,12 @@ class MideaAC : public midea_dongle::MideaAppliance, public climate::Climate, pu
void set_preset_sleep(bool state) { this->traits_preset_sleep_ = state; } void set_preset_sleep(bool state) { this->traits_preset_sleep_ = state; }
void set_preset_boost(bool state) { this->traits_preset_boost_ = state; } void set_preset_boost(bool state) { this->traits_preset_boost_ = state; }
bool allow_preset(climate::ClimatePreset preset) const; bool allow_preset(climate::ClimatePreset preset) const;
void set_custom_fan_modes(std::vector<std::string> custom_fan_modes) { void set_custom_fan_modes(std::set<std::string> custom_fan_modes) {
this->traits_custom_fan_modes_ = custom_fan_modes; this->traits_custom_fan_modes_ = std::move(custom_fan_modes);
}
void set_custom_presets(std::set<std::string> custom_presets) {
this->traits_custom_presets_ = std::move(custom_presets);
} }
void set_custom_presets(std::vector<std::string> custom_presets) { this->traits_custom_presets_ = custom_presets; }
bool allow_custom_preset(const std::string &custom_preset) const; bool allow_custom_preset(const std::string &custom_preset) const;
protected: protected:
@ -53,8 +55,8 @@ class MideaAC : public midea_dongle::MideaAppliance, public climate::Climate, pu
bool traits_preset_eco_{false}; bool traits_preset_eco_{false};
bool traits_preset_sleep_{false}; bool traits_preset_sleep_{false};
bool traits_preset_boost_{false}; bool traits_preset_boost_{false};
std::vector<std::string> traits_custom_fan_modes_{{}}; std::set<std::string> traits_custom_fan_modes_{{}};
std::vector<std::string> traits_custom_presets_{{}}; std::set<std::string> traits_custom_presets_{{}};
}; };
} // namespace midea_ac } // namespace midea_ac

14
esphome/components/mqtt/mqtt_climate.cpp
View file

@ -61,7 +61,7 @@ void MQTTClimateComponent::send_discovery(JsonObject &root, mqtt::SendDiscoveryC
// temp_step // temp_step
root["temp_step"] = traits.get_visual_temperature_step(); root["temp_step"] = traits.get_visual_temperature_step();
if (traits.get_supports_away()) { if (traits.supports_preset(CLIMATE_PRESET_AWAY)) {
// away_mode_command_topic // away_mode_command_topic
root["away_mode_cmd_t"] = this->get_away_command_topic(); root["away_mode_cmd_t"] = this->get_away_command_topic();
// away_mode_state_topic // away_mode_state_topic
@ -164,19 +164,19 @@ void MQTTClimateComponent::setup() {
}); });
} }
if (traits.get_supports_away()) { if (traits.supports_preset(CLIMATE_PRESET_AWAY)) {
this->subscribe(this->get_away_command_topic(), [this](const std::string &topic, const std::string &payload) { this->subscribe(this->get_away_command_topic(), [this](const std::string &topic, const std::string &payload) {
auto onoff = parse_on_off(payload.c_str()); auto onoff = parse_on_off(payload.c_str());
auto call = this->device_->make_call(); auto call = this->device_->make_call();
switch (onoff) { switch (onoff) {
case PARSE_ON: case PARSE_ON:
call.set_away(true); call.set_preset(CLIMATE_PRESET_AWAY);
break; break;
case PARSE_OFF: case PARSE_OFF:
call.set_away(false); call.set_preset(CLIMATE_PRESET_HOME);
break; break;
case PARSE_TOGGLE: case PARSE_TOGGLE:
call.set_away(!this->device_->away); call.set_preset(this->device_->preset == CLIMATE_PRESET_AWAY ? CLIMATE_PRESET_HOME : CLIMATE_PRESET_AWAY);
break; break;
case PARSE_NONE: case PARSE_NONE:
default: default:
@ -259,8 +259,8 @@ bool MQTTClimateComponent::publish_state_() {
success = false; success = false;
} }
if (traits.get_supports_away()) { if (traits.supports_preset(CLIMATE_PRESET_AWAY)) {
std::string payload = ONOFF(this->device_->away); std::string payload = ONOFF(this->device_->preset == CLIMATE_PRESET_AWAY);
if (!this->publish(this->get_away_state_topic(), payload)) if (!this->publish(this->get_away_state_topic(), payload))
success = false; success = false;
} }

10
esphome/components/pid/pid_climate.cpp
View file

@ -39,10 +39,14 @@ void PIDClimate::control(const climate::ClimateCall &call) {
climate::ClimateTraits PIDClimate::traits() { climate::ClimateTraits PIDClimate::traits() {
auto traits = climate::ClimateTraits(); auto traits = climate::ClimateTraits();
traits.set_supports_current_temperature(true); traits.set_supports_current_temperature(true);
traits.set_supports_heat_cool_mode(true);
traits.set_supports_two_point_target_temperature(false); traits.set_supports_two_point_target_temperature(false);
traits.set_supports_cool_mode(this->supports_cool_());
traits.set_supports_heat_mode(this->supports_heat_()); traits.set_supported_modes({climate::CLIMATE_MODE_OFF, climate::CLIMATE_MODE_HEAT_COOL});
if (supports_cool_())
traits.add_supported_mode(climate::CLIMATE_MODE_COOL);
if (supports_heat_())
traits.add_supported_mode(climate::CLIMATE_MODE_HEAT);
traits.set_supports_action(true); traits.set_supports_action(true);
return traits; return traits;
} }

73
esphome/components/thermostat/thermostat_climate.cpp
View file

@ -50,12 +50,13 @@ void ThermostatClimate::control(const climate::ClimateCall &call) {
this->target_temperature_low = *call.get_target_temperature_low(); this->target_temperature_low = *call.get_target_temperature_low();
if (call.get_target_temperature_high().has_value()) if (call.get_target_temperature_high().has_value())
this->target_temperature_high = *call.get_target_temperature_high(); this->target_temperature_high = *call.get_target_temperature_high();
if (call.get_away().has_value()) { if (call.get_preset().has_value()) {
// setup_complete_ blocks modifying/resetting the temps immediately after boot // setup_complete_ blocks modifying/resetting the temps immediately after boot
if (this->setup_complete_) { if (this->setup_complete_) {
this->change_away_(*call.get_away()); this->change_away_(*call.get_preset() == climate::CLIMATE_PRESET_AWAY);
} else { } else {
this->away = *call.get_away(); this->preset = *call.get_preset();
;
} }
} }
// set point validation // set point validation
@ -78,27 +79,51 @@ void ThermostatClimate::control(const climate::ClimateCall &call) {
climate::ClimateTraits ThermostatClimate::traits() { climate::ClimateTraits ThermostatClimate::traits() {
auto traits = climate::ClimateTraits(); auto traits = climate::ClimateTraits();
traits.set_supports_current_temperature(true); traits.set_supports_current_temperature(true);
traits.set_supports_auto_mode(this->supports_auto_); if (supports_auto_)
traits.set_supports_heat_cool_mode(this->supports_heat_cool_); traits.add_supported_mode(climate::CLIMATE_MODE_AUTO);
traits.set_supports_cool_mode(this->supports_cool_); if (supports_heat_cool_)
traits.set_supports_dry_mode(this->supports_dry_); traits.add_supported_mode(climate::CLIMATE_MODE_HEAT_COOL);
traits.set_supports_fan_only_mode(this->supports_fan_only_); if (supports_cool_)
traits.set_supports_heat_mode(this->supports_heat_); traits.add_supported_mode(climate::CLIMATE_MODE_COOL);
traits.set_supports_fan_mode_on(this->supports_fan_mode_on_); if (supports_dry_)
traits.set_supports_fan_mode_off(this->supports_fan_mode_off_); traits.add_supported_mode(climate::CLIMATE_MODE_DRY);
traits.set_supports_fan_mode_auto(this->supports_fan_mode_auto_); if (supports_fan_only_)
traits.set_supports_fan_mode_low(this->supports_fan_mode_low_); traits.add_supported_mode(climate::CLIMATE_MODE_FAN_ONLY);
traits.set_supports_fan_mode_medium(this->supports_fan_mode_medium_); if (supports_heat_)
traits.set_supports_fan_mode_high(this->supports_fan_mode_high_); traits.add_supported_mode(climate::CLIMATE_MODE_HEAT);
traits.set_supports_fan_mode_middle(this->supports_fan_mode_middle_);
traits.set_supports_fan_mode_focus(this->supports_fan_mode_focus_); if (supports_fan_mode_on_)
traits.set_supports_fan_mode_diffuse(this->supports_fan_mode_diffuse_); traits.add_supported_fan_mode(climate::CLIMATE_FAN_ON);
traits.set_supports_swing_mode_both(this->supports_swing_mode_both_); if (supports_fan_mode_off_)
traits.set_supports_swing_mode_horizontal(this->supports_swing_mode_horizontal_); traits.add_supported_fan_mode(climate::CLIMATE_FAN_OFF);
traits.set_supports_swing_mode_off(this->supports_swing_mode_off_); if (supports_fan_mode_auto_)
traits.set_supports_swing_mode_vertical(this->supports_swing_mode_vertical_); traits.add_supported_fan_mode(climate::CLIMATE_FAN_AUTO);
if (supports_fan_mode_low_)
traits.add_supported_fan_mode(climate::CLIMATE_FAN_LOW);
if (supports_fan_mode_medium_)
traits.add_supported_fan_mode(climate::CLIMATE_FAN_MEDIUM);
if (supports_fan_mode_high_)
traits.add_supported_fan_mode(climate::CLIMATE_FAN_HIGH);
if (supports_fan_mode_middle_)
traits.add_supported_fan_mode(climate::CLIMATE_FAN_MIDDLE);
if (supports_fan_mode_focus_)
traits.add_supported_fan_mode(climate::CLIMATE_FAN_FOCUS);
if (supports_fan_mode_diffuse_)
traits.add_supported_fan_mode(climate::CLIMATE_FAN_DIFFUSE);
if (supports_swing_mode_both_)
traits.add_supported_swing_mode(climate::CLIMATE_SWING_BOTH);
if (supports_swing_mode_horizontal_)
traits.add_supported_swing_mode(climate::CLIMATE_SWING_HORIZONTAL);
if (supports_swing_mode_off_)
traits.add_supported_swing_mode(climate::CLIMATE_SWING_OFF);
if (supports_swing_mode_vertical_)
traits.add_supported_swing_mode(climate::CLIMATE_SWING_VERTICAL);
if (supports_away_)
traits.set_supported_presets({climate::CLIMATE_PRESET_HOME, climate::CLIMATE_PRESET_AWAY});
traits.set_supports_two_point_target_temperature(this->supports_two_points_); traits.set_supports_two_point_target_temperature(this->supports_two_points_);
traits.set_supports_away(this->supports_away_);
traits.set_supports_action(true); traits.set_supports_action(true);
return traits; return traits;
} }
@ -399,7 +424,7 @@ void ThermostatClimate::change_away_(bool away) {
} else } else
this->target_temperature = this->away_config_.default_temperature; this->target_temperature = this->away_config_.default_temperature;
} }
this->away = away; this->preset = away ? climate::CLIMATE_PRESET_AWAY : climate::CLIMATE_PRESET_HOME;
} }
void ThermostatClimate::set_normal_config(const ThermostatClimateTargetTempConfig &normal_config) { void ThermostatClimate::set_normal_config(const ThermostatClimateTargetTempConfig &normal_config) {
this->normal_config_ = normal_config; this->normal_config_ = normal_config;

6
esphome/components/tuya/climate/tuya_climate.cpp
View file

@ -68,8 +68,10 @@ void TuyaClimate::control(const climate::ClimateCall &call) {
climate::ClimateTraits TuyaClimate::traits() { climate::ClimateTraits TuyaClimate::traits() {
auto traits = climate::ClimateTraits(); auto traits = climate::ClimateTraits();
traits.set_supports_current_temperature(this->current_temperature_id_.has_value()); traits.set_supports_current_temperature(this->current_temperature_id_.has_value());
traits.set_supports_heat_mode(this->supports_heat_); if (supports_heat_)
traits.set_supports_cool_mode(this->supports_cool_); traits.add_supported_mode(climate::CLIMATE_MODE_HEAT);
if (supports_cool_)
traits.add_supported_mode(climate::CLIMATE_MODE_COOL);
traits.set_supports_action(true); traits.set_supports_action(true);
return traits; return traits;
} }

11
esphome/components/yashima/yashima.cpp
View file

@ -82,11 +82,14 @@ const uint32_t YASHIMA_CARRIER_FREQUENCY = 38000;
climate::ClimateTraits YashimaClimate::traits() { climate::ClimateTraits YashimaClimate::traits() {
auto traits = climate::ClimateTraits(); auto traits = climate::ClimateTraits();
traits.set_supports_current_temperature(this->sensor_ != nullptr); traits.set_supports_current_temperature(this->sensor_ != nullptr);
traits.set_supports_heat_cool_mode(true);
traits.set_supports_cool_mode(this->supports_cool_); traits.set_supported_modes({climate::CLIMATE_MODE_OFF, climate::CLIMATE_MODE_HEAT_COOL});
traits.set_supports_heat_mode(this->supports_heat_); if (supports_cool_)
traits.add_supported_mode(climate::CLIMATE_MODE_COOL);
if (supports_heat_)
traits.add_supported_mode(climate::CLIMATE_MODE_HEAT);
traits.set_supports_two_point_target_temperature(false); traits.set_supports_two_point_target_temperature(false);
traits.set_supports_away(false);
traits.set_visual_min_temperature(YASHIMA_TEMP_MIN); traits.set_visual_min_temperature(YASHIMA_TEMP_MIN);
traits.set_visual_max_temperature(YASHIMA_TEMP_MAX); traits.set_visual_max_temperature(YASHIMA_TEMP_MAX);
traits.set_visual_temperature_step(1); traits.set_visual_temperature_step(1);

1
script/api_protobuf/api_protobuf.py Normal file → Executable file
View file

@ -1,3 +1,4 @@
#!/usr/bin/env python3
"""Python 3 script to automatically generate C++ classes for ESPHome's native API. """Python 3 script to automatically generate C++ classes for ESPHome's native API.
It's pretty crappy spaghetti code, but it works. It's pretty crappy spaghetti code, but it works.