TimerAlarmRepeatingDriverSTM32 Class Reference

STM32 Repeating Timer functions for repeated execution: Please use the typedef TimerAlarmRepeating. By default the TIM1 is used. More...

#include <AudioTimerSTM32.h>

Inheritance diagram for TimerAlarmRepeatingDriverSTM32:

Public Member Functions
	TimerAlarmRepeatingDriverSTM32 ()
	~TimerAlarmRepeatingDriverSTM32 ()
bool	begin (repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit=MS) override
void *	callbackParameter ()
bool	end () override
void	setCallbackParameter (void *obj)
virtual void	setIsSave (bool is_save)
	Not used.
void	setTimer (int timerIdx) override
	selects the timer: 0 = TIM1, 1 = TIM2,2 = TIM3, 3 = TIM4, 4 = TIM5
void	setTimer (TIM_TypeDef *timerDef)
	select the timer
virtual void	setTimerFunction (TimerFunction function=DirectTimerCallback)

Protected Member Functions
const char *	toString (TimeUnit unit)

Protected Attributes
void *	object = nullptr
HardwareTimer *	timer = nullptr
int	timer_index
TIM_TypeDef *	timers [6] = {TIM1, TIM2, TIM3, TIM4, TIM5}

Detailed Description

STM32 Repeating Timer functions for repeated execution: Please use the typedef TimerAlarmRepeating. By default the TIM1 is used.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

TimerAlarmRepeatingDriverSTM32()

TimerAlarmRepeatingDriverSTM32 ( )

inline

~TimerAlarmRepeatingDriverSTM32()

~TimerAlarmRepeatingDriverSTM32 ( )

inline

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

Reimplemented from TimerAlarmRepeatingDriverBase.

setCallbackParameter()

void setCallbackParameter ( void *  obj )

inlineinherited

setIsSave()

virtual void setIsSave ( bool  is_save )

inlinevirtualinherited

Not used.

setTimer() [1/2]

void setTimer ( int  timerIdx )

inlineoverridevirtual

selects the timer: 0 = TIM1, 1 = TIM2,2 = TIM3, 3 = TIM4, 4 = TIM5

Reimplemented from TimerAlarmRepeatingDriverBase.

setTimer() [2/2]

void setTimer ( TIM_TypeDef *  timerDef )

inline

select the timer

setTimerFunction()

virtual void setTimerFunction ( TimerFunction  function = DirectTimerCallback )

inlinevirtualinherited

toString()

const char * toString ( TimeUnit  unit )

inlineprotectedinherited

Member Data Documentation

object

void* object = nullptr

protectedinherited

timer

HardwareTimer* timer = nullptr

protected

timer_index

int timer_index

protected

timers

TIM_TypeDef* timers[6] = {TIM1, TIM2, TIM3, TIM4, TIM5}

protected

---

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

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