Arduino-Timer

A basic and rough Timer library for the Arduino, extended from Daniel Shiffman's O-o timer for Processing found in: Learning Processing, Example 10.5

Installation

• Download a copy of the current library
• Navigate to Documents/Arduino/libraries
• Unpack the library there
• Open the Arduino IDE and #include <timer.h>;

What it is for

This is a very basic and rough library for looping and non-looping timers. It is useful for triggering a function every n milliseconds, or reading values out of a sensor. There are lots of good timer libraries for the Arduino. I wrote this one to have a simple start/stop interface for quick setups with sensors.

Usage

Reading values out of pin 4 every 100ms

#include <timer.h>
#define BUTTON_PIN 4

Timer timer;

void setup() {
  Serial.begin( 9600 );
  pinMode( BUTTON_PIN, INPUT );
  timer.start( 100, true );
}

void loop() {
  timer.isFinished( printVal );
}

void printVal() {
    int val = digitalRead( BUTTON_PIN );
    Serial.println( val );
}

Longer version

#include <timer.h>
#define BUTTON_PIN 4

Timer timer;

void setup() {
  Serial.begin( 9600 );
  pinMode( BUTTON_PIN, INPUT );
  timer.setDuration( 100 );
  timer.setLoop( true );
  timer.start();
}

void loop() {
  if ( timer.isFinished() ) {
    int val = digitalRead( BUTTON_PIN );
    Serial.println( val );
  }
}

Overview

void setDuration( int )

To set the duration of a timer cycle in milliseconds (default: 1000ms)

int getDuration()

To get the duration of a timer cycle in milliseconds

void setLoop( bool )

To set if the timer must loop or not

bool isLoop()

To get if the timer is looping or not

bool isActive()

To get if the timer is currently running

void start()

To start the timer

void start( int, bool )

Convenience method to start the timer with a duration and loop flag

void stop()

To stop the timer

int checkTime()

To check how much time has passed since the start of the timer. If the timer loop is complete, returns -1

bool isFinished()

To check if this cycle is finished

bool isFinished( void(*)() )

Convenience method with callback