diff --git a/components/binary_sensor/hydreon_rgxx.rst b/components/binary_sensor/hydreon_rgxx.rst new file mode 100644 index 000000000..88879093b --- /dev/null +++ b/components/binary_sensor/hydreon_rgxx.rst @@ -0,0 +1,55 @@ +Hydreon Rain Sensor Binary Sensor +================================= + +.. seo:: + :description: Instructions for setting up Hydreon rain sensors + :image: hydreon_rg9.jpg + :keywords: hydreon + +The ``hydreon_rgxx`` binary sensor platform gives access to information provided by a Hydreon Rain Sensor. +For this sensor to work, a :doc:`/components/sensor/hydreon_rgxx` must be set up. + +.. code-block:: yaml + + # Example RG-9 entry + + uart: + rx_pin: GPIO16 + tx_pin: GPIO17 + baud_rate: 9600 + + sensor: + - platform: hydreon_rgxx + model: "RG_9" + id: "hydreon_1" + update_interval: 1s + moisture: + name: "rain" + expire_after: 30s + + binary_sensor: + - platform: hydreon_rgxx + hydreon_rgxx_id: "hydreon_1" + too_cold: + name: "too cold" + +Configuration variables: +------------------------ + +- **hydreon_rgxx_id** (*Optional*, :ref:`config-id`): The ID of the Hydreon Rain Sensor display. + +- **too_cold** (*Optional*): `true` if the sensor reports being too cold. Hydreon only mentions this feature for the RG-9. + + - **name** (**Required**, string): The name for the voltage sensor. + + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + + - All other options from :ref:`Binary Sensor `. + + +See Also +-------- + +- :doc:`/components/sensor/hydreon_rgxx` +- :doc:`index` +- :ghedit:`Edit` diff --git a/components/sensor/hydreon_rgxx.rst b/components/sensor/hydreon_rgxx.rst new file mode 100644 index 000000000..aea638d5d --- /dev/null +++ b/components/sensor/hydreon_rgxx.rst @@ -0,0 +1,114 @@ +Hydreon Rain Sensor +=================== + +.. seo:: + :description: Instructions for setting up Hydreon rain sensors + :image: hydreon_rg9.jpg + :keywords: hydreon + +The ``hydreon_rgxx`` sensor platform allows you to use rain sensors by Hydreon. Currently supported are the RG-9 and RG-15 (`rainsensors `_) sensors. +These optical rain sensors use a UART connection at 3.3V. The :ref:`UART ` is +required to be set up in your configuration for this sensor to work. + + +.. figure:: images/hydreon_rg9_full.jpg + :align: center + :width: 50.0% + + Hydreon RG-9 Rain Sensor. Image by `Hydreon `_. + +.. code-block:: yaml + + # Example RG-9 entry + + uart: + rx_pin: GPIO16 + tx_pin: GPIO17 + baud_rate: 9600 + + sensor: + - platform: hydreon_rgxx + model: "RG_9" + update_interval: 60s + moisture: + name: "rain" + expire_after: 120s + + binary_sensor: + - platform: hydreon_rgxx + too_cold: + name: "too cold" + +.. code-block:: yaml + + # Example RG-15 entry + + uart: + rx_pin: GPIO16 + tx_pin: GPIO17 + baud_rate: 9600 + + sensor: + - platform: hydreon_rgxx + model: "RG_15" + update_interval: 60s + acc: + name: "rain" + event_acc: + name: "rain event" + total_acc: + name: "rain total" + r_int: + name: "rain intensity" + +Configuration variables: +------------------------ + +- **model**: (**Required**, int): Specify which rain sensor you have connected. Must be either ``RG_9`` or ``RG_15``. + +- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`UART Component ` if you want + to use multiple UART buses. + +- **moisture** (*Optional*): Rain intensity level from 0-7. Only on RG-9. + + - **name** (**Required**, string): The name for the voltage sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +- **acc** (*Optional*): Amount of rain since last message (see `update_interval`), in `mm`. Only on RG-15. + + - **name** (**Required**, string): The name for the voltage sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +- **event_acc** (*Optional*): Amount of rain for this event (i.e. since it last stopped raining), in `mm`. Only on RG-15. + + - **name** (**Required**, string): The name for the voltage sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +- **total_acc** (*Optional*): Total amount of rain this sensor has ever measured, in `mm`. Only on RG-15. + + - **name** (**Required**, string): The name for the voltage sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +- **r_int** (*Optional*): Current rain intensity in `mm/h`. Only on RG-15. + + - **name** (**Required**, string): The name for the voltage sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. + + +See Also +-------- + +- :ref:`sensor-filters` +- :doc:`../binary_sensor/hydreon_rgxx` +- `Hydreon RG-9 `__ +- `Hydreon RG-15 `__ +- `RG-15 V1.000 manual `__ +- `RG-9 V1.000 manual `__ +- :ghedit:`Edit` diff --git a/components/sensor/images/hydreon_rg9_full.jpg b/components/sensor/images/hydreon_rg9_full.jpg new file mode 100644 index 000000000..a3d774c45 Binary files /dev/null and b/components/sensor/images/hydreon_rg9_full.jpg differ diff --git a/images/hydreon_rg9.jpg b/images/hydreon_rg9.jpg new file mode 100644 index 000000000..a4ba0b0e8 Binary files /dev/null and b/images/hydreon_rg9.jpg differ diff --git a/index.rst b/index.rst index f307fe462..819331f32 100644 --- a/index.rst +++ b/index.rst @@ -295,6 +295,7 @@ Environmental HDC1080, components/sensor/hdc1080, hdc1080.jpg, Temperature & Humidity Honeywell ABP, components/sensor/honeywellabp, honeywellabp.jpg, Pressure & Temperature HTU21D / Si7021 / SHT21, components/sensor/htu21d, htu21d.jpg, Temperature & Humidity + Hydreon Rain Sensor, components/sensor/hydreon_rgxx, hydreon_rg9.jpg, Rain Inkbird IBS-TH1 Mini, components/sensor/inkbird_ibsth1_mini, inkbird_isbth1_mini.jpg, Temperature & Humidity MCP9808, components/sensor/mcp9808, mcp9808.jpg, Temperature MH-Z19, components/sensor/mhz19, mhz19.jpg, CO2 & Temperature @@ -401,6 +402,7 @@ Binary Sensor Components Analog Threshold, components/binary_sensor/analog_threshold, analog_threshold.svg ESP32 BLE Presence, components/binary_sensor/ble_presence, bluetooth.svg ESP32 Touch Pad, components/binary_sensor/esp32_touch, touch.svg + Hydreon Rain Sensor Binary Sensor, components/binary_sensor/hydreon_rgxx, hydreon_rg9.jpg MPR121 Capacitive Touch Sensor, components/binary_sensor/mpr121, mpr121.jpg Nextion Binary Sensor, components/binary_sensor/nextion, nextion.jpg Template Binary Sensor, components/binary_sensor/template, description.svg