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 >

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

bool isTransactionRunning ()
 
bool runTransaction ()
 Starts our own transaction and waits until finished.
 
bool startTransaction ()
 Starts the transaction with our own transaction object.
 
bool startTransaction (modm::I2cTransaction *transaction)
 Starts the transaction with a separate transaction object.
 
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.

bool modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::isTransactionRunning ( )
inheritedinlineprotected
Returns
true when transaction is busy.
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: