real_time_clock.h

Go to the documentation of this file.

#pragma once
 
#include <bitset>
#include <cstdlib>
#include "esphome/core/automation.h"
#include "esphome/core/component.h"
#include "esphome/core/helpers.h"
#include "esphome/core/time.h"
#ifdef USE_TIME_TIMEZONE
#include "posix_tz.h"
#endif
 
namespace esphome::time {
 
class RealTimeClock : public PollingComponent {
 public:
  explicit RealTimeClock();
 
#ifdef USE_TIME_TIMEZONE
  void set_timezone(const char *tz) { this->apply_timezone_(tz); }
 
  void set_timezone(const char *tz, size_t len) {
    if (tz == nullptr) {
      this->apply_timezone_(nullptr);
      return;
    }
    // Stack buffer - TZ strings from tzdata are typically short (< 50 chars)
    char buf[128];
    if (len >= sizeof(buf))
      len = sizeof(buf) - 1;
    memcpy(buf, tz, len);
    buf[len] = '\0';
    this->apply_timezone_(buf);
  }
 
  void set_timezone(const std::string &tz) { this->apply_timezone_(tz.c_str()); }
#endif
 
  ESPTime now();
 
  ESPTime utcnow() { return ESPTime::from_epoch_utc(this->timestamp_now()); }
 
  time_t timestamp_now() { return ::time(nullptr); }
 
  void add_on_time_sync_callback(std::function<void()> &&callback) {
    this->time_sync_callback_.add(std::move(callback));
  };
 
  void dump_config() override;
 
 protected:
  void synchronize_epoch_(uint32_t epoch);
 
#ifdef USE_TIME_TIMEZONE
  void apply_timezone_(const char *tz);
#endif
 
  LazyCallbackManager<void()> time_sync_callback_;
};
 
template<typename... Ts> class TimeHasTimeCondition : public Condition<Ts...> {
 public:
  TimeHasTimeCondition(RealTimeClock *parent) : parent_(parent) {}
  bool check(const Ts &...x) override { return this->parent_->now().is_valid(); }
 
 protected:
  RealTimeClock *parent_;
};
 
}  // namespace esphome::time