ESPHome  2022.12.8
automation.cpp
Go to the documentation of this file.
1 #include "automation.h"
2 #include "esphome/core/log.h"
3 #include <cinttypes>
4 
5 namespace esphome {
6 namespace time {
7 
8 static const char *const TAG = "automation";
9 static const int MAX_TIMESTAMP_DRIFT = 900; // how far can the clock drift before we consider
10  // there has been a drastic time synchronization
11 
12 void CronTrigger::add_second(uint8_t second) { this->seconds_[second] = true; }
13 void CronTrigger::add_minute(uint8_t minute) { this->minutes_[minute] = true; }
14 void CronTrigger::add_hour(uint8_t hour) { this->hours_[hour] = true; }
15 void CronTrigger::add_day_of_month(uint8_t day_of_month) { this->days_of_month_[day_of_month] = true; }
16 void CronTrigger::add_month(uint8_t month) { this->months_[month] = true; }
17 void CronTrigger::add_day_of_week(uint8_t day_of_week) { this->days_of_week_[day_of_week] = true; }
18 bool CronTrigger::matches(const ESPTime &time) {
19  return time.is_valid() && this->seconds_[time.second] && this->minutes_[time.minute] && this->hours_[time.hour] &&
20  this->days_of_month_[time.day_of_month] && this->months_[time.month] && this->days_of_week_[time.day_of_week];
21 }
23  ESPTime time = this->rtc_->now();
24  if (!time.is_valid())
25  return;
26 
27  if (this->last_check_.has_value()) {
28  if (*this->last_check_ > time && this->last_check_->timestamp - time.timestamp > MAX_TIMESTAMP_DRIFT) {
29  // We went back in time (a lot), probably caused by time synchronization
30  ESP_LOGW(TAG, "Time has jumped back!");
31  } else if (*this->last_check_ >= time) {
32  // already handled this one
33  return;
34  } else if (time > *this->last_check_ && time.timestamp - this->last_check_->timestamp > MAX_TIMESTAMP_DRIFT) {
35  // We went ahead in time (a lot), probably caused by time synchronization
36  ESP_LOGW(TAG, "Time has jumped ahead!");
37  this->last_check_ = time;
38  return;
39  }
40 
41  while (true) {
42  this->last_check_->increment_second();
43  if (*this->last_check_ >= time)
44  break;
45 
46  if (this->matches(*this->last_check_))
47  this->trigger();
48  }
49  }
50 
51  this->last_check_ = time;
52  if (!time.fields_in_range()) {
53  ESP_LOGW(TAG, "Time is out of range!");
54  ESP_LOGD(TAG, "Second=%02u Minute=%02u Hour=%02u DayOfWeek=%u DayOfMonth=%u DayOfYear=%u Month=%u time=%" PRId64,
55  time.second, time.minute, time.hour, time.day_of_week, time.day_of_month, time.day_of_year, time.month,
56  (int64_t) time.timestamp);
57  }
58 
59  if (this->matches(time))
60  this->trigger();
61 }
63 void CronTrigger::add_seconds(const std::vector<uint8_t> &seconds) {
64  for (uint8_t it : seconds)
65  this->add_second(it);
66 }
67 void CronTrigger::add_minutes(const std::vector<uint8_t> &minutes) {
68  for (uint8_t it : minutes)
69  this->add_minute(it);
70 }
71 void CronTrigger::add_hours(const std::vector<uint8_t> &hours) {
72  for (uint8_t it : hours)
73  this->add_hour(it);
74 }
75 void CronTrigger::add_days_of_month(const std::vector<uint8_t> &days_of_month) {
76  for (uint8_t it : days_of_month)
77  this->add_day_of_month(it);
78 }
79 void CronTrigger::add_months(const std::vector<uint8_t> &months) {
80  for (uint8_t it : months)
81  this->add_month(it);
82 }
83 void CronTrigger::add_days_of_week(const std::vector<uint8_t> &days_of_week) {
84  for (uint8_t it : days_of_week)
85  this->add_day_of_week(it);
86 }
88 
90  rtc->add_on_time_sync_callback([this]() { this->trigger(); });
91 }
92 
93 } // namespace time
94 } // namespace esphome
void add_days_of_week(const std::vector< uint8_t > &days_of_week)
Definition: automation.cpp:83
void add_hour(uint8_t hour)
Definition: automation.cpp:14
uint8_t month
month; january=1 [1-12]
ESPTime now()
Get the time in the currently defined timezone.
bool is_valid() const
Check if this ESPTime is valid (all fields in range and year is greater than 2018) ...
bool matches(const ESPTime &time)
Definition: automation.cpp:18
SyncTrigger(RealTimeClock *rtc)
Definition: automation.cpp:89
The RealTimeClock class exposes common timekeeping functions via the device&#39;s local real-time clock...
time_t timestamp
unix epoch time (seconds since UTC Midnight January 1, 1970)
void add_minutes(const std::vector< uint8_t > &minutes)
Definition: automation.cpp:67
std::bitset< 61 > seconds_
Definition: automation.h:32
float get_setup_priority() const override
Definition: automation.cpp:87
void add_on_time_sync_callback(std::function< void()> callback)
void add_seconds(const std::vector< uint8_t > &seconds)
Definition: automation.cpp:63
void trigger(Ts... x)
Inform the parent automation that the event has triggered.
Definition: automation.h:95
CronTrigger(RealTimeClock *rtc)
Definition: automation.cpp:62
uint8_t minute
minutes after the hour [0-59]
std::bitset< 13 > months_
Definition: automation.h:36
uint16_t day_of_year
day of the year [1-366]
A more user-friendly version of struct tm from time.h.
void add_month(uint8_t month)
Definition: automation.cpp:16
std::bitset< 60 > minutes_
Definition: automation.h:33
void add_day_of_month(uint8_t day_of_month)
Definition: automation.cpp:15
RealTimeClock * rtc_
Definition: automation.h:38
void add_months(const std::vector< uint8_t > &months)
Definition: automation.cpp:79
uint8_t second
seconds after the minute [0-60]
void add_days_of_month(const std::vector< uint8_t > &days_of_month)
Definition: automation.cpp:75
bool fields_in_range() const
Check if all time fields of this ESPTime are in range.
std::bitset< 8 > days_of_week_
Definition: automation.h:37
std::bitset< 32 > days_of_month_
Definition: automation.h:35
uint8_t day_of_week
day of the week; sunday=1 [1-7]
optional< ESPTime > last_check_
Definition: automation.h:39
const float HARDWARE
For components that deal with hardware and are very important like GPIO switch.
Definition: component.cpp:17
std::bitset< 24 > hours_
Definition: automation.h:34
void add_second(uint8_t second)
Definition: automation.cpp:12
Definition: a4988.cpp:4
void add_day_of_week(uint8_t day_of_week)
Definition: automation.cpp:17
uint8_t day_of_month
day of the month [1-31]
void add_hours(const std::vector< uint8_t > &hours)
Definition: automation.cpp:71
void add_minute(uint8_t minute)
Definition: automation.cpp:13
uint8_t hour
hours since midnight [0-23]