TimerAlarmRepeatingDriverESP32 Class Reference

Repeating Timer functions for simple scheduling of repeated execution using esp_timer_create() More...

#include <AudioTimerESP32.h>

Inheritance diagram for TimerAlarmRepeatingDriverESP32:

Public Member Functions
virtual	~TimerAlarmRepeatingDriverESP32 ()
bool	begin (repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit=MS) override
	Starts the alarm timer.
void *	callbackParameter ()
bool	end () override
	ends the timer and if necessary the task
void	setCallbackParameter (void *obj)
void	setIsSave (bool is_save) override
	Not used.
virtual void	setTimer (int timer)
void	setTimerFunction (TimerFunction function) override

Protected Member Functions
const char *	toString (TimeUnit unit)

Protected Attributes
bool	initialized = false
void *	object = nullptr
esp_timer_handle_t	rtsp_timer = nullptr
bool	started = false
uint64_t	time_us = 0
TimerFunction	timer_function = TimerCallbackInThread

Detailed Description

Repeating Timer functions for simple scheduling of repeated execution using esp_timer_create()

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

~TimerAlarmRepeatingDriverESP32()

virtual ~TimerAlarmRepeatingDriverESP32 ( )

inlinevirtual

Member Function Documentation

begin()

bool begin ( repeating_timer_callback_t  callback_f, uint32_t  time, TimeUnit  unit = MS  )

inlineoverridevirtual

Starts the alarm timer.

Implements TimerAlarmRepeatingDriverBase.

callbackParameter()

void * callbackParameter ( )

inlineinherited

end()

bool end ( )

inlineoverridevirtual

ends the timer and if necessary the task

Reimplemented from TimerAlarmRepeatingDriverBase.

setCallbackParameter()

void setCallbackParameter ( void *  obj )

inlineinherited

setIsSave()

void setIsSave ( bool  is_save )

inlineoverridevirtual

Not used.

Reimplemented from TimerAlarmRepeatingDriverBase.

setTimer()

virtual void setTimer ( int  timer )

inlinevirtualinherited

Reimplemented in TimerAlarmRepeatingDriverRenesas, and TimerAlarmRepeatingDriverSTM32.

setTimerFunction()

void setTimerFunction ( TimerFunction  function )

inlineoverridevirtual

Reimplemented from TimerAlarmRepeatingDriverBase.

toString()

const char * toString ( TimeUnit  unit )

inlineprotectedinherited

Member Data Documentation

initialized

bool initialized = false

protected

object

void* object = nullptr

protectedinherited

rtsp_timer

esp_timer_handle_t rtsp_timer = nullptr

protected

started

bool started = false

protected

time_us

uint64_t time_us = 0

protected

timer_function

TimerFunction timer_function = TimerCallbackInThread

protected

---

The documentation for this class was generated from the following file:

• src/AudioTools/CoreAudio/AudioTimer/AudioTimerESP32.h