IrReceiverSampler.h

Go to the documentation of this file.

#ifndef IRRECEIVERSAMPLE_H
#define IRRECEIVERSAMPLE_H

#include "IrReceiver.h"

// The interrupt routine must have access to some stuff here.
// This needs to be public, and, since the interrupt routing
// fumbles with it, volatile.
class IrReceiverSampler : public IrReceiver {
public:

    static const unsigned long microsPerTick = 50; // was USECPERTICK

    enum ReceiverState_t {
        STATE_IDLE, 
        STATE_MARK, 
        STATE_SPACE, 
        STATE_STOP  
    };

    volatile ReceiverState_t receiverState; // previously rcvstate;

    // Note: use the following ones instead of beginningTimeout and endingTimeout
    // inherited from IrReader.
    uint32_t endingTimeoutInTicks; // previously GAP_TICKS

    uint32_t beginningTimeoutInTicks; // previously TIMEOUT_TICKS;

    volatile uint32_t timer;

    volatile microseconds_t *durationData; // previously rawbuf;

    volatile size_t dataLength; // previously rawlen

private:
    static IrReceiverSampler *instance;
    static uint32_t millisecs2ticks(milliseconds_t ms);
    static milliseconds_t ticks2millisecs(uint32_t tix);

protected:
    virtual ~IrReceiverSampler();

private:
    IrReceiverSampler(size_t captureLength = defaultCaptureLength,
            pin_t pin = defaultPin,
            boolean pullup = false,
            microseconds_t markExcess = defaultMarkExcess,
            milliseconds_t beginningTimeout = defaultBeginningTimeout,
            milliseconds_t endingTimeout = defaultEndingTimeout);

public:
    static IrReceiverSampler *newIrReceiverSampler(size_t captureLength = defaultCaptureLength,
            pin_t pin = defaultPin,
            boolean pullup = false,
            microseconds_t markExcess = defaultMarkExcess,
            milliseconds_t beginningTimeout = defaultBeginningTimeout,
            milliseconds_t endingTimeout = defaultEndingTimeout);

    static void deleteInstance();

    static IrReceiverSampler *getInstance() {
        return instance;
    }

    void enable();

    void disable();

    void reset();

    void setEndingTimeout(milliseconds_t timeOut);

    milliseconds_t getEndingTimeout() const;

    void setBeginningTimeout(milliseconds_t timeOut);

    milliseconds_t getBeginningTimeout() const;

    size_t getDataLength() const {
        return dataLength;
    }

    microseconds_t getDuration(unsigned int i) const {
        return (microseconds_t) (microsPerTick * durationData[i] + (i & 1 ? markExcess : -markExcess));
    }

    boolean isReady() const {
        return receiverState == STATE_STOP;
    }
};

#endif  /* IRRECEIVERSAMPLE_H */