Base class for classes based upon ICP pins capture. More...

#include <IrWidget.h>

Inheritance diagram for IrWidget:

Collaboration diagram for IrWidget:

Public Member Functions
virtual void	capture ()=0

void	receive ()
	For compatibility with the receiver classes, receive is a synonym for capture. More...

size_t	getDataLength () const
	Returns the number of collected durations. More...

boolean	isReady () const
	Returns true if there is collected data. More...

void	reset ()

microseconds_t	getDuration (unsigned int i) const
	Returns the index-th duration, if possible. More...

void	setEndingTimeout (milliseconds_t timeout)
	Sets the ending timeout. More...

milliseconds_t	getEndingTimeout () const

frequency_t	getFrequency () const

void	dump (Stream &stream) const
	Prints a textual representation of the received data to the Stream supplied. More...

Public Member Functions inherited from IrReader
virtual void	enable ()
	Start reception of IR data. More...

virtual void	disable ()
	Stop reception of IR data. More...

IrSequence *	toIrSequence () const
	Generates an IrSequence from the IrReader. More...

virtual boolean	isEmpty () const

virtual void	setBeginningTimeout (milliseconds_t timeOut)

virtual milliseconds_t	getBeginningTimeout () const

unsigned int	getBufferSize () const

void	setMarkExcess (int16_t markExcess_)
	Sets the markExcess, a number (possibly negative) to be subtracted from the on-durations and added to the off.durations. More...

int16_t	getMarkExcess () const
	Gets the markExcess, a number (possibly negative) to be subtracted from the on-durations and added to the off.durations. More...

Static Public Attributes
static const int16_t	defaultMarkExcess = 0

static const boolean	invertingSensor = true

Static Public Attributes inherited from IrReader
static const milliseconds_t	defaultBeginningTimeout = 2000U

static const milliseconds_t	defaultEndingTimeout = 30U

static const size_t	defaultCaptureLength = 100U

Protected Types
typedef uint8_t	ovlBitsDataType

Protected Member Functions
	IrWidget (size_t captureLength=defaultCaptureLength, boolean pullup=false, int16_t markExcess=defaultMarkExcess, milliseconds_t beginningTimeout=defaultBeginningTimeout, milliseconds_t endingTimeout=defaultEndingTimeout)

virtual	~IrWidget ()

void	debugPinToggle (void)

void	debugPinClear (void)

virtual uint32_t	unpackTimeVal (uint32_t val) const =0

Protected Member Functions inherited from IrReader
	IrReader (size_t bufSize_)
	Constructs an IrReader with buffersize bufSize_, possibly increased to be even. More...

	IrReader ()

virtual	~IrReader ()

Static Protected Member Functions
static uint32_t	timerValueToNanoSeconds (uint32_t x)

Static Protected Member Functions inherited from IrReader
static unsigned int	forceEven (unsigned int x)

Protected Attributes
frequency_t	frequency

ovlBitsDataType	endingTimeout

uint16_t *	captureData

uint16_t	captureCount

uint16_t	period

Protected Attributes inherited from IrReader
milliseconds_t	beginningTimeout

milliseconds_t	endingTimeout

size_t	bufferSize

int16_t	markExcess
	Microseconds subtracted from pulses and added to gaps. More...

boolean	timeouted
	True if last receive ended with a timeout. More...

Static Protected Attributes
static const uint8_t	RANGE_EXTENSION_BITS = 4

static const uint8_t	sampleSize = 2

Detailed Description

Base class for classes based upon ICP pins capture.

See this article (in German).

Definition at line 44 of file IrWidget.h.

Member Typedef Documentation

typedef uint8_t IrWidget::ovlBitsDataType

protected

Definition at line 122 of file IrWidget.h.

Constructor & Destructor Documentation

IrWidget::IrWidget	(	size_t	captureLength = `defaultCaptureLength`,
		boolean	pullup = `false`,
		int16_t	markExcess = `defaultMarkExcess`,
		milliseconds_t	beginningTimeout = `defaultBeginningTimeout`,
		milliseconds_t	endingTimeout = `defaultEndingTimeout`
	)

protected

Definition at line 32 of file IrWidget.cpp.

IrWidget::~IrWidget ( )

protectedvirtual

Definition at line 49 of file IrWidget.cpp.

Member Function Documentation

virtual void IrWidget::capture ( )

pure virtual

Implemented in IrWidgetAggregating.

void IrWidget::debugPinClear ( void )

inlineprotected

Definition at line 189 of file IrWidget.h.

void IrWidget::debugPinToggle ( void )

inlineprotected

Definition at line 183 of file IrWidget.h.

void IrWidget::dump ( Stream & stream ) const

virtual

Prints a textual representation of the received data to the Stream supplied.

Parameters

stream Stream to which to print

Reimplemented from IrReader.

Definition at line 62 of file IrWidget.cpp.

size_t IrWidget::getDataLength ( ) const

inlinevirtual

Returns the number of collected durations.

Returns: number durations

Implements IrReader.

Definition at line 67 of file IrWidget.h.

microseconds_t IrWidget::getDuration ( unsigned int index ) const

inlinevirtual

Returns the index-th duration, if possible.

Parameters

index index of duration

Returns: requested duration

Implements IrReader.

Definition at line 79 of file IrWidget.h.

milliseconds_t IrWidget::getEndingTimeout ( ) const

virtual

Reimplemented from IrReader.

Definition at line 57 of file IrWidget.cpp.

frequency_t IrWidget::getFrequency ( ) const

inline

Definition at line 97 of file IrWidget.h.

boolean IrWidget::isReady ( ) const

inlinevirtual

Returns true if there is collected data.

Returns: status

Implements IrReader.

Definition at line 71 of file IrWidget.h.

void IrWidget::receive ( )

inlinevirtual

For compatibility with the receiver classes, receive is a synonym for capture.

Implements IrReader.

Definition at line 63 of file IrWidget.h.

void IrWidget::reset ( )

inlinevirtual

Reimplemented from IrReader.

Definition at line 75 of file IrWidget.h.

void IrWidget::setEndingTimeout ( milliseconds_t timeout )

virtual

Sets the ending timeout.

In this implementation, this is effectively rounded to the nearest multiple of 32 milliseconds.

Parameters

timeout timeout in milliseconds.

Reimplemented from IrReader.

Definition at line 53 of file IrWidget.cpp.

static uint32_t IrWidget::timerValueToNanoSeconds ( uint32_t x )

inlinestaticprotected

Definition at line 205 of file IrWidget.h.

virtual uint32_t IrWidget::unpackTimeVal ( uint32_t val ) const

protectedpure virtual

Member Data Documentation

uint16_t IrWidget::captureCount

protected

Definition at line 195 of file IrWidget.h.

uint16_t* IrWidget::captureData

protected

Definition at line 194 of file IrWidget.h.

const int16_t IrWidget::defaultMarkExcess = 0

static

Definition at line 46 of file IrWidget.h.

ovlBitsDataType IrWidget::endingTimeout

protected

Definition at line 129 of file IrWidget.h.

frequency_t IrWidget::frequency

protected

Definition at line 49 of file IrWidget.h.

const boolean IrWidget::invertingSensor = true

static

Definition at line 58 of file IrWidget.h.

uint16_t IrWidget::period

protected

Definition at line 196 of file IrWidget.h.

const uint8_t IrWidget::RANGE_EXTENSION_BITS = 4

staticprotected

Definition at line 126 of file IrWidget.h.

const uint8_t IrWidget::sampleSize = 2

staticprotected

Definition at line 199 of file IrWidget.h.

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

src/IrWidget.h
src/IrWidget.cpp

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation