Meaning.h

Go to the documentation of this file.

#ifndef _MEANING_H_
#define _MEANING_H_
 
#include <vector>
#include <Arduino.h>
#include "config.h"
 
class Pulsetrain;
 
/// @brief Encodes type of modulation for a MeaningElement
typedef enum modulation {
    UNKNOWN,
    PULSE,
    GAP,
    PWM,
    PPM
} modulation;
 
/// @brief Chunks of parsed packet. Either a pulse, a gap or a block of decoded data 
typedef struct MeaningElement {
    modulation type;
    std::vector<uint8_t> data;
    uint16_t data_len;   // in bits
    uint16_t time1;
    uint16_t time2;
    uint16_t time3;
} MeaningElement;
 
/// @brief Holds the parsed packet as a collection of MeaningElements
class Meaning {
public:
    /// @brief The MeaningElement structs that make up the parsed packet
    std::vector<MeaningElement> elements;
    /// @brief Set when there were no repetitions and the number of bits detected is not divisible by 4
    bool suspected_incomplete = false;
    /// @brief Number of repeats of the signal
    uint16_t repeats = 0;
    /// @brief Shortest time between two repetitions
    uint16_t gap = 0;
 
    static bool maybe(String str);
    operator bool();
    void zap();
    bool fromPulsetrain(Pulsetrain &train);
    Pulsetrain toPulsetrain();
    bool addPulse(uint16_t pulse_time);
    bool addGap(uint16_t pulse_time);
    bool addPWM(int space, int mark, int bits, uint8_t* tmp_data);
    bool addPPM(int space, int mark, int filler, int bits, uint8_t* tmp_data);
    String toString();
    bool fromString(String in);
    int parsePWM(const Pulsetrain &train, int from, int to, int space, int mark);
    int parsePPM(const Pulsetrain &train, int from, int to, int space, int mark, int filler);
};
 
#endif