uTimerLib Class Reference

Arduino tiny and cross-device compatible timer library. More...

Public Member Functions
	uTimerLib ()
	Constructor.
void	setInterval_us (void(*)(), unsigned long int)
	Attaches a callback function to be executed each us microseconds. More...
void	setInterval_s (void(*)(), unsigned long int)
	Attaches a callback function to be executed each s seconds. More...
void	setTimeout_us (void(*)(), unsigned long int)
	Attaches a callback function to be executed once when us microseconds have passed. More...
void	setTimeout_s (void(*)(), unsigned long int)
	Attaches a callback function to be executed once when s seconds have passed. More...
void	clearTimer ()
	Loads last bit of time needed to precisely count until desired time (non complete loop) More...
void	_interrupt ()
	Internal intermediate function to control timer interrupts. More...

Detailed Description

Arduino tiny and cross-device compatible timer library.

Timers used by each microcontroller:

• Atmel ATtiny: Timer1 (2nd timer) - https://github.com/damellis/attiny and https://github.com/SpenceKonde/Disgispark AVRCore (25, 45 and 85)
• DisgiSpark AVR: Timer0 (1st timer) - https://github.com/digistump/DigistumpArduino
• Atmel AVR 32U4: Timer3 (4rd timer)
• Atmel AVR other: Timer2 (3rd timer)
• STM32: Timer3 (3rd timer)
• SAM (Due): TC3 (Timer1, channel 0)
• ESP8266: OS Timer, one slot of seven available (Software timer provided by Arduino because ESP8266 has only two hardware timers and one is needed by it normal operation)
• ESP32: OS Hardware Timer.
• SAMD21: Timer 4, CC0 (TC3). See http://ww1.microchip.com/downloads/en/DeviceDoc/40001882A.pdf
• SAMD51: Timer 2 (TC1), 16 bits mode (See http://ww1.microchip.com/downloads/en/DeviceDoc/60001507C.pdf

You have public TimerLib variable with following methods:

• TimerLib.setInterval_us(callback_function, microseconds);* : callback_function will be called each microseconds.
• TimerLib.setInterval_s(callback_function, seconds);* : callback_function will be called each seconds.
• TimerLib.setTimeout_us(callback_function, microseconds);* : callback_function will be called once when microseconds have passed.
• TimerLib.setTimeout_s(callback_function, seconds);* : callback_function will be called once when seconds have passed.
• TimerLib.clearTimer();* : will clear any timed function if exists.

Member Function Documentation

_interrupt()

void uTimerLib::_interrupt

(

)

Internal intermediate function to control timer interrupts.

As timers doesn't give us enougth flexibility for large timings, this function implements oferflow control to offer user desired timings.

clearTimer()

void uTimerLib::clearTimer

(

)

Loads last bit of time needed to precisely count until desired time (non complete loop)

Note: This is device-dependant

setInterval_s()

void uTimerLib::setInterval_s	(	void(*)()	cb,
		unsigned long int	s
	)

Attaches a callback function to be executed each s seconds.

Parameters

cb	Callback function to be called
s	Interval in seconds

setInterval_us()

void uTimerLib::setInterval_us	(	void(*)()	cb,
		unsigned long int	us
	)

Attaches a callback function to be executed each us microseconds.

Parameters

cb	Callback function to be called
us	Interval in microseconds

setTimeout_s()

void uTimerLib::setTimeout_s	(	void(*)()	cb,
		unsigned long int	s
	)

Attaches a callback function to be executed once when s seconds have passed.

Parameters

cb	Callback function to be called
s	Timeout in seconds

setTimeout_us()

void uTimerLib::setTimeout_us	(	void(*)()	cb,
		unsigned long int	us
	)

Attaches a callback function to be executed once when us microseconds have passed.

Parameters

cb	Callback function to be called
us	Timeout in microseconds

---

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

• uTimerLib.h
• uTimerLib.cpp