esphome-docs/api/sensor/index.rst

161 lines
3.1 KiB
ReStructuredText
Raw Normal View History

2018-05-13 11:37:02 +02:00
Sensor
======
The `sensor` namespace contains all sensors.
2018-05-14 21:15:49 +02:00
.. cpp:namespace:: nullptr
2018-05-13 11:37:02 +02:00
See :cpp:func:`Application::register_sensor`.
.. toctree::
:maxdepth: 1
adc-sensor.rst
dallas.rst
dht.rst
2018-05-17 17:34:49 +02:00
dht12.rst
2018-05-13 11:37:02 +02:00
pulse-counter.rst
ultrasonic.rst
ads1115.rst
bmp085.rst
htu21d.rst
hdc1080.rst
mpu6050.rst
tsl2561.rst
bme280.rst
bme680.rst
sht3xd.rst
2018-05-14 21:15:49 +02:00
bh1750.rst
2018-06-01 18:10:00 +02:00
max6675.rst
rotary_encoder.rst
template.rst
2018-05-13 11:37:02 +02:00
API Reference
-------------
.. cpp:namespace:: nullptr
Sensor
******
.. doxygenclass:: sensor::Sensor
:members:
:protected-members:
:undoc-members:
.. doxygentypedef:: sensor::sensor_callback_t
.. doxygenclass:: sensor::PollingSensorComponent
:members:
:protected-members:
:undoc-members:
.. doxygenclass:: sensor::EmptySensor
:members:
:protected-members:
:undoc-members:
.. doxygenclass:: sensor::EmptyPollingParentSensor
:members:
:protected-members:
:undoc-members:
.. doxygenvariable:: sensor::ICON_EMPTY
.. doxygenvariable:: sensor::ICON_WATER_PERCENT
.. doxygenvariable:: sensor::ICON_GAUGE
.. doxygenvariable:: sensor::ICON_FLASH
.. doxygenvariable:: sensor::ICON_SCREEN_ROTATION
.. doxygenvariable:: sensor::ICON_BRIEFCASE_DOWNLOAD
.. doxygenvariable:: sensor::UNIT_C
.. doxygenvariable:: sensor::UNIT_PERCENT
.. doxygenvariable:: sensor::UNIT_HPA
.. doxygenvariable:: sensor::UNIT_V
.. doxygenvariable:: sensor::UNIT_DEGREES_PER_SECOND
.. doxygenvariable:: sensor::UNIT_M_PER_S_SQUARED
Filter
******
.. doxygenclass:: sensor::Filter
:members:
:protected-members:
:undoc-members:
.. doxygenclass:: sensor::SlidingWindowMovingAverageFilter
:members:
:protected-members:
:undoc-members:
.. doxygenclass:: sensor::ExponentialMovingAverageFilter
:members:
:protected-members:
:undoc-members:
.. doxygentypedef:: sensor::lambda_filter_t
.. doxygenclass:: sensor::LambdaFilter
:members:
:protected-members:
:undoc-members:
.. doxygenclass:: sensor::OffsetFilter
:members:
:protected-members:
:undoc-members:
.. doxygenclass:: sensor::MultiplyFilter
:members:
:protected-members:
:undoc-members:
.. doxygenclass:: sensor::FilterOutValueFilter
:members:
:protected-members:
:undoc-members:
.. doxygenclass:: sensor::FilterOutNANFilter
:members:
:protected-members:
:undoc-members:
2018-05-17 21:39:46 +02:00
.. doxygenclass:: sensor::ThrottleFilter
:members:
:protected-members:
:undoc-members:
2018-05-18 08:21:52 +02:00
.. doxygenclass:: sensor::HeartbeatFilter
2018-05-17 21:39:46 +02:00
:members:
:protected-members:
:undoc-members:
2018-05-18 08:21:52 +02:00
.. doxygenclass:: sensor::DebounceFilter
:members:
:protected-members:
:undoc-members:
.. doxygenclass:: sensor::DeltaFilter
2018-05-17 21:39:46 +02:00
:members:
:protected-members:
:undoc-members:
2018-05-18 08:21:52 +02:00
.. doxygenclass:: sensor::OrFilter
2018-05-17 21:39:46 +02:00
:members:
:protected-members:
:undoc-members:
.. doxygenclass:: sensor::UniqueFilter
:members:
:protected-members:
:undoc-members:
2018-05-13 11:37:02 +02:00
MQTTSensorComponent
*******************
.. doxygenclass:: sensor::MQTTSensorComponent
:members:
:protected-members:
:undoc-members: