sensesp::ConstantSensor< T > Class Template Reference

Base class for constant value sensors. More...

#include <sensesp/sensors/constant_sensor.h>

Inheritance diagram for sensesp::ConstantSensor< T >:

Public Member Functions
	ConstantSensor (T value, int send_interval=30, String config_path="")
void	start () override
void	set_value (T value)
T	get_value ()
Public Member Functions inherited from sensesp::SensorT< T >
	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)

Protected Member Functions
virtual void	get_configuration (JsonObject &doc) override
virtual bool	set_configuration (const JsonObject &config) override
virtual String	get_config_schema () override
void	update ()
Protected Member Functions inherited from sensesp::Configurable
virtual void	load_configuration ()

Protected Attributes
T	value_
int	send_interval_
Protected Attributes inherited from sensesp::Configurable
String	description_ = ""
int	sort_order_ = 1000
Protected Attributes inherited from sensesp::ValueProducer< T >
T	output

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_

Detailed Description

template<class T>
class sensesp::ConstantSensor< T >

Base class for constant value sensors.

Definition at line 53 of file constant_sensor.h.

Constructor & Destructor Documentation

ConstantSensor()

template<class T >

sensesp::ConstantSensor< T >::ConstantSensor ( T  value, int  send_interval = 30, String  config_path = ""  )

inline

Definition at line 55 of file constant_sensor.h.

Here is the call graph for this function:

Member Function Documentation

get_config_schema()

template<class T >

virtual String sensesp::ConstantSensor< T >::get_config_schema ( )

inlineoverrideprotectedvirtual

Returns a configuration schema that specifies the key/value pairs that can be expected when calling get_configuration(), or are expected by set_configuration(). The schema will be in JSON Schema format

See also

https://json-schema.org

Reimplemented from sensesp::Configurable.

Definition at line 82 of file constant_sensor.h.

get_configuration()

template<class T >

virtual void sensesp::ConstantSensor< T >::get_configuration ( JsonObject &  configObject )

inlineoverrideprotectedvirtual

Returns the current configuration data as a JsonObject. In general, the current state of local member variables are saved to a new object created with JsonDocument::as<JsonObject>() and returned.

Reimplemented from sensesp::Configurable.

Definition at line 68 of file constant_sensor.h.

get_value()

template<class T >

T sensesp::ConstantSensor< T >::get_value ( )

inline

Definition at line 65 of file constant_sensor.h.

set_configuration()

template<class T >

virtual bool sensesp::ConstantSensor< T >::set_configuration ( const JsonObject &  config )

inlineoverrideprotectedvirtual

Sets the current state of local member variables using the data stored in config.

Reimplemented from sensesp::Configurable.

Definition at line 72 of file constant_sensor.h.

set_value()

template<class T >

void sensesp::ConstantSensor< T >::set_value ( T  value )

inline

Definition at line 64 of file constant_sensor.h.

start()

template<class T >

void sensesp::ConstantSensor< T >::start ( )

inlineoverridevirtual

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 constant_sensor.h.

Here is the call graph for this function:

update()

template<class T >

void sensesp::ConstantSensor< T >::update ( )

inlineprotected

Definition at line 85 of file constant_sensor.h.

Here is the call graph for this function:

Member Data Documentation

send_interval_

template<class T >

int sensesp::ConstantSensor< T >::send_interval_

protected

Definition at line 88 of file constant_sensor.h.

value_

template<class T >

T sensesp::ConstantSensor< T >::value_

protected

Definition at line 87 of file constant_sensor.h.

---

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

• src/sensesp/sensors/constant_sensor.h