Add support for RX8130 RTC Chip (#10511)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
Co-authored-by: Jonathan Swoboda <154711427+swoboda1337@users.noreply.github.com>

CODEOWNERS

@@ -396,6 +396,7 @@ esphome/components/rpi_dpi_rgb/* @clydebarrow
 esphome/components/rtl87xx/* @kuba2k2
 esphome/components/rtttl/* @glmnet
 esphome/components/runtime_stats/* @bdraco
+esphome/components/rx8130/* @beormund
 esphome/components/safe_mode/* @jsuanet @kbx81 @paulmonigatti
 esphome/components/scd4x/* @martgras @sjtrny
 esphome/components/script/* @esphome/core

esphome/components/rx8130/rx8130.cpp

@@ -0,0 +1,127 @@
+#include "rx8130.h"
+#include "esphome/core/log.h"
+
+// https://download.epsondevice.com/td/pdf/app/RX8130CE_en.pdf
+
+namespace esphome {
+namespace rx8130 {
+
+static const uint8_t RX8130_REG_SEC = 0x10;
+static const uint8_t RX8130_REG_MIN = 0x11;
+static const uint8_t RX8130_REG_HOUR = 0x12;
+static const uint8_t RX8130_REG_WDAY = 0x13;
+static const uint8_t RX8130_REG_MDAY = 0x14;
+static const uint8_t RX8130_REG_MONTH = 0x15;
+static const uint8_t RX8130_REG_YEAR = 0x16;
+static const uint8_t RX8130_REG_EXTEN = 0x1C;
+static const uint8_t RX8130_REG_FLAG = 0x1D;
+static const uint8_t RX8130_REG_CTRL0 = 0x1E;
+static const uint8_t RX8130_REG_CTRL1 = 0x1F;
+static const uint8_t RX8130_REG_DIG_OFFSET = 0x30;
+static const uint8_t RX8130_BIT_CTRL_STOP = 0x40;
+static const uint8_t RX8130_BAT_FLAGS = 0x30;
+static const uint8_t RX8130_CLEAR_FLAGS = 0x00;
+
+static const char *const TAG = "rx8130";
+
+constexpr uint8_t bcd2dec(uint8_t val) { return (val >> 4) * 10 + (val & 0x0f); }
+constexpr uint8_t dec2bcd(uint8_t val) { return ((val / 10) << 4) + (val % 10); }
+
+void RX8130Component::setup() {
+  // Set digital offset to disabled with no offset
+  if (this->write_register(RX8130_REG_DIG_OFFSET, &RX8130_CLEAR_FLAGS, 1) != i2c::ERROR_OK) {
+    this->mark_failed();
+    return;
+  }
+  // Disable wakeup timers
+  if (this->write_register(RX8130_REG_EXTEN, &RX8130_CLEAR_FLAGS, 1) != i2c::ERROR_OK) {
+    this->mark_failed();
+    return;
+  }
+  // Clear VLF flag in case there has been data loss
+  if (this->write_register(RX8130_REG_FLAG, &RX8130_CLEAR_FLAGS, 1) != i2c::ERROR_OK) {
+    this->mark_failed();
+    return;
+  }
+  // Clear test flag and disable interrupts
+  if (this->write_register(RX8130_REG_CTRL0, &RX8130_CLEAR_FLAGS, 1) != i2c::ERROR_OK) {
+    this->mark_failed();
+    return;
+  }
+  // Enable battery charging and switching
+  if (this->write_register(RX8130_REG_CTRL1, &RX8130_BAT_FLAGS, 1) != i2c::ERROR_OK) {
+    this->mark_failed();
+    return;
+  }
+  // Clear STOP bit
+  this->stop_(false);
+}
+
+void RX8130Component::update() { this->read_time(); }
+
+void RX8130Component::dump_config() {
+  ESP_LOGCONFIG(TAG, "RX8130:");
+  LOG_I2C_DEVICE(this);
+}
+
+void RX8130Component::read_time() {
+  uint8_t date[7];
+  if (this->read_register(RX8130_REG_SEC, date, 7) != i2c::ERROR_OK) {
+    this->status_set_warning(ESP_LOG_MSG_COMM_FAIL);
+    return;
+  }
+  ESPTime rtc_time{
+      .second = bcd2dec(date[0] & 0x7f),
+      .minute = bcd2dec(date[1] & 0x7f),
+      .hour = bcd2dec(date[2] & 0x3f),
+      .day_of_week = bcd2dec(date[3] & 0x7f),
+      .day_of_month = bcd2dec(date[4] & 0x3f),
+      .day_of_year = 1,  // ignored by recalc_timestamp_utc(false)
+      .month = bcd2dec(date[5] & 0x1f),
+      .year = static_cast<uint16_t>(bcd2dec(date[6]) + 2000),
+      .is_dst = false,  // not used
+      .timestamp = 0    // overwritten by recalc_timestamp_utc(false)
+  };
+  rtc_time.recalc_timestamp_utc(false);
+  if (!rtc_time.is_valid()) {
+    ESP_LOGE(TAG, "Invalid RTC time, not syncing to system clock.");
+    return;
+  }
+  ESP_LOGD(TAG, "Read UTC time: %04d-%02d-%02d %02d:%02d:%02d", rtc_time.year, rtc_time.month, rtc_time.day_of_month,
+           rtc_time.hour, rtc_time.minute, rtc_time.second);
+  time::RealTimeClock::synchronize_epoch_(rtc_time.timestamp);
+}
+
+void RX8130Component::write_time() {
+  auto now = time::RealTimeClock::utcnow();
+  if (!now.is_valid()) {
+    ESP_LOGE(TAG, "Invalid system time, not syncing to RTC.");
+    return;
+  }
+  uint8_t buff[7];
+  buff[0] = dec2bcd(now.second);
+  buff[1] = dec2bcd(now.minute);
+  buff[2] = dec2bcd(now.hour);
+  buff[3] = dec2bcd(now.day_of_week);
+  buff[4] = dec2bcd(now.day_of_month);
+  buff[5] = dec2bcd(now.month);
+  buff[6] = dec2bcd(now.year % 100);
+  this->stop_(true);
+  if (this->write_register(RX8130_REG_SEC, buff, 7) != i2c::ERROR_OK) {
+    this->status_set_warning(ESP_LOG_MSG_COMM_FAIL);
+  } else {
+    ESP_LOGD(TAG, "Wrote UTC time: %04d-%02d-%02d %02d:%02d:%02d", now.year, now.month, now.day_of_month, now.hour,
+             now.minute, now.second);
+  }
+  this->stop_(false);
+}
+
+void RX8130Component::stop_(bool stop) {
+  const uint8_t data = stop ? RX8130_BIT_CTRL_STOP : RX8130_CLEAR_FLAGS;
+  if (this->write_register(RX8130_REG_CTRL0, &data, 1) != i2c::ERROR_OK) {
+    this->status_set_warning(ESP_LOG_MSG_COMM_FAIL);
+  }
+}
+
+}  // namespace rx8130
+}  // namespace esphome

esphome/components/rx8130/rx8130.h

@@ -0,0 +1,35 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/components/i2c/i2c.h"
+#include "esphome/components/time/real_time_clock.h"
+
+namespace esphome {
+namespace rx8130 {
+
+class RX8130Component : public time::RealTimeClock, public i2c::I2CDevice {
+ public:
+  void setup() override;
+  void update() override;
+  void dump_config() override;
+  void read_time();
+  void write_time();
+  /// Ensure RTC is initialized at the correct time in the setup sequence
+  float get_setup_priority() const override { return setup_priority::DATA; }
+
+ protected:
+  void stop_(bool stop);
+};
+
+template<typename... Ts> class WriteAction : public Action<Ts...>, public Parented<RX8130Component> {
+ public:
+  void play(const Ts... x) override { this->parent_->write_time(); }
+};
+
+template<typename... Ts> class ReadAction : public Action<Ts...>, public Parented<RX8130Component> {
+ public:
+  void play(const Ts... x) override { this->parent_->read_time(); }
+};
+
+}  // namespace rx8130
+}  // namespace esphome

esphome/components/rx8130/time.py

@@ -0,0 +1,56 @@
+from esphome import automation
+import esphome.codegen as cg
+from esphome.components import i2c, time
+import esphome.config_validation as cv
+from esphome.const import CONF_ID
+
+CODEOWNERS = ["@beormund"]
+DEPENDENCIES = ["i2c"]
+rx8130_ns = cg.esphome_ns.namespace("rx8130")
+RX8130Component = rx8130_ns.class_("RX8130Component", time.RealTimeClock, i2c.I2CDevice)
+WriteAction = rx8130_ns.class_("WriteAction", automation.Action)
+ReadAction = rx8130_ns.class_("ReadAction", automation.Action)
+
+
+CONFIG_SCHEMA = time.TIME_SCHEMA.extend(
+    {
+        cv.GenerateID(): cv.declare_id(RX8130Component),
+    }
+).extend(i2c.i2c_device_schema(0x32))
+
+
+@automation.register_action(
+    "rx8130.write_time",
+    WriteAction,
+    cv.Schema(
+        {
+            cv.GenerateID(): cv.use_id(RX8130Component),
+        }
+    ),
+)
+async def rx8130_write_time_to_code(config, action_id, template_arg, args):
+    var = cg.new_Pvariable(action_id, template_arg)
+    await cg.register_parented(var, config[CONF_ID])
+    return var
+
+
+@automation.register_action(
+    "rx8130.read_time",
+    ReadAction,
+    automation.maybe_simple_id(
+        {
+            cv.GenerateID(): cv.use_id(RX8130Component),
+        }
+    ),
+)
+async def rx8130_read_time_to_code(config, action_id, template_arg, args):
+    var = cg.new_Pvariable(action_id, template_arg)
+    await cg.register_parented(var, config[CONF_ID])
+    return var
+
+
+async def to_code(config):
+    var = cg.new_Pvariable(config[CONF_ID])
+    await cg.register_component(var, config)
+    await i2c.register_i2c_device(var, config)
+    await time.register_time(var, config)

tests/components/rx8130/common.yaml

@@ -0,0 +1,8 @@
+esphome:
+  on_boot:
+    - rx8130.read_time
+    - rx8130.write_time
+
+time:
+  - platform: rx8130
+    i2c_id: i2c_bus

tests/components/rx8130/test.esp32-idf.yaml

@@ -0,0 +1,4 @@
+packages:
+  i2c: !include ../../test_build_components/common/i2c/esp32-idf.yaml
+
+<<: !include common.yaml

tests/components/rx8130/test.esp8266-ard.yaml

@@ -0,0 +1,4 @@
+packages:
+  i2c: !include ../../test_build_components/common/i2c/esp8266-ard.yaml
+
+<<: !include common.yaml

tests/components/rx8130/test.rp2040-ard.yaml

@@ -0,0 +1,4 @@
+packages:
+  i2c: !include ../../test_build_components/common/i2c/rp2040-ard.yaml
+
+<<: !include common.yaml