Add Seeed Studio mmWave Kit MR24HPC1

CODEOWNERS

@@ -290,6 +290,7 @@ esphome/components/scd4x/* @martgras @sjtrny
 esphome/components/script/* @esphome/core
 esphome/components/sdm_meter/* @jesserockz @polyfaces
 esphome/components/sdp3x/* @Azimath
+esphome/components/seeed_mr24hpc1/* @limengdu
 esphome/components/selec_meter/* @sourabhjaiswal
 esphome/components/select/* @esphome/core
 esphome/components/sen0321/* @notjj

esphome/components/seeed_mr24hpc1/__init__.py

@@ -0,0 +1,51 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import uart
+from esphome.const import CONF_ID
+
+DEPENDENCIES = ["uart"]
+# is the code owner of the relevant code base
+CODEOWNERS = ["@limengdu"]
+# The current component or platform can be configured or defined multiple times in the same configuration file.
+MULTI_CONF = True
+
+# This line of code creates a new namespace called mr24hpc1_ns.
+# This namespace will be used as a prefix for all classes, functions and variables associated with the mr24hpc1_ns component, ensuring that they do not conflict with the names of other components.
+mr24hpc1_ns = cg.esphome_ns.namespace("seeed_mr24hpc1")
+# This MR24HPC1Component class will be a periodically polled UART device
+MR24HPC1Component = mr24hpc1_ns.class_(
+    "MR24HPC1Component", cg.Component, uart.UARTDevice
+)
+
+CONF_MR24HPC1_ID = "mr24hpc1_id"
+
+CONFIG_SCHEMA = (
+    cv.Schema(
+        {
+            cv.GenerateID(): cv.declare_id(MR24HPC1Component),
+        }
+    )
+    .extend(uart.UART_DEVICE_SCHEMA)
+    .extend(cv.COMPONENT_SCHEMA)
+)
+
+# A verification mode was created to verify the configuration parameters of a UART device named "seeed_mr24hpc1".
+# This authentication mode requires that the device must have transmit and receive functionality, a parity mode of "NONE", and a stop bit of one.
+FINAL_VALIDATE_SCHEMA = uart.final_validate_device_schema(
+    "seeed_mr24hpc1",
+    require_tx=True,
+    require_rx=True,
+    parity="NONE",
+    stop_bits=1,
+)
+
+
+# The async def keyword is used to define a concurrent function.
+# Concurrent functions are special functions designed to work with Python's asyncio library to support asynchronous I/O operations.
+async def to_code(config):
+    # This line of code creates a new Pvariable (a Python object representing a C++ variable) with the variable's ID taken from the configuration.
+    var = cg.new_Pvariable(config[CONF_ID])
+    # This line of code registers the newly created Pvariable as a component so that ESPHome can manage it at runtime.
+    await cg.register_component(var, config)
+    # This line of code registers the newly created Pvariable as a device.
+    await uart.register_uart_device(var, config)

esphome/components/seeed_mr24hpc1/binary_sensor.py

@@ -0,0 +1,23 @@
+import esphome.codegen as cg
+from esphome.components import binary_sensor
+import esphome.config_validation as cv
+from esphome.const import (
+    DEVICE_CLASS_OCCUPANCY,
+)
+from . import CONF_MR24HPC1_ID, MR24HPC1Component
+
+CONF_HAS_TARGET = "has_target"
+
+CONFIG_SCHEMA = {
+    cv.GenerateID(CONF_MR24HPC1_ID): cv.use_id(MR24HPC1Component),
+    cv.Optional(CONF_HAS_TARGET): binary_sensor.binary_sensor_schema(
+        device_class=DEVICE_CLASS_OCCUPANCY, icon="mdi:motion-sensor"
+    ),
+}
+
+
+async def to_code(config):
+    mr24hpc1_component = await cg.get_variable(config[CONF_MR24HPC1_ID])
+    if has_target_config := config.get(CONF_HAS_TARGET):
+        sens = await binary_sensor.new_binary_sensor(has_target_config)
+        cg.add(mr24hpc1_component.set_has_target_binary_sensor(sens))

esphome/components/seeed_mr24hpc1/button/__init__.py

@@ -0,0 +1,42 @@
+import esphome.codegen as cg
+from esphome.components import button
+import esphome.config_validation as cv
+from esphome.const import (
+    DEVICE_CLASS_RESTART,
+    ENTITY_CATEGORY_CONFIG,
+    ICON_RESTART_ALERT,
+)
+from .. import CONF_MR24HPC1_ID, MR24HPC1Component, mr24hpc1_ns
+
+RestartButton = mr24hpc1_ns.class_("RestartButton", button.Button)
+CustomSetEndButton = mr24hpc1_ns.class_("CustomSetEndButton", button.Button)
+
+CONF_RESTART = "restart"
+CONF_CUSTOM_SET_END = "custom_set_end"
+
+CONFIG_SCHEMA = {
+    cv.GenerateID(CONF_MR24HPC1_ID): cv.use_id(MR24HPC1Component),
+    cv.Optional(CONF_RESTART): button.button_schema(
+        RestartButton,
+        device_class=DEVICE_CLASS_RESTART,
+        entity_category=ENTITY_CATEGORY_CONFIG,
+        icon=ICON_RESTART_ALERT,
+    ),
+    cv.Optional(CONF_CUSTOM_SET_END): button.button_schema(
+        CustomSetEndButton,
+        entity_category=ENTITY_CATEGORY_CONFIG,
+        icon="mdi:cog",
+    ),
+}
+
+
+async def to_code(config):
+    mr24hpc1_component = await cg.get_variable(config[CONF_MR24HPC1_ID])
+    if restart_config := config.get(CONF_RESTART):
+        b = await button.new_button(restart_config)
+        await cg.register_parented(b, config[CONF_MR24HPC1_ID])
+        cg.add(mr24hpc1_component.set_restart_button(b))
+    if custom_set_end_config := config.get(CONF_CUSTOM_SET_END):
+        b = await button.new_button(custom_set_end_config)
+        await cg.register_parented(b, config[CONF_MR24HPC1_ID])
+        cg.add(mr24hpc1_component.set_custom_set_end_button(b))

esphome/components/seeed_mr24hpc1/button/custom_mode_end_button.cpp

@@ -0,0 +1,9 @@
+#include "custom_mode_end_button.h"
+
+namespace esphome {
+namespace seeed_mr24hpc1 {
+
+void CustomSetEndButton::press_action() { this->parent_->set_custom_end_mode(); }
+
+}  // namespace seeed_mr24hpc1
+}  // namespace esphome

esphome/components/seeed_mr24hpc1/button/custom_mode_end_button.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include "esphome/components/button/button.h"
+#include "../seeed_mr24hpc1.h"
+
+namespace esphome {
+namespace seeed_mr24hpc1 {
+
+class CustomSetEndButton : public button::Button, public Parented<MR24HPC1Component> {
+ public:
+  CustomSetEndButton() = default;
+
+ protected:
+  void press_action() override;
+};
+
+}  // namespace seeed_mr24hpc1
+}  // namespace esphome

esphome/components/seeed_mr24hpc1/button/restart_button.cpp

@@ -0,0 +1,9 @@
+#include "restart_button.h"
+
+namespace esphome {
+namespace seeed_mr24hpc1 {
+
+void RestartButton::press_action() { this->parent_->set_restart(); }
+
+}  // namespace seeed_mr24hpc1
+}  // namespace esphome

esphome/components/seeed_mr24hpc1/button/restart_button.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include "esphome/components/button/button.h"
+#include "../seeed_mr24hpc1.h"
+
+namespace esphome {
+namespace seeed_mr24hpc1 {
+
+class RestartButton : public button::Button, public Parented<MR24HPC1Component> {
+ public:
+  RestartButton() = default;
+
+ protected:
+  void press_action() override;
+};
+
+}  // namespace seeed_mr24hpc1
+}  // namespace esphome

esphome/components/seeed_mr24hpc1/number/__init__.py

@@ -0,0 +1,132 @@
+import esphome.codegen as cg
+from esphome.components import number
+import esphome.config_validation as cv
+from esphome.const import (
+    ENTITY_CATEGORY_CONFIG,
+)
+from .. import CONF_MR24HPC1_ID, MR24HPC1Component, mr24hpc1_ns
+
+SensitivityNumber = mr24hpc1_ns.class_("SensitivityNumber", number.Number)
+CustomModeNumber = mr24hpc1_ns.class_("CustomModeNumber", number.Number)
+ExistenceThresholdNumber = mr24hpc1_ns.class_("ExistenceThresholdNumber", number.Number)
+MotionThresholdNumber = mr24hpc1_ns.class_("MotionThresholdNumber", number.Number)
+MotionTriggerTimeNumber = mr24hpc1_ns.class_("MotionTriggerTimeNumber", number.Number)
+MotionToRestTimeNumber = mr24hpc1_ns.class_("MotionToRestTimeNumber", number.Number)
+CustomUnmanTimeNumber = mr24hpc1_ns.class_("CustomUnmanTimeNumber", number.Number)
+
+CONF_SENSITIVITY = "sensitivity"
+CONF_CUSTOM_MODE = "custom_mode"
+CONF_EXISTENCE_THRESHOLD = "existence_threshold"
+CONF_MOTION_THRESHOLD = "motion_threshold"
+CONF_MOTION_TRIGGER = "motion_trigger"
+CONF_MOTION_TO_REST = "motion_to_rest"
+CONF_CUSTOM_UNMAN_TIME = "custom_unman_time"
+
+CONFIG_SCHEMA = cv.Schema(
+    {
+        cv.GenerateID(CONF_MR24HPC1_ID): cv.use_id(MR24HPC1Component),
+        cv.Optional(CONF_SENSITIVITY): number.number_schema(
+            SensitivityNumber,
+            entity_category=ENTITY_CATEGORY_CONFIG,
+            icon="mdi:archive-check-outline",
+        ),
+        cv.Optional(CONF_CUSTOM_MODE): number.number_schema(
+            CustomModeNumber,
+            entity_category=ENTITY_CATEGORY_CONFIG,
+            icon="mdi:cog",
+        ),
+        cv.Optional(CONF_EXISTENCE_THRESHOLD): number.number_schema(
+            ExistenceThresholdNumber,
+            entity_category=ENTITY_CATEGORY_CONFIG,
+        ),
+        cv.Optional(CONF_MOTION_THRESHOLD): number.number_schema(
+            MotionThresholdNumber,
+            entity_category=ENTITY_CATEGORY_CONFIG,
+        ),
+        cv.Optional(CONF_MOTION_TRIGGER): number.number_schema(
+            MotionTriggerTimeNumber,
+            entity_category=ENTITY_CATEGORY_CONFIG,
+            icon="mdi:camera-timer",
+            unit_of_measurement="ms",
+        ),
+        cv.Optional(CONF_MOTION_TO_REST): number.number_schema(
+            MotionToRestTimeNumber,
+            entity_category=ENTITY_CATEGORY_CONFIG,
+            icon="mdi:camera-timer",
+            unit_of_measurement="ms",
+        ),
+        cv.Optional(CONF_CUSTOM_UNMAN_TIME): number.number_schema(
+            CustomUnmanTimeNumber,
+            entity_category=ENTITY_CATEGORY_CONFIG,
+            icon="mdi:camera-timer",
+            unit_of_measurement="s",
+        ),
+    }
+)
+
+
+async def to_code(config):
+    mr24hpc1_component = await cg.get_variable(config[CONF_MR24HPC1_ID])
+    if sensitivity_config := config.get(CONF_SENSITIVITY):
+        n = await number.new_number(
+            sensitivity_config,
+            min_value=0,
+            max_value=3,
+            step=1,
+        )
+        await cg.register_parented(n, mr24hpc1_component)
+        cg.add(mr24hpc1_component.set_sensitivity_number(n))
+    if custom_mode_config := config.get(CONF_CUSTOM_MODE):
+        n = await number.new_number(
+            custom_mode_config,
+            min_value=0,
+            max_value=4,
+            step=1,
+        )
+        await cg.register_parented(n, mr24hpc1_component)
+        cg.add(mr24hpc1_component.set_custom_mode_number(n))
+    if existence_threshold_config := config.get(CONF_EXISTENCE_THRESHOLD):
+        n = await number.new_number(
+            existence_threshold_config,
+            min_value=0,
+            max_value=250,
+            step=1,
+        )
+        await cg.register_parented(n, mr24hpc1_component)
+        cg.add(mr24hpc1_component.set_existence_threshold_number(n))
+    if motion_threshold_config := config.get(CONF_MOTION_THRESHOLD):
+        n = await number.new_number(
+            motion_threshold_config,
+            min_value=0,
+            max_value=250,
+            step=1,
+        )
+        await cg.register_parented(n, mr24hpc1_component)
+        cg.add(mr24hpc1_component.set_motion_threshold_number(n))
+    if motion_trigger_config := config.get(CONF_MOTION_TRIGGER):
+        n = await number.new_number(
+            motion_trigger_config,
+            min_value=0,
+            max_value=150,
+            step=1,
+        )
+        await cg.register_parented(n, mr24hpc1_component)
+        cg.add(mr24hpc1_component.set_motion_trigger_number(n))
+    if motion_to_rest_config := config.get(CONF_MOTION_TO_REST):
+        n = await number.new_number(
+            motion_to_rest_config,
+            min_value=0,
+            max_value=3000,
+            step=1,
+        )
+        await cg.register_parented(n, mr24hpc1_component)
+        cg.add(mr24hpc1_component.set_motion_to_rest_number(n))
+    if custom_unman_time_config := config.get(CONF_CUSTOM_UNMAN_TIME):
+        n = await number.new_number(
+            custom_unman_time_config,
+            min_value=0,
+            max_value=3600,
+            step=1,
+        )
+        await cg.register_parented(n, mr24hpc1_component)
+        cg.add(mr24hpc1_component.set_custom_unman_time_number(n))

esphome/components/seeed_mr24hpc1/number/custom_mode_number.cpp

@@ -0,0 +1,12 @@
+#include "custom_mode_number.h"
+
+namespace esphome {
+namespace seeed_mr24hpc1 {
+
+void CustomModeNumber::control(float value) {
+  this->publish_state(value);
+  this->parent_->set_custom_mode(value);
+}
+
+}  // namespace seeed_mr24hpc1
+}  // namespace esphome

esphome/components/seeed_mr24hpc1/number/custom_mode_number.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include "esphome/components/number/number.h"
+#include "../seeed_mr24hpc1.h"
+
+namespace esphome {
+namespace seeed_mr24hpc1 {
+
+class CustomModeNumber : public number::Number, public Parented<MR24HPC1Component> {
+ public:
+  CustomModeNumber() = default;
+
+ protected:
+  void control(float value) override;
+};
+
+}  // namespace seeed_mr24hpc1
+}  // namespace esphome

esphome/components/seeed_mr24hpc1/number/custom_unman_time_number.cpp

@@ -0,0 +1,9 @@
+#include "custom_unman_time_number.h"
+
+namespace esphome {
+namespace seeed_mr24hpc1 {
+
+void CustomUnmanTimeNumber::control(float value) { this->parent_->set_custom_unman_time(value); }
+
+}  // namespace seeed_mr24hpc1
+}  // namespace esphome

esphome/components/seeed_mr24hpc1/number/custom_unman_time_number.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include "esphome/components/number/number.h"
+#include "../seeed_mr24hpc1.h"
+
+namespace esphome {
+namespace seeed_mr24hpc1 {
+
+class CustomUnmanTimeNumber : public number::Number, public Parented<MR24HPC1Component> {
+ public:
+  CustomUnmanTimeNumber() = default;
+
+ protected:
+  void control(float value) override;
+};
+
+}  // namespace seeed_mr24hpc1
+}  // namespace esphome

esphome/components/seeed_mr24hpc1/number/existence_threshold_number.cpp

@@ -0,0 +1,9 @@
+#include "existence_threshold_number.h"
+
+namespace esphome {
+namespace seeed_mr24hpc1 {
+
+void ExistenceThresholdNumber::control(float value) { this->parent_->set_existence_threshold(value); }
+
+}  // namespace seeed_mr24hpc1
+}  // namespace esphome