diff --git a/components/images/seeed-mr24hpc1-card.png b/components/images/seeed-mr24hpc1-card.png new file mode 100644 index 000000000..abaafcae7 Binary files /dev/null and b/components/images/seeed-mr24hpc1-card.png differ diff --git a/components/images/seeed-mr24hpc1-mmwave-kit.png b/components/images/seeed-mr24hpc1-mmwave-kit.png new file mode 100644 index 000000000..effbc383e Binary files /dev/null and b/components/images/seeed-mr24hpc1-mmwave-kit.png differ diff --git a/components/images/seeed-mr24hpc1.jpg b/components/images/seeed-mr24hpc1.jpg new file mode 100644 index 000000000..416d901b7 Binary files /dev/null and b/components/images/seeed-mr24hpc1.jpg differ diff --git a/components/sensor/images/seeed-mr24hpc1-card.png b/components/sensor/images/seeed-mr24hpc1-card.png new file mode 100644 index 000000000..e5b1dc275 Binary files /dev/null and b/components/sensor/images/seeed-mr24hpc1-card.png differ diff --git a/components/sensor/images/seeed-mr24hpc1-mmwave-kit.png b/components/sensor/images/seeed-mr24hpc1-mmwave-kit.png new file mode 100644 index 000000000..4212b2731 Binary files /dev/null and b/components/sensor/images/seeed-mr24hpc1-mmwave-kit.png differ diff --git a/components/sensor/images/seeed-mr24hpc1.jpg b/components/sensor/images/seeed-mr24hpc1.jpg new file mode 100644 index 000000000..29f5b04f7 Binary files /dev/null and b/components/sensor/images/seeed-mr24hpc1.jpg differ diff --git a/components/sensor/seeed_mr24hpc1.rst b/components/sensor/seeed_mr24hpc1.rst new file mode 100644 index 000000000..8b1f96870 --- /dev/null +++ b/components/sensor/seeed_mr24hpc1.rst @@ -0,0 +1,164 @@ +Seeed Studio MR24HPC1 mmWave (Kit) +================================== + +.. seo:: + :description: Instructions for setting up MR24HPC1 mmWave (Kit). + :image: seeed-mr24hpc1.jpg + +Component/Hub +------------- +.. _mr24hpc1-component: + +The ``mr24hpc1`` sensor platform allows you to use Seeed Studio 24GHz mmWave Sensor - Human Static Presence Module Lite +(`Using Documents `__) and Seeed Studio mmWave Human Detection Sensor Kit (`Using Documents `__) with ESPHome. + +The :ref:`UART ` is required to be set up in your configuration for this sensor to work, ``parity`` and ``stop_bits`` **must be** respectively ``NONE`` and ``1``. +You can use the ESP32 software or hardware serial to use this MR24HPC1, its default baud rate is 115200. + +.. figure:: images/seeed-mr24hpc1.jpg + :align: center + :width: 50.0% + + Seeed Studio 24GHz mmWave Sensor - Human Static Presence Module Lite + + +.. figure:: images/seeed-mr24hpc1-mmwave-kit.png + :align: center + :width: 50.0% + + Seeed Studio mmWave Human Detection Sensor Kit + + +.. code-block:: yaml + + # Example configuration entry + mr24hpc1: + +Configuration variables: +************************ + +- **id** (*Optional*, :ref:`config-id`): Manually specify the ID for this :doc:`seeed_mr24hpc1` component if you need multiple components. + +Binary Sensor +------------- + +The ``mr24hpc1`` binary sensor allows you to use your :doc:`seeed_mr24hpc1` to perform different measurements. + +.. code-block:: yaml + + binary_sensor: + - platform: mr24hpc1 + someoneexist: + name: "Presence Information" + +Configuration variables: +************************ + +- **someoneexist** (*Optional*): If true target detect either still or in movement. All options from :ref:`Binary Sensor `. + +Sensor +------ + +The ``mr24hpc1`` sensor allows you to use your :doc:`seeed_mr24hpc1` to perform different measurements. + +.. code-block:: yaml + + sensor: + - platform: mr24hpc1 + custompresenceofdetection: + name: "Static Distance" + +Configuration variables: +************************ + +- **custompresenceofdetection** (*Optional*, float): Distance in meter of detected still target. All options from :ref:`Sensor `. + + + +Text Sensor +----------- + +The ``mr24hpc1`` text sensor allows you to get information about your :doc:`seeed_mr24hpc1`. + +.. code-block:: yaml + + text_sensor: + - platform: mr24hpc1 + heartbeat: + name: "Heartbeat" + productmodel: + name: "Product Model" + productid: + name: "Product ID" + hardwaremodel: + name: "Hardware Model" + hardwareversion: + name: "Hardware Version" + keepaway: + name: "Active Reporting Of Proximity" + motionstatus: + name: "Motion Information" + +Configuration variables: +************************ + +- **heartbeat** (*Optional*): Sensor operating status indicator. All options from :ref:`Text Sensor `. +- **productmodel** (*Optional*): The product model. All options from :ref:`Text Sensor `. +- **productid** (*Optional*): The product ID. All options from :ref:`Text Sensor `.` +- **hardwaremodel** (*Optional*) The hardware model. All options from :ref:`Text Sensor `.` +- **hardwareversion** (*Optional*) The hardware version. All options from :ref:`Text Sensor `.` +- **keepaway** (*Optional*) Indicator for detecting objects approaching or moving away. All options from :ref:`Text Sensor `.` +- **motionstatus** (*Optional*) An indicator that detects the movement or stationarity of an object. All options from :ref:`Text Sensor `.` + + +Home Assistant Card +******************* + +For a more intuitive view of the sensor data, you can use the customised card below. + +.. code-block:: yaml + + - type: horizontal-stack + cards: + - type: entities + entities: + - entity: sensor.DEVICE_hardware_model + name: Hardware Model + - entity: sensor.DEVICE_hardware_version + name: Hardware Version + - entity: sensor.DEVICE_heartbeat + name: Heartbeat + - entity: sensor.DEVICE_product_id + name: Product ID + - entity: sensor.DEVICE_product_model + name: Product Model + title: DEVICE Information + - type: vertical-stack + cards: + - type: entities + entities: + - entity: binary_sensor.DEVICE_presence_information + name: Presence Information + - entity: sensor.DEVICE_motion_information + name: Motion Information + - entity: sensor.DEVICE_static_distance + name: Static Distance + - entity: sensor.DEVICE_active_reporting_of_proximity + name: Active Reporting Of Proximity + title: Unsolicited Information + +Then replace all instances of ``DEVICE`` with your device name + +The result: + +.. figure:: images/seeed-mr24hpc1-card.png + :align: center + +See Also +-------- + +- `Official Using Documents for Seeed Studio 24GHz mmWave Sensor - Human Static Presence Module Lite `_ +- `Official Using Documents for Seeed Studio mmWave Human Detection Sensor Kit `_ +- `Source of inspiration for implementation `_ +- :apiref:`seeed_mr24hpc1/mr24hpc1.h` +- :ghedit:`Edit` diff --git a/images/seeed-mr24hpc1-card.jpg b/images/seeed-mr24hpc1-card.jpg new file mode 100644 index 000000000..915631e59 Binary files /dev/null and b/images/seeed-mr24hpc1-card.jpg differ diff --git a/images/seeed-mr24hpc1-mmwave-kit.jpg b/images/seeed-mr24hpc1-mmwave-kit.jpg new file mode 100644 index 000000000..4a6abf81f Binary files /dev/null and b/images/seeed-mr24hpc1-mmwave-kit.jpg differ diff --git a/images/seeed-mr24hpc1.jpg b/images/seeed-mr24hpc1.jpg new file mode 100644 index 000000000..416d901b7 Binary files /dev/null and b/images/seeed-mr24hpc1.jpg differ diff --git a/index.rst b/index.rst index 24e7af3f5..5b2062a71 100644 --- a/index.rst +++ b/index.rst @@ -409,6 +409,7 @@ Motion BMI160, components/sensor/bmi160, bmi160.jpg, Accelerometer & Gyroscope LD2410, components/sensor/ld2410, ld2410.jpg, Motion & Presence LD2420, components/sensor/ld2420, ld2420.jpg, Motion & Presence + Seeed Studio MR24HPC1 mmWave, components/sensor/seeed_mr24hpc1, seeed-mr24hpc1.jpg, Motion & Presence MPU6050, components/sensor/mpu6050, mpu6050.jpg, Accelerometer & Gyroscope MPU6886, components/sensor/mpu6886, mpu6886.jpg, Accelerometer & Gyroscope RuuviTag, components/sensor/ruuvitag, ruuvitag.jpg, Temperature & Humidity & Accelerometer @@ -499,6 +500,7 @@ Presence Detection DFRobot mmWave Radar, components/dfrobot_sen0395, dfrobot_sen0395.jpg LD2410, components/sensor/ld2410, ld2410.jpg LD2420, components/sensor/ld2420, ld2420.jpg + Seeed Studio MR24HPC1 mmWave, components/sensor/seeed_mr24hpc1, seeed-mr24hpc1.jpg Miscellaneous *************