sensesp::AngleCorrection Class Reference

Add a value to an angle input (in radians). The output value is wrapped to a range between [0, 2*pi]. This transform is useful for correcting e.g. a heading or a wind direction reading. More...

#include <sensesp/transforms/angle_correction.h>

Inheritance diagram for sensesp::AngleCorrection:

Public Member Functions
	AngleCorrection (float offset, float min_angle=0, String config_path="")
virtual void	set_input (float input, uint8_t inputChannel=0) 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::SymmetricTransform< float >
	SymmetricTransform (String config_path="")
Public Member Functions inherited from sensesp::Transform< C, P >
	Transform (String config_path="")
Transform< C, P > *	connect_from (ValueProducer< P > *producer0, ValueProducer< P > *producer1=NULL, ValueProducer< P > *producer2=NULL, ValueProducer< P > *producer3=NULL, ValueProducer< P > *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)
virtual void	start ()
const int	get_start_priority ()
void	set_start_priority (int priority)
Public Member Functions inherited from sensesp::ValueConsumer< C >
virtual void	set_input (C new_value, uint8_t input_channel=0)
void	connect_from (ValueProducer< C > *producer, uint8_t input_channel=0)
Public Member Functions inherited from sensesp::ValueProducer< P >
	ValueProducer ()
virtual const P &	get () const
void	connect_to (ValueConsumer< P > *consumer, uint8_t input_channel=0)
void	connect_to (ValueConsumer< CT > *consumer, uint8_t input_channel=0)
	Connect a producer to a consumer of a different type.
Transform< P, T2 > *	connect_to (Transform< P, T2 > *consumer_producer, uint8_t input_channel=0)
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 (P 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< P >
P	output

Detailed Description

Add a value to an angle input (in radians). The output value is wrapped to a range between [0, 2*pi]. This transform is useful for correcting e.g. a heading or a wind direction reading.

Parameters

offset	Value to be added, in radians.
min_angle	If you have output between -pi and pi, use -3.14159265, otherwise use 0. Default value is 0.
config_path	Path to configure this transform in the Config UI.

Definition at line 20 of file angle_correction.h.

Constructor & Destructor Documentation

AngleCorrection()

sensesp::AngleCorrection::AngleCorrection	(	float	offset,
		float	min_angle = 0,
		String	config_path = ""
	)

Definition at line 7 of file angle_correction.cpp.

Here is the call graph for this function:

Member Function Documentation

get_config_schema()

String sensesp::AngleCorrection::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 38 of file angle_correction.cpp.

get_configuration()

void sensesp::AngleCorrection::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 25 of file angle_correction.cpp.

set_configuration()

bool sensesp::AngleCorrection::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 40 of file angle_correction.cpp.

set_input()

void sensesp::AngleCorrection::set_input ( float  input, uint8_t  inputChannel = 0  )

overridevirtual

Definition at line 13 of file angle_correction.cpp.

Here is the call graph for this function:

---

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

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