COSA
An Object-Oriented Platform for Arduino Programming
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Touch Class Referenceabstract

#include <Touch.hh>

Inheritance diagram for Touch:
Inheritance graph
Collaboration diagram for Touch:
Collaboration graph

Public Member Functions

 Touch (Job::Scheduler *scheduler, Board::DigitalPin pin, uint16_t threshold=250)
 
virtual void on_touch ()=0
 
void period (uint32_t time)
 
uint32_t period () const
 
void reschedule ()
 
void expire_at (uint32_t time)
 
uint32_t expire_at () const
 
void expire_after (uint32_t time)
 
int32_t expire_after () const
 
uint32_t time () const
 
bool is_started () const
 
bool start ()
 
bool stop ()
 
virtual void on_expired ()
 
void detach ()
 
Linkage * succ () const
 
Linkage * pred () const
 
void attach (Linkage *pred)
 

Protected Member Functions

virtual void run ()
 
virtual void on_event (uint8_t type, uint16_t value)
 

Protected Attributes

const uint16_t THRESHOLD
 
uint32_t m_start
 
uint8_t m_sampling
 
uint8_t m_touched
 
uint32_t m_period
 
uint32_t m_expires
 
Scheduler * m_scheduler
 
Linkage * m_succ
 
Linkage * m_pred
 

Static Protected Attributes

static const uint16_t SAMPLE_RATE = 16
 

Private Types

enum  Mode { OUTPUT_MODE = 0, INPUT_MODE = 1 }
 
enum  Direction { MSB_FIRST = 0, LSB_FIRST = 1 }
 

Private Member Functions

void mode (Mode mode)
 
Mode mode () const
 
void _set () const
 
void _set (int value) const
 
void set () const
 
void set (int value) const
 
void high () const
 
void on () const
 
void _clear () const
 
void clear () const
 
void low () const
 
void off () const
 
void _toggle () const
 
void toggle () const
 
void _write (int value) const
 
void write (int value) const
 
void write (uint8_t value, OutputPin &clk, Direction order=MSB_FIRST) const
 
void write (uint16_t value, uint8_t bits, uint16_t us) const
 
OutputPin & operator<< (int value)
 
void pulse (uint16_t us) const
 
volatile uint8_t * PIN () const
 
volatile uint8_t * DDR () const
 
volatile uint8_t * PORT () const
 
uint8_t pin () const
 
bool is_set () const
 
bool is_high () const
 
bool is_on () const
 
bool is_clear () const
 
bool is_low () const
 
bool is_off () const
 
bool read () const
 
uint8_t read (OutputPin &clk, Direction order=MSB_FIRST) const
 
 operator bool () const
 
Pin & operator>> (uint8_t &var)
 
volatile uint8_t * PCIMR () const
 

Static Private Member Functions

static void mode (Board::DigitalPin pin, Mode mode)
 
static Mode mode (Board::DigitalPin pin)
 
static void mode (Board::DigitalPin pin, uint8_t initial=0)
 
static void toggle (Board::DigitalPin pin)
 
static void _write (Board::DigitalPin pin, uint8_t value)
 
static void write (Board::DigitalPin pin, int value)
 
static uint8_t MASK (uint8_t pin)
 
static volatile uint8_t * PIN (uint8_t pin)
 
static volatile uint8_t * DDR (uint8_t pin)
 
static volatile uint8_t * PORT (uint8_t pin)
 
static bool read (Board::DigitalPin pin)
 

Private Attributes

volatile uint8_t *const m_sfr
 
const uint8_t m_mask
 
const uint8_t m_pin
 

Detailed Description

Touch Capacitive Sensor using periodic discharging to detect a sensor touch. Uses the Cosa IOPin to allow changing of data direction and the watchdog for periodic reading. A callback, virtual member function is called on detection.

Circuit

Connect a 1-10 M ohm pullup resistor to the selected pin.

(VCC)---[1M]---+
|
|
(Dn)-----------+-----[]

Definition at line 43 of file Touch.hh.

Constructor & Destructor Documentation

Touch::Touch ( Job::Scheduler *  scheduler,
Board::DigitalPin  pin,
uint16_t  threshold = 250 
)

Create a touch capacitive sensor connected to the given pin.

Parameters
[in]scheduler.
[in]pinidentity.
[in]thresholdtime between release detect (Default 250 ms).

Definition at line 24 of file Touch.cpp.

Member Function Documentation

void Linkage::attach ( Linkage *  pred)
inlineinherited

Attach given linkage as predecessor. Will check and detach if already attached.

Parameters
[in]predlinkage to attach.
Note
atomic

Definition at line 71 of file Linkage.hh.

void Link::detach ( )
inlineinherited

Detach this link. Unlink from any list.

Definition at line 125 of file Linkage.hh.

void Job::expire_after ( uint32_t  time)
inlineinherited

Set expire time relative to latest expire time.

Parameters
[in]timeto add to latest expire time.

Definition at line 111 of file Job.hh.

int32_t Job::expire_after ( ) const
inlineinherited

Get time remaining before expired.

Returns
time.

Definition at line 129 of file Job.hh.

void Job::expire_at ( uint32_t  time)
inlineinherited

Set expire time. Absolute time in scheduler time unit.

Parameters
[in]timeto expire.

Definition at line 102 of file Job.hh.

uint32_t Job::expire_at ( ) const
inlineinherited

Get expire time.

Returns
time.

Definition at line 120 of file Job.hh.

bool Job::is_started ( ) const
inlineinherited

Return true(1) if the job is queued otherwise false(0).

Returns
bool.

Definition at line 149 of file Job.hh.

virtual void Periodic::on_event ( uint8_t  type,
uint16_t  value 
)
inlineprotectedvirtualinherited

Periodic event handler; dispatch the run() function on timeout events and reschedule the periodic job.

Parameters
[in]typethe type of event.
[in]valuethe event value.

Reimplemented from Job.

Definition at line 91 of file Periodic.hh.

virtual void Job::on_expired ( )
inlinevirtualinherited

Job member function that is called Scheduler::dispatch() when the job time has expired. This function is normally called from an interrupt service routine. The default implementation will push a timeout event with the job as target. The default event handler will call the job run() virtual member function. Override this function if the job should be executed during the interrupt service routine.

Definition at line 185 of file Job.hh.

virtual void Touch::on_touch ( )
pure virtual

Callback virtual member function; Should be implemented by sub-class.

void Periodic::period ( uint32_t  time)
inlineinherited

Set timeout period.

Parameters
[in]timeperiod of timeout.

Definition at line 57 of file Periodic.hh.

uint32_t Periodic::period ( ) const
inlineinherited

Get timeout period.

Returns
period of timeout.

Definition at line 67 of file Periodic.hh.

Linkage* Linkage::pred ( ) const
inlineinherited

Return predecessor in sequence.

Returns
predecessor linkage.

Definition at line 60 of file Linkage.hh.

void Periodic::reschedule ( )
inlineinherited

Reschedule after a new period.

Definition at line 76 of file Periodic.hh.

void Touch::run ( )
protectedvirtual

Called on watchdog timeout. Two state period function where the io-pin is discharged and sampled.

Reimplemented from Job.

Definition at line 36 of file Touch.cpp.

bool Job::start ( )
inlineinherited

Start the job. Returns true(1) if scheduled otherwise false(0).

Returns
bool.

Definition at line 159 of file Job.hh.

bool Job::stop ( )
inlineinherited

Stop the job. Returns true(1) if scheduled otherwise false(0).

Returns
bool.

Definition at line 169 of file Job.hh.

Linkage* Linkage::succ ( ) const
inlineinherited

Return successor in sequence.

Returns
successor linkage.

Definition at line 51 of file Linkage.hh.

uint32_t Job::time ( ) const
inlineinherited

Get current scheduler time. May be used to set relative expire time.

Returns
time.

Definition at line 139 of file Job.hh.

Member Data Documentation

uint32_t Job::m_expires
protectedinherited

Expire time. Scale (us, ms, s) depends on scheduler.

Definition at line 214 of file Job.hh.

uint32_t Periodic::m_period
protectedinherited

Time period. Time unit is defined by the scheduler.

Definition at line 100 of file Periodic.hh.

Linkage* Linkage::m_pred
protectedinherited

Definition at line 94 of file Linkage.hh.

uint8_t Touch::m_sampling
protected

Discharging of sampling mode.

Definition at line 70 of file Touch.hh.

Scheduler* Job::m_scheduler
protectedinherited

Job scheduler.

Definition at line 217 of file Job.hh.

uint32_t Touch::m_start
protected

Start release detect.

Definition at line 67 of file Touch.hh.

Linkage* Linkage::m_succ
protectedinherited

Double linked list pointers.

Definition at line 93 of file Linkage.hh.

uint8_t Touch::m_touched
protected

Current state.

Definition at line 73 of file Touch.hh.

const uint16_t Touch::SAMPLE_RATE = 16
staticprotected

Pin sampling rate; watchdog timeout request.

Definition at line 61 of file Touch.hh.

const uint16_t Touch::THRESHOLD
protected

Minimum delay between release detect.

Definition at line 64 of file Touch.hh.

The documentation for this class was generated from the following files: