freertos_timer.hpp

Go to the documentation of this file.

/*
 *     SocialLedge.com - Copyright (C) 2013
 *
 *     This file is part of free software framework for embedded processors.
 *     You can use it and/or distribute it as long as this copyright header
 *     remains unmodified.  The code is free for personal use and requires
 *     permission to use in a commercial product.
 *
 *      THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
 *      OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 *      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
 *      I SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
 *      CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 *     You can reach the author of this software at :
 *          p r e e t . w i k i @ g m a i l . c o m
 */

#ifndef TIMER_HPP_
#define TIMER_HPP_

#include "FreeRTOS.h"
#include "timers.h"
#include "task.h"



typedef TickType_t timeMs_t;

typedef enum { TimerOneShot, TimerPeriodic } TimerType;

class FreeRTOSTimer
{
    public:
        FreeRTOSTimer(TimerCallbackFunction_t pFunction, timeMs_t t, TimerType type=TimerPeriodic);
        ~FreeRTOSTimer(); 

        void start();                   
        void stop();                    
        void reset();                   
        void changePeriod(timeMs_t t);  
        bool isRunning();               

        void startFromISR();                    
        void stopFromISR();                     
        void resetFromISR();                    
        void changePeriodFromISR(timeMs_t t);    

        inline TimerHandle_t getTimerHandle() { return mTimerHandle; }

    private:
        TimerHandle_t mTimerHandle;
};

#endif /* TIMER_HPP_ */