Fix time.on_time triggering if time jumped back (#1806)

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

esphome/components/fastled_clockless/light.py

@@ -31,6 +31,7 @@ CHIPSETS = [
     "GW6205_400",
     "LPD1886",
     "LPD1886_8BIT",
+    "SM16703",
 ]
 
 

esphome/components/integration/integration_sensor.cpp

@@ -16,6 +16,8 @@ void IntegrationSensor::setup() {
   }
 
   this->last_update_ = millis();
+  this->last_save_ = this->last_update_;
+
   this->publish_and_save_(this->result_);
   this->sensor_->add_on_state_callback([this](float state) { this->process_sensor_value_(state); });
 }

esphome/components/integration/integration_sensor.h

@@ -27,6 +27,7 @@ class IntegrationSensor : public sensor::Sensor, public Component {
   void setup() override;
   void dump_config() override;
   float get_setup_priority() const override { return setup_priority::DATA; }
+  void set_min_save_interval(uint32_t min_interval) { this->min_save_interval_ = min_interval; }
   void set_sensor(Sensor *sensor) { sensor_ = sensor; }
   void set_time(IntegrationSensorTime time) { time_ = time; }
   void set_method(IntegrationMethod method) { method_ = method; }
@@ -55,6 +56,10 @@ class IntegrationSensor : public sensor::Sensor, public Component {
     this->result_ = result;
     this->publish_state(result);
     float result_f = result;
+    const uint32_t now = millis();
+    if (now - this->last_save_ < this->min_save_interval_)
+      return;
+    this->last_save_ = now;
     this->rtc_.save(&result_f);
   }
   std::string unit_of_measurement() override;
@@ -67,6 +72,8 @@ class IntegrationSensor : public sensor::Sensor, public Component {
   bool restore_;
   ESPPreferenceObject rtc_;
 
+  uint32_t last_save_{0};
+  uint32_t min_save_interval_{0};
   uint32_t last_update_;
   double result_{0.0f};
   float last_value_{0.0f};

esphome/components/integration/sensor.py

@@ -27,6 +27,8 @@ INTEGRATION_METHODS = {
 
 CONF_TIME_UNIT = "time_unit"
 CONF_INTEGRATION_METHOD = "integration_method"
+CONF_MIN_SAVE_INTERVAL = "min_save_interval"
+
 
 CONFIG_SCHEMA = sensor.SENSOR_SCHEMA.extend(
     {
@@ -37,6 +39,9 @@ CONFIG_SCHEMA = sensor.SENSOR_SCHEMA.extend(
             INTEGRATION_METHODS, lower=True
         ),
         cv.Optional(CONF_RESTORE, default=False): cv.boolean,
+        cv.Optional(
+            CONF_MIN_SAVE_INTERVAL, default="0s"
+        ): cv.positive_time_period_milliseconds,
     }
 ).extend(cv.COMPONENT_SCHEMA)
 
@@ -52,6 +57,7 @@ async def to_code(config):
     cg.add(var.set_time(config[CONF_TIME_UNIT]))
     cg.add(var.set_method(config[CONF_INTEGRATION_METHOD]))
     cg.add(var.set_restore(config[CONF_RESTORE]))
+    cg.add(var.set_min_save_interval(config[CONF_MIN_SAVE_INTERVAL]))
 
 
 @automation.register_action(

esphome/components/time/automation.cpp

@@ -22,7 +22,10 @@ void CronTrigger::loop() {
     return;
 
   if (this->last_check_.has_value()) {
-    if (*this->last_check_ >= time) {
+    if (*this->last_check_ > time && this->last_check_->timestamp - time.timestamp > 900) {
+      // We went back in time (a lot), probably caused by time synchronization
+      ESP_LOGW(TAG, "Time has jumped back!");
+    } else if (*this->last_check_ >= time) {
       // already handled this one
       return;
     }

esphome/components/total_daily_energy/sensor.py

@@ -12,6 +12,7 @@ from esphome.const import (
 DEPENDENCIES = ["time"]
 
 CONF_POWER_ID = "power_id"
+CONF_MIN_SAVE_INTERVAL = "min_save_interval"
 total_daily_energy_ns = cg.esphome_ns.namespace("total_daily_energy")
 TotalDailyEnergy = total_daily_energy_ns.class_(
     "TotalDailyEnergy", sensor.Sensor, cg.Component
@@ -29,6 +30,9 @@ CONFIG_SCHEMA = (
             cv.GenerateID(): cv.declare_id(TotalDailyEnergy),
             cv.GenerateID(CONF_TIME_ID): cv.use_id(time.RealTimeClock),
             cv.Required(CONF_POWER_ID): cv.use_id(sensor.Sensor),
+            cv.Optional(
+                CONF_MIN_SAVE_INTERVAL, default="0s"
+            ): cv.positive_time_period_milliseconds,
         }
     )
     .extend(cv.COMPONENT_SCHEMA)
@@ -45,3 +49,4 @@ async def to_code(config):
     cg.add(var.set_parent(sens))
     time_ = await cg.get_variable(config[CONF_TIME_ID])
     cg.add(var.set_time(time_))
+    cg.add(var.set_min_save_interval(config[CONF_MIN_SAVE_INTERVAL]))

esphome/components/total_daily_energy/total_daily_energy.cpp

@@ -16,6 +16,7 @@ void TotalDailyEnergy::setup() {
     this->publish_state_and_save(0);
   }
   this->last_update_ = millis();
+  this->last_save_ = this->last_update_;
 
   this->parent_->add_on_state_callback([this](float state) { this->process_new_state_(state); });
 }
@@ -37,9 +38,14 @@ void TotalDailyEnergy::loop() {
   }
 }
 void TotalDailyEnergy::publish_state_and_save(float state) {
-  this->pref_.save(&state);
   this->total_energy_ = state;
   this->publish_state(state);
+  const uint32_t now = millis();
+  if (now - this->last_save_ < this->min_save_interval_) {
+    return;
+  }
+  this->last_save_ = now;
+  this->pref_.save(&state);
 }
 void TotalDailyEnergy::process_new_state_(float state) {
   if (isnan(state))

esphome/components/total_daily_energy/total_daily_energy.h

@@ -10,6 +10,7 @@ namespace total_daily_energy {
 
 class TotalDailyEnergy : public sensor::Sensor, public Component {
  public:
+  void set_min_save_interval(uint32_t min_interval) { this->min_save_interval_ = min_interval; }
   void set_time(time::RealTimeClock *time) { time_ = time; }
   void set_parent(Sensor *parent) { parent_ = parent; }
   void setup() override;
@@ -30,6 +31,8 @@ class TotalDailyEnergy : public sensor::Sensor, public Component {
   Sensor *parent_;
   uint16_t last_day_of_year_{};
   uint32_t last_update_{0};
+  uint32_t last_save_{0};
+  uint32_t min_save_interval_{0};
   float total_energy_{0.0f};
 };
 

esphome/components/waveshare_epaper/display.py

@@ -31,6 +31,9 @@ WaveshareEPaper2P9InB = waveshare_epaper_ns.class_(
 WaveshareEPaper4P2In = waveshare_epaper_ns.class_(
     "WaveshareEPaper4P2In", WaveshareEPaper
 )
+WaveshareEPaper4P2InBV2 = waveshare_epaper_ns.class_(
+    "WaveshareEPaper4P2InBV2", WaveshareEPaper
+)
 WaveshareEPaper5P8In = waveshare_epaper_ns.class_(
     "WaveshareEPaper5P8In", WaveshareEPaper
 )
@@ -56,6 +59,7 @@ MODELS = {
     "2.70in": ("b", WaveshareEPaper2P7In),
     "2.90in-b": ("b", WaveshareEPaper2P9InB),
     "4.20in": ("b", WaveshareEPaper4P2In),
+    "4.20in-bv2": ("b", WaveshareEPaper4P2InBV2),
     "5.83in": ("b", WaveshareEPaper5P8In),
     "7.50in": ("b", WaveshareEPaper7P5In),
     "7.50inv2": ("b", WaveshareEPaper7P5InV2),

esphome/components/waveshare_epaper/waveshare_epaper.cpp

@@ -765,6 +765,62 @@ void WaveshareEPaper4P2In::dump_config() {
   LOG_UPDATE_INTERVAL(this);
 }
 
+// ========================================================
+//               4.20in Type B (LUT from OTP)
+// Datasheet:
+//  - https://www.waveshare.com/w/upload/2/20/4.2inch-e-paper-module-user-manual-en.pdf
+//  - https://github.com/waveshare/e-Paper/blob/master/RaspberryPi_JetsonNano/c/lib/e-Paper/EPD_4in2b_V2.c
+// ========================================================
+void WaveshareEPaper4P2InBV2::initialize() {
+  // these exact timings are required for a proper reset/init
+  this->reset_pin_->digital_write(false);
+  delay(2);
+  this->reset_pin_->digital_write(true);
+  delay(200);  // NOLINT
+
+  // COMMAND POWER ON
+  this->command(0x04);
+  this->wait_until_idle_();
+
+  // COMMAND PANEL SETTING
+  this->command(0x00);
+  this->data(0x0f);  // LUT from OTP
+}
+
+void HOT WaveshareEPaper4P2InBV2::display() {
+  // COMMAND DATA START TRANSMISSION 1 (B/W data)
+  this->command(0x10);
+  this->start_data_();
+  this->write_array(this->buffer_, this->get_buffer_length_());
+  this->end_data_();
+
+  // COMMAND DATA START TRANSMISSION 2 (RED data)
+  this->command(0x13);
+  this->start_data_();
+  for (int i = 0; i < this->get_buffer_length_(); i++)
+    this->write_byte(0xFF);
+  this->end_data_();
+  delay(2);
+
+  // COMMAND DISPLAY REFRESH
+  this->command(0x12);
+  this->wait_until_idle_();
+
+  // COMMAND POWER OFF
+  // NOTE: power off < deep sleep
+  this->command(0x02);
+}
+int WaveshareEPaper4P2InBV2::get_width_internal() { return 400; }
+int WaveshareEPaper4P2InBV2::get_height_internal() { return 300; }
+void WaveshareEPaper4P2InBV2::dump_config() {
+  LOG_DISPLAY("", "Waveshare E-Paper", this);
+  ESP_LOGCONFIG(TAG, "  Model: 4.2in (B V2)");
+  LOG_PIN("  Reset Pin: ", this->reset_pin_);
+  LOG_PIN("  DC Pin: ", this->dc_pin_);
+  LOG_PIN("  Busy Pin: ", this->busy_pin_);
+  LOG_UPDATE_INTERVAL(this);
+}
+
 void WaveshareEPaper5P8In::initialize() {
   // COMMAND POWER SETTING
   this->command(0x01);

esphome/components/waveshare_epaper/waveshare_epaper.h

@@ -115,6 +115,7 @@ class WaveshareEPaperTypeA : public WaveshareEPaper {
 enum WaveshareEPaperTypeBModel {
   WAVESHARE_EPAPER_2_7_IN = 0,
   WAVESHARE_EPAPER_4_2_IN,
+  WAVESHARE_EPAPER_4_2_IN_B_V2,
   WAVESHARE_EPAPER_7_5_IN,
   WAVESHARE_EPAPER_7_5_INV2,
 };
@@ -202,6 +203,34 @@ class WaveshareEPaper4P2In : public WaveshareEPaper {
   int get_height_internal() override;
 };
 
+class WaveshareEPaper4P2InBV2 : public WaveshareEPaper {
+ public:
+  void initialize() override;
+
+  void display() override;
+
+  void dump_config() override;
+
+  void deep_sleep() override {
+    // COMMAND VCOM AND DATA INTERVAL SETTING
+    this->command(0x50);
+    this->data(0xF7);  // border floating
+
+    // COMMAND POWER OFF
+    this->command(0x02);
+    this->wait_until_idle_();
+
+    // COMMAND DEEP SLEEP
+    this->command(0x07);
+    this->data(0xA5);  // check code
+  }
+
+ protected:
+  int get_width_internal() override;
+
+  int get_height_internal() override;
+};
+
 class WaveshareEPaper5P8In : public WaveshareEPaper {
  public:
   void initialize() override;

tests/test1.yaml

@@ -540,6 +540,11 @@ sensor:
     sensor: hlw8012_power
     name: 'Integration Sensor'
     time_unit: s
+  - platform: integration
+    sensor: hlw8012_power
+    name: 'Integration Sensor lazy'
+    time_unit: s
+    min_save_interval: 60s
   - platform: hmc5883l
     address: 0x68
     field_strength_x: