m5::unit::UnitUnified Class Reference

For managing and leading units. More...

#include <M5UnitUnified.hpp>

Public Types
using	container_type = std::vector<Component*>

Public Member Functions
bool	begin ()
	Begin of all units under management.
void	update (const bool force=false)
	Update of all units under management.
std::string	debugInfo () const
	Output information for debug.
Constructor
Warning COPY PROHIBITED
	UnitUnified (const UnitUnified &)=delete
	UnitUnified (UnitUnified &&) noexcept=default
Assignment
Warning COPY PROHIBITED
UnitUnified &	operator= (const UnitUnified &)=delete
UnitUnified &	operator= (UnitUnified &&) noexcept=default
Add unit
bool	add (Component &u, TwoWire &wire)
	Adding unit to be managed (I2C)
bool	add (Component &u, const int8_t rx_pin, const int8_t tx_pin)
	Adding unit to be managed (GPIO)
bool	add (Component &u, HardwareSerial &wire)
	Adding unit to be managed (UART)
bool	add (Component &u, m5::hal::bus::Bus *bus)
	Adding unit to be managed (M5HAL)

Protected Member Functions
bool	add_children (Component &u)
std::string	make_unit_info (const Component *u, const uint8_t indent=0) const

Protected Attributes
container_type	_units {}

Detailed Description

For managing and leading units.

Member Function Documentation

add() [1/4]

bool m5::unit::UnitUnified::add	(	Component &	u,
		const int8_t	rx_pin,
		const int8_t	tx_pin )

Adding unit to be managed (GPIO)

Parameters

u	Unit Component
rx_pin	Pin number to be used for RX
tx_pin	Pin number to be used for TX

Returns

True if successful

add() [2/4]

bool m5::unit::UnitUnified::add	(	Component &	u,
		HardwareSerial &	wire )

Adding unit to be managed (UART)

Parameters

u	Unit Component
serial	HardwareSerial to be used

Returns

True if successful

add() [3/4]

bool m5::unit::UnitUnified::add	(	Component &	u,
		m5::hal::bus::Bus *	bus )

Adding unit to be managed (M5HAL)

Parameters

u	Unit Component
bus	Bus to be used

Returns

True if successful

add() [4/4]

bool m5::unit::UnitUnified::add	(	Component &	u,
		TwoWire &	wire )

Adding unit to be managed (I2C)

Parameters

u	Unit Component
wire	TwoWire to be used

Returns

True if successful