esphome-docs/components/sensor/duty_cycle.rst

42 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2018-06-13 22:38:49 +02:00
Duty Cycle Sensor
=================
2018-11-14 22:12:27 +01:00
.. seo::
2019-02-16 23:25:23 +01:00
:description: Instructions for setting up duty cycle sensors in ESPHome
:image: percent.png
2018-11-14 22:12:27 +01:00
2018-06-13 22:38:49 +02:00
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
2018-06-13 22:38:49 +02:00
# 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.
2019-01-06 18:56:14 +01:00
- **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.
2019-02-17 12:28:17 +01:00
- All other options from :ref:`Sensor <config-sensor>`.
2018-10-12 16:33:22 +02:00
See Also
--------
- :ref:`sensor-filters`
- :apiref:`sensor/duty_cycle_sensor.h`
- :ghedit:`Edit`