M5Timer.h

Go to the documentation of this file.

// Copyright (c) M5Stack. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
#ifndef __M5_Timer_H__
#define __M5_Timer_H__
 
#include <functional>
#include <stdint.h>
#include <stddef.h>
 
typedef std::function<void(void)> timer_callback;
 
class M5Timer {
   public:
    static constexpr const uint32_t MAX_TIMERS = 10;
 
    M5Timer(void);
 
    void run(void);
 
    int_fast8_t setTimer(uint32_t interval_msec, timer_callback function, uint32_t times);
 
    inline int_fast8_t setInterval(uint32_t interval_msec, timer_callback function) {
        return setTimer(interval_msec, function, 0);
    }
 
    inline int_fast8_t setTimeout(uint32_t interval_msec, timer_callback function) {
        return setTimer(interval_msec, function, 1);
    }
 
    void deleteTimer(int_fast8_t id);
 
    void restartTimer(int_fast8_t id);
 
    void enable(int_fast8_t id) {
        if ((uint_fast8_t)id < MAX_TIMERS) {
            _timer_info[id].setEnabled(true);
        }
    }
 
    void disable(int_fast8_t id) {
        if ((uint_fast8_t)id < MAX_TIMERS) {
            _timer_info[id].setEnabled(false);
        }
    }
 
    void toggle(int_fast8_t id) {
        if ((uint_fast8_t)id < MAX_TIMERS) {
            _timer_info[id].toggle();
        }
    }
 
    bool isEnabled(int_fast8_t id) const {
        return ((uint_fast8_t)id < MAX_TIMERS) ? _timer_info[id].getEnabled() : false;
    }
 
    uint_fast8_t getNumTimers(void) const {
        return _enable_count;
    }
 
    uint_fast8_t getNumAvailableTimers(void) const {
        return MAX_TIMERS - _enable_count;
    }
 
   private:
 
    class timer_info_t {
    public:
        void set(uint32_t interval_msec, timer_callback function, uint32_t times);
        bool run(uint32_t interval_msec);
        void clear(void);
 
        inline timer_callback getCallback(void) const { return _callback; }
        inline bool getEnabled(void) const { return _enabled; }
        inline void setEnabled(bool flg) { _enabled = flg; }
        inline void toggle(void) { _enabled = !_enabled; }
        inline void setPreviousMsec(uint32_t msec) { _prev_msec = msec; }
 
    private:
        timer_callback _callback = nullptr;
        uint32_t _prev_msec = 0;
        uint32_t _interval = 0;
        uint32_t _remain = 0;
        bool _enabled = false;
    };
 
    timer_info_t _timer_info[MAX_TIMERS];
 
    uint8_t _enable_count = 0;
};
 
#endif