esphome-docs/api/sensor/pulse_counter.rst

30 lines
670 B
ReStructuredText
Raw Normal View History

2018-11-10 15:29:50 +01:00
Pulse Counter Sensor
====================
2018-05-13 11:37:02 +02:00
Example Usage
-------------
.. code-block:: cpp
// Basic
2018-10-20 15:10:26 +02:00
App.make_pulse_counter_sensor("Pulse Counter", 13);
2018-05-13 11:37:02 +02:00
// Unit conversion
2018-10-20 15:10:26 +02:00
auto pcnt_1 = App.make_pulse_counter_sensor("Pulse Counter 2", 13);
pcnt_1.pcnt->set_unit_of_measurement("kW");
pcnt_1.pcnt->clear_filters();
pcnt_1.pcnt->add_multiply_filter(0.06f); // convert from Wh pulse to kW
2018-05-13 11:37:02 +02:00
2018-05-14 21:15:49 +02:00
.. cpp:namespace:: nullptr
2018-05-13 11:37:02 +02:00
See :cpp:func:`Application::make_pulse_counter_sensor`.
API Reference
-------------
.. cpp:namespace:: nullptr
.. doxygenclass:: sensor::PulseCounterSensorComponent
:members:
:protected-members:
:undoc-members: