Class espos::sensors::PulseCounter¶

ClassList > espos > sensors > PulseCounter

#include <espos_sensors/sensors.hpp>

Inherits the following classes: espos::flow::NodeBase, espos::flow::Producer

Public Types inherited from espos::flow::Producer¶

Type	Name
typedef T	produces_type

Public Attributes inherited from espos::flow::NodeBase¶

See espos::flow::NodeBase

Type	Name
NodeBase *	next_node = `[nullptr](classespos_1_1flow_1_1Poll.md)`

Public Functions¶

Type	Name
	PulseCounter (const char * id, int gpio, uint32_t period_ms=1000, uint32_t max_glitch_ns=1000, bool pull_up=true, bool falling=false)
esp_err_t	open_error () const
void	set_total (uint64_t t)
esp_err_t	start ()
void	stop ()
uint64_t	total () const

Public Functions inherited from espos::flow::NodeBase¶

See espos::flow::NodeBase

Type	Name
	NodeBase (const char * id="")
	NodeBase (const NodeBase &) = delete
const char *	id () const
NodeBase &	operator= (const NodeBase &) = delete
const char *	title () const
NodeBase &	with_title (const char * t)
	~NodeBase () = default

Public Functions inherited from espos::flow::Producer¶

See espos::flow::Producer

Type	Name
Sink &	connect_to (Sink & sink)
std::size_t	edge_count () const
void	emit (const T & value)
uint32_t	emitted_at_ms () const
const T &	get () const
bool	has_value () const
Sink &	operator>> (Sink & sink)

Public Static Functions¶

Type	Name
bool	hardware ()

Protected Functions¶

Type	Name
virtual const char *	node_id_for_error () override const

Protected Functions inherited from espos::flow::NodeBase¶

See espos::flow::NodeBase

Type	Name
void	set_id (const char * id)

Protected Functions inherited from espos::flow::Producer¶

See espos::flow::Producer

Type	Name
virtual const char *	node_id_for_error () const
	~Producer () = default

Public Functions Documentation¶

function PulseCounter¶

inline espos::sensors::PulseCounter::PulseCounter (
    const char * id,
    int gpio,
    uint32_t period_ms=1000,
    uint32_t max_glitch_ns=1000,
    bool pull_up=true,
    bool falling=false
)

function open_error¶

inline esp_err_t espos::sensors::PulseCounter::open_error () const

function set_total¶

inline void espos::sensors::PulseCounter::set_total (
    uint64_t t
)

function start¶

inline esp_err_t espos::sensors::PulseCounter::start ()

function stop¶

inline void espos::sensors::PulseCounter::stop ()

function total¶

inline uint64_t espos::sensors::PulseCounter::total () const

Public Static Functions Documentation¶

function hardware¶

static inline bool espos::sensors::PulseCounter::hardware ()

Protected Functions Documentation¶

function node_id_for_error¶

inline virtual const char * espos::sensors::PulseCounter::node_id_for_error () override const

Implements espos::flow::Producer::node_id_for_error

The documentation for this class was generated from the following file espos_sensors/include/espos_sensors/sensors.hpp