Class espos::sensors::Analog¶

ClassList > espos > sensors > Analog

#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
	Analog (const char * id, int gpio, uint32_t period_ms, espos_adc_atten_t atten=ESPOS_ADC_ATTEN_12DB, uint8_t samples=16)
bool	calibrated () const
esp_err_t	open_error () const
std::optional< float >	read_now ()
esp_err_t	start ()
void	stop ()

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)

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 Analog¶

inline espos::sensors::Analog::Analog (
    const char * id,
    int gpio,
    uint32_t period_ms,
    espos_adc_atten_t atten=ESPOS_ADC_ATTEN_12DB,
    uint8_t samples=16
)

function calibrated¶

inline bool espos::sensors::Analog::calibrated () const

function open_error¶

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

function read_now¶

inline std::optional< float > espos::sensors::Analog::read_now ()

function start¶

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

function stop¶

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

Protected Functions Documentation¶

function node_id_for_error¶

inline virtual const char * espos::sensors::Analog::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