Translates an integer value into a boolean value, which depends on whether the integer value is "in range" or "out of range". More...

#include <sensesp/transforms/threshold.h>

Inheritance diagram for sensesp::IntThreshold:

[legend]

Public Member Functions
	IntThreshold (int min_value, int max_value, bool in_range=true, String config_path="")

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::ThresholdTransform< int, bool >
	ThresholdTransform (int min_value, int max_value, bool in_range, String config_path="")

virtual void	set_input (int new_value, uint8_t input_channel=0) override

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 >
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::ThresholdTransform< int, bool >
int	min_value_

int	max_value_

bool	in_range_

Protected Attributes inherited from sensesp::Configurable
String	description_ = ""

int	sort_order_ = 1000

Protected Attributes inherited from sensesp::ValueProducer< P >
P	output

Detailed Description

Translates an integer value into a boolean value, which depends on whether the integer value is "in range" or "out of range".

Parameters

min_value	The minimum of the range for the input value to be "in range".
max_value	The maximum of the range for the input value to be "in range".
in_range	The output value if the input value is "in range". Default is true. (If the input value is not "in range", the value of output is the opposite of in_range.)
config_path	Path to configure this transform in the Config UI.

Definition at line 80 of file threshold.h.

Constructor & Destructor Documentation

◆ IntThreshold()

sensesp::IntThreshold::IntThreshold	(	int	min_value,
		int	max_value,
		bool	in_range = `true`,
		String	config_path = `""`
	)

inline

Definition at line 82 of file threshold.h.

Member Function Documentation

◆ get_config_schema()

String sensesp::IntThreshold::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 74 of file threshold.cpp.

◆ get_configuration()

void sensesp::IntThreshold::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 46 of file threshold.cpp.

◆ set_configuration()

bool sensesp::IntThreshold::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 61 of file threshold.cpp.

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

src/sensesp/transforms/threshold.h
src/sensesp/transforms/threshold.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IntThreshold()

Member Function Documentation

◆ get_config_schema()

◆ get_configuration()

◆ set_configuration()