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...
 
uint_fast8_t rawlen
 counter of entries in rawbuf More...
 
uint16_t rawbuf [RAW_BUFFER_LENGTH]
 raw data / tick counts per mark/space, first entry is the length of the gap between previous and current command 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 95 of file IRremoteInt.h.

Member Data Documentation

◆ IRReceivePin

uint_fast8_t irparams_struct::IRReceivePin

Pin connected to IR data from detector.

Definition at line 98 of file IRremoteInt.h.

◆ OverflowFlag

bool irparams_struct::OverflowFlag

Raw buffer OverflowFlag occurred.

Definition at line 107 of file IRremoteInt.h.

◆ rawbuf

uint16_t irparams_struct::rawbuf[RAW_BUFFER_LENGTH]

raw data / tick counts per mark/space, first entry is the length of the gap between previous and current command

Definition at line 113 of file IRremoteInt.h.

◆ rawlen

uint_fast8_t irparams_struct::rawlen

counter of entries in rawbuf

Definition at line 109 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 105 of file IRremoteInt.h.

◆ StateForISR

volatile uint8_t irparams_struct::StateForISR

State Machine state.

Definition at line 97 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 103 of file IRremoteInt.h.


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