Digital pin manager module. More...

#include <Digital.h>

Inheritance diagram for Loom_Digital:

Public Member Functions
CONSTRUCTORS / DESTRUCTOR
	Loom_Digital (LoomManager *manager, const bool enable5=true, const bool enable6=true, const bool enable9=false, const bool enable10=false, const bool enable11=false, const bool enable12=false, const bool enableA0=false, const bool enableA1=false, const bool enableA2=false, const bool enableA3=false, const bool enableA4=false, const bool enableA5=false)
	Digital manager module constructor. More...

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

	~Loom_Digital ()=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
bool	get_digital_val (const uint8_t pin) const
	Get value on digital pin. More...

bool	get_pin_enabled (const uint8_t pin) const
	Get if pin is enabled in manager. 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
bool	pin_enabled [DIGITAL_COUNT]
	Array of which pins are enabled. More...

bool	digital_vals [DIGITAL_COUNT]
	Array of last read digital values. 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...

SETTERS
void	set_digital_val (const uint8_t pin, const bool state)
	Set digital value of pin. More...

void	set_pin_enabled (const uint8_t pin, const bool e)
	Set pin enable state in manager. More...

Additional Inherited Members
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...

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

Digital pin manager module.

Available digital pins 5, 6, 9, 10, 11, 12, A0(14), A1(15), A2(16), A3(17), A4(18), A5(19)

Resources

Constructor & Destructor Documentation

Loom_Digital::Loom_Digital	(	LoomManager *	manager,
		const bool	enable5 = `true`,
		const bool	enable6 = `true`,
		const bool	enable9 = `false`,
		const bool	enable10 = `false`,
		const bool	enable11 = `false`,
		const bool	enable12 = `false`,
		const bool	enableA0 = `false`,
		const bool	enableA1 = `false`,
		const bool	enableA2 = `false`,
		const bool	enableA3 = `false`,
		const bool	enableA4 = `false`,
		const bool	enableA5 = `false`
	)

Digital manager module constructor.

Parameters

[in]	enable5	Bool \| <true> \| {true, false} \| Enable pin 5 for managing
[in]	enable6	Bool \| <true> \| {true, false} \| Enable pin 6 for managing
[in]	enable9	Bool \| <false> \| {true, false} \| Enable pin 9 for managing
[in]	enable10	Bool \| <false> \| {true, false} \| Enable pin 10 for managing
[in]	enable11	Bool \| <false> \| {true, false} \| Enable pin 11 for managing
[in]	enable12	Bool \| <false> \| {true, false} \| Enable pin 12 for managing
[in]	enableA0	Bool \| <false> \| {true, false} \| Enable pin A0 for managing
[in]	enableA1	Bool \| <false> \| {true, false} \| Enable pin A1 for managing
[in]	enableA2	Bool \| <false> \| {true, false} \| Enable pin A2 for managing
[in]	enableA3	Bool \| <false> \| {true, false} \| Enable pin A3 for managing
[in]	enableA4	Bool \| <false> \| {true, false} \| Enable pin A4 for managing
[in]	enableA5	Bool \| <false> \| {true, false} \| Enable pin A5 for managing

Loom_Digital::Loom_Digital	(	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_Digital::~Loom_Digital ( )

default

Destructor.

Member Function Documentation

void Loom_Digital::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.

bool Loom_Digital::get_digital_val ( const uint8_t pin ) const

Get value on digital pin.

Returns: True if HIGH, false if LOW

bool Loom_Digital::get_pin_enabled ( const uint8_t pin ) const

Get if pin is enabled in manager.

Returns: Enable state of pin

void Loom_Digital::measure ( )

overridevirtual

Take any relevant measurements.

Implements LoomSensor.

void Loom_Digital::package ( JsonObject json )

overridevirtual

Package a modules measurements or state.

Parameters

[out] json Object to put data into

Implements LoomModule.

void Loom_Digital::print_config ( ) const

overridevirtual

Display the configuration settings of the module.

Reimplemented from LoomSensor.

void Loom_Digital::print_measurements ( ) const

overridevirtual

Print the last set of measurements taken.

Does not package the data.

Implements LoomSensor.

void Loom_Digital::set_digital_val	(	const uint8_t	pin,
		const bool	state
	)

Set digital value of pin.

Parameters

[in]	pin	Pin to set value of
[in]	state	State to set pin to

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

Set pin enable state in manager.

Parameters

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

Member Data Documentation

bool Loom_Digital::digital_vals[DIGITAL_COUNT]

protected

Array of last read digital values.

bool Loom_Digital::pin_enabled[DIGITAL_COUNT]

protected

Array of which pins are enabled.

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

src/Sensors/Digital.h
src/Sensors/Digital.cpp

Public Member Functions

Protected Attributes

SETTERS

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation