IRremote
Classes | Macros | Enumerations | Functions
IRremote.h File Reference

Public API to the library. More...

#include "private/IRremoteInt.h"
Include dependency graph for IRremote.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  decode_results
 Results returned from the decoder. More...
 
class  IRrecv
 Main class for receiving IR. More...
 
class  IRsend
 Main class for sending IR. More...
 

Macros

#define DECODE_RC5   1
 
#define SEND_RC5   1
 
#define DECODE_RC6   1
 
#define SEND_RC6   1
 
#define DECODE_NEC   1
 
#define SEND_NEC   1
 
#define DECODE_SONY   1
 
#define SEND_SONY   1
 
#define DECODE_PANASONIC   1
 
#define SEND_PANASONIC   1
 
#define DECODE_JVC   1
 
#define SEND_JVC   1
 
#define DECODE_SAMSUNG   1
 
#define SEND_SAMSUNG   1
 
#define DECODE_WHYNTER   1
 
#define SEND_WHYNTER   1
 
#define DECODE_AIWA_RC_T501   1
 
#define SEND_AIWA_RC_T501   1
 
#define DECODE_LG   1
 
#define SEND_LG   1
 
#define DECODE_SANYO   1
 
#define SEND_SANYO   0
 
#define DECODE_MITSUBISHI   1
 
#define SEND_MITSUBISHI   0
 
#define DECODE_DISH   0
 
#define SEND_DISH   1
 
#define DECODE_SHARP   1
 
#define SEND_SHARP   1
 
#define DECODE_SHARP_ALT   1
 
#define SEND_SHARP_ALT   1
 
#define DECODE_DENON   1
 
#define SEND_DENON   1
 
#define DECODE_PRONTO   0
 
#define SEND_PRONTO   0
 
#define DECODE_LEGO_PF   0
 
#define SEND_LEGO_PF   1
 
#define DECODE_BOSEWAVE   1
 
#define SEND_BOSEWAVE   1
 
#define DECODE_HASH   1
 
#define PRONTO_ONCE   false
 
#define PRONTO_REPEAT   true
 
#define PRONTO_FALLBACK   true
 
#define PRONTO_NOFALLBACK   false
 
#define DEBUG   0
 Set DEBUG to 1 for lots of lovely debug output. More...
 
#define DBG_PRINT(...)   void()
 If DEBUG, print the arguments, otherwise do nothing. More...
 
#define DBG_PRINTLN(...)   void()
 If DEBUG, print the arguments as a line, otherwise do nothing. More...
 
#define STR_HELPER(x)   #x
 
#define STR(x)   STR_HELPER(x)
 
#define REPEAT   0xFFFFFFFF
 Decoded value for NEC when a repeat code is received. More...
 

Enumerations

enum  decode_type_t {
  UNKNOWN = -1, UNUSED = 0, RC5, RC6,
  NEC, SONY, PANASONIC, JVC,
  SAMSUNG, WHYNTER, AIWA_RC_T501, LG,
  SANYO, MITSUBISHI, DISH, SHARP,
  SHARP_ALT, DENON, PRONTO, LEGO_PF,
  BOSEWAVE
}
 An enum consisting of all supported formats. More...
 

Functions

int MATCH (int measured, int desired)
 
int MATCH_MARK (int measured_ticks, int desired_us)
 
int MATCH_SPACE (int measured_ticks, int desired_us)
 

Detailed Description

Public API to the library.

Definition in file IRremote.h.

Macro Definition Documentation

◆ DBG_PRINT

#define DBG_PRINT (   ...)    void()

If DEBUG, print the arguments, otherwise do nothing.

Definition at line 152 of file IRremote.h.

◆ DBG_PRINTLN

#define DBG_PRINTLN (   ...)    void()

If DEBUG, print the arguments as a line, otherwise do nothing.

Definition at line 156 of file IRremote.h.

◆ DEBUG

#define DEBUG   0

Set DEBUG to 1 for lots of lovely debug output.

Definition at line 140 of file IRremote.h.

◆ DECODE_AIWA_RC_T501

#define DECODE_AIWA_RC_T501   1

Definition at line 59 of file IRremote.h.

◆ DECODE_BOSEWAVE

#define DECODE_BOSEWAVE   1

Definition at line 89 of file IRremote.h.

◆ DECODE_DENON

#define DECODE_DENON   1

Definition at line 80 of file IRremote.h.

◆ DECODE_DISH

#define DECODE_DISH   0

Definition at line 71 of file IRremote.h.

◆ DECODE_HASH

#define DECODE_HASH   1

Definition at line 92 of file IRremote.h.

◆ DECODE_JVC

#define DECODE_JVC   1

Definition at line 50 of file IRremote.h.

◆ DECODE_LEGO_PF

#define DECODE_LEGO_PF   0

Definition at line 86 of file IRremote.h.

◆ DECODE_LG

#define DECODE_LG   1

Definition at line 62 of file IRremote.h.

◆ DECODE_MITSUBISHI

#define DECODE_MITSUBISHI   1

Definition at line 68 of file IRremote.h.

◆ DECODE_NEC

#define DECODE_NEC   1

Definition at line 41 of file IRremote.h.

◆ DECODE_PANASONIC

#define DECODE_PANASONIC   1

Definition at line 47 of file IRremote.h.

◆ DECODE_PRONTO

#define DECODE_PRONTO   0

Definition at line 83 of file IRremote.h.

◆ DECODE_RC5

#define DECODE_RC5   1

Definition at line 35 of file IRremote.h.

◆ DECODE_RC6

#define DECODE_RC6   1

Definition at line 38 of file IRremote.h.

◆ DECODE_SAMSUNG

#define DECODE_SAMSUNG   1

Definition at line 53 of file IRremote.h.

◆ DECODE_SANYO

#define DECODE_SANYO   1

Definition at line 65 of file IRremote.h.

◆ DECODE_SHARP

#define DECODE_SHARP   1

Definition at line 74 of file IRremote.h.

◆ DECODE_SHARP_ALT

#define DECODE_SHARP_ALT   1

Definition at line 77 of file IRremote.h.

◆ DECODE_SONY

#define DECODE_SONY   1

Definition at line 44 of file IRremote.h.

◆ DECODE_WHYNTER

#define DECODE_WHYNTER   1

Definition at line 56 of file IRremote.h.

◆ PRONTO_FALLBACK

#define PRONTO_FALLBACK   true

Definition at line 106 of file IRremote.h.

◆ PRONTO_NOFALLBACK

#define PRONTO_NOFALLBACK   false

Definition at line 107 of file IRremote.h.

◆ PRONTO_ONCE

#define PRONTO_ONCE   false

Definition at line 104 of file IRremote.h.

◆ PRONTO_REPEAT

#define PRONTO_REPEAT   true

Definition at line 105 of file IRremote.h.

◆ REPEAT

#define REPEAT   0xFFFFFFFF

Decoded value for NEC when a repeat code is received.

Definition at line 189 of file IRremote.h.

◆ SEND_AIWA_RC_T501

#define SEND_AIWA_RC_T501   1

Definition at line 60 of file IRremote.h.

◆ SEND_BOSEWAVE

#define SEND_BOSEWAVE   1

Definition at line 90 of file IRremote.h.

◆ SEND_DENON

#define SEND_DENON   1

Definition at line 81 of file IRremote.h.

◆ SEND_DISH

#define SEND_DISH   1

Definition at line 72 of file IRremote.h.

◆ SEND_JVC

#define SEND_JVC   1

Definition at line 51 of file IRremote.h.

◆ SEND_LEGO_PF

#define SEND_LEGO_PF   1

Definition at line 87 of file IRremote.h.

◆ SEND_LG

#define SEND_LG   1

Definition at line 63 of file IRremote.h.

◆ SEND_MITSUBISHI

#define SEND_MITSUBISHI   0

Definition at line 69 of file IRremote.h.

◆ SEND_NEC

#define SEND_NEC   1

Definition at line 42 of file IRremote.h.

◆ SEND_PANASONIC

#define SEND_PANASONIC   1

Definition at line 48 of file IRremote.h.

◆ SEND_PRONTO

#define SEND_PRONTO   0

Definition at line 84 of file IRremote.h.

◆ SEND_RC5

#define SEND_RC5   1

Definition at line 36 of file IRremote.h.

◆ SEND_RC6

#define SEND_RC6   1

Definition at line 39 of file IRremote.h.

◆ SEND_SAMSUNG

#define SEND_SAMSUNG   1

Definition at line 54 of file IRremote.h.

◆ SEND_SANYO

#define SEND_SANYO   0

Definition at line 66 of file IRremote.h.

◆ SEND_SHARP

#define SEND_SHARP   1

Definition at line 75 of file IRremote.h.

◆ SEND_SHARP_ALT

#define SEND_SHARP_ALT   1

Definition at line 78 of file IRremote.h.

◆ SEND_SONY

#define SEND_SONY   1

Definition at line 45 of file IRremote.h.

◆ SEND_WHYNTER

#define SEND_WHYNTER   1

Definition at line 57 of file IRremote.h.

◆ STR

#define STR (   x)    STR_HELPER(x)

Definition at line 163 of file IRremote.h.

◆ STR_HELPER

#define STR_HELPER (   x)    #x

Definition at line 162 of file IRremote.h.

Enumeration Type Documentation

◆ decode_type_t

An enum consisting of all supported formats.

You do NOT need to remove entries from this list when disabling protocols!

Enumerator
UNKNOWN 
UNUSED 
RC5 
RC6 
NEC 
SONY 
PANASONIC 
JVC 
SAMSUNG 
WHYNTER 
AIWA_RC_T501 
LG 
SANYO 
MITSUBISHI 
DISH 
SHARP 
SHARP_ALT 
DENON 
PRONTO 
LEGO_PF 
BOSEWAVE 

Definition at line 112 of file IRremote.h.

Function Documentation

◆ MATCH()

int MATCH ( int  measured,
int  desired 
)

Definition at line 43 of file IRremote.cpp.

◆ MATCH_MARK()

int MATCH_MARK ( int  measured_ticks,
int  desired_us 
)

Definition at line 63 of file IRremote.cpp.

◆ MATCH_SPACE()

int MATCH_SPACE ( int  measured_ticks,
int  desired_us 
)

Definition at line 89 of file IRremote.cpp.