From 721b532d71b4ca82c811e3db3b3e189e134704d8 Mon Sep 17 00:00:00 2001
From: Piotr Szulc <piotr.szulc@gmail.com>
Date: Fri, 30 Aug 2024 02:53:34 +0200
Subject: [PATCH] Tuya Number: allow restoring value of hidden datapoints
 (#7346)

---
 esphome/components/tuya/number/__init__.py    |  3 ++
 .../components/tuya/number/tuya_number.cpp    | 45 +++++++++++++++++--
 esphome/components/tuya/number/tuya_number.h  |  9 +++-
 3 files changed, 51 insertions(+), 6 deletions(-)

diff --git a/esphome/components/tuya/number/__init__.py b/esphome/components/tuya/number/__init__.py
index 25be6329ab..c00ea08d23 100644
--- a/esphome/components/tuya/number/__init__.py
+++ b/esphome/components/tuya/number/__init__.py
@@ -9,6 +9,7 @@ from esphome.const import (
     CONF_MULTIPLY,
     CONF_STEP,
     CONF_INITIAL_VALUE,
+    CONF_RESTORE_VALUE,
 )
 from .. import tuya_ns, CONF_TUYA_ID, Tuya, TuyaDatapointType
 
@@ -58,6 +59,7 @@ CONFIG_SCHEMA = cv.All(
                             DATAPOINT_TYPES, lower=True
                         ),
                         cv.Optional(CONF_INITIAL_VALUE): cv.float_,
+                        cv.Optional(CONF_RESTORE_VALUE, default=False): cv.boolean,
                     }
                 )
             ),
@@ -90,3 +92,4 @@ async def to_code(config):
             hidden_init_value := hidden_config.get(CONF_INITIAL_VALUE, None)
         ) is not None:
             cg.add(var.set_datapoint_initial_value(hidden_init_value))
+        cg.add(var.set_restore_value(hidden_config[CONF_RESTORE_VALUE]))
diff --git a/esphome/components/tuya/number/tuya_number.cpp b/esphome/components/tuya/number/tuya_number.cpp
index 7eeb08fde2..68a7f8f2a7 100644
--- a/esphome/components/tuya/number/tuya_number.cpp
+++ b/esphome/components/tuya/number/tuya_number.cpp
@@ -7,14 +7,28 @@ namespace tuya {
 static const char *const TAG = "tuya.number";
 
 void TuyaNumber::setup() {
+  if (this->restore_value_) {
+    this->pref_ = global_preferences->make_preference<float>(this->get_object_id_hash());
+  }
+
   this->parent_->register_listener(this->number_id_, [this](const TuyaDatapoint &datapoint) {
     if (datapoint.type == TuyaDatapointType::INTEGER) {
       ESP_LOGV(TAG, "MCU reported number %u is: %d", datapoint.id, datapoint.value_int);
-      this->publish_state(datapoint.value_int / multiply_by_);
+      float value = datapoint.value_int / multiply_by_;
+      this->publish_state(value);
+      if (this->restore_value_)
+        this->pref_.save(&value);
     } else if (datapoint.type == TuyaDatapointType::ENUM) {
       ESP_LOGV(TAG, "MCU reported number %u is: %u", datapoint.id, datapoint.value_enum);
-      this->publish_state(datapoint.value_enum);
+      float value = datapoint.value_enum;
+      this->publish_state(value);
+      if (this->restore_value_)
+        this->pref_.save(&value);
+    } else {
+      ESP_LOGW(TAG, "Reported type (%d) is not a number!", static_cast<int>(datapoint.type));
+      return;
     }
+
     if ((this->type_) && (this->type_ != datapoint.type)) {
       ESP_LOGW(TAG, "Reported type (%d) different than previously set (%d)!", static_cast<int>(datapoint.type),
                static_cast<int>(*this->type_));
@@ -23,8 +37,26 @@ void TuyaNumber::setup() {
   });
 
   this->parent_->add_on_initialized_callback([this] {
-    if ((this->initial_value_) && (this->type_)) {
-      this->control(*this->initial_value_);
+    if (this->type_) {
+      float value;
+      if (!this->restore_value_) {
+        if (this->initial_value_) {
+          value = *this->initial_value_;
+        } else {
+          return;
+        }
+      } else {
+        if (!this->pref_.load(&value)) {
+          if (this->initial_value_) {
+            value = *this->initial_value_;
+          } else {
+            value = this->traits.get_min_value();
+            ESP_LOGW(TAG, "Failed to restore and there is no initial value defined. Setting min_value (%f)", value);
+          }
+        }
+      }
+
+      this->control(value);
     }
   });
 }
@@ -38,6 +70,9 @@ void TuyaNumber::control(float value) {
     this->parent_->set_enum_datapoint_value(this->number_id_, value);
   }
   this->publish_state(value);
+
+  if (this->restore_value_)
+    this->pref_.save(&value);
 }
 
 void TuyaNumber::dump_config() {
@@ -52,6 +87,8 @@ void TuyaNumber::dump_config() {
   if (this->initial_value_) {
     ESP_LOGCONFIG(TAG, "  Initial Value: %f", *this->initial_value_);
   }
+
+  ESP_LOGCONFIG(TAG, "  Restore Value: %s", YESNO(this->restore_value_));
 }
 
 }  // namespace tuya
diff --git a/esphome/components/tuya/number/tuya_number.h b/esphome/components/tuya/number/tuya_number.h
index 545584128e..53137d6f66 100644
--- a/esphome/components/tuya/number/tuya_number.h
+++ b/esphome/components/tuya/number/tuya_number.h
@@ -1,9 +1,10 @@
 #pragma once
 
-#include "esphome/core/component.h"
-#include "esphome/components/tuya/tuya.h"
 #include "esphome/components/number/number.h"
+#include "esphome/components/tuya/tuya.h"
+#include "esphome/core/component.h"
 #include "esphome/core/optional.h"
+#include "esphome/core/preferences.h"
 
 namespace esphome {
 namespace tuya {
@@ -16,6 +17,7 @@ class TuyaNumber : public number::Number, public Component {
   void set_write_multiply(float factor) { multiply_by_ = factor; }
   void set_datapoint_type(TuyaDatapointType type) { type_ = type; }
   void set_datapoint_initial_value(float value) { this->initial_value_ = value; }
+  void set_restore_value(bool restore_value) { this->restore_value_ = restore_value; }
 
   void set_tuya_parent(Tuya *parent) { this->parent_ = parent; }
 
@@ -27,6 +29,9 @@ class TuyaNumber : public number::Number, public Component {
   float multiply_by_{1.0};
   optional<TuyaDatapointType> type_{};
   optional<float> initial_value_{};
+  bool restore_value_{false};
+
+  ESPPreferenceObject pref_;
 };
 
 }  // namespace tuya