#include <pulse_meter_sensor.h>

Inheritance diagram for esphome::pulse_meter::PulseMeterSensor:

Data Structures
struct	EdgeState
	Filter state for edge mode. More...

struct	PulseState
	Filter state for pulse mode. More...

struct	State

Public Types
enum	InternalFilterMode { FILTER_EDGE = 0, FILTER_PULSE }

Public Member Functions
void	set_pin (InternalGPIOPin *pin)

void	set_filter_us (uint32_t filter)

void	set_timeout_us (uint32_t timeout)

void	set_total_sensor (sensor::Sensor *sensor)

void	set_filter_mode (InternalFilterMode mode)

void	set_total_pulses (uint32_t pulses)

void	setup () override

void	loop () override

float	get_setup_priority () const override

void	dump_config () override

Public Member Functions inherited from esphome::sensor::Sensor
	Sensor ()

int8_t	get_accuracy_decimals ()
	Get the accuracy in decimals, using the manual override if set. More...

void	set_accuracy_decimals (int8_t accuracy_decimals)
	Manually set the accuracy in decimals. More...

StateClass	get_state_class ()
	Get the state class, using the manual override if set. More...

void	set_state_class (StateClass state_class)
	Manually set the state class. More...

bool	get_force_update () const
	Get whether force update mode is enabled. More...

void	set_force_update (bool force_update)
	Set force update mode. More...

void	add_filter (Filter *filter)
	Add a filter to the filter chain. Will be appended to the back. More...

void	add_filters (const std::vector< Filter *> &filters)
	Add a list of vectors to the back of the filter chain. More...

void	set_filters (const std::vector< Filter *> &filters)
	Clear the filters and replace them by filters. More...

void	clear_filters ()
	Clear the entire filter chain. More...

float	get_state () const
	Getter-syntax for .state. More...

float	get_raw_state () const
	Getter-syntax for .raw_state. More...

void	publish_state (float state)
	Publish a new state to the front-end. More...

void	add_on_state_callback (std::function< void(float)> &&callback)
	Add a callback that will be called every time a filtered value arrives. More...

void	add_on_raw_state_callback (std::function< void(float)> &&callback)
	Add a callback that will be called every time the sensor sends a raw value. More...

bool	has_state () const
	Return whether this sensor has gotten a full state (that passed through all filters) yet. More...

virtual std::string	unique_id ()
	Override this method to set the unique ID of this sensor. More...

void	internal_send_state_to_frontend (float state)

Public Member Functions inherited from esphome::EntityBase
const StringRef &	get_name () const

void	set_name (const char *name)

bool	has_own_name () const

std::string	get_object_id () const

void	set_object_id (const char *object_id)

uint32_t	get_object_id_hash ()

bool	is_internal () const

void	set_internal (bool internal)

bool	is_disabled_by_default () const

void	set_disabled_by_default (bool disabled_by_default)

EntityCategory	get_entity_category () const

void	set_entity_category (EntityCategory entity_category)

std::string	get_icon () const

void	set_icon (const char *icon)

Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string	get_device_class ()
	Get the device class, using the manual override if set. More...

void	set_device_class (const char *device_class)
	Manually set the device class. More...

Public Member Functions inherited from esphome::EntityBase_UnitOfMeasurement
std::string	get_unit_of_measurement ()
	Get the unit of measurement, using the manual override if set. More...

void	set_unit_of_measurement (const char *unit_of_measurement)
	Manually set the unit of measurement. More...

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop(). More...

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages. More...

const char *	get_component_source () const
	Get the integration where this component was declared as a string. More...

Protected Types
enum	MeterState { MeterState::INITIAL, MeterState::RUNNING, MeterState::TIMED_OUT }

Static Protected Member Functions
static void	edge_intr (PulseMeterSensor *sensor)

static void	pulse_intr (PulseMeterSensor *sensor)

Protected Attributes
InternalGPIOPin *	pin_ {nullptr}

uint32_t	filter_us_ = 0

uint32_t	timeout_us_ = 1000000UL * 60UL * 5UL

sensor::Sensor *	total_sensor_ {nullptr}

InternalFilterMode	filter_mode_ {FILTER_EDGE}

MeterState	meter_state_ = MeterState::INITIAL

bool	peeked_edge_ = false

uint32_t	total_pulses_ = 0

uint32_t	last_processed_edge_us_ = 0

State	state_ [2]

volatile State *	set_ = state_

volatile State *	get_ = state_ + 1

ISRInternalGPIOPin	isr_pin_

EdgeState	edge_state_ {}

PulseState	pulse_state_ {}

Protected Attributes inherited from esphome::sensor::Sensor
CallbackManager< void(float)>	raw_callback_
	Storage for raw state callbacks. More...

CallbackManager< void(float)>	callback_
	Storage for filtered state callbacks. More...

Filter *	filter_list_ {nullptr}
	Store all active filters. More...

optional< int8_t >	accuracy_decimals_
	Accuracy in decimals override. More...

optional< StateClass >	state_class_ {STATE_CLASS_NONE}
	State class override. More...

bool	force_update_ {false}
	Force update mode. More...

bool	has_state_ {false}

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

const char *	object_id_c_str_ {nullptr}

const char *	icon_c_str_ {nullptr}

uint32_t	object_id_hash_

bool	has_own_name_ {false}

bool	internal_ {false}

bool	disabled_by_default_ {false}

EntityCategory	entity_category_ {ENTITY_CATEGORY_NONE}

Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char *	device_class_ {nullptr}
	Device class override. More...

Protected Attributes inherited from esphome::EntityBase_UnitOfMeasurement
const char *	unit_of_measurement_ {nullptr}
	Unit of measurement override. More...

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

Additional Inherited Members
Data Fields inherited from esphome::sensor::Sensor
float	state
	This member variable stores the last state that has passed through all filters. More...

float	raw_state
	This member variable stores the current raw state of the sensor, without any filters applied. More...

Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t	hash_base ()
	The hash_base() function has been deprecated. More...

void	calc_object_id_ ()

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name. More...

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function. More...

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name. More...

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function. More...

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name. More...

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function. More...

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty. More...

Detailed Description

Definition at line 13 of file pulse_meter_sensor.h.

Member Enumeration Documentation

◆ InternalFilterMode

enum esphome::pulse_meter::PulseMeterSensor::InternalFilterMode

Enumerator
FILTER_EDGE
FILTER_PULSE

Definition at line 15 of file pulse_meter_sensor.h.

◆ MeterState

enum esphome::pulse_meter::PulseMeterSensor::MeterState

strongprotected

Enumerator
INITIAL
RUNNING
TIMED_OUT

Definition at line 44 of file pulse_meter_sensor.h.

Member Function Documentation

◆ dump_config()

void esphome::pulse_meter::PulseMeterSensor::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 107 of file pulse_meter_sensor.cpp.

◆ edge_intr()

void IRAM_ATTR esphome::pulse_meter::PulseMeterSensor::edge_intr ( PulseMeterSensor * sensor )

staticprotected

Definition at line 119 of file pulse_meter_sensor.cpp.

◆ get_setup_priority()

float esphome::pulse_meter::PulseMeterSensor::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 105 of file pulse_meter_sensor.cpp.

◆ loop()

void esphome::pulse_meter::PulseMeterSensor::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 34 of file pulse_meter_sensor.cpp.

◆ pulse_intr()

void IRAM_ATTR esphome::pulse_meter::PulseMeterSensor::pulse_intr ( PulseMeterSensor * sensor )

staticprotected

Definition at line 134 of file pulse_meter_sensor.cpp.

◆ set_filter_mode()

void esphome::pulse_meter::PulseMeterSensor::set_filter_mode ( InternalFilterMode mode )

inline

Definition at line 24 of file pulse_meter_sensor.h.

◆ set_filter_us()

void esphome::pulse_meter::PulseMeterSensor::set_filter_us ( uint32_t filter )

inline

Definition at line 21 of file pulse_meter_sensor.h.

◆ set_pin()

void esphome::pulse_meter::PulseMeterSensor::set_pin ( InternalGPIOPin * pin )

inline

Definition at line 20 of file pulse_meter_sensor.h.

◆ set_timeout_us()

void esphome::pulse_meter::PulseMeterSensor::set_timeout_us ( uint32_t timeout )

inline

Definition at line 22 of file pulse_meter_sensor.h.

◆ set_total_pulses()

void esphome::pulse_meter::PulseMeterSensor::set_total_pulses ( uint32_t pulses )

Definition at line 10 of file pulse_meter_sensor.cpp.

◆ set_total_sensor()

void esphome::pulse_meter::PulseMeterSensor::set_total_sensor ( sensor::Sensor * sensor )

inline

Definition at line 23 of file pulse_meter_sensor.h.

◆ setup()

void esphome::pulse_meter::PulseMeterSensor::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file pulse_meter_sensor.cpp.

Field Documentation

◆ edge_state_

EdgeState esphome::pulse_meter::PulseMeterSensor::edge_state_ {}

protected

Definition at line 71 of file pulse_meter_sensor.h.

◆ filter_mode_

InternalFilterMode esphome::pulse_meter::PulseMeterSensor::filter_mode_ {FILTER_EDGE}

protected

Definition at line 41 of file pulse_meter_sensor.h.

◆ filter_us_

uint32_t esphome::pulse_meter::PulseMeterSensor::filter_us_ = 0

protected

Definition at line 38 of file pulse_meter_sensor.h.

◆ get_

volatile State* esphome::pulse_meter::PulseMeterSensor::get_ = state_ + 1

protected

Definition at line 62 of file pulse_meter_sensor.h.

◆ isr_pin_

ISRInternalGPIOPin esphome::pulse_meter::PulseMeterSensor::isr_pin_

protected

Definition at line 65 of file pulse_meter_sensor.h.

◆ last_processed_edge_us_

uint32_t esphome::pulse_meter::PulseMeterSensor::last_processed_edge_us_ = 0

protected

Definition at line 48 of file pulse_meter_sensor.h.

◆ meter_state_

MeterState esphome::pulse_meter::PulseMeterSensor::meter_state_ = MeterState::INITIAL

protected

Definition at line 45 of file pulse_meter_sensor.h.

◆ peeked_edge_

bool esphome::pulse_meter::PulseMeterSensor::peeked_edge_ = false

protected

Definition at line 46 of file pulse_meter_sensor.h.

◆ pin_

InternalGPIOPin* esphome::pulse_meter::PulseMeterSensor::pin_ {nullptr}

protected

Definition at line 37 of file pulse_meter_sensor.h.

◆ pulse_state_

PulseState esphome::pulse_meter::PulseMeterSensor::pulse_state_ {}

protected

Definition at line 79 of file pulse_meter_sensor.h.

◆ set_

volatile State* esphome::pulse_meter::PulseMeterSensor::set_ = state_

protected

Definition at line 61 of file pulse_meter_sensor.h.

◆ state_

State esphome::pulse_meter::PulseMeterSensor::state_[2]

protected

Definition at line 60 of file pulse_meter_sensor.h.

◆ timeout_us_

uint32_t esphome::pulse_meter::PulseMeterSensor::timeout_us_ = 1000000UL * 60UL * 5UL

protected

Definition at line 39 of file pulse_meter_sensor.h.

◆ total_pulses_

uint32_t esphome::pulse_meter::PulseMeterSensor::total_pulses_ = 0

protected

Definition at line 47 of file pulse_meter_sensor.h.

◆ total_sensor_

sensor::Sensor* esphome::pulse_meter::PulseMeterSensor::total_sensor_ {nullptr}

protected

Definition at line 40 of file pulse_meter_sensor.h.

The documentation for this class was generated from the following files:

/opt/build/esphome/esphome/components/pulse_meter/pulse_meter_sensor.h
/opt/build/esphome/esphome/components/pulse_meter/pulse_meter_sensor.cpp

Data Structures

Public Types

Public Member Functions

Protected Types

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ InternalFilterMode

◆ MeterState

Member Function Documentation

◆ dump_config()

◆ edge_intr()

◆ get_setup_priority()

◆ loop()

◆ pulse_intr()

◆ set_filter_mode()

◆ set_filter_us()

◆ set_pin()

◆ set_timeout_us()

◆ set_total_pulses()

◆ set_total_sensor()

◆ setup()

Field Documentation

◆ edge_state_

◆ filter_mode_

◆ filter_us_

◆ get_

◆ isr_pin_

◆ last_processed_edge_us_

◆ meter_state_

◆ peeked_edge_

◆ pin_

◆ pulse_state_

◆ set_

◆ state_

◆ timeout_us_

◆ total_pulses_

◆ total_sensor_