timer.hpp

Go to the documentation of this file.

/****************************************************************************
 *
 *  Copyright (c) 2017, Michael Becker (michael.f.becker@gmail.com)
 *
 *  This file is part of the FreeRTOS Add-ons project.
 *
 *  Source Code:
 *  https://github.com/michaelbecker/freertos-addons
 *
 *  Project Page:
 *  http://michaelbecker.github.io/freertos-addons/
 *
 *  On-line Documentation:
 *  http://michaelbecker.github.io/freertos-addons/docs/html/index.html
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a
 *  copy of this software and associated documentation files
 *  (the "Software"), to deal in the Software without restriction, including
 *  without limitation the rights to use, copy, modify, merge, publish,
 *  distribute, sublicense, and/or sell copies of the Software, and to
 *  permit persons to whom the Software is furnished to do so,subject to the
 *  following conditions:
 *
 *  + The above copyright notice and this permission notice shall be included
 *    in all copies or substantial portions of the Software.
 *  + Credit is appreciated, but not required, if you find this project
 *    useful enough to include in your application, product, device, etc.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 *  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 *  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 *  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 *  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 ***************************************************************************/


#ifndef TIMER_HPP_
#define TIMER_HPP_


#ifndef CPP_FREERTOS_NO_EXCEPTIONS
#include <exception>
#include <string>
#include <cstdio>
#ifdef CPP_FREERTOS_NO_CPP_STRINGS
#error "FreeRTOS-Addons require C++ Strings if you are using exceptions"
#endif
#endif
#include "FreeRTOS.h"
#include "timers.h"


namespace cpp_freertos {


#ifndef CPP_FREERTOS_NO_EXCEPTIONS

class TimerCreateException  : public std::exception {

    public:
        TimerCreateException()
        {
            sprintf(errorString, "Timer Constructor Failed");
        }

        virtual const char *what() const throw()
        {
            return errorString;
        }

    private:
        char errorString[40];
};
#endif


class Timer {

    //
    //  Public API
    //
    public:
        Timer(  const char * const TimerName,
                TickType_t PeriodInTicks,
                bool Periodic = true
                );

        Timer(  TickType_t PeriodInTicks,
                bool Periodic = true
                );

        virtual ~Timer();

        bool IsActive();

        bool Start(TickType_t CmdTimeout = portMAX_DELAY);

        bool StartFromISR(BaseType_t *pxHigherPriorityTaskWoken);

        bool Stop(TickType_t CmdTimeout = portMAX_DELAY);

        bool StopFromISR(BaseType_t *pxHigherPriorityTaskWoken);

        bool Reset(TickType_t CmdTimeout = portMAX_DELAY);

        bool ResetFromISR(BaseType_t *pxHigherPriorityTaskWoken);

        bool SetPeriod( TickType_t NewPeriod,
                        TickType_t CmdTimeout = portMAX_DELAY);

        bool SetPeriodFromISR(  TickType_t NewPeriod,
                                BaseType_t *pxHigherPriorityTaskWoken);

#if (INCLUDE_xTimerGetTimerDaemonTaskHandle == 1)

        static TaskHandle_t GetTimerDaemonHandle();
#endif

    //
    //  Protected API
    //  Available from inside your Thread implementation.
    //  You should make sure that you are only calling these methods
    //  from within your Run() method, or that your Run() method is on the
    //  callstack.
    //
    protected:
        virtual void Run() = 0;

    //
    //  Private API
    //  The internals of this wrapper class.
    //
    private:
        TimerHandle_t handle;

        static void TimerCallbackFunctionAdapter(TimerHandle_t xTimer);
};


}
#endif