Number and Template Number updates (#2036)

Co-authored-by: Otto winter <otto@otto-winter.com>

esphome/components/template/number/__init__.py

@@ -4,6 +4,7 @@ import esphome.config_validation as cv
 from esphome.components import number
 from esphome.const import (
     CONF_ID,
+    CONF_INITIAL_VALUE,
     CONF_LAMBDA,
     CONF_MAX_VALUE,
     CONF_MIN_VALUE,
@@ -32,9 +33,10 @@ CONFIG_SCHEMA = cv.All(
             cv.Required(CONF_MAX_VALUE): cv.float_,
             cv.Required(CONF_MIN_VALUE): cv.float_,
             cv.Required(CONF_STEP): cv.positive_float,
-            cv.Optional(CONF_LAMBDA): cv.returning_lambda,
-            cv.Optional(CONF_OPTIMISTIC, default=False): cv.boolean,
+            cv.Exclusive(CONF_LAMBDA, "lambda-optimistic"): cv.returning_lambda,
+            cv.Exclusive(CONF_OPTIMISTIC, "lambda-optimistic"): cv.boolean,
             cv.Optional(CONF_SET_ACTION): automation.validate_automation(single=True),
+            cv.Optional(CONF_INITIAL_VALUE): cv.float_,
         }
     ).extend(cv.polling_component_schema("60s")),
     validate_min_max,
@@ -44,20 +46,27 @@ CONFIG_SCHEMA = cv.All(
 async def to_code(config):
     var = cg.new_Pvariable(config[CONF_ID])
     await cg.register_component(var, config)
-    await number.register_number(var, config)
+    await number.register_number(
+        var,
+        config,
+        min_value=config[CONF_MIN_VALUE],
+        max_value=config[CONF_MAX_VALUE],
+        step=config[CONF_STEP],
+    )
 
     if CONF_LAMBDA in config:
         template_ = await cg.process_lambda(
             config[CONF_LAMBDA], [], return_type=cg.optional.template(float)
         )
         cg.add(var.set_template(template_))
+
+    elif CONF_OPTIMISTIC in config:
+        cg.add(var.set_optimistic(config[CONF_OPTIMISTIC]))
+
     if CONF_SET_ACTION in config:
         await automation.build_automation(
             var.get_set_trigger(), [(float, "x")], config[CONF_SET_ACTION]
         )
 
-    cg.add(var.set_optimistic(config[CONF_OPTIMISTIC]))
-
-    cg.add(var.set_min_value(config[CONF_MIN_VALUE]))
-    cg.add(var.set_max_value(config[CONF_MAX_VALUE]))
-    cg.add(var.set_step(config[CONF_STEP]))
+    if CONF_INITIAL_VALUE in config:
+        cg.add(var.set_initial_value(config[CONF_INITIAL_VALUE]))

esphome/components/template/number/template_number.cpp

@@ -6,34 +6,45 @@ namespace template_ {
 
 static const char *const TAG = "template.number";
 
-TemplateNumber::TemplateNumber() : set_trigger_(new Trigger<float>()) {}
+void TemplateNumber::setup() {
+  if (this->f_.has_value() || !this->optimistic_)
+    return;
+
+  this->pref_ = global_preferences.make_preference<float>(this->get_object_id_hash());
+  float value;
+  if (!this->pref_.load(&value)) {
+    if (!isnan(this->initial_value_))
+      value = this->initial_value_;
+    else
+      value = this->traits.get_min_value();
+  }
+  this->publish_state(value);
+}
 
 void TemplateNumber::update() {
   if (!this->f_.has_value())
     return;
 
   auto val = (*this->f_)();
-  if (val.has_value()) {
-    this->publish_state(*val);
-  }
+  if (!val.has_value())
+    return;
+
+  this->publish_state(*val);
 }
 
-void TemplateNumber::set(float value) {
+void TemplateNumber::control(float value) {
   this->set_trigger_->trigger(value);
 
-  if (this->optimistic_)
+  if (this->optimistic_) {
     this->publish_state(value);
+    this->pref_.save(&value);
+  }
 }
-float TemplateNumber::get_setup_priority() const { return setup_priority::HARDWARE; }
-void TemplateNumber::set_template(std::function<optional<float>()> &&f) { this->f_ = f; }
 void TemplateNumber::dump_config() {
   LOG_NUMBER("", "Template Number", this);
   ESP_LOGCONFIG(TAG, "  Optimistic: %s", YESNO(this->optimistic_));
   LOG_UPDATE_INTERVAL(this);
 }
 
-void TemplateNumber::set_optimistic(bool optimistic) { this->optimistic_ = optimistic; }
-Trigger<float> *TemplateNumber::get_set_trigger() const { return this->set_trigger_; };
-
 }  // namespace template_
 }  // namespace esphome

esphome/components/template/number/template_number.h

@@ -3,27 +3,32 @@
 #include "esphome/components/number/number.h"
 #include "esphome/core/automation.h"
 #include "esphome/core/component.h"
+#include "esphome/core/preferences.h"
 
 namespace esphome {
 namespace template_ {
 
 class TemplateNumber : public number::Number, public PollingComponent {
  public:
-  TemplateNumber();
-  void set_template(std::function<optional<float>()> &&f);
+  void set_template(std::function<optional<float>()> &&f) { this->f_ = f; }
 
+  void setup() override;
   void update() override;
   void dump_config() override;
-  float get_setup_priority() const override;
+  float get_setup_priority() const override { return setup_priority::HARDWARE; }
 
-  Trigger<float> *get_set_trigger() const;
-  void set_optimistic(bool optimistic);
+  Trigger<float> *get_set_trigger() const { return set_trigger_; }
+  void set_optimistic(bool optimistic) { optimistic_ = optimistic; }
+  void set_initial_value(float initial_value) { initial_value_ = initial_value; }
 
  protected:
-  void set(float value) override;
+  void control(float value) override;
   bool optimistic_{false};
-  Trigger<float> *set_trigger_;
+  float initial_value_{NAN};
+  Trigger<float> *set_trigger_ = new Trigger<float>();
   optional<std::function<optional<float>()>> f_;
+
+  ESPPreferenceObject pref_;
 };
 
 }  // namespace template_