Add Number entities (from Home Assistant) (#1971)

Co-authored-by: Oxan van Leeuwen <oxan@oxanvanleeuwen.nl>

esphome/components/template/number/__init__.py

@@ -0,0 +1,63 @@
+from esphome import automation
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import number
+from esphome.const import (
+    CONF_ID,
+    CONF_LAMBDA,
+    CONF_MAX_VALUE,
+    CONF_MIN_VALUE,
+    CONF_OPTIMISTIC,
+    CONF_STEP,
+)
+from .. import template_ns
+
+TemplateNumber = template_ns.class_(
+    "TemplateNumber", number.Number, cg.PollingComponent
+)
+
+CONF_SET_ACTION = "set_action"
+
+
+def validate_min_max(config):
+    if config[CONF_MAX_VALUE] <= config[CONF_MIN_VALUE]:
+        raise cv.Invalid("max_value must be greater than min_value")
+    return config
+
+
+CONFIG_SCHEMA = cv.All(
+    number.NUMBER_SCHEMA.extend(
+        {
+            cv.GenerateID(): cv.declare_id(TemplateNumber),
+            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.Optional(CONF_SET_ACTION): automation.validate_automation(single=True),
+        }
+    ).extend(cv.polling_component_schema("60s")),
+    validate_min_max,
+)
+
+
+async def to_code(config):
+    var = cg.new_Pvariable(config[CONF_ID])
+    await cg.register_component(var, config)
+    await number.register_number(var, config)
+
+    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_))
+    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]))

esphome/components/template/number/template_number.cpp

@@ -0,0 +1,39 @@
+#include "template_number.h"
+#include "esphome/core/log.h"
+
+namespace esphome {
+namespace template_ {
+
+static const char *const TAG = "template.number";
+
+TemplateNumber::TemplateNumber() : set_trigger_(new Trigger<float>()) {}
+
+void TemplateNumber::update() {
+  if (!this->f_.has_value())
+    return;
+
+  auto val = (*this->f_)();
+  if (val.has_value()) {
+    this->publish_state(*val);
+  }
+}
+
+void TemplateNumber::set(float value) {
+  this->set_trigger_->trigger(value);
+
+  if (this->optimistic_)
+    this->publish_state(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

@@ -0,0 +1,30 @@
+#pragma once
+
+#include "esphome/components/number/number.h"
+#include "esphome/core/automation.h"
+#include "esphome/core/component.h"
+
+namespace esphome {
+namespace template_ {
+
+class TemplateNumber : public number::Number, public PollingComponent {
+ public:
+  TemplateNumber();
+  void set_template(std::function<optional<float>()> &&f);
+
+  void update() override;
+  void dump_config() override;
+  float get_setup_priority() const override;
+
+  Trigger<float> *get_set_trigger() const;
+  void set_optimistic(bool optimistic);
+
+ protected:
+  void set(float value) override;
+  bool optimistic_{false};
+  Trigger<float> *set_trigger_;
+  optional<std::function<optional<float>()>> f_;
+};
+
+}  // namespace template_
+}  // namespace esphome