Infrared4Arduino  1.1.0
Macros | Typedefs | Variables
InfraredTypes.h File Reference

This file defines some general data types that are used in the library. More...

#include <Arduino.h>
Include dependency graph for InfraredTypes.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define MICROSECONDS_T_MAX   65535
 Largest microseconds_t number possible. More...
 
#define MILLISECONDS_T_MAX   65535
 Largest milliseconds_t number possible. More...
 
#define PIN_T_MAX   255
 Largest pin_t number possible. More...
 

Typedefs

typedef uint16_t microseconds_t
 Type for durations in micro seconds. More...
 
typedef uint16_t milliseconds_t
 Type for durations in milli seconds. More...
 
typedef uint32_t frequency_t
 Type for modulation frequency in Hz. More...
 
typedef int8_t dutycycle_t
 Type for duty cycle in percent. More...
 
typedef uint8_t pin_t
 Type for GPIO pin, compatible with Arduino libs. More...
 

Variables

const pin_t invalidPin = 255
 Symbolic name for an invalid pin number. More...
 

Detailed Description

This file defines some general data types that are used in the library.

Definition in file InfraredTypes.h.

Macro Definition Documentation

◆ MICROSECONDS_T_MAX

#define MICROSECONDS_T_MAX   65535

Largest microseconds_t number possible.

Definition at line 18 of file InfraredTypes.h.

◆ MILLISECONDS_T_MAX

#define MILLISECONDS_T_MAX   65535

Largest milliseconds_t number possible.

Definition at line 27 of file InfraredTypes.h.

◆ PIN_T_MAX

#define PIN_T_MAX   255

Largest pin_t number possible.

Definition at line 46 of file InfraredTypes.h.

Typedef Documentation

◆ dutycycle_t

typedef int8_t dutycycle_t

Type for duty cycle in percent.

Less than 0 means no information/don't care.

Definition at line 37 of file InfraredTypes.h.

◆ frequency_t

typedef uint32_t frequency_t

Type for modulation frequency in Hz.

Definition at line 32 of file InfraredTypes.h.

◆ microseconds_t

typedef uint16_t microseconds_t

Type for durations in micro seconds.

Change to a longer type if needed, AND you know what you are doing. But DO NOT use a system dependent type like int!

Definition at line 15 of file InfraredTypes.h.

◆ milliseconds_t

typedef uint16_t milliseconds_t

Type for durations in milli seconds.

Using a larger type than 16 bits probably is not sensible.

Definition at line 25 of file InfraredTypes.h.

◆ pin_t

typedef uint8_t pin_t

Type for GPIO pin, compatible with Arduino libs.

Definition at line 42 of file InfraredTypes.h.

Variable Documentation

◆ invalidPin

const pin_t invalidPin = 255

Symbolic name for an invalid pin number.

Definition at line 44 of file InfraredTypes.h.