A transform that takes the output of an analog-to-digital converter and outputs the voltage that went into it. (This can be the built-in ADC on the ESP, or it can be an external ADC like the ADS1015/1115.) More...
#include <sensesp/transforms/analogvoltage.h>
Public Member Functions | |
| AnalogVoltage (float max_voltage=3.3, float multiplier=1.0, float offset=0.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
A transform that takes the output of an analog-to-digital converter and outputs the voltage that went into it. (This can be the built-in ADC on the ESP, or it can be an external ADC like the ADS1015/1115.)
It can also be used like the Linear transport since it has a multiplier and an offset.
If you don't need to use the mulitplier or offset, you probably don't need this transform, because the AnalogInput sensor now has the ability to output the original voltage that came into it, using its output_scale parameter.
- Parameters
-
max_voltage is the maximum voltage allowable on the Analog Input pin of the microcontroller, which is 3.3V on most ESP's, but only 1.0V on some. multiplier The raw output of the transform is multiplied by multiplier. Default value is 1.0, so it does nothing if you don't change it. offset Added to (or subtracted from, if it's negative) the value after multiplier has been applied. Default value is 0.0, so it does nothing if you don't change it. config_path The path in the Config UI to configure this transform.
Definition at line 38 of file analogvoltage.h.
Constructor & Destructor Documentation
◆ AnalogVoltage()
| sensesp::AnalogVoltage::AnalogVoltage | ( | float | max_voltage = 3.3, |
| float | multiplier = 1.0, | ||
| float | offset = 0.0, | ||
| const String & | config_path = "" ) |
Member Function Documentation
◆ from_json()
|
overridevirtual |
Deserializes the current object data from a JsonObject.
Reimplemented from sensesp::Serializable.
Definition at line 26 of file analogvoltage.cpp.
◆ set()
|
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 14 of file analogvoltage.cpp.
◆ to_json()
|
overridevirtual |
Serializes the current object data into a JsonObject.
Reimplemented from sensesp::Serializable.
Definition at line 19 of file analogvoltage.cpp.
The documentation for this class was generated from the following files:
- src/sensesp/transforms/analogvoltage.h
- src/sensesp/transforms/analogvoltage.cpp
