m5::unit::UnitTCS34725 Class Reference

Color recognition unit. More...

#include <unit_TCS3472x.hpp>

Inheritance diagram for m5::unit::UnitTCS34725:

Public Member Functions
	UnitTCS34725 (const uint8_t addr=DEFAULT_ADDRESS)
Public Member Functions inherited from m5::unit::UnitTCS3472x
	UnitTCS3472x (const uint8_t addr=DEFAULT_ADDRESS)
virtual bool	begin () override
virtual void	update (const bool force=false) override
bool	readStatus (uint8_t &status)
config_t	config ()
	Gets the configration.
void	config (const config_t &cfg)
	Set the configration.
uint8_t	R8 () const
	Oldest measured Red.
uint8_t	G8 () const
	Oldest measured Green.
uint8_t	B8 () const
	Oldest measured Blue.
uint16_t	RGB565 () const
	Oldest measured RGB565.
bool	readPersistence (tcs3472x::Persistence &pers)
	Read the persistence.
bool	writePersistence (const tcs3472x::Persistence pers)
	Write the persistence.
bool	readGain (tcs3472x::Gain &gc)
	Read the gain control.
bool	writeGain (const tcs3472x::Gain gc)
	Write the gain control.
bool	readAtime (uint8_t &raw)
	Read the The RGBC integration time (ATIME)
bool	readAtime (float &ms)
	Read the The RGBC integration time (ATIME)
template<typename T , typename std::enable_if< std::is_integral< T >::value, std::nullptr_t >::type = nullptr>
bool	writeAtime (const T raw)
	Write the The RGBC integration time (ATIME)
bool	writeAtime (const float ms)
	Write the The RGBC integration time (ATIME)
bool	readWtime (uint8_t &raw, bool &wlong)
	Read the wait time (WTIME)
bool	readWtime (float &ms)
	Read the wait time (WTIME)
bool	writeWtime (const uint8_t raw, const bool wlong)
	Write the wait time (WTIME)
bool	writeWtime (const float ms)
	Write the wait time (WTIME)
bool	startPeriodicMeasurement (const tcs3472x::Gain gc, const float atime, const float wtime)
	Start periodic measurement.
bool	startPeriodicMeasurement ()
	Start periodic measurement using current settings.
bool	stopPeriodicMeasurement (const bool power_off=true)
	Stop periodic measurement.
bool	measureSingleshot (tcs3472x::Data &d, const tcs3472x::Gain gc, const float atime)
	Measurement single shot.
bool	measureSingleshot (tcs3472x::Data &d)
	Measurement single shot using current settings.
bool	readInterrupt (bool &enable)
	Read the interrupt status.
bool	writeInterrupt (const bool enable)
	Write the interrupt status.
bool	readInterruptThreshold (uint16_t &low, uint16_t &high)
	Read the interrupt thresholds for clear channel.
bool	writeInterruptThreshold (const uint16_t low, const uint16_t high)
	Write the interrupt thresholds for clear channel.
bool	clearInterrupt ()
	Clear interrupt.

Static Public Attributes
static constexpr uint8_t	UNIT_ID {0x44}

Protected Member Functions
virtual bool	is_valid_id (const uint8_t id) override
Protected Member Functions inherited from m5::unit::UnitTCS3472x
bool	read_register8 (const uint8_t reg, uint8_t &val)
bool	write_register8 (const uint8_t reg, const uint8_t val)
bool	read_register (const uint8_t reg, uint8_t *buf, const uint32_t len)
bool	write_register (const uint8_t reg, const uint8_t *buf, const uint32_t len)
bool	start_periodic_measurement (const tcs3472x::Gain gc, const float atime, const float wtime)
bool	start_periodic_measurement ()
bool	stop_periodic_measurement (const bool power_off)
bool	is_data_ready ()
bool	read_measurement (tcs3472x::Data &d)
bool	write_atime (const uint8_t raw)
	M5_UNIT_COMPONENT_PERIODIC_MEASUREMENT_ADAPTER_HPP_BUILDER (UnitTCS3472x, tcs3472x::Data)

Detailed Description

Color recognition unit.

Member Function Documentation

is_valid_id()

virtual bool m5::unit::UnitTCS34725::is_valid_id ( const uint8_t id )

inlineoverrideprotectedvirtual

Reimplemented from m5::unit::UnitTCS3472x.