IRremote
Macros
IRremoteBoardDefs.h File Reference

All board specific information should be contained in this file. It defines a number of macros, depending on the board, as determined by pre-proccesor symbols. It was previously contained within IRremoteInt.h. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define HAS_AVR_INTERRUPT_H
 Define if the current board has/needs the header avr/interrupt.h. More...
 
#define USE_DEFAULT_ENABLE_IR_IN
 Defined if the standard enableIRIn function should be used. More...
 
#define SENDING_SUPPORTED
 Define if the current board supports sending. More...
 
#define USE_DEFAULT_ENABLE_IR_OUT
 Defined if the standard enableIROut function should be used. More...
 
#define DUTY_CYCLE   30
 Duty cycle in percent for sent signals. More...
 
#define PULSE_CORRECTION   3
 If USE_SOFT_CARRIER or USE_NO_CARRIER, this amount (in micro seconds) is subtracted from the on-time of the pulses. More...
 
#define BLINKLED   LED_BUILTIN
 If defined, denotes pin number of LED that should be blinked during IR reception. More...
 
#define BLINKLED_ON()   digitalWrite(BLINKLED, HIGH)
 Board dependent macro to turn BLINKLED on. More...
 
#define BLINKLED_OFF()   digitalWrite(BLINKLED, HIGH)
 Board dependent macro to turn BLINKLED off. More...
 
#define USE_NO_CARRIER
 Define to use no carrier PWM, just simulate a receiver signal. More...
 
#define USE_SOFT_CARRIER
 Define to use carrier generation in software, instead of hardware PWM. More...
 
#define USE_SPIN_WAIT
 Define to use spin wait instead of delayMicros() for USE_SOFT_CARRIER. More...
 
#define USECPERTICK   50
 
#define SENDPIN_ON(pin)   digitalWrite(pin, HIGH)
 Board dependent macro to turn on the pin given as argument. More...
 
#define SENDPIN_OFF(pin)   digitalWrite(pin, LOW)
 Board dependent macro to turn off the pin given as argument. More...
 
#define SYSCLOCK   F_CPU
 Clock frequency to be used for timing. More...
 
#define IR_SEND_PIN
 If applicable, pin number for sending IR. More...
 
#define ISR
 Interrupt service routine. More...
 

Detailed Description

All board specific information should be contained in this file. It defines a number of macros, depending on the board, as determined by pre-proccesor symbols. It was previously contained within IRremoteInt.h.

Definition in file IRremoteBoardDefs.h.

Macro Definition Documentation

◆ BLINKLED

#define BLINKLED   LED_BUILTIN

If defined, denotes pin number of LED that should be blinked during IR reception.

Leave undefined to disable blinking.

Definition at line 75 of file IRremoteBoardDefs.h.

◆ BLINKLED_OFF

#define BLINKLED_OFF ( )    digitalWrite(BLINKLED, HIGH)

Board dependent macro to turn BLINKLED off.

Definition at line 85 of file IRremoteBoardDefs.h.

◆ BLINKLED_ON

#define BLINKLED_ON ( )    digitalWrite(BLINKLED, HIGH)

Board dependent macro to turn BLINKLED on.

Definition at line 80 of file IRremoteBoardDefs.h.

◆ DUTY_CYCLE

#define DUTY_CYCLE   30

Duty cycle in percent for sent signals.

Definition at line 56 of file IRremoteBoardDefs.h.

◆ HAS_AVR_INTERRUPT_H

#define HAS_AVR_INTERRUPT_H

Define if the current board has/needs the header avr/interrupt.h.

Definition at line 33 of file IRremoteBoardDefs.h.

◆ IR_SEND_PIN

#define IR_SEND_PIN

If applicable, pin number for sending IR.

Note that in most cases, this is not used and ignored if set. Instead, the sending pin is determined by the timer deployed.

Definition at line 363 of file IRremoteBoardDefs.h.

◆ ISR

#define ISR

Interrupt service routine.

Called as interrupt routine to collect read IR data.

Definition at line 368 of file IRremoteBoardDefs.h.

◆ PULSE_CORRECTION

#define PULSE_CORRECTION   3

If USE_SOFT_CARRIER or USE_NO_CARRIER, this amount (in micro seconds) is subtracted from the on-time of the pulses.

Definition at line 63 of file IRremoteBoardDefs.h.

◆ SENDING_SUPPORTED

#define SENDING_SUPPORTED

Define if the current board supports sending.

Definition at line 44 of file IRremoteBoardDefs.h.

◆ SENDPIN_OFF

#define SENDPIN_OFF (   pin)    digitalWrite(pin, LOW)

Board dependent macro to turn off the pin given as argument.

Definition at line 337 of file IRremoteBoardDefs.h.

◆ SENDPIN_ON

#define SENDPIN_ON (   pin)    digitalWrite(pin, HIGH)

Board dependent macro to turn on the pin given as argument.

Definition at line 330 of file IRremoteBoardDefs.h.

◆ SYSCLOCK

#define SYSCLOCK   F_CPU

Clock frequency to be used for timing.

Definition at line 350 of file IRremoteBoardDefs.h.

◆ USE_DEFAULT_ENABLE_IR_IN

#define USE_DEFAULT_ENABLE_IR_IN

Defined if the standard enableIRIn function should be used.

Undefine for boards supplying their own.

Definition at line 39 of file IRremoteBoardDefs.h.

◆ USE_DEFAULT_ENABLE_IR_OUT

#define USE_DEFAULT_ENABLE_IR_OUT

Defined if the standard enableIROut function should be used.

Undefine for boards supplying their own.

Definition at line 50 of file IRremoteBoardDefs.h.

◆ USE_NO_CARRIER

#define USE_NO_CARRIER

Define to use no carrier PWM, just simulate a receiver signal.

Definition at line 90 of file IRremoteBoardDefs.h.

◆ USE_SOFT_CARRIER

#define USE_SOFT_CARRIER

Define to use carrier generation in software, instead of hardware PWM.

Definition at line 95 of file IRremoteBoardDefs.h.

◆ USE_SPIN_WAIT

#define USE_SPIN_WAIT

Define to use spin wait instead of delayMicros() for USE_SOFT_CARRIER.

Definition at line 100 of file IRremoteBoardDefs.h.

◆ USECPERTICK

#define USECPERTICK   50

Definition at line 167 of file IRremoteBoardDefs.h.