sensesp::DigitalInputState Class Reference

DigitalInputState polls the state of an input pin every read_delay ms. More...

#include <sensesp/sensors/digital_input.h>

Inheritance diagram for sensesp::DigitalInputState:

Public Member Functions
	DigitalInputState (uint8_t pin, int pin_mode, int read_delay=1000, String config_path="")
virtual void	start () override final
Public Member Functions inherited from sensesp::DigitalInput
	DigitalInput (uint8_t pin, int pin_mode)
Public Member Functions inherited from sensesp::SensorT< bool >
	SensorT (String config_path="")
Public Member Functions inherited from sensesp::Sensor
	Sensor (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::Configurable
	Configurable (String config_path="", String description="", int sort_order=1000)
String	get_description ()
void	set_description (String description)
	Set the description of the Configurable.
int	get_sort_order ()
void	set_sort_order (int sort_order)
virtual void	save_configuration ()
Public Member Functions inherited from sensesp::Startable
	Startable (int priority=0)
const int	get_start_priority ()
void	set_start_priority (int priority)
Public Member Functions inherited from sensesp::ValueProducer< T >
	ValueProducer ()
virtual const T &	get () const
void	connect_to (ValueConsumer< T > *consumer, uint8_t input_channel=0)
template<typename CT >
void	connect_to (ValueConsumer< CT > *consumer, uint8_t input_channel=0)
	Connect a producer to a consumer of a different type.
template<typename T2 >
Transform< T, T2 > *	connect_to (Transform< T, T2 > *consumer_producer, uint8_t input_channel=0)
template<typename TT , typename T2 >
Transform< TT, T2 > *	connect_to (Transform< TT, T2 > *consumer_producer, uint8_t input_channel=0)
	Connect a producer to a transform with a different input type.
void	emit (T new_value)

Additional Inherited Members
Static Public Member Functions inherited from sensesp::Sensor
static const std::set< Sensor * > &	get_sensors ()
Static Public Member Functions inherited from sensesp::Startable
static void	start_all ()
Public Attributes inherited from sensesp::Configurable
const String	config_path_
Protected Member Functions inherited from sensesp::Configurable
virtual void	load_configuration ()
Protected Attributes inherited from sensesp::DigitalInput
uint8_t	pin_
Protected Attributes inherited from sensesp::Configurable
String	description_ = ""
int	sort_order_ = 1000
Protected Attributes inherited from sensesp::ValueProducer< T >
T	output

Detailed Description

DigitalInputState polls the state of an input pin every read_delay ms.

It is useful for sampling the state of an input at constant time intervals when you are not interested in rapid changes within those time intervals.

You can use it for monitoring a device (such as a bilge pump) that should (or shouldn't) normally be on (or off). If you use the Signal K to InfluxDb Plugin and Grafana, you can easily see the frequency and duration of the device being on and off.

Parameters

pin	The GPIO pin to which the device is connected.
pin_mode	Will be INPUT or INPUT_PULLUP.
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 48 of file digital_input.h.

Constructor & Destructor Documentation

DigitalInputState()

sensesp::DigitalInputState::DigitalInputState ( uint8_t  pin, int  pin_mode, int  read_delay = 1000, String  config_path = ""  )

inline

Definition at line 50 of file digital_input.h.

Here is the call graph for this function:

Member Function Documentation

start()

virtual void sensesp::DigitalInputState::start ( )

inlinefinaloverridevirtual

Called during the initialization process. Override this method to add runtime initialization code to your class

Reimplemented from sensesp::Startable.

Definition at line 59 of file digital_input.h.

Here is the call graph for this function:

---

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

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