This class implements the IrWidget. More...

#include <IrWidgetAggregating.h>

Inheritance diagram for IrWidgetAggregating:

Collaboration diagram for IrWidgetAggregating:

Public Member Functions
void	capture ()

Public Member Functions inherited from IrWidget
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 Member Functions
static void	deleteInstance ()

static IrWidgetAggregating *	getInstance ()

static IrWidgetAggregating *	newIrWidgetAggregating (size_t captureLength=defaultCaptureLength, boolean pullup=false, int16_t markExcess=defaultMarkExcess, milliseconds_t beginningTimeout=defaultBeginningTimeout, milliseconds_t endingTimeout=defaultEndingTimeout)

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

Protected Member Functions inherited from IrWidget
	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)

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 ()

Additional Inherited Members
Static Public Attributes inherited from IrWidget
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 inherited from IrWidget
typedef uint8_t	ovlBitsDataType

Static Protected Member Functions inherited from IrWidget
static uint32_t	timerValueToNanoSeconds (uint32_t x)

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

Protected Attributes inherited from IrWidget
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 inherited from IrWidget
static const uint8_t	RANGE_EXTENSION_BITS = 4

static const uint8_t	sampleSize = 2

Detailed Description

This class implements the IrWidget.

It delivers the duration and an estimate of the modulation frequency based upon the collected samples. Since it uses a single timer, it is singleton class, only instantiable by the factory method newIrWidgetAggregating.

Definition at line 16 of file IrWidgetAggregating.h.

Constructor & Destructor Documentation

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

protected

Definition at line 8 of file IrWidgetAggregating.cpp.

Member Function Documentation

void IrWidgetAggregating::capture ( )

virtual

Implements IrWidget.

Definition at line 36 of file IrWidgetAggregating.cpp.

void IrWidgetAggregating::deleteInstance ( )

static

Definition at line 30 of file IrWidgetAggregating.cpp.

static IrWidgetAggregating* IrWidgetAggregating::getInstance ( )

inlinestatic

Definition at line 26 of file IrWidgetAggregating.h.

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

static

Definition at line 18 of file IrWidgetAggregating.cpp.

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

src/IrWidgetAggregating.h
src/IrWidgetAggregating.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation