IrReceiverPoll Class Reference

An implementation of IrReceiver using polling of the input pin. More...

#include <IrReceiverPoll.h>

Inheritance diagram for IrReceiverPoll:

Collaboration diagram for IrReceiverPoll:

Public Member Functions
	IrReceiverPoll (size_t captureLength=defaultCaptureLength, pin_t pin=defaultPin, boolean pullup=false, microseconds_t markExcess=defaultMarkExcess, milliseconds_t beginningTimeout=defaultBeginningTimeout, milliseconds_t endingTimeout=defaultEndingTimeout)
	~IrReceiverPoll ()
boolean	isReady () const
	Returns true if there is collected data. More...
void	reset ()
size_t	getDataLength () const
	Returns the number of collected durations. More...
microseconds_t	getDuration (unsigned int i) const
	Returns the index-th duration, if possible. More...
void	setEndingTimeout (milliseconds_t timeOut)
milliseconds_t	getEndingTimeout () const
milliseconds_t	getBeginningTimeout () const
void	setBeginningTimeout (milliseconds_t timeOut)
void	enable ()
	In this class, enable does the actual collection of the data. More...
void	disable ()
	Stop reception of IR data. More...
Public Member Functions inherited from IrReceiver
	IrReceiver (size_t bufSize, pin_t pin, boolean pullup=false, microseconds_t markExcess=defaultMarkExcess)
	Constructor. More...
virtual	~IrReceiver ()
virtual void	receive ()
	Convenience function: enable, wait until data is collected or timeout has occured, disable. More...
pin_t	getPin () const
Public Member Functions inherited from IrReader
virtual void	dump (Stream &stream) const
	Prints a textual representation of the received data to the Stream supplied. More...
IrSequence *	toIrSequence () const
	Generates an IrSequence from the IrReader. More...
virtual boolean	isEmpty () 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...

Additional Inherited Members
Public Types inherited from IrReceiver
enum	irdata_t { IR_MARK, IR_SPACE }
	Enum for the duration types. More...
Static Public Attributes inherited from IrReceiver
static const pin_t	defaultPin = 5
static const microseconds_t	defaultMarkExcess = 50U
static const boolean	invertingSensor = true
	Are we using inverting sensor, like most TSOPs? More...
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 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 inherited from IrReader
static unsigned int	forceEven (unsigned int x)
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...

Detailed Description

An implementation of IrReceiver using polling of the input pin.

Thus uses no timer.

Definition at line 9 of file IrReceiverPoll.h.

Constructor & Destructor Documentation

IrReceiverPoll::IrReceiverPoll	(	size_t	captureLength = defaultCaptureLength,
		pin_t	pin = defaultPin,
		boolean	pullup = false,
		microseconds_t	markExcess = defaultMarkExcess,
		milliseconds_t	beginningTimeout = defaultBeginningTimeout,
		milliseconds_t	endingTimeout = defaultEndingTimeout
	)

Definition at line 4 of file IrReceiverPoll.cpp.

IrReceiverPoll::~IrReceiverPoll

(

)

Definition at line 16 of file IrReceiverPoll.cpp.

Member Function Documentation

void IrReceiverPoll::disable ( )

inlinevirtual

Stop reception of IR data.

Reimplemented from IrReader.

Definition at line 64 of file IrReceiverPoll.h.

void IrReceiverPoll::enable ( )

virtual

In this class, enable does the actual collection of the data.

It returns when either the signal is captured, or (beginning) timeout occurs.

Reimplemented from IrReader.

Definition at line 26 of file IrReceiverPoll.cpp.

milliseconds_t IrReceiverPoll::getBeginningTimeout ( ) const

inlinevirtual

Reimplemented from IrReader.

Definition at line 49 of file IrReceiverPoll.h.

size_t IrReceiverPoll::getDataLength ( ) const

inlinevirtual

Returns the number of collected durations.

Returns

number durations

Implements IrReader.

Definition at line 33 of file IrReceiverPoll.h.

microseconds_t IrReceiverPoll::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 37 of file IrReceiverPoll.h.

milliseconds_t IrReceiverPoll::getEndingTimeout ( ) const

inlinevirtual

Reimplemented from IrReader.

Definition at line 45 of file IrReceiverPoll.h.

boolean IrReceiverPoll::isReady ( ) const

inlinevirtual

Returns true if there is collected data.

Returns

status

Implements IrReader.

Definition at line 27 of file IrReceiverPoll.h.

void IrReceiverPoll::reset ( )

virtual

Reimplemented from IrReader.

Definition at line 21 of file IrReceiverPoll.cpp.

void IrReceiverPoll::setBeginningTimeout ( milliseconds_t  timeOut )

inlinevirtual

Reimplemented from IrReader.

Definition at line 53 of file IrReceiverPoll.h.

void IrReceiverPoll::setEndingTimeout ( milliseconds_t  timeOut )

inlinevirtual

Reimplemented from IrReader.

Definition at line 41 of file IrReceiverPoll.h.

---

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

• src/IrReceiverPoll.h
• src/IrReceiverPoll.cpp