IRremote
Public Member Functions | List of all members
IRrecv Class Reference

Main class for receiving IR. More...

#include <IRremote.h>

Public Member Functions

 IRrecv (int recvpin)
 Instantiate the IRrecv class. More...
 
 IRrecv (int recvpin, int blinkpin)
 Instantiate the IRrecv class. More...
 
void blink13 (int blinkflag)
 TODO: Why is this public??? More...
 
int decode (decode_results *results)
 Attempt to decode the recently receive IR signal. More...
 
void enableIRIn ()
 Enable IR reception. More...
 
void disableIRIn ()
 Disable IR reception. More...
 
bool isIdle ()
 Returns status of reception. More...
 
void resume ()
 Called to re-enable IR reception. More...
 

Detailed Description

Main class for receiving IR.

Definition at line 193 of file IRremote.h.

Constructor & Destructor Documentation

◆ IRrecv() [1/2]

IRrecv::IRrecv ( int  recvpin)

Instantiate the IRrecv class.

Multiple instantiation is not supported.

Parameters
recvpinArduino pin to use. No sanity check is made.

Definition at line 144 of file irRecv.cpp.

◆ IRrecv() [2/2]

IRrecv::IRrecv ( int  recvpin,
int  blinkpin 
)

Instantiate the IRrecv class.

Multiple instantiation is not supported.

Parameters
recvpinArduino pin to use, where a demodulating IR receiver is connected.
blinkpinpin to blink when receiving IR. Not supported by all hardware. No sanity check is made.

Definition at line 149 of file irRecv.cpp.

Member Function Documentation

◆ blink13()

void IRrecv::blink13 ( int  blinkflag)

TODO: Why is this public???

Parameters
blinkflag

Definition at line 197 of file irRecv.cpp.

◆ decode()

int IRrecv::decode ( decode_results results)

Attempt to decode the recently receive IR signal.

Parameters
resultsdecode_results instance returning the decode, if any.
Returns
success of operation. TODO: convert to bool

Definition at line 8 of file irRecv.cpp.

◆ disableIRIn()

void IRrecv::disableIRIn ( )

Disable IR reception.

Definition at line 185 of file irRecv.cpp.

◆ enableIRIn()

void IRrecv::enableIRIn ( )

Enable IR reception.

Definition at line 160 of file irRecv.cpp.

◆ isIdle()

bool IRrecv::isIdle ( )

Returns status of reception.

Returns
true if no reception is on-going.

Definition at line 209 of file irRecv.cpp.

◆ resume()

void IRrecv::resume ( )

Called to re-enable IR reception.

Definition at line 215 of file irRecv.cpp.


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