Outputs the moving average of the last sample_size inputs. More...

#include <sensesp/transforms/moving_average.h>

Inheritance diagram for sensesp::MovingAverage:

Public Member Functions
	MovingAverage (int sample_size, float multiplier=1.0, const String &config_path="")

virtual void	set (const float &input) override

virtual bool	to_json (JsonObject &root) override

virtual bool	from_json (const JsonObject &config) override

Public Member Functions inherited from sensesp::SymmetricTransform< float >
	SymmetricTransform (String config_path="")

Public Member Functions inherited from sensesp::Transform< float, float >
	Transform (String config_path="")

Transform< float, float > *	connect_from (ValueProducer< float > producer0, ValueProducer< float > producer1=NULL, ValueProducer< float > producer2=NULL, ValueProducer< float > producer3=NULL, ValueProducer< float > *producer4=NULL)

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

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::ValueConsumer< float >
virtual void	set_input (const float &new_value)

void	connect_from (ValueProducer< float > *producer)

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

	ValueProducer (const float &initial_value)

virtual const float &	get () const

std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< float, 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< float, 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< float, typenameVConsumer::input_type >::value, VConsumer * >::type	connect_to (VConsumer &consumer)

void	emit (const float &new_value)

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

	Observable (Observable &&other)
	Move constructor.

void	notify ()

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

Additional Inherited Members
Public Types inherited from sensesp::ValueConsumer< float >
using	input_type

Static Public Member Functions inherited from sensesp::TransformBase
static const std::set< TransformBase * > &	get_transforms ()

Protected Attributes inherited from sensesp::Saveable
const String	config_path_

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

Detailed Description

Outputs the moving average of the last sample_size inputs.

Used to smooth the output of a value (signal) that has frequent variations. For example, the output of a temperature sensor may vary from 180 to 185 several times over a short period, but you just want to see the average of that. MovingAverage outputs the average of the most recent sample_size values. It also incorporates a "scale" factor, in case you want to increase or decrease your final output by a fixed percentage.

Definition at line 23 of file moving_average.h.

Constructor & Destructor Documentation

◆ MovingAverage()

sensesp::MovingAverage::MovingAverage	(	int	sample_size,
		float	multiplier = 1.0,
		const String &	config_path = "" )

Parameters

sample_size	The number of most recent values you want to average for your output.
multiplier	Moving average will be multiplied by multiplier before it is output - make it something other than 1. if you need to scale your output up or down by a fixed percentage.
config_path	The path used to configure this transform in the Config UI.

Definition at line 7 of file moving_average.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ from_json()

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

overridevirtual

Deserializes the current object data from a JsonObject.

Reimplemented from sensesp::Serializable.

Definition at line 44 of file moving_average.cpp.

◆ set()

void sensesp::MovingAverage::set ( const float & new_value )

overridevirtual

Used to set an input of this consumer. It is called automatically by a ValueProducer but can also be called manually.

Parameters

new_value the value of the input

Reimplemented from sensesp::ValueConsumer< float >.

Definition at line 19 of file moving_average.cpp.

Here is the call graph for this function:

◆ to_json()

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

overridevirtual

Serializes the current object data into a JsonObject.

Reimplemented from sensesp::Serializable.

Definition at line 38 of file moving_average.cpp.

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

src/sensesp/transforms/moving_average.h
src/sensesp/transforms/moving_average.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MovingAverage()

Member Function Documentation

◆ from_json()

◆ set()

◆ to_json()