DigitalInputCounter counts interrupts and reports the count every read_delay ms. More...

#include <sensesp/sensors/digital_input.h>

Inheritance diagram for sensesp::DigitalInputCounter:

Public Member Functions
	DigitalInputCounter (uint8_t pin, int pin_mode, int interrupt_type, unsigned int read_delay, String config_path="")

virtual bool	to_json (JsonObject &root) override

virtual bool	from_json (const JsonObject &config) override

Public Member Functions inherited from sensesp::DigitalInput
	DigitalInput (uint8_t pin, int pin_mode)

Public Member Functions inherited from sensesp::Sensor< int >
	Sensor (String config_path)

Public Member Functions inherited from sensesp::SensorConfig
	SensorConfig (const String &config_path)

Public Member Functions inherited from sensesp::Observable
	Observable ()

	Observable (Observable &&other)
	Move constructor.

void	notify ()

void	attach (std::function< void()> observer)

Public Member Functions inherited from sensesp::FileSystemSaveable
	FileSystemSaveable (const String &config_path)

virtual bool	load () override
	Load and populate the object from a persistent storage.

virtual bool	save () override
	Save the object to a persistent storage.

virtual bool	clear () override
	Delete the data from a persistent storage.

bool	find_config_file (const String &config_path, String &filename)

Public Member Functions inherited from sensesp::Saveable
	Saveable (const String &config_path)

virtual bool	refresh ()
	Refresh the object. This may or may not access the persistent storage but is not expected to overwrite the object's state.

const String &	get_config_path () const

Public Member Functions inherited from sensesp::Serializable
Public Member Functions inherited from sensesp::ValueProducer< int >
	ValueProducer ()

	ValueProducer (const int &initial_value)

virtual const int &	get () const

std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< int, typenameVConsumer::input_type >::value, std::shared_ptr< VConsumer > >::type	connect_to (std::shared_ptr< VConsumer > consumer)
	Connect a producer to a transform with a different input type.

std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< int, typenameVConsumer::input_type >::value, VConsumer * >::type	connect_to (VConsumer *consumer)

std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< int, typenameVConsumer::input_type >::value, VConsumer * >::type	connect_to (VConsumer &consumer)

void	emit (const int &new_value)

Protected Member Functions
	DigitalInputCounter (uint8_t pin, int pin_mode, int interrupt_type, unsigned int read_delay, String config_path, std::function< void()> interrupt_handler)

Protected Attributes
unsigned int	read_delay_

volatile unsigned int	counter_ = 0

Protected Attributes inherited from sensesp::DigitalInput
uint8_t	pin_

Protected Attributes inherited from sensesp::Saveable
const String	config_path_

Protected Attributes inherited from sensesp::ValueProducer< int >
int	output_

Detailed Description

DigitalInputCounter counts interrupts and reports the count every read_delay ms.

A typical use case is to count the revolutions of something, such as an engine, to determine RPM. See /examples/rpm_counter.cpp

Parameters

pin	The GPIO pin to which the device is connected
pin_mode	Will be INPUT or INPUT_PULLUP
interrupt_type	Will be RISING, FALLING, or CHANGE
read_delay	How often you want to read the pin, in ms
config_path	The path to configuring read_delay in the Config UI

Definition at line 93 of file digital_input.h.

Constructor & Destructor Documentation

◆ DigitalInputCounter() [1/2]

sensesp::DigitalInputCounter::DigitalInputCounter	(	uint8_t	pin,
		int	pin_mode,
		int	interrupt_type,
		unsigned int	read_delay,
		String	config_path = "" )

inline

Definition at line 95 of file digital_input.h.

◆ DigitalInputCounter() [2/2]

sensesp::DigitalInputCounter::DigitalInputCounter	(	uint8_t	pin,
		int	pin_mode,
		int	interrupt_type,
		unsigned int	read_delay,
		String	config_path,
		std::function< void()>	interrupt_handler )

inlineprotected

Definition at line 114 of file digital_input.h.

Here is the call graph for this function:

Member Function Documentation

◆ from_json()

bool sensesp::DigitalInputCounter::from_json ( const JsonObject & root )

overridevirtual

Deserializes the current object data from a JsonObject.

Reimplemented from sensesp::Serializable.

Definition at line 31 of file digital_input.cpp.

◆ to_json()

bool sensesp::DigitalInputCounter::to_json ( JsonObject & root )

overridevirtual

Serializes the current object data into a JsonObject.

Reimplemented from sensesp::Serializable.

Definition at line 26 of file digital_input.cpp.

Member Data Documentation

◆ counter_

volatile unsigned int sensesp::DigitalInputCounter::counter_ = 0

protected

Definition at line 126 of file digital_input.h.

◆ read_delay_

unsigned int sensesp::DigitalInputCounter::read_delay_

protected

Definition at line 125 of file digital_input.h.

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

src/sensesp/sensors/digital_input.h
src/sensesp/sensors/digital_input.cpp

Public Member Functions

Protected Member Functions

Protected Attributes