esphome-docs/components/sensor/duty_cycle.rst
Otto Winter 6053f490b5
Update svg2png and seo.py (#1380)
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
2021-11-16 15:19:33 +13:00

42 lines
1.1 KiB
ReStructuredText

Duty Cycle Sensor
=================
.. seo::
:description: Instructions for setting up duty cycle sensors in ESPHome
:image: percent.svg
The duty cycle sensor allows you to measure for what percentage of time a signal
on a GPIO pin is HIGH or LOW.
For example, you can measure if a status LED of a pool controller is permanently active
(indicating that the pump is on) or blinking.
.. figure:: images/duty_cycle-ui.png
:align: center
:width: 80.0%
.. code-block:: yaml
# Example configuration entry
sensor:
- platform: duty_cycle
pin: D0
name: Duty Cycle Sensor
Configuration variables:
------------------------
- **pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The pin to observe for the duty
cycle.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
See Also
--------
- :ref:`sensor-filters`
- :apiref:`duty_cycle/duty_cycle_sensor.h`
- :ghedit:`Edit`