modm API documentation
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
modm::Ft6x06< I2cMaster > Class Template Reference
External Device Drivers » FT6x06 Capacitive Touch Controller

#include <modm/driver/touch/ft6x06.hpp>

Inheritance diagram for modm::Ft6x06< I2cMaster >:
modm::I2cDevice< I2cMaster >

Classes

struct  Data
 
struct  touch_t
 

Public Types

enum  Gesture : uint8_t
 
enum  Event : uint8_t
 
enum  InterruptMode : uint8_t
 

Public Member Functions

 Ft6x06 (Data &data, uint8_t address=0x2A)
 Constructor, requires an ft6x06::Data object, sets address to default of 0x2A.
 
bool configure (InterruptMode mode, uint8_t activeRate=60, uint8_t monitorRate=25)
 
bool readTouches ()
 Reads all touches and writes the result to the data object.
 
Data & getData ()
 Get the data object for this sensor.
 
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.
 

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

I2cWriteReadTransaction transaction
 

Detailed Description

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

FT6x06 capacitive touch panel driver.

The driver is reasonably simple, due to the datasheet not being very descriptive.

Author
Niklas Hauser

Member Function Documentation

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: