Merge branch 'pr3/time-based-actuator-base' into pr5/time-based-valve

Author: exciton

esphome/components/actuator/iactuator.h

@@ -1,5 +1,6 @@
 #pragma once
 #include <cstdint>
+#include "esphome/core/optional.h"
 
 namespace esphome::actuator {
 
@@ -14,6 +15,10 @@ class IActuator {
   virtual ActuatorOperation get_operation() const = 0;
   virtual void set_operation(ActuatorOperation op) = 0;
   virtual void do_publish_state(bool save) = 0;
+  /// Restore previously saved state and return restored position, or empty if no saved state.
+  virtual optional<float> do_restore_state() = 0;
+  /// Return the name of the entity (for logging).
+  virtual const char *get_entity_name() const = 0;
 };
 
 }  // namespace esphome::actuator

esphome/components/cover/cover.cpp

@@ -167,6 +167,23 @@ void Cover::publish_state(bool save) {
   }
 }
 
+optional<CoverRestoreState> Cover::restore_state_() {
+  this->rtc_ = this->make_entity_preference<CoverRestoreState>();
+  CoverRestoreState recovered{};
+  if (!this->rtc_.load(&recovered))
+    return {};
+  return recovered;
+}
+
+optional<float> Cover::do_restore_state() {
+  auto restore = this->restore_state_();
+  if (!restore.has_value())
+    return {};
+  restore->apply(this);
+  float pos = restore->position;  // copy to avoid packed-field reference
+  return pos;
+}
+
 bool Cover::is_fully_open() const { return this->position == COVER_OPEN; }
 bool Cover::is_fully_closed() const { return this->position == COVER_CLOSED; }
 

esphome/components/cover/cover.h

@@ -127,6 +127,8 @@ class Cover : public actuator::ActuatorBase, public actuator::IActuator {
   actuator::ActuatorOperation get_operation() const override { return this->current_operation; }
   void set_operation(actuator::ActuatorOperation op) override { this->current_operation = op; }
   void do_publish_state(bool save) override { this->publish_state(save); }
+  optional<float> do_restore_state() override;
+  const char *get_entity_name() const override { return this->get_name().c_str(); }
 
  protected:
   friend CoverCall;
@@ -136,7 +138,7 @@ class Cover : public actuator::ActuatorBase, public actuator::IActuator {
   // Bridge from ActuatorBase — safe cast because Cover::make_call() always constructs a CoverCall
   void control(const actuator::ActuatorCallBase &call) final { this->control(static_cast<const CoverCall &>(call)); }
 
-  optional<CoverRestoreState> restore_state_() { return ActuatorBase::restore_state_<CoverRestoreState>(); }
+  optional<CoverRestoreState> restore_state_();
 };
 
 }  // namespace esphome::cover

esphome/components/time_based/time_based_actuator.cpp

@@ -34,7 +34,7 @@ void TimeBasedActuatorBase::loop() {
   }
 }
 
-void TimeBasedActuatorBase::control(const ActuatorCallBase &call) {
+void TimeBasedActuatorBase::control_(const ActuatorCallBase &call) {
   if (call.get_stop()) {
     this->start_direction_(ACTUATOR_OPERATION_IDLE);
     this->actuator_->do_publish_state(true);

esphome/components/time_based/time_based_actuator.h

@@ -24,7 +24,7 @@ class TimeBasedActuatorBase : public Component {
   bool get_assumed_state() const { return this->assumed_state_; }
 
  protected:
-  void control(const actuator::ActuatorCallBase &call);
+  void control_(const actuator::ActuatorCallBase &call);
   void stop_prev_trigger_();
   bool is_at_target_() const;
   void start_direction_(actuator::ActuatorOperation dir);

esphome/components/time_based/time_based_cover.h

@@ -15,7 +15,7 @@ class TimeBasedCover : public TimeBasedActuatorBase, public cover::Cover {
   void dump_config() override;
 
  protected:
-  void control(const cover::CoverCall &call) override { TimeBasedActuatorBase::control(call); }
+  void control(const cover::CoverCall &call) override { TimeBasedActuatorBase::control_(call); }
 };
 
 }  // namespace esphome::time_based

esphome/components/valve/valve.cpp

@@ -141,6 +141,15 @@ void Valve::publish_state(bool save) {
 bool Valve::is_fully_open() const { return this->position == VALVE_OPEN; }
 bool Valve::is_fully_closed() const { return this->position == VALVE_CLOSED; }
 
+optional<float> Valve::do_restore_state() {
+  auto restore = this->restore_state_();
+  if (!restore.has_value())
+    return {};
+  restore->apply(this);
+  float pos = restore->position;  // copy to avoid packed-field reference
+  return pos;
+}
+
 ValveCall ValveRestoreState::to_call(Valve *valve) {
   auto call = valve->make_call();
   call.set_position(this->position);

esphome/components/valve/valve.h

@@ -118,6 +118,8 @@ class Valve : public actuator::ActuatorBase, public actuator::IActuator {
   actuator::ActuatorOperation get_operation() const override { return this->current_operation; }
   void set_operation(actuator::ActuatorOperation op) override { this->current_operation = op; }
   void do_publish_state(bool save) override { this->publish_state(save); }
+  optional<float> do_restore_state() override;
+  const char *get_entity_name() const override { return this->get_name().c_str(); }
 
  protected:
   friend ValveCall;

tests/unit_tests/test_time_based_actuator.py

@@ -1,21 +1,15 @@
-"""Unit tests for the TimeBasedActuatorBase component.
-
-Phases:
-  Phase 8: Tests must FAIL (cpp stub not yet populated, class not exported)
-  Phase 9: Import tests pass (TimeBasedActuatorBase exported, cpp implemented)
-  Phase 10: Inheritance test passes (TimeBasedCover inherits TimeBasedActuatorBase)
-"""
+"""Unit tests for the TimeBasedActuatorBase component."""
 
 
 def test_time_based_actuator_importable():
     # pylint: disable-next=unused-import
-    from esphome.components.actuator import TimeBasedActuatorBase  # noqa: F401
+    from esphome.components.time_based import TimeBasedActuatorBase  # noqa: F401
 
 
 def test_time_based_cover_inherits_actuator_base():
-    """After Phase 10, TimeBasedCover must inherit TimeBasedActuatorBase."""
-    from esphome.components.actuator import TimeBasedActuatorBase
+    """Verify TimeBasedCover inherits TimeBasedActuatorBase."""
     from esphome.components.cover import Cover
+    from esphome.components.time_based import TimeBasedActuatorBase
     from esphome.components.time_based.cover import TimeBasedCover
 
     # MockObjClass does not support Python's issubclass(); use inherits_from() instead
@@ -26,6 +20,6 @@ def test_time_based_cover_inherits_actuator_base():
 
 
 def test_time_based_actuator_class_exported():
-    import esphome.components.actuator as actuator_mod
+    import esphome.components.time_based as time_based_mod
 
-    assert hasattr(actuator_mod, "TimeBasedActuatorBase")
+    assert hasattr(time_based_mod, "TimeBasedActuatorBase")