sensesp::Frequency Class Reference

Transforms its input into frequency (Hz: cycles per second) More...

#include <sensesp/transforms/frequency.h>

Inheritance diagram for sensesp::Frequency:

Public Member Functions
	Frequency (float multiplier=1, String config_path="")
virtual void	set_input (int input, uint8_t inputChannel=0) override
virtual void	start () override
virtual void	get_configuration (JsonObject &doc) override
virtual bool	set_configuration (const JsonObject &config) override
virtual String	get_config_schema () override
Public Member Functions inherited from sensesp::Transform< int, float >
	Transform (String config_path="")
Transform< int, 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 (String config_path="")
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::ValueConsumer< T >
virtual void	set_input (T new_value, uint8_t input_channel=0)
void	connect_from (ValueProducer< T > *producer, uint8_t input_channel=0)
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)
Public Member Functions inherited from sensesp::Observable
	Observable ()
	Observable (Observable &&other)
	Move constructor.
void	notify ()
void	attach (std::function< void()> observer)

Additional Inherited Members
Static Public Member Functions inherited from sensesp::TransformBase
static const std::set< TransformBase * > &	get_transforms ()
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::Configurable
String	description_ = ""
int	sort_order_ = 1000
Protected Attributes inherited from sensesp::ValueProducer< T >
T	output

Detailed Description

Transforms its input into frequency (Hz: cycles per second)

Divides its input value by the time elapsed since the last reading.

Parameters

multiplier	Output is multiplied by this parameter before being output, as a way to adjust the scale of the ouput. For example, if you're calculating the frequency of engine revolutions and you're sensing 4 signals per revolution (such as with 4 magnets on the flywheel), set multiplier = 0.25 to convert the total signals into "revolutions".
config_path	Path to configure this transform in the Config UI.

Definition at line 21 of file frequency.h.

Constructor & Destructor Documentation

Frequency()

sensesp::Frequency::Frequency	(	float	multiplier = 1,
		String	config_path = ""
	)

Definition at line 7 of file frequency.cpp.

Here is the call graph for this function:

Member Function Documentation

get_config_schema()

String sensesp::Frequency::get_config_schema ( )

overridevirtual

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 32 of file frequency.cpp.

get_configuration()

void sensesp::Frequency::get_configuration ( JsonObject &  configObject )

overridevirtual

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 21 of file frequency.cpp.

set_configuration()

bool sensesp::Frequency::set_configuration ( const JsonObject &  config )

overridevirtual

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

Reimplemented from sensesp::Configurable.

Definition at line 34 of file frequency.cpp.

set_input()

void sensesp::Frequency::set_input ( int  input, uint8_t  inputChannel = 0  )

overridevirtual

Definition at line 14 of file frequency.cpp.

Here is the call graph for this function:

start()

void sensesp::Frequency::start ( )

overridevirtual

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

Reimplemented from sensesp::Startable.

Definition at line 12 of file frequency.cpp.

---

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

• src/sensesp/transforms/frequency.h
• src/sensesp/transforms/frequency.cpp