mirror of
https://github.com/ByteWelder/Tactility.git
synced 2026-02-18 19:03:16 +00:00
111 lines
2.5 KiB
C++
111 lines
2.5 KiB
C++
#pragma once
|
|
|
|
#include "CoreTypes.h"
|
|
|
|
#ifdef ESP_PLATFORM
|
|
#include "freertos/FreeRTOS.h"
|
|
#include "freertos/timers.h"
|
|
#else
|
|
#include "FreeRTOS.h"
|
|
#include "timers.h"
|
|
#endif
|
|
|
|
namespace tt {
|
|
|
|
|
|
class Timer {
|
|
private:
|
|
TimerHandle_t timerHandle;
|
|
public:
|
|
|
|
typedef void (*Callback)(void* context);
|
|
typedef void (*PendigCallback)(void* context, uint32_t arg);
|
|
|
|
|
|
Callback callback;
|
|
void* callbackContext;
|
|
|
|
typedef enum {
|
|
TypeOnce = 0, ///< One-shot timer.
|
|
TypePeriodic = 1 ///< Repeating timer.
|
|
} Type;
|
|
|
|
/**
|
|
* @param[in] type The timer type
|
|
* @param[in] callback The callback function
|
|
* @param callbackContext The callback context
|
|
*/
|
|
Timer(Type type, Callback callback, void* callbackContext);
|
|
|
|
~Timer();
|
|
|
|
/** Start timer
|
|
*
|
|
* @warning This is asynchronous call, real operation will happen as soon as
|
|
* timer service process this request.
|
|
*
|
|
* @param[in] ticks The interval in ticks
|
|
* @return The status.
|
|
*/
|
|
TtStatus start(uint32_t ticks);
|
|
|
|
/** Restart timer with previous timeout value
|
|
*
|
|
* @warning This is asynchronous call, real operation will happen as soon as
|
|
* timer service process this request.
|
|
*
|
|
* @param[in] ticks The interval in ticks
|
|
*
|
|
* @return The status.
|
|
*/
|
|
TtStatus restart(uint32_t ticks);
|
|
|
|
|
|
/** Stop timer
|
|
*
|
|
* @warning This is asynchronous call, real operation will happen as soon as
|
|
* timer service process this request.
|
|
*
|
|
* @return The status.
|
|
*/
|
|
TtStatus stop();
|
|
|
|
/** Is timer running
|
|
*
|
|
* @warning This cal may and will return obsolete timer state if timer
|
|
* commands are still in the queue. Please read FreeRTOS timer
|
|
* documentation first.
|
|
*
|
|
* @return true when running
|
|
*/
|
|
bool isRunning();
|
|
|
|
/** Get timer expire time
|
|
*
|
|
* @param instance The Timer instance
|
|
*
|
|
* @return expire tick
|
|
*/
|
|
uint32_t getExpireTime();
|
|
|
|
void pendingCallback(PendigCallback callback, void* callbackContext, uint32_t arg);
|
|
|
|
typedef enum {
|
|
TimerThreadPriorityNormal, /**< Lower then other threads */
|
|
TimerThreadPriorityElevated, /**< Same as other threads */
|
|
} TimerThreadPriority;
|
|
|
|
/** Set Timer thread priority
|
|
*
|
|
* @param[in] priority The priority
|
|
*/
|
|
void setThreadPriority(TimerThreadPriority priority);
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
} // namespace
|