diff --git a/components/sensor/images/pmwcs3.jpg b/components/sensor/images/pmwcs3.jpg new file mode 100644 index 000000000..0c775b6f7 Binary files /dev/null and b/components/sensor/images/pmwcs3.jpg differ diff --git a/components/sensor/pmwcs3.rst b/components/sensor/pmwcs3.rst new file mode 100644 index 000000000..e282e3de5 --- /dev/null +++ b/components/sensor/pmwcs3.rst @@ -0,0 +1,135 @@ +PMWCS3 Capacitive Soil Moisture and Temperature Sensor +====================================================== + +.. seo:: + :description: Instructions for setting up PMWCS3 capacitive soil moisture sensor in ESPHome. + :image: pmwcs3.jpg + :keywords: PMWCS3 + +The ``pmwcs3`` sensor platform allows you to use your PMWCS3 +(`informations `__) +capacitive soil moisture and temperature sensor with ESPHome. The :ref:`I²C bus ` is required to be set up in +your configuration for this sensor to work. Wiring scheme: red is 3.3V, black & shield is GND, green is SDA and white is SCL. +2.2kOhm resistors are advised to pullup both SDA & SDA lines. + +.. figure:: images/pmwcs3.jpg + :align: center + :width: 80.0% + + PMWCS3 Capacitive Soil Moisture and Temperature Sensor. + + +.. code-block:: yaml + + # Example configuration entry + sensor: + - platform: pmwcs3 + e25: + name: "pmwcs3 e25" + ec: + name: "pmwcs3 ec" + temperature: + name: "pmwcs3 temperature" + vwc: + name: "pmwcs3 vwc" + +Configuration variables: +------------------------ + +- **e25** (*Optional*): Electrical Conductivity, reference at 25°C in dS/m. + All options from :ref:`Sensor `. +- **ec** (*Optional*): Electrical Conductivity in mS/m. + All options from :ref:`Sensor `. +- **temperature** (*Optional*): Soil temperature in °C. + All options from :ref:`Sensor `. +- **vwc** (*Optional*): Volumetric Water Content in cm3cm−3. + All options from :ref:`Sensor `. +- **address** (*Optional*, int): Manually specify the I²C address of the sensor. + Defaults to ``0x63``. +- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the + sensor. Defaults to ``60s``. + +.. _sensor-PMWCS3AirCalibrationAction: + +``pmwcs3.air_calibration`` Action +----------------------------------- + +The pmwcs3 probe can to be calibrated in dry/air conditions. +The air calibration is a 30s procedure. + +.. code-block:: yaml + + # Example configuration entry + sensor: + - platform: pmwcs3 + id: pmwcs3_id + # ... + + # in some trigger + on_...: + - sensor.pmwcs3_id.air_calibration: + id: pmwcs3_id + +Configuration option: + +- **id** (**Required**, :ref:`config-id`): The ID of the pmwcs3 sensor. + +.. _sensor-PMWCS3WaterCalibrationAction: + +``pmwcs3.water_calibration`` Action +----------------------------------- + +The pmwcs3 probe can to be also calibrated in water saturated conditions. Install the probe into a glass of water. +The water calibration is also a 30s procedure. + +.. code-block:: yaml + + # Example configuration entry + sensor: + - platform: pmwcs3 + id: pmwcs3_id + # ... + + # in some trigger + on_...: + - sensor.pmwcs3_id.water_calibration: + id: pmwcs3_id + +Configuration option: + +- **id** (**Required**, :ref:`config-id`): The ID of the pmwcs3 sensor. + +.. _sensor-PMWCS3NewI2cAddressAction: + +``pmwcs3.newi2caddress`` Action +----------------------------------- + +A new I2C address can be set (for multi-probes cases for example) + +.. code-block:: yaml + + # Example configuration entry + sensor: + - platform: pmwcs3 + id: pmwcs3_id + # ... + + # in some trigger + on_...: + - sensor.pmwcs3_id.newi2caddress: + id: pmwcs3_id + newaddress: 0x65 + +Configuration options: + +- **id** (**Required**, :ref:`config-id`): The ID of the pmwcs3 sensor. +- **newaddress** (**Required**, int): New I2C address. + +See Also +-------- + +- :ref:`sensor-filters` +- :apiref:`pmwcs3/pmwcs3.h` +- `Temperature Compensation for Conductivity `__ +- `PMWCS3 Library `__ by `@tinovi `__ +- :ghedit:`Edit` diff --git a/images/pmwcs3.jpg b/images/pmwcs3.jpg new file mode 100644 index 000000000..ab5c75301 Binary files /dev/null and b/images/pmwcs3.jpg differ diff --git a/index.rst b/index.rst index bc7f3bc98..76b675a20 100644 --- a/index.rst +++ b/index.rst @@ -311,6 +311,7 @@ Environmental MPL3115A2, components/sensor/mpl3115a2, mpl3115a2.jpg, Temperature & Pressure MS5611, components/sensor/ms5611, ms5611.jpg, Pressure NTC Thermistor, components/sensor/ntc, ntc.jpg, Temperature + PMWCS3, components/sensor/pmwcs3, pmwcs3.jpg, Soil moisture & Temperature QMP6988, components/sensor/qmp6988, qmp6988_env3.png, Temperature & Pressure RadonEye BLE, components/sensor/radon_eye_ble, radon_eye_logo.png, Radon RuuviTag, components/sensor/ruuvitag, ruuvitag.jpg, Temperature & Humidity & Accelerometer