Analog pin manager module. More...

#include <Analog.h>

Inheritance diagram for Loom_Analog:

Public Types
enum	Conversion { Conversion::NONE, Conversion::VOLTAGE, Conversion::THERMISTOR, Conversion::PH, Conversion::TURBIDITY, Conversion::EC, Conversion::TDS, Conversion::SALINITY }
	Different types of conversions from analog to specified unit. More...

Public Types inherited from LoomModule
enum	Type { Type::Unknown = 0, Type::Other =1000, Type::Interrupt_Manager, Type::Sleep_Manager, Type::Multiplexer, Type::NTP, Type::TempSync, Type::WarmUp_Manager, Type::Sensor =2000, Type::Analog, Type::Digital, Type::I2C =2100, Type::ADS1115, Type::AS7262, Type::AS7263, Type::AS7265X, Type::FXAS21002, Type::FXOS8700, Type::LIS3DH, Type::MB1232, Type::MMA8451, Type::MPU6050, Type::MS5803, Type::SHT31D, Type::TMP007, Type::TSL2561, Type::TSL2591, Type::ZXGesture, Type::STEMMA, Type::SDI12 =2200, Type::Decagon5TM, Type::DecagonGS3, Type::SPI =2300, Type::MAX31855, Type::MAX31856, Type::L_SERIAL =2400, Type::K30, Type::L_RTC =3000, Type::DS3231, Type::PCF8523, Type::Actuator =4000, Type::Neopixel, Type::Relay, Type::Servo, Type::Stepper, Type::LogPlat =5000, Type::OLED, Type::SDCARD, Type::BATCHSD, Type::CommPlat =6000, Type::LoRa, Type::nRF, Type::Bluetooth, Type::InternetPlat =7000, Type::Ethernet, Type::WiFi, Type::LTE, Type::PublishPlat =8000, Type::GoogleSheets, Type::MaxPub, Type::SpoolPub, Type::SubscribePlats =9000, Type::MaxSub }
	Enum to check against to when finding individual component managed by a LoomManager. More...

enum	Category { Category::Unknown =0, Category::Other =1, Category::Sensor =2, Category::L_RTC =3, Category::Actuator =4, Category::LogPlat =5, Category::CommPlat =6, Category::InternetPlat =7, Category::PublishPlat =8, Category::SubscribePlat =9 }
	Enum to classify modules. More...

Public Member Functions
CONSTRUCTORS / DESTRUCTOR
	Loom_Analog (LoomManager *manager, const uint8_t num_samples=8, const uint8_t read_resolution=12, const bool enableA0=true, const bool enableA1=true, const bool enableA2=true, const bool enableA3=true, const bool enableA4=true, const bool enableA5=true, const Conversion convertA0=Conversion::NONE, const Conversion convertA1=Conversion::NONE, const Conversion convertA2=Conversion::NONE, const Conversion convertA3=Conversion::NONE, const Conversion convertA4=Conversion::NONE, const Conversion convertA5=Conversion::NONE, const float temperature=25.0)
	Analog manager module constructor. More...

	Loom_Analog (LoomManager *manager, JsonArrayConst p)
	Constructor that takes Json Array, extracts args and delegates to regular constructor. More...

	~Loom_Analog ()=default
	Destructor. More...

OPERATION
void	measure () override
	Take any relevant measurements. More...

void	package (JsonObject json) override
	Package a modules measurements or state. More...

void	add_config (JsonObject json) override
	Add configuration information to JsonObject. More...

PRINT INFORMATION
void	print_config () const override
	Display the configuration settings of the module. More...

void	print_measurements () const override
	Print the last set of measurements taken. More...

GETTERS
uint8_t	get_analog_resolution () const
	Get the current analog read resolution. More...

int	get_analog_val (const uint8_t pin) const
	Get the analog value of specified pin. More...

float	get_battery () const
	Get the battery voltage of the device. More...

bool	get_pin_enabled (const uint8_t pin) const
	Get if a pin is enabled in manager. More...

Conversion	get_conversion (const uint8_t pin) const
	Get the current conversion associated with a pin. More...

SETTERS
void	set_analog_resolution (const uint8_t res)
	Set the analog read resolution. More...

void	set_pin_enabled (const uint8_t pin, const bool e)
	Set the enable state of a pin. More...

void	set_conversion (const uint8_t pin, const Conversion c)
	Set the current conversion associated with a pin. More...

void	set_enable_conversions (const bool e)
	Enable or disable all conversions. More...

void	set_temperature (const float temp)
	Set temperature to use in conversions that require temperature compensation. More...

Public Member Functions inherited from LoomSensor
	LoomSensor (LoomManager manager, const char module_name, const LoomModule::Type module_type, const uint8_t num_samples)
	Constructor. More...

virtual	~LoomSensor ()=default
	Destructor. More...

virtual void	calibrate ()
	Calibration routine. More...

uint8_t	get_num_samples () const
	Get the number of samples sensor is set to take. More...

void	set_num_samples (const uint8_t n)
	Set the number of samples to take. More...

Public Member Functions inherited from LoomModule
	LoomModule (LoomManager manager, const char module_name="Unknown", const Type module_type=Type::Unknown)
	Constructor. More...

virtual	~LoomModule ()=default
	Destructor. More...

virtual void	second_stage_ctor ()
	Second stage construction. More...

virtual bool	dispatch (JsonObject json)
	Route command to driver. More...

virtual void	power_down ()
	Turn off any hardware. More...

virtual void	power_up ()
	Turn on any hardware. More...

Type	get_module_type () const
	Get module type. More...

LoomManager *	get_device_manager () const
	Get the device manager class if linked. More...

void	get_module_name (char *buf) const
	Copy module name into buffer. More...

const char *	get_module_name () const
	Get module name. More...

Verbosity	get_print_verbosity () const
	Get print verbosity. More...

Verbosity	get_package_verbosity () const
	Get package verbosity. More...

bool	get_active () const
	Get whether or not the module should be treated as active. More...

Category	category () const
	Get the category of the module. More...

virtual void	link_device_manager (LoomManager *LM)
	Add pointer back to device manager. More...

void	set_print_verbosity (const Verbosity v)
	Set print verbosity Controlls level of detail included in debug prints. More...

void	set_package_verbosity (const Verbosity v)
	Set package verbosity. More...

void	set_active (const bool enable)
	Set whether or not the module should be treated as active. More...

virtual void	print_state () const
	Display current state of the module. More...

Protected Attributes
uint8_t	read_resolution
	Which resolution to read at (generally use 12 or 10) More...

bool	pin_enabled [ANALOG_COUNT]
	Whether pins A0-A5 are enabled for analog reading. More...

uint16_t	analog_vals [ANALOG_COUNT]
	Last known analog readings for pin A0-A5. More...

float	battery
	Battery voltage. More...

bool	enable_conversions
	Enable or disable all conversions. More...

Conversion	conversions [ANALOG_COUNT]
	Conversion (if any) to apply to analog value when printing / packaging. More...

float	temperature
	Temperature to use in conversions. More...

Protected Attributes inherited from LoomSensor
uint8_t	num_samples
	How many samples to take and average each call to measure() More...

Protected Attributes inherited from LoomModule
const Type	module_type
	Module type. More...

LoomManager *	device_manager
	Pointer to manager. More...

const String	module_name_base
	The name of the module (Should have a DEFAULT but can be overriden if provided to constructor) More...

const char *	module_name

bool	active
	Whether or not the module should be treated as active. More...

Verbosity	print_verbosity
	Print verbosity. More...

Verbosity	package_verbosity
	Package verbosity. More...

MISCELLANEOUS
static const char *	conversion_name (const Conversion conversion)
	Get string of name associated with conversion enum. More...

Additional Inherited Members
Static Public Member Functions inherited from LoomModule
static const char *	enum_verbosity_string (const Verbosity v)
	Get string of name associated with verbosity enum. More...

static const char *	enum_category_string (const Category c)
	Get string of the category associated with a Category. More...

Protected Member Functions inherited from LoomModule
void	print_module_label () const
	Print the module name as a label. More...

Detailed Description

Analog pin manager module.

Resources

Member Enumeration Documentation

enum Loom_Analog::Conversion

strong

Different types of conversions from analog to specified unit.

Enumerator
NONE	No conversion applied.
VOLTAGE	Analog to voltage.
THERMISTOR	Thermistor.
PH	pH value
TURBIDITY	Turbidity.
EC	Electrical Conductivity.
TDS	Total Dissolved Solids.
SALINITY	Salinity.

Constructor & Destructor Documentation

Loom_Analog::Loom_Analog	(	LoomManager *	manager,
		const uint8_t	num_samples = `8`,
		const uint8_t	read_resolution = `12`,
		const bool	enableA0 = `true`,
		const bool	enableA1 = `true`,
		const bool	enableA2 = `true`,
		const bool	enableA3 = `true`,
		const bool	enableA4 = `true`,
		const bool	enableA5 = `true`,
		const Conversion	convertA0 = `Conversion::NONE`,
		const Conversion	convertA1 = `Conversion::NONE`,
		const Conversion	convertA2 = `Conversion::NONE`,
		const Conversion	convertA3 = `Conversion::NONE`,
		const Conversion	convertA4 = `Conversion::NONE`,
		const Conversion	convertA5 = `Conversion::NONE`,
		const float	temperature = `25.0`
	)

Analog manager module constructor.

Parameters

[in]	num_samples	Set(Int) \| <8> \| {1, 2, 4, 8, 16} \| How many samples to take and average
[in]	read_resolution	Int \| <12> \| [8-12] \| How many bits to read analog values at
[in]	enableA0	Bool \| <true> \| {true, false} \| Enable pin A0 for managing
[in]	enableA1	Bool \| <true> \| {true, false} \| Enable pin A1 for managing
[in]	enableA2	Bool \| <true> \| {true, false} \| Enable pin A2 for managing
[in]	enableA3	Bool \| <true> \| {true, false} \| Enable pin A3 for managing
[in]	enableA4	Bool \| <true> \| {true, false} \| Enable pin A4 for managing
[in]	enableA5	Bool \| <true> \| {true, false} \| Enable pin A5 for managing
[in]	convertA0	Set(Conversion) \| <0> \| {0("No conversion"), 1("Analog to voltage"), 2("Thermistor" ), 3("pH"), 4("Turbidity"), 5("Electrical Conductivity"), 6("Total Dissolved Solids"), 7("Salinity")} \| Conversion to apply to analog readings on pin A0
[in]	convertA1	Set(Conversion) \| <0> \| {0("No conversion"), 1("Analog to voltage"), 2("Thermistor" ), 3("pH"), 4("Turbidity"), 5("Electrical Conductivity"), 6("Total Dissolved Solids"), 7("Salinity")} \| Conversion to apply to analog readings on pin A1
[in]	convertA2	Set(Conversion) \| <0> \| {0("No conversion"), 1("Analog to voltage"), 2("Thermistor" ), 3("pH"), 4("Turbidity"), 5("Electrical Conductivity"), 6("Total Dissolved Solids"), 7("Salinity")} \| Conversion to apply to analog readings on pin A2
[in]	convertA3	Set(Conversion) \| <0> \| {0("No conversion"), 1("Analog to voltage"), 2("Thermistor" ), 3("pH"), 4("Turbidity"), 5("Electrical Conductivity"), 6("Total Dissolved Solids"), 7("Salinity")} \| Conversion to apply to analog readings on pin A3
[in]	convertA4	Set(Conversion) \| <0> \| {0("No conversion"), 1("Analog to voltage"), 2("Thermistor" ), 3("pH"), 4("Turbidity"), 5("Electrical Conductivity"), 6("Total Dissolved Solids"), 7("Salinity")} \| Conversion to apply to analog readings on pin A4
[in]	convertA5	Set(Conversion) \| <0> \| {0("No conversion"), 1("Analog to voltage"), 2("Thermistor" ), 3("pH"), 4("Turbidity"), 5("Electrical Conductivity"), 6("Total Dissolved Solids"), 7("Salinity")} \| Conversion to apply to analog readings on pin A5
[in]	temperature	float \| <25.0> \| [0.-100.] \| Temperature to using in conversions

Loom_Analog::Loom_Analog	(	LoomManager *	manager,
		JsonArrayConst	p
	)

Constructor that takes Json Array, extracts args and delegates to regular constructor.

Parameters

[in] p The array of constuctor args to expand

Loom_Analog::~Loom_Analog ( )

default

Destructor.

Member Function Documentation

void Loom_Analog::add_config ( JsonObject json )

overridevirtual

Add configuration information to JsonObject.

LoomManager iterates over modules to build complete configuration

Parameters

[in] json Json configuration object to add to

Reimplemented from LoomModule.

const char * Loom_Analog::conversion_name ( const Conversion conversion )

static

Get string of name associated with conversion enum.

Returns: String of conversion

uint8_t Loom_Analog::get_analog_resolution ( ) const

inline

Get the current analog read resolution.

Returns: Read resolution

int Loom_Analog::get_analog_val ( const uint8_t pin ) const

Get the analog value of specified pin.

Parameters

[in] pin Pin to read

Returns: The analog value

float Loom_Analog::get_battery ( ) const

inline

Get the battery voltage of the device.

Returns: The battery voltage

Conversion Loom_Analog::get_conversion ( const uint8_t pin ) const

inline

Get the current conversion associated with a pin.

Parameters

[in] pin The pin to get conversion for

Returns: The current Conversion setting

bool Loom_Analog::get_pin_enabled ( const uint8_t pin ) const

inline

Get if a pin is enabled in manager.

Parameters

[in] pin Pin to get enable state of

Returns: The enabled state of pin

void Loom_Analog::measure ( )

overridevirtual

Take any relevant measurements.

Implements LoomSensor.

void Loom_Analog::package ( JsonObject json )

overridevirtual

Package a modules measurements or state.

Parameters

[out] json Object to put data into

Implements LoomModule.

void Loom_Analog::print_config ( ) const

overridevirtual

Display the configuration settings of the module.

Reimplemented from LoomSensor.

void Loom_Analog::print_measurements ( ) const

overridevirtual

Print the last set of measurements taken.

Does not package the data.

Implements LoomSensor.

void Loom_Analog::set_analog_resolution ( const uint8_t res )

inline

Set the analog read resolution.

Parameters

[in] res Resolution to read at (12 bit max)

void Loom_Analog::set_conversion	(	const uint8_t	pin,
		const Conversion	c
	)

inline

Set the current conversion associated with a pin.

Parameters

[in]	pin	The pin to set conversion for
[in]	c	The Conversion to use

void Loom_Analog::set_enable_conversions ( const bool e )

inline

Enable or disable all conversions.

Parameters

[in] e Enable state

void Loom_Analog::set_pin_enabled	(	const uint8_t	pin,
		const bool	e
	)

Set the enable state of a pin.

Parameters

[in]	pin	The pin to set enable state of
[in]	e	Enable state

void Loom_Analog::set_temperature ( const float temp )

inline

Set temperature to use in conversions that require temperature compensation.

Parameters

[in] temp Temperature to use

Member Data Documentation

uint16_t Loom_Analog::analog_vals[ANALOG_COUNT]

protected

Last known analog readings for pin A0-A5.

float Loom_Analog::battery

protected

Battery voltage.

Conversion Loom_Analog::conversions[ANALOG_COUNT]

protected

Conversion (if any) to apply to analog value when printing / packaging.

bool Loom_Analog::enable_conversions

protected

Enable or disable all conversions.

bool Loom_Analog::pin_enabled[ANALOG_COUNT]

protected

Whether pins A0-A5 are enabled for analog reading.

uint8_t Loom_Analog::read_resolution

protected

Which resolution to read at (generally use 12 or 10)

float Loom_Analog::temperature

protected

Temperature to use in conversions.

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

src/Sensors/Analog.h
src/Sensors/Analog.cpp

Public Types

Public Member Functions

Protected Attributes

MISCELLANEOUS

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation