From a39181592155a15ae908fff657f7e26e0cdba935 Mon Sep 17 00:00:00 2001
From: kahrendt <kahrendt@gmail.com>
Date: Tue, 11 Jul 2023 00:24:18 -0400
Subject: [PATCH] Add Zio Ultrasonic Distance Sensor Component (#5059)

---
 CODEOWNERS                                    |  1 +
 esphome/components/zio_ultrasonic/__init__.py |  0
 esphome/components/zio_ultrasonic/sensor.py   | 34 +++++++++++++++++++
 .../zio_ultrasonic/zio_ultrasonic.cpp         | 31 +++++++++++++++++
 .../zio_ultrasonic/zio_ultrasonic.h           | 22 ++++++++++++
 tests/test1.yaml                              |  4 +++
 6 files changed, 92 insertions(+)
 create mode 100644 esphome/components/zio_ultrasonic/__init__.py
 create mode 100644 esphome/components/zio_ultrasonic/sensor.py
 create mode 100644 esphome/components/zio_ultrasonic/zio_ultrasonic.cpp
 create mode 100644 esphome/components/zio_ultrasonic/zio_ultrasonic.h

diff --git a/CODEOWNERS b/CODEOWNERS
index 94813f73dd..ca2c259624 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -321,3 +321,4 @@ esphome/components/xiaomi_mhoc401/* @vevsvevs
 esphome/components/xiaomi_rtcgq02lm/* @jesserockz
 esphome/components/xl9535/* @mreditor97
 esphome/components/xpt2046/* @nielsnl68 @numo68
+esphome/components/zio_ultrasonic/* @kahrendt
diff --git a/esphome/components/zio_ultrasonic/__init__.py b/esphome/components/zio_ultrasonic/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/esphome/components/zio_ultrasonic/sensor.py b/esphome/components/zio_ultrasonic/sensor.py
new file mode 100644
index 0000000000..c5eed14e64
--- /dev/null
+++ b/esphome/components/zio_ultrasonic/sensor.py
@@ -0,0 +1,34 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import i2c, sensor
+from esphome.const import (
+    DEVICE_CLASS_DISTANCE,
+    STATE_CLASS_MEASUREMENT,
+)
+
+DEPENDENCIES = ["i2c"]
+CODEOWNERS = ["@kahrendt"]
+
+zio_ultrasonic_ns = cg.esphome_ns.namespace("zio_ultrasonic")
+
+ZioUltrasonicComponent = zio_ultrasonic_ns.class_(
+    "ZioUltrasonicComponent", cg.PollingComponent, i2c.I2CDevice, sensor.Sensor
+)
+
+CONFIG_SCHEMA = (
+    sensor.sensor_schema(
+        ZioUltrasonicComponent,
+        unit_of_measurement="mm",
+        accuracy_decimals=0,
+        device_class=DEVICE_CLASS_DISTANCE,
+        state_class=STATE_CLASS_MEASUREMENT,
+    )
+    .extend(cv.polling_component_schema("60s"))
+    .extend(i2c.i2c_device_schema(0x00))
+)
+
+
+async def to_code(config):
+    var = await sensor.new_sensor(config)
+    await cg.register_component(var, config)
+    await i2c.register_i2c_device(var, config)
diff --git a/esphome/components/zio_ultrasonic/zio_ultrasonic.cpp b/esphome/components/zio_ultrasonic/zio_ultrasonic.cpp
new file mode 100644
index 0000000000..565bbe9b4f
--- /dev/null
+++ b/esphome/components/zio_ultrasonic/zio_ultrasonic.cpp
@@ -0,0 +1,31 @@
+
+#include "zio_ultrasonic.h"
+
+#include "esphome/core/log.h"
+
+namespace esphome {
+namespace zio_ultrasonic {
+
+static const char *const TAG = "zio_ultrasonic";
+
+void ZioUltrasonicComponent::dump_config() {
+  ESP_LOGCONFIG(TAG, "Zio Ultrasonic Sensor:");
+  LOG_I2C_DEVICE(this);
+  LOG_UPDATE_INTERVAL(this);
+  LOG_SENSOR("  ", "Sensor:", this);
+}
+
+void ZioUltrasonicComponent::update() {
+  uint16_t distance;
+
+  // Read an unsigned two byte integerfrom register 0x01 which gives distance in mm
+  if (!this->read_byte_16(0x01, &distance)) {
+    ESP_LOGE(TAG, "Error reading data from Zio Ultrasonic");
+    this->publish_state(NAN);
+  } else {
+    this->publish_state(distance);
+  }
+}
+
+}  // namespace zio_ultrasonic
+}  // namespace esphome
diff --git a/esphome/components/zio_ultrasonic/zio_ultrasonic.h b/esphome/components/zio_ultrasonic/zio_ultrasonic.h
new file mode 100644
index 0000000000..84c8d44c65
--- /dev/null
+++ b/esphome/components/zio_ultrasonic/zio_ultrasonic.h
@@ -0,0 +1,22 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/components/sensor/sensor.h"
+#include "esphome/components/i2c/i2c.h"
+
+static const char *const TAG = "Zio Ultrasonic";
+
+namespace esphome {
+namespace zio_ultrasonic {
+
+class ZioUltrasonicComponent : public i2c::I2CDevice, public PollingComponent, public sensor::Sensor {
+ public:
+  float get_setup_priority() const override { return setup_priority::DATA; }
+
+  void dump_config() override;
+
+  void update() override;
+};
+
+}  // namespace zio_ultrasonic
+}  // namespace esphome
diff --git a/tests/test1.yaml b/tests/test1.yaml
index 05ba07d1d8..21379e807c 100644
--- a/tests/test1.yaml
+++ b/tests/test1.yaml
@@ -1310,6 +1310,10 @@ sensor:
       fault_count: 1
       polarity: active_high
       function: comparator
+  - platform: zio_ultrasonic
+    name: "Distance"
+    update_interval: 60s
+    i2c_id: i2c_bus
 
 esp32_touch:
   setup_mode: false