Pronto.h

Go to the documentation of this file.

#pragma once

#include "InfraredTypes.h"
#include "IrSignal.h"

class Pronto {
private:
    typedef uint16_t prontoInt;

    static const prontoInt learnedToken = 0x0000;
    static const prontoInt learnedNonModulatedToken = 0x0100;
    static const unsigned int bitsInHexadecimal = 4;
    static const unsigned int digitsInProntoNumber = 4;
    static const unsigned int numbersInPreamble = 4;
    static const unsigned int hexMask = 0xF;
    static const unsigned int charsInPreamble = numbersInPreamble * (digitsInProntoNumber + 1);
    static constexpr double prontoFreqConst = 0.241246;
    static const uint32_t prontoConst = (uint32_t) (1E6 / prontoFreqConst); // 4145146
    static const prontoInt fallbackFrequencyCode = 0x0040; // To use with frequency = 0;
    static const frequency_t fallbackFrequency = 64767; // To use with frequency = 0;

    Pronto() {};

    static IrSequence *mkSequence(const uint16_t *data, size_t pairs, double timebase);

    static frequency_t toFrequency(prontoInt code);

    static prontoInt toFrequencyCode(frequency_t frequency);

    static size_t lengthHexString(size_t introLength, size_t repeatLength);

    static char* setup(frequency_t frequency, size_t introLength, size_t repeatLength);

    static char hexDigit(unsigned int x);

    static unsigned int appendChar(char *result, unsigned int index, char ch);

    static unsigned int appendDuration(char *result, unsigned int index, microseconds_t duration, frequency_t frequency);

    static unsigned int appendDigit(char *result, unsigned int index, unsigned int number);

    static unsigned int appendNumber(char *result, unsigned int index, prontoInt number);

    static unsigned int appendSequence(char *result, unsigned int index, const microseconds_t *data, size_t length, frequency_t frequency);

    static unsigned int appendSequence(char *result, unsigned int index, const IrSequence& irSequence, frequency_t frequency);

public:
    static IrSignal *parse(const uint16_t *data, size_t size);

    static IrSignal *parse(const char *str);

#if defined(ARDUINO) & defined(ARDUINO_ARCH_AVR)

    static IrSignal *parse(const __FlashStringHelper *str);
#endif

    static char* toProntoHex(const IrSignal& irSignal);

    static char* toProntoHex(const microseconds_t* data, size_t length, frequency_t frequency = IrSignal::defaultFrequency);

    static char* toProntoHex(const IrSequence& irSequence, frequency_t frequency = IrSignal::defaultFrequency);
};