Multiplexer manager for interfacing with multiple I2C sensors. More...

#include <Multiplexer.h>

Inheritance diagram for Loom_Multiplexer:

Public Member Functions
CONSTRUCTORS / DESTRUCTOR
	Loom_Multiplexer (LoomManager *manager, const byte i2c_address=0x71, const uint8_t num_ports=8, const bool dynamic_list=true, const uint update_period=5000)
	Multiplexer module constructor. More...

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

	~Loom_Multiplexer ()
	Destructor. More...

OPERATION
void	measure ()
	Call measure on all connected sensors. More...

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

bool	dispatch (JsonObject) override
	Route command to driver. More...

void	get_sensor_list (JsonObject json)
	Populate a bundle with a list of sensors currently attached. More...

void	refresh_sensors ()
	Update sensor list. More...

LoomI2CSensor *	get_sensor (uint8_t port) const
	Get the sensor object for sensor on provided port. More...

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

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

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

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

void	print_measurements () const
	Prints measurements of all connected sensors. More...

GETTERS
bool	get_is_dynamic () const
	Get whether or not sensors are updated dynamically. More...

int	get_update_period () const
	Get the sensor list update period. More...

SETTERS
void	set_is_dynamic (const bool dynamic)
	Set whether or not to periodically update list of attached sensors. More...

void	set_update_period (const uint period)
	Set the sensor list update period. 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 void	add_config (JsonObject json)
	Add configuration information to JsonObject. 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...

Protected Attributes
LoomI2CSensor **	sensors
	Array of I2C sensor objects. More...

byte	i2c_address
	The multiplexer's I2C address. More...

uint8_t	num_ports
	The number of ports on the multiplexer. More...

bool	dynamic_list
	Whether or not sensor list is dynamic (refresh sensor list periodically) More...

uint	update_period
	Interval to update sensor list at. More...

uint8_t	control_port

byte	control_address

unsigned long	last_update_time
	When the sensor list was last updated. More...

std::vector< byte >	i2c_conflicts
	List of I2C address conflicts. 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...

Static Protected Attributes
static const std::array< byte, 9 >	alt_addresses

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

Multiplexer manager for interfacing with multiple I2C sensors.

Resources

Documentation

Constructor & Destructor Documentation

Loom_Multiplexer::Loom_Multiplexer	(	LoomManager *	manager,
		const byte	i2c_address = `0x71`,
		const uint8_t	num_ports = `8`,
		const bool	dynamic_list = `true`,
		const uint	update_period = `5000`
	)

Multiplexer module constructor.

Parameters

[in]	i2c_address	Set(Int) \| <0x71> \| {0x71} \| I2C address
[in]	num_ports	Int \| <8> \| [1-8] \| Number of ports available
[in]	dynamic_list	Bool \| <true> \| {true, false} \| Whether or not to automatically check for new sensors
[in]	update_period	Int \| <5000> \| [500-30000] \| The time between sensor list updates (if dynamic_list enabled)

Loom_Multiplexer::Loom_Multiplexer	(	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_Multiplexer::~Loom_Multiplexer ( )

Destructor.

Member Function Documentation

bool Loom_Multiplexer::dispatch ( JsonObject json )

inlineoverridevirtual

Route command to driver.

Reimplemented from LoomModule.

bool Loom_Multiplexer::get_is_dynamic ( ) const

inline

Get whether or not sensors are updated dynamically.

Returns: True if dynamic

LoomI2CSensor* Loom_Multiplexer::get_sensor ( uint8_t port ) const

inline

Get the sensor object for sensor on provided port.

Parameters

void Loom_Multiplexer::get_sensor_list ( JsonObject json )

Populate a bundle with a list of sensors currently attached.

Parameters

[out] json Json object to populate with sensor list

int Loom_Multiplexer::get_update_period ( ) const

inline

Get the sensor list update period.

Returns: The update period

void Loom_Multiplexer::measure ( )

Call measure on all connected sensors.

void Loom_Multiplexer::package ( JsonObject json )

overridevirtual

Package a modules measurements or state.

Parameters

[out] json Object to put data into

Implements LoomModule.

void Loom_Multiplexer::power_down ( )

overridevirtual

Turn off any hardware.

Reimplemented from LoomModule.

void Loom_Multiplexer::power_up ( )

overridevirtual

Turn on any hardware.

Reimplemented from LoomModule.

void Loom_Multiplexer::print_config ( ) const

overridevirtual

Display the configuration settings of the module.

Reimplemented from LoomModule.

void Loom_Multiplexer::print_measurements ( ) const

Prints measurements of all connected sensors.

Calls implementations of LoomI2CSensor::print_measurements() const

void Loom_Multiplexer::print_state ( ) const

overridevirtual

Display current state of the module.

Reimplemented from LoomModule.

void Loom_Multiplexer::refresh_sensors ( )

Update sensor list.

Polls all ports of multiplexer getting sensor on port (if any)

void Loom_Multiplexer::set_is_dynamic ( const bool dynamic )

inline

Set whether or not to periodically update list of attached sensors.

Parameters

[in] dynamic The setting to set

void Loom_Multiplexer::set_update_period ( const uint period )

inline

Set the sensor list update period.

Requires dynamic_list to be enabled

Parameters

[in] period New update period

Member Data Documentation

const std::array< byte, 9 > Loom_Multiplexer::alt_addresses

staticprotected

Initial value:

= {
    0x70,
    0x71,
    0x72,
    0x73,
    0x74,
    0x75,
    0x76,
    0x77,
    0x78
}

byte Loom_Multiplexer::control_address

protected

uint8_t Loom_Multiplexer::control_port

protected

bool Loom_Multiplexer::dynamic_list

protected

Whether or not sensor list is dynamic (refresh sensor list periodically)

byte Loom_Multiplexer::i2c_address

protected

The multiplexer's I2C address.

std::vector<byte> Loom_Multiplexer::i2c_conflicts

protected

List of I2C address conflicts.

unsigned long Loom_Multiplexer::last_update_time

protected

When the sensor list was last updated.

uint8_t Loom_Multiplexer::num_ports

protected

The number of ports on the multiplexer.

LoomI2CSensor** Loom_Multiplexer::sensors

protected

Array of I2C sensor objects.

uint Loom_Multiplexer::update_period

protected

Interval to update sensor list at.

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

src/Multiplexer.h
src/Multiplexer.cpp

Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation