MillisMicrosTimer.hpp

Go to the documentation of this file.

#pragma once
 
#include <AH/Settings/Warnings.hpp>
AH_DIAGNOSTIC_WERROR() // Enable errors on warnings
 
AH_DIAGNOSTIC_EXTERNAL_HEADER()
#include <Arduino.h> // millis, micros
AH_DIAGNOSTIC_POP()
 
#include <AH/Settings/NamespaceSettings.hpp>
 
BEGIN_AH_NAMESPACE
 
/// A function type that returns a time value.
using timefunction = unsigned long (*)();
 
/// @addtogroup    AH_Timing
/// @{
 
/**
 * @brief   A class for easily managing timed events. A wrapper for "Blink 
 *          Without Delay".
 * 
 * @tparam time
 *         The time function to use.
 */
template <timefunction time = micros>
class Timer {
  public:
    /**
     * @brief   Constructor.
     * @param   interval
     *          The interval between two events.
     */
    Timer(unsigned long interval) : interval(interval) {
#ifdef ARDUINO
        begin();
#endif
    }
    /// Initialize the timer.
    void begin() { previous = time() - interval; }
    /// Update the timer and return true if the event should fire.
    explicit operator bool() {
        auto now = time();
        if (now - previous >= interval) {
            previous += interval;
            return true;
        }
        return false;
    }
 
  private:
    const unsigned long interval;
    unsigned long previous = 0;
};
 
/// @}
 
END_AH_NAMESPACE
 
AH_DIAGNOSTIC_POP()