Merge branch 'dev' into globals_polling

esphome/components/alarm_control_panel/alarm_control_panel.cpp

@@ -67,29 +67,52 @@ void AlarmControlPanel::add_on_ready_callback(std::function<void()> &&callback)
   this->ready_callback_.add(std::move(callback));
 }
 
-void AlarmControlPanel::arm_with_code_(AlarmControlPanelCall &(AlarmControlPanelCall::*arm_method)(),
-                                       const char *code) {
+void AlarmControlPanel::arm_away(optional<std::string> code) {
   auto call = this->make_call();
-  (call.*arm_method)();
-  if (code != nullptr)
-    call.set_code(code);
+  call.arm_away();
+  if (code.has_value())
+    call.set_code(code.value());
   call.perform();
 }
 
-void AlarmControlPanel::arm_away(const char *code) { this->arm_with_code_(&AlarmControlPanelCall::arm_away, code); }
-
-void AlarmControlPanel::arm_home(const char *code) { this->arm_with_code_(&AlarmControlPanelCall::arm_home, code); }
-
-void AlarmControlPanel::arm_night(const char *code) { this->arm_with_code_(&AlarmControlPanelCall::arm_night, code); }
-
-void AlarmControlPanel::arm_vacation(const char *code) {
-  this->arm_with_code_(&AlarmControlPanelCall::arm_vacation, code);
+void AlarmControlPanel::arm_home(optional<std::string> code) {
+  auto call = this->make_call();
+  call.arm_home();
+  if (code.has_value())
+    call.set_code(code.value());
+  call.perform();
 }
 
-void AlarmControlPanel::arm_custom_bypass(const char *code) {
-  this->arm_with_code_(&AlarmControlPanelCall::arm_custom_bypass, code);
+void AlarmControlPanel::arm_night(optional<std::string> code) {
+  auto call = this->make_call();
+  call.arm_night();
+  if (code.has_value())
+    call.set_code(code.value());
+  call.perform();
 }
 
-void AlarmControlPanel::disarm(const char *code) { this->arm_with_code_(&AlarmControlPanelCall::disarm, code); }
+void AlarmControlPanel::arm_vacation(optional<std::string> code) {
+  auto call = this->make_call();
+  call.arm_vacation();
+  if (code.has_value())
+    call.set_code(code.value());
+  call.perform();
+}
+
+void AlarmControlPanel::arm_custom_bypass(optional<std::string> code) {
+  auto call = this->make_call();
+  call.arm_custom_bypass();
+  if (code.has_value())
+    call.set_code(code.value());
+  call.perform();
+}
+
+void AlarmControlPanel::disarm(optional<std::string> code) {
+  auto call = this->make_call();
+  call.disarm();
+  if (code.has_value())
+    call.set_code(code.value());
+  call.perform();
+}
 
 }  // namespace esphome::alarm_control_panel

esphome/components/alarm_control_panel/alarm_control_panel.h

@@ -76,53 +76,37 @@ class AlarmControlPanel : public EntityBase {
    *
    * @param code The code
    */
-  void arm_away(const char *code = nullptr);
-  void arm_away(const optional<std::string> &code) {
-    this->arm_away(code.has_value() ? code.value().c_str() : nullptr);
-  }
+  void arm_away(optional<std::string> code = nullopt);
 
   /** arm the alarm in home mode
    *
    * @param code The code
    */
-  void arm_home(const char *code = nullptr);
-  void arm_home(const optional<std::string> &code) {
-    this->arm_home(code.has_value() ? code.value().c_str() : nullptr);
-  }
+  void arm_home(optional<std::string> code = nullopt);
 
   /** arm the alarm in night mode
    *
    * @param code The code
    */
-  void arm_night(const char *code = nullptr);
-  void arm_night(const optional<std::string> &code) {
-    this->arm_night(code.has_value() ? code.value().c_str() : nullptr);
-  }
+  void arm_night(optional<std::string> code = nullopt);
 
   /** arm the alarm in vacation mode
    *
    * @param code The code
    */
-  void arm_vacation(const char *code = nullptr);
-  void arm_vacation(const optional<std::string> &code) {
-    this->arm_vacation(code.has_value() ? code.value().c_str() : nullptr);
-  }
+  void arm_vacation(optional<std::string> code = nullopt);
 
   /** arm the alarm in custom bypass mode
    *
    * @param code The code
    */
-  void arm_custom_bypass(const char *code = nullptr);
-  void arm_custom_bypass(const optional<std::string> &code) {
-    this->arm_custom_bypass(code.has_value() ? code.value().c_str() : nullptr);
-  }
+  void arm_custom_bypass(optional<std::string> code = nullopt);
 
   /** disarm the alarm
    *
    * @param code The code
    */
-  void disarm(const char *code = nullptr);
-  void disarm(const optional<std::string> &code) { this->disarm(code.has_value() ? code.value().c_str() : nullptr); }
+  void disarm(optional<std::string> code = nullopt);
 
   /** Get the state
    *
@@ -134,8 +118,6 @@ class AlarmControlPanel : public EntityBase {
 
  protected:
   friend AlarmControlPanelCall;
-  // Helper to reduce code duplication for arm/disarm methods
-  void arm_with_code_(AlarmControlPanelCall &(AlarmControlPanelCall::*arm_method)(), const char *code);
   // in order to store last panel state in flash
   ESPPreferenceObject pref_;
   // current state

esphome/components/alarm_control_panel/alarm_control_panel_call.cpp

@@ -10,10 +10,8 @@ static const char *const TAG = "alarm_control_panel";
 
 AlarmControlPanelCall::AlarmControlPanelCall(AlarmControlPanel *parent) : parent_(parent) {}
 
-AlarmControlPanelCall &AlarmControlPanelCall::set_code(const char *code) {
-  if (code != nullptr) {
-    this->code_ = std::string(code);
-  }
+AlarmControlPanelCall &AlarmControlPanelCall::set_code(const std::string &code) {
+  this->code_ = code;
   return *this;
 }
 

esphome/components/alarm_control_panel/alarm_control_panel_call.h

@@ -14,8 +14,7 @@ class AlarmControlPanelCall {
  public:
   AlarmControlPanelCall(AlarmControlPanel *parent);
 
-  AlarmControlPanelCall &set_code(const char *code);
-  AlarmControlPanelCall &set_code(const std::string &code) { return this->set_code(code.c_str()); }
+  AlarmControlPanelCall &set_code(const std::string &code);
   AlarmControlPanelCall &arm_away();
   AlarmControlPanelCall &arm_home();
   AlarmControlPanelCall &arm_night();

esphome/components/alarm_control_panel/automation.h

@@ -66,7 +66,15 @@ template<typename... Ts> class ArmAwayAction : public Action<Ts...> {
 
   TEMPLATABLE_VALUE(std::string, code)
 
-  void play(const Ts &...x) override { this->alarm_control_panel_->arm_away(this->code_.optional_value(x...)); }
+  void play(const Ts &...x) override {
+    auto call = this->alarm_control_panel_->make_call();
+    auto code = this->code_.optional_value(x...);
+    if (code.has_value()) {
+      call.set_code(code.value());
+    }
+    call.arm_away();
+    call.perform();
+  }
 
  protected:
   AlarmControlPanel *alarm_control_panel_;
@@ -78,7 +86,15 @@ template<typename... Ts> class ArmHomeAction : public Action<Ts...> {
 
   TEMPLATABLE_VALUE(std::string, code)
 
-  void play(const Ts &...x) override { this->alarm_control_panel_->arm_home(this->code_.optional_value(x...)); }
+  void play(const Ts &...x) override {
+    auto call = this->alarm_control_panel_->make_call();
+    auto code = this->code_.optional_value(x...);
+    if (code.has_value()) {
+      call.set_code(code.value());
+    }
+    call.arm_home();
+    call.perform();
+  }
 
  protected:
   AlarmControlPanel *alarm_control_panel_;
@@ -90,7 +106,15 @@ template<typename... Ts> class ArmNightAction : public Action<Ts...> {
 
   TEMPLATABLE_VALUE(std::string, code)
 
-  void play(const Ts &...x) override { this->alarm_control_panel_->arm_night(this->code_.optional_value(x...)); }
+  void play(const Ts &...x) override {
+    auto call = this->alarm_control_panel_->make_call();
+    auto code = this->code_.optional_value(x...);
+    if (code.has_value()) {
+      call.set_code(code.value());
+    }
+    call.arm_night();
+    call.perform();
+  }
 
  protected:
   AlarmControlPanel *alarm_control_panel_;

esphome/components/globals/__init__.py

@@ -6,6 +6,7 @@ from esphome.const import (
     CONF_INITIAL_VALUE,
     CONF_RESTORE_VALUE,
     CONF_TYPE,
+    CONF_UPDATE_INTERVAL,
     CONF_VALUE,
 )
 from esphome.core import CoroPriority, coroutine_with_priority
@@ -13,25 +14,37 @@ from esphome.core import CoroPriority, coroutine_with_priority
 CODEOWNERS = ["@esphome/core"]
 globals_ns = cg.esphome_ns.namespace("globals")
 GlobalsComponent = globals_ns.class_("GlobalsComponent", cg.Component)
-RestoringGlobalsComponent = globals_ns.class_("RestoringGlobalsComponent", cg.Component)
+RestoringGlobalsComponent = globals_ns.class_(
+    "RestoringGlobalsComponent", cg.PollingComponent
+)
 RestoringGlobalStringComponent = globals_ns.class_(
-    "RestoringGlobalStringComponent", cg.Component
+    "RestoringGlobalStringComponent", cg.PollingComponent
 )
 GlobalVarSetAction = globals_ns.class_("GlobalVarSetAction", automation.Action)
 
 CONF_MAX_RESTORE_DATA_LENGTH = "max_restore_data_length"
 
 
+def validate_update_interval(config):
+    if CONF_UPDATE_INTERVAL in config and not config.get(CONF_RESTORE_VALUE, False):
+        raise cv.Invalid("update_interval requires restore_value to be true")
+    return config
+
+
 MULTI_CONF = True
-CONFIG_SCHEMA = cv.Schema(
-    {
-        cv.Required(CONF_ID): cv.declare_id(GlobalsComponent),
-        cv.Required(CONF_TYPE): cv.string_strict,
-        cv.Optional(CONF_INITIAL_VALUE): cv.string_strict,
-        cv.Optional(CONF_RESTORE_VALUE, default=False): cv.boolean,
-        cv.Optional(CONF_MAX_RESTORE_DATA_LENGTH): cv.int_range(0, 254),
-    }
-).extend(cv.COMPONENT_SCHEMA)
+CONFIG_SCHEMA = cv.All(
+    cv.Schema(
+        {
+            cv.Required(CONF_ID): cv.declare_id(GlobalsComponent),
+            cv.Required(CONF_TYPE): cv.string_strict,
+            cv.Optional(CONF_INITIAL_VALUE): cv.string_strict,
+            cv.Optional(CONF_RESTORE_VALUE, default=False): cv.boolean,
+            cv.Optional(CONF_MAX_RESTORE_DATA_LENGTH): cv.int_range(0, 254),
+            cv.Optional(CONF_UPDATE_INTERVAL): cv.update_interval,
+        }
+    ).extend(cv.COMPONENT_SCHEMA),
+    validate_update_interval,
+)
 
 
 # Run with low priority so that namespaces are registered first
@@ -65,6 +78,8 @@ async def to_code(config):
             value = value.encode()
         hash_ = int(hashlib.md5(value).hexdigest()[:8], 16)
         cg.add(glob.set_name_hash(hash_))
+        if CONF_UPDATE_INTERVAL in config:
+            cg.add(glob.set_update_interval(config[CONF_UPDATE_INTERVAL]))
 
 
 @automation.register_action(

esphome/components/globals/globals_component.h

@@ -5,8 +5,7 @@
 #include "esphome/core/helpers.h"
 #include <cstring>
 
-namespace esphome {
-namespace globals {
+namespace esphome::globals {
 
 template<typename T> class GlobalsComponent : public Component {
  public:
@@ -24,13 +23,14 @@ template<typename T> class GlobalsComponent : public Component {
   T value_{};
 };
 
-template<typename T> class RestoringGlobalsComponent : public Component {
+template<typename T> class RestoringGlobalsComponent : public PollingComponent {
  public:
   using value_type = T;
-  explicit RestoringGlobalsComponent() = default;
-  explicit RestoringGlobalsComponent(T initial_value) : value_(initial_value) {}
+  explicit RestoringGlobalsComponent() : PollingComponent(1000) {}
+  explicit RestoringGlobalsComponent(T initial_value) : PollingComponent(1000), value_(initial_value) {}
   explicit RestoringGlobalsComponent(
-      std::array<typename std::remove_extent<T>::type, std::extent<T>::value> initial_value) {
+      std::array<typename std::remove_extent<T>::type, std::extent<T>::value> initial_value)
+      : PollingComponent(1000) {
     memcpy(this->value_, initial_value.data(), sizeof(T));
   }
 
@@ -44,7 +44,7 @@ template<typename T> class RestoringGlobalsComponent : public Component {
 
   float get_setup_priority() const override { return setup_priority::HARDWARE; }
 
-  void loop() override { store_value_(); }
+  void update() override { store_value_(); }
 
   void on_shutdown() override { store_value_(); }
 
@@ -66,13 +66,14 @@ template<typename T> class RestoringGlobalsComponent : public Component {
 };
 
 // Use with string or subclasses of strings
-template<typename T, uint8_t SZ> class RestoringGlobalStringComponent : public Component {
+template<typename T, uint8_t SZ> class RestoringGlobalStringComponent : public PollingComponent {
  public:
   using value_type = T;
-  explicit RestoringGlobalStringComponent() = default;
-  explicit RestoringGlobalStringComponent(T initial_value) { this->value_ = initial_value; }
+  explicit RestoringGlobalStringComponent() : PollingComponent(1000) {}
+  explicit RestoringGlobalStringComponent(T initial_value) : PollingComponent(1000) { this->value_ = initial_value; }
   explicit RestoringGlobalStringComponent(
-      std::array<typename std::remove_extent<T>::type, std::extent<T>::value> initial_value) {
+      std::array<typename std::remove_extent<T>::type, std::extent<T>::value> initial_value)
+      : PollingComponent(1000) {
     memcpy(this->value_, initial_value.data(), sizeof(T));
   }
 
@@ -90,7 +91,7 @@ template<typename T, uint8_t SZ> class RestoringGlobalStringComponent : public C
 
   float get_setup_priority() const override { return setup_priority::HARDWARE; }
 
-  void loop() override { store_value_(); }
+  void update() override { store_value_(); }
 
   void on_shutdown() override { store_value_(); }
 
@@ -144,5 +145,4 @@ template<typename T> T &id(GlobalsComponent<T> *value) { return value->value();
 template<typename T> T &id(RestoringGlobalsComponent<T> *value) { return value->value(); }
 template<typename T, uint8_t SZ> T &id(RestoringGlobalStringComponent<T, SZ> *value) { return value->value(); }
 
-}  // namespace globals
-}  // namespace esphome
+}  // namespace esphome::globals