IrSender Class Reference

Abstract base class for all sending classes. More...

#include <IrSender.h>

Inheritance diagram for IrSender:

Public Member Functions
virtual	~IrSender ()
virtual void	send (const IrSequence &irSequence, frequency_t frequency=IrSignal::defaultFrequency)=0
	Sends an IrSequence with the prescribed frequency. More...
void	sendIrSignal (const IrSignal &irSignal, unsigned int noSends=1)
	Sends the IrSignal given as argument the prescribed number of times. More...
void	sendWhile (const IrSignal &irSignal, bool(*trigger)())
	Send an IrSignal, when and as long as trigger() returns true. More...
virtual void	mute ()
	Send an IrSignal, when and as long as buttonPin is LOW. More...

Protected Member Functions
pin_t	getOutputPin () const
void	delayUSecs (microseconds_t T)
	IrSender ()
	IrSender (pin_t pin)

Detailed Description

Abstract base class for all sending classes.

Definition at line 26 of file IrSender.h.

Constructor & Destructor Documentation

IrSender() [1/2]

IrSender::IrSender ( )

protected

Definition at line 35 of file IrSender.cpp.

IrSender() [2/2]

IrSender::IrSender ( pin_t  pin )

protected

Definition at line 39 of file IrSender.cpp.

~IrSender()

IrSender::~IrSender ( )

virtual

Definition at line 45 of file IrSender.cpp.

Member Function Documentation

delayUSecs()

void IrSender::delayUSecs ( microseconds_t  T )

protected

Definition at line 25 of file IrSender.cpp.

getOutputPin()

pin_t IrSender::getOutputPin ( ) const

inlineprotected

Definition at line 31 of file IrSender.h.

mute()

void IrSender::mute ( )

virtual

Send an IrSignal, when and as long as buttonPin is LOW.

Parameters

irSignal
buttonPinForce	output pin inactive.

Definition at line 49 of file IrSender.cpp.

send()

virtual void IrSender::send ( const IrSequence &  irSequence, frequency_t  frequency = IrSignal::defaultFrequency  )

pure virtual

Sends an IrSequence with the prescribed frequency.

Parameters

irSequence
frequency	frequency in Hz

Implemented in IrSenderPwm, IrSenderNonMod, and IrSenderSimulator.

sendIrSignal()

void IrSender::sendIrSignal	(	const IrSignal &	irSignal,
		unsigned int	noSends = 1
	)

Sends the IrSignal given as argument the prescribed number of times.

This will send the intro sequence signal of the IrSignal, noSend of the repeat, alternatively noSends - 1 repeats if intro is non-empty, and finally the ending sequence.

Parameters

irSignal
noSends

Definition at line 53 of file IrSender.cpp.

sendWhile()

void IrSender::sendWhile	(	const IrSignal &	irSignal,
		bool(*)()	trigger
	)

Send an IrSignal, when and as long as trigger() returns true.

Parameters

irSignal
trigger	Function returning bool.

Definition at line 62 of file IrSender.cpp.

---

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

• src/IrSender.h
• src/IrSender.cpp