m5::unit::Adapter Class Reference

Adapter base class to treat M5HAL and TwoWire,GPIO,Serial,SPI... in the same way. More...

#include <adapter_base.hpp>

Inheritance diagram for m5::unit::Adapter:

Classes
class	Impl

Public Types
enum class	Type : uint8_t {   Unknown , I2C , GPIO , UART ,   SPI }

Public Member Functions
	Adapter (const Adapter &)=delete
	Adapter (Adapter &&) noexcept=default
Adapter &	operator= (const Adapter &)=delete
Adapter &	operator= (Adapter &&) noexcept=default
Type	type () const
virtual Adapter *	duplicate (const uint8_t)
m5::hal::error::error_t	readWithTransaction (uint8_t *data, const size_t len)
m5::hal::error::error_t	writeWithTransaction (const uint8_t *data, const size_t len, const uint32_t exparam=1)
m5::hal::error::error_t	writeWithTransaction (const uint8_t reg, const uint8_t *data, const size_t len, const uint32_t exparam=1)
m5::hal::error::error_t	writeWithTransaction (const uint16_t reg, const uint8_t *data, const size_t len, const uint32_t exparam=1)
m5::hal::error::error_t	generalCall (const uint8_t *data, const size_t len)
m5::hal::error::error_t	pinModeRX (const gpio::Mode m)
m5::hal::error::error_t	writeDigitalRX (const bool high)
m5::hal::error::error_t	readDigitalRX (bool &high)
m5::hal::error::error_t	writeAnalogRX (const uint16_t v)
m5::hal::error::error_t	readAnalogRX (uint16_t &v)
m5::hal::error::error_t	pulseInRX (uint32_t &duration, const int state, const uint32_t timeout_us)
m5::hal::error::error_t	pinModeTX (const gpio::Mode m)
m5::hal::error::error_t	writeDigitalTX (const bool high)
m5::hal::error::error_t	readDigitalTX (bool &high)
m5::hal::error::error_t	writeAnalogTX (const uint16_t v)
m5::hal::error::error_t	readAnalogTX (uint16_t &v)
m5::hal::error::error_t	pulseInTX (uint32_t &duration, const int state, const uint32_t timeout_us)
uint32_t	clock () const
void	setClock (const uint32_t)
int16_t	sda () const
int16_t	scl () const
void	pinMode (const uint8_t pin, const uint8_t mode)
void	digitalWrite (const uint8_t pin, const uint8_t high)
bool	begin ()
bool	end ()

Protected Member Functions
	Adapter (const Type t, Impl *impl)

Protected Attributes
std::unique_ptr< Impl >	_impl {}

Detailed Description

Adapter base class to treat M5HAL and TwoWire,GPIO,Serial,SPI... in the same way.