IrReader.h

Go to the documentation of this file.

/*
Copyright (C) 2015 Bengt Martensson.
 
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version.
 
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
 
You should have received a copy of the GNU General Public License along with
this program. If not, see http://www.gnu.org/licenses/.
*/
 
#pragma once
 
#include <Arduino.h>
 
#include "InfraredTypes.h"
#include "IrSequence.h"
 
class IrReader {
public:
    // Defaults
    static constexpr milliseconds_t defaultBeginningTimeout = 2000U;
    static constexpr milliseconds_t defaultEndingTimeout = 30U;
    static constexpr size_t defaultCaptureLength = 100U;
 
protected:
    milliseconds_t beginningTimeout;
    milliseconds_t endingTimeout;
 
    size_t bufferSize;
 
    int16_t markExcess;
 
    bool timeouted;
 
    static unsigned int forceEven(unsigned int x) {
        return (x & 1) ? x + 1 : x;
    }
 
    IrReader(size_t bufSize_) : bufferSize(forceEven(bufSize_)),timeouted(false) {
    }
 
    IrReader() {
    }
 
#ifndef DOXYGEN
    IrReader(const IrReader&) = delete;
    IrReader(IrReader&&) = delete;
    IrReader& operator=(const IrReader&) = delete;
    IrReader& operator=(IrReader&&) = delete;
#endif // ! DOXYGEN
 
    virtual ~IrReader() {
    };
 
public:
    virtual void reset() {
        timeouted = false;
    };
 
    virtual frequency_t getFrequency() const = 0;
 
    virtual void enable() {
    };
 
    virtual void disable() {
    };
 
    virtual void receive() = 0;
 
    virtual bool isReady() const = 0;
 
    operator bool() const {
        return isReady();
    }
 
    virtual size_t getDataLength() const = 0;
 
    virtual microseconds_t getDuration(unsigned int index) const = 0;
 
    virtual void dump(Stream &stream) const;
 
    IrSequence *toIrSequence() const;
 
    virtual bool isEmpty() const {
        return getDataLength() == 0;
    }
 
    virtual void setEndingTimeout(milliseconds_t timeOut) {
        endingTimeout = timeOut;
    }
 
    virtual milliseconds_t getEndingTimeout() const {
        return endingTimeout;
    }
 
    virtual void setBeginningTimeout(milliseconds_t timeOut) {
        beginningTimeout = timeOut;
    }
 
    virtual milliseconds_t getBeginningTimeout() const {
        return beginningTimeout;
    }
 
    unsigned int getBufferSize() const {
        return bufferSize;
    }
 
    void setMarkExcess(int16_t markExcess_) {
        markExcess = markExcess_;
    }
 
    int16_t getMarkExcess() const {
        return markExcess;
    }
};