IRplatform.h

Go to the documentation of this file.

// Copyright 2025 IRremoteIDF contributors
//
// ESP-IDF platform layer for the IR library.
// Everything the protocol code needs from the underlying framework lives here,
// so the ~120 protocol implementations stay framework agnostic.
 
#ifndef IRPLATFORM_H_
#define IRPLATFORM_H_
 
#define __STDC_LIMIT_MACROS
#include <stdint.h>
#include <stddef.h>
#include <string>
#include <type_traits>
#ifdef UNIT_TEST
#include <iostream>  // Debug output goes to cout when off-target.
#endif  // UNIT_TEST
 
typedef std::string String;
 
// The library uses Arduino's F()/PROGMEM flash-string markers in a few places.
// ESP-IDF maps constants into flash transparently, so they are no-ops.
#ifndef F
#define F(x) x
#endif  // F
#ifndef PROGMEM
#define PROGMEM
#endif  // PROGMEM
#ifndef FPSTR
#define FPSTR(x) x
#endif  // FPSTR
 
#ifndef UNIT_TEST
 
#include "sdkconfig.h"
 
const uint8_t kIrLow = 0;
const uint8_t kIrHigh = 1;
#ifndef LOW
#define LOW kIrLow
#endif  // LOW
#ifndef HIGH
#define HIGH kIrHigh
#endif  // HIGH
 
uint32_t irMillis(void);
uint32_t irMicros(void);
void irDelayMs(uint32_t msec);
void irDelayUs(uint32_t usec);
void irYield(void);
 
bool irGpioOutput(uint16_t pin);
bool irGpioInput(uint16_t pin, bool pullup);
void irGpioWrite(uint16_t pin, uint8_t level);
uint8_t irGpioRead(uint16_t pin);
 
void irRestart(void);
 
#ifdef CONFIG_IRREMOTE_TX_HW_CARRIER
// Optional LEDC-generated carrier. The CPU then only has to time the
// mark/space boundaries instead of every single carrier pulse.
 
int8_t irCarrierAttach(uint16_t pin, bool inverted);
void irCarrierDetach(int8_t channel, uint16_t pin, bool inverted);
void irCarrierConfig(int8_t channel, uint32_t freq, uint8_t duty);
void irCarrierOn(int8_t channel);
void irCarrierOff(int8_t channel);
#endif  // CONFIG_IRREMOTE_TX_HW_CARRIER
 
#endif  // UNIT_TEST
 
// Debug output. Enable with CONFIG_IRREMOTE_DEBUG or by defining DEBUG
// (e.g. -DDEBUG=1). IRconfig.h maps the former onto the latter, so it has to
// be seen before the test below.
#include "IRconfig.h"
#ifdef DEBUG
#ifdef UNIT_TEST
#define DPRINT(x) do { \
    std::cout << x; \
  } while (0)
#define DPRINTLN(x) do { \
    std::cout << x << std::endl; \
  } while (0)
#else  // UNIT_TEST
void irDebugPrint(const char *str);
void irDebugPrint(const String &str);
void irDebugPrint(char c);
void irDebugPrint(uint64_t value);
void irDebugPrint(int64_t value);
template <typename T>
inline typename std::enable_if<std::is_integral<T>::value>::type
irDebugPrint(T value) {
  if (std::is_signed<T>::value)
    irDebugPrint(static_cast<int64_t>(value));
  else
    irDebugPrint(static_cast<uint64_t>(value));
}
#define DPRINT(x) do { \
    irDebugPrint(x); \
  } while (0)
#define DPRINTLN(x) do { \
    irDebugPrint(x); \
    irDebugPrint("\n"); \
  } while (0)
#endif  // UNIT_TEST
#else  // DEBUG
#define DPRINT(x)
#define DPRINTLN(x)
#endif  // DEBUG
 
#endif  // IRPLATFORM_H_