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 all units under management.
void	update (const bool force=false)
	Update 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(I2C)
bool	add (Component &u, TwoWire &wire)
	Add unit to be managed (I2C via TwoWire)
bool	add (Component &u, i2c_master_bus_handle_t bus)
	Adding unit to be managed (I2C, ESP-IDF native driver)
bool	add (Component &u, const i2c_port_t port, const gpio_num_t sda, const gpio_num_t scl)
	Adding unit to be managed (I2C, ESP-IDF legacy driver)
bool	add (Component &u, m5::I2C_Class &i2c)
	Add unit to be managed (I2C via I2C_Class)
Add unit(GPIO)
bool	add (Component &u, const int8_t rx_pin, const int8_t tx_pin)
	Add unit to be managed (GPIO)
Add unit(UART)
bool	add (Component &u, HardwareSerial &serial)
	Add unit to be managed (UART)
bool	add (Component &u, const uart_port_t uart_num)
	Adding unit to be managed (UART, ESP-IDF native driver)
Add unit(SPI)
bool	add (Component &u, SPIClass &spi, const SPISettings &settings)
	Add unit to be managed (SPI)
bool	add (Component &u, spi_device_handle_t handle, const gpio_num_t cs=GPIO_NUM_NC)
	Adding unit to be managed (SPI, ESP-IDF native driver)
Add unit(M5HAL)
bool	add (Component &u, m5::hal::bus::Bus *bus)
	Add unit to be managed (M5HAL bus)

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/10]

bool m5::unit::UnitUnified::add	(	Component &	u,
		const i2c_port_t	port,
		const gpio_num_t	sda,
		const gpio_num_t	scl )

Adding unit to be managed (I2C, ESP-IDF legacy driver)

Parameters

u	Unit Component
port	I2C port (driver must be installed beforehand via i2c_param_config / i2c_driver_install)
sda	SDA GPIO
scl	SCL GPIO

Returns

True if successful

add() [2/10]

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

Add 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() [3/10]

bool m5::unit::UnitUnified::add	(	Component &	u,
		const uart_port_t	uart_num )

Adding unit to be managed (UART, ESP-IDF native driver)

Parameters

u	Unit Component
uart_num	UART port number (the driver must be installed beforehand via uart_driver_install / uart_param_config / uart_set_pin)

Returns

True if successful

add() [4/10]

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

Add unit to be managed (UART)

Parameters

u	Unit Component
serial	HardwareSerial to be used

Returns

True if successful

add() [5/10]

bool m5::unit::UnitUnified::add	(	Component &	u,
		i2c_master_bus_handle_t	bus )

Adding unit to be managed (I2C, ESP-IDF native driver)

Parameters

u	Unit Component
bus	ESP-IDF I2C master bus handle

Returns

True if successful

add() [6/10]

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

Add unit to be managed (M5HAL bus)

Parameters

u	Unit Component
bus	Bus to be used

Returns

True if successful

add() [7/10]

bool m5::unit::UnitUnified::add	(	Component &	u,
		m5::I2C_Class &	i2c )

Add unit to be managed (I2C via I2C_Class)

Parameters

u	Unit Component
i2c	I2C_Class to be used (e.g. M5.In_I2C)

Returns

True if successful

add() [8/10]

bool m5::unit::UnitUnified::add	(	Component &	u,
		spi_device_handle_t	handle,
		const gpio_num_t	cs = GPIO_NUM_NC )

Adding unit to be managed (SPI, ESP-IDF native driver)

Parameters

u	Unit Component
handle	ESP-IDF SPI device handle (create with spics_io_num = -1; init bus with SPI_DMA_DISABLED)
cs	CS GPIO controlled manually by this library. If GPIO_NUM_NC (default), uses Component::address() as the CS pin (same convention as Arduino SPI)

Returns

True if successful

add() [9/10]

bool m5::unit::UnitUnified::add	(	Component &	u,
		SPIClass &	spi,
		const SPISettings &	settings )

Add unit to be managed (SPI)

Parameters

u	Unit Component
spi	SPIClass to be used
settings	SPI settings to be applied

Returns

True if successful

add() [10/10]

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

Add unit to be managed (I2C via TwoWire)

Parameters

u	Unit Component
wire	TwoWire to be used

Returns

True if successful

begin()

bool m5::unit::UnitUnified::begin

(

)

Begin all units under management.

Returns

True if all units began successfully

debugInfo()

std::string m5::unit::UnitUnified::debugInfo

(

)

const

Output information for debug.

Returns

String containing debug information

update()

void m5::unit::UnitUnified::update

(

const bool

force = false

)

Update all units under management.

Parameters

force

Forced communication for updates if true