/uTimerLib

Arduino tiny and cross-device compatible timer library

Primary LanguageC++GNU Lesser General Public License v3.0LGPL-3.0

Arduino tiny and cross-device compatible timer library - uTimerLib

What is this repository for?

Tiny and cross-device compatible timer-driven timed function calls library.

Supports Arduino AVR, SAM, STM32, ESP8266 and SAMD21 microcontrollers.

Current status

While being in 0.X.Y version, library is still in development.

Currently suported architectures:

  • AVR
  • STM32
  • SAM (Arduino Due)
  • ESP8266
  • SAMD21 (Arduino Zero and Zero MKR, experimental)

Device timer usage

Depending on wich architecture this library uses one or another device timer. Take in mind this because can caause conflicts with other libraries:

  • AVR: Timer2 (3rd timer)
  • STM32: Timer3 (3rd timer)
  • SAM: TC3 (Timer1, channel 0)
  • ESP8266: Ticker library (inside ESP8266 core, no extras needed)
  • SAMD21: Timer2 (3rd timer)

Usage

This library defines a global variable when included called "TimerLib".

You have these 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.

It only manages one function at a time, if you call any setXXX method it will cancel any running timed function and process new one.

An attached functions broker could be implemented, but then this would not be (micro)TimerLib. Maybe in other project.....

How do I get set up?

You can get it from Arduino libraries directly, searching by uTimerLib.

For manual installation:

Examples

Included on example folder, available on Arduino IDE.

Who do I talk to?