modm API documentation
Classes | Public Typedefs | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
modm::Tcs3414< I2cMaster > Class Template Reference
External Device Drivers » TCS3414 Digital Color Sensor

#include <modm/driver/color/tcs3414.hpp>

Inheritance diagram for modm::Tcs3414< I2cMaster >:
modm::I2cDevice< I2cMaster, 2 > modm::NestedResumable< 10+1 >

Classes

struct  Data
 

Public Typedefs

using Rgb = color::RgbT< uint16_t >
 

Public Types

enum  Gain : uint8_t
 Analog gain control.
 
enum  Prescaler : uint8_t
 Prescaler mode.
 
enum  IntegrationMode : uint8_t
 Select mode how to choose the integration time.
 
enum  NominalIntegrationTime : uint8_t
 Integration for a fixed time.
 
enum  SyncPulseCount : uint8_t
 The number of pulses on sync pin to integrate over.
 
enum  RegisterAddress : uint8_t
 Register addresses.
 

Public Member Functions

 Tcs3414 (Data &data, uint8_t address=addr ())
 
modm::ResumableResult< bool > initialize ()
 
modm::ResumableResult< bool > configure (Gain gain=Gain::X1, Prescaler prescaler=Prescaler::D1)
 
modm::ResumableResult< bool > setGain (Gain gain=Gain::X1, Prescaler prescaler=Prescaler::D1)
 The gain can be used to adjust the sensitivity of all ADC output channels.
 
modm::ResumableResult< bool > setIntegrationTime (IntegrationMode mode, NominalIntegrationTime time)
 Sets the integration time for the ADCs.
 
modm::ResumableResult< bool > setIntegrationTime (IntegrationMode mode, SyncPulseCount time)
 Sets the integration time for the ADCs.
 
modm::ResumableResult< bool > readColor ()
 Read current samples of ADC conversions for all channels.
 
modm::ResumableResult< bool > readRegisters (RegisterAddress address, uint8_t *values, uint8_t count=1)
 
modm::ResumableResult< bool > writeRegister (RegisterAddress address, uint8_t value)
 
void attachConfigurationHandler (I2c::ConfigurationHandler handler)
 
modm::ResumableResult< bool > ping ()
 
modm::ResumableResult< bool > read (uint8_t *buffer, std::size_t size)
 Starts a write transaction and waits until finished.
 
void setAddress (uint8_t address)
 
modm::ResumableResult< bool > write (const uint8_t *buffer, std::size_t size)
 Starts a write transaction and waits until finished.
 
modm::ResumableResult< bool > writeRead (const uint8_t *writeBuffer, std::size_t writeSize, uint8_t *readBuffer, std::size_t readSize)
 Starts a write-read transaction and waits until finished.
 

Static Public Member Functions

static constexpr uint8_t addr (uint8_t version=4)
 

Protected Member Functions

modm::ResumableResult< ReturnType > resumable function (...)
 
int8_t getResumableDepth () const
 
bool isResumableRunning () const
 
bool isTransactionRunning ()
 
modm::ResumableResult< bool > runTransaction ()
 Starts our own transaction and waits until finished.
 
bool startRead (uint8_t *buffer, std::size_t size)
 Configures the transaction with a read operation and starts it.
 
bool startTransaction ()
 Starts the transaction with our own transaction object.
 
bool startTransaction (modm::I2cTransaction *transaction)
 Starts the transaction with a separate transaction object.
 
bool startWrite (const uint8_t *buffer, std::size_t size)
 Configures the transaction with a write operation and starts it.
 
bool startWriteRead (const uint8_t *writeBuffer, std::size_t writeSize, uint8_t *readBuffer, std::size_t readSize)
 Configures the transaction with a write/read operation and starts it.
 
void stopResumable ()
 Force all resumable functions to stop running at the current nesting level.
 
bool wasTransactionSuccessful ()
 

Protected Attributes

Data & data
 
uint8_t buffer [3]
 
I2cWriteReadTransaction transaction
 

Detailed Description

template<typename I2cMaster>
class modm::Tcs3414< I2cMaster >

TCS3414 Digital Color Sensors

See also
tcs3414
Author
David Hebbeker, Niklas Hauser

Member Function Documentation

template<typename I2cMaster >
static constexpr uint8_t modm::Tcs3414< I2cMaster >::addr ( uint8_t  version = 4)
inlinestaticconstexpr

Device Address depends on version TCS341x

  • TCS3413 = 0x29
  • TCS3414 = 0x39
  • TCS3415 = 0x49
  • TCS3416 = 0x59
void modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::attachConfigurationHandler ( I2c::ConfigurationHandler  handler)
inheritedinline

Attaches a configuration handler, which is called before a transaction, whenever the configuration has to be changed.

modm::ResumableResult< ReturnType > resumable modm::NestedResumable< 1 >::function (   ...)
inherited

Run the resumable function.

You need to implement this method in you subclass yourself.

Returns
>NestingError if still running, <=NestingError if it has finished.
int8_t modm::NestedResumable< 1 >::getResumableDepth ( ) const
inheritedinline
Returns
the nesting depth in the current resumable function, or -1 if called outside any resumable function
bool modm::NestedResumable< 1 >::isResumableRunning ( ) const
inheritedinline
Returns
true if a resumable function is running at the current nesting level, else false
bool modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::isTransactionRunning ( )
inheritedinlineprotected
Returns
true when transaction is busy.
modm::ResumableResult<bool> modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::ping ( )
inheritedinline
Return Values
truedevice responds to address
falseno device with address found
void modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::setAddress ( uint8_t  address)
inheritedinline

Sets a new address of the slave device.

Parameters
addressthe slave address not yet shifted left (address < 128).
bool modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::wasTransactionSuccessful ( )
inheritedinlineprotected
Returns
true when transaction did not return an error.
The documentation for this class was generated from the following file: