From 2a9e3d84fd83e28620d6a2ca67e108624d8c9bc6 Mon Sep 17 00:00:00 2001
From: Otto Winter <otto@otto-winter.com>
Date: Mon, 26 Jul 2021 15:19:50 +0200
Subject: [PATCH] Fix climate restore schema changed resulting in invalid
 restore (#2068)

Co-authored-by: Stefan Agner <stefan@agner.ch>
---
 esphome/components/climate/climate.cpp | 6 +++++-
 esphome/components/climate/climate.h   | 1 +
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/esphome/components/climate/climate.cpp b/esphome/components/climate/climate.cpp
index 07347e4eee..8da2206f37 100644
--- a/esphome/components/climate/climate.cpp
+++ b/esphome/components/climate/climate.cpp
@@ -312,8 +312,12 @@ void Climate::add_on_state_callback(std::function<void()> &&callback) {
   this->state_callback_.add(std::move(callback));
 }
 
+// Random 32bit value; If this changes existing restore preferences are invalidated
+static const uint32_t RESTORE_STATE_VERSION = 0x848EA6ADUL;
+
 optional<ClimateDeviceRestoreState> Climate::restore_state_() {
-  this->rtc_ = global_preferences.make_preference<ClimateDeviceRestoreState>(this->get_object_id_hash());
+  this->rtc_ =
+      global_preferences.make_preference<ClimateDeviceRestoreState>(this->get_object_id_hash() ^ RESTORE_STATE_VERSION);
   ClimateDeviceRestoreState recovered{};
   if (!this->rtc_.load(&recovered))
     return {};
diff --git a/esphome/components/climate/climate.h b/esphome/components/climate/climate.h
index ed5c5069b7..690e81c250 100644
--- a/esphome/components/climate/climate.h
+++ b/esphome/components/climate/climate.h
@@ -120,6 +120,7 @@ class ClimateCall {
 };
 
 /// Struct used to save the state of the climate device in restore memory.
+/// Make sure to update RESTORE_STATE_VERSION when changing the struct entries.
 struct ClimateDeviceRestoreState {
   ClimateMode mode;
   bool uses_custom_fan_mode{false};