IRremote
irparams_struct Struct Reference

This struct contains the data and control used for receiver static functions and the ISR (interrupt service routine) Only StateForISR needs to be volatile. More...

#include <IRremoteInt.h>

Public Attributes

volatile uint8_t StateForISR
 State Machine state. More...
 
uint_fast8_t IRReceivePin
 Pin connected to IR data from detector. More...
 
volatile uint_fast16_t TickCounterForISR
 Counts 50uS ticks. The value is copied into the rawbuf array on every transition. Counting is independent of state or resume(). More...
 
void(* ReceiveCompleteCallbackFunction )(void)
 The function to call if a protocol message has arrived, i.e. StateForISR changed to IR_REC_STATE_STOP. More...
 
bool OverflowFlag
 Raw buffer OverflowFlag occurred. More...
 
IRRawlenType rawlen
 counter of entries in rawbuf More...
 
uint16_t initialGapTicks
 Tick counts of the length of the gap between previous and current IR frame. Pre 4.4: rawbuf[0]. More...
 
IRRawbufType rawbuf [RAW_BUFFER_LENGTH]
 raw data / tick counts per mark/space. With 8 bit we can only store up to 12.7 ms. First entry is empty to be backwards compatible. More...
 

Detailed Description

This struct contains the data and control used for receiver static functions and the ISR (interrupt service routine) Only StateForISR needs to be volatile.

All the other fields are not written by ISR after data available and before start/resume.

Definition at line 129 of file IRremoteInt.h.

Member Data Documentation

◆ initialGapTicks

uint16_t irparams_struct::initialGapTicks

Tick counts of the length of the gap between previous and current IR frame. Pre 4.4: rawbuf[0].

Definition at line 143 of file IRremoteInt.h.

◆ IRReceivePin

uint_fast8_t irparams_struct::IRReceivePin

Pin connected to IR data from detector.

Definition at line 132 of file IRremoteInt.h.

◆ OverflowFlag

bool irparams_struct::OverflowFlag

Raw buffer OverflowFlag occurred.

Definition at line 141 of file IRremoteInt.h.

◆ rawbuf

IRRawbufType irparams_struct::rawbuf[RAW_BUFFER_LENGTH]

raw data / tick counts per mark/space. With 8 bit we can only store up to 12.7 ms. First entry is empty to be backwards compatible.

Definition at line 144 of file IRremoteInt.h.

◆ rawlen

IRRawlenType irparams_struct::rawlen

counter of entries in rawbuf

Definition at line 142 of file IRremoteInt.h.

◆ ReceiveCompleteCallbackFunction

void(* irparams_struct::ReceiveCompleteCallbackFunction) (void)

The function to call if a protocol message has arrived, i.e. StateForISR changed to IR_REC_STATE_STOP.

Definition at line 139 of file IRremoteInt.h.

◆ StateForISR

volatile uint8_t irparams_struct::StateForISR

State Machine state.

Definition at line 131 of file IRremoteInt.h.

◆ TickCounterForISR

volatile uint_fast16_t irparams_struct::TickCounterForISR

Counts 50uS ticks. The value is copied into the rawbuf array on every transition. Counting is independent of state or resume().

Definition at line 137 of file IRremoteInt.h.


The documentation for this struct was generated from the following file: