OneButton.h

// -----
// OneButton.h - Library for detecting button clicks, doubleclicks and long press pattern on a single button.
// This class is implemented for use with the Arduino environment.
// Copyright (c) by Matthias Hertel, http://www.mathertel.de
// This work is licensed under a BSD style license. See http://www.mathertel.de/License.aspx
// More information on: http://www.mathertel.de/Arduino
// -----
// 02.10.2010 created by Matthias Hertel
// 21.04.2011 transformed into a library
// 01.12.2011 include file changed to work with the Arduino 1.0 environment
// 23.03.2014 Enhanced long press functionalities by adding longPressStart and longPressStop callbacks
// 21.09.2015 A simple way for debounce detection added.
// 03.10.2015 Modifications by Ryan Tyler (tested with ESP8266):
//    - Add click pattern for detecting any variety of click/long press combination
//    - Add adjustable repeat time to LongPress
// -----

#ifndef OneButton_h
#define OneButton_h

#include "Arduino.h"

// ----- Callback function types -----

extern "C" {
  typedef void (*callbackFunction)(void);
}


class OneButton
{
public:
  // ----- Constructor -----
  OneButton(int pin, int active);
  
  // ----- Set runtime parameters -----

  // set # millisec after single click is assumed.
  void setClickTicks(int ticks);

  // set # millisec after press is assumed.
  void setPressTicks(int ticks);

  // attach functions that will be called when button was pressed in the specified way.
  void attachClick(callbackFunction newFunction);
  void attachDoubleClick(callbackFunction newFunction);
  void attachPress(callbackFunction newFunction); // DEPRECATED, replaced by longPressStart, longPressStop and duringLongPress
  void attachLongPressStart(callbackFunction newFunction);
  void attachLongPressStop(callbackFunction newFunction);
  void attachDuringLongPress(callbackFunction newFunction);
  void attachDuringLongPress(callbackFunction newFunction, int repeatTime);
  void attachPatternStart(callbackFunction newFunction);
  void attachPatternEnd(callbackFunction newFunction);

  // ----- State machine functions -----

  // call this function every some milliseconds for handling button events.
  void tick(void);
  
  bool isLongPressed();
  int getPatternLength();
  String getPattern();  // returns click pattern, C = click, L = long press
  
private:
  int _pin;        // hardware pin number. 
  int _timeoutTicks; // number of ticks that have to pass by before a click end is detected
  int _longPressTicks; // number of ticks that have to pass by before a long button press is detected
  int _longPressReTicks; // number of ticks that have to pass between long press callbacks
  const int _debounceTicks = 50; // number of ticks for debounce times.
  
  int _buttonReleased;
  int _buttonPressed;

  int _patternLength;
  String _pattern;

  bool _isLongPressed;

  // These variables will hold functions acting as event source.
  callbackFunction _clickFunc;
  callbackFunction _doubleClickFunc;
  callbackFunction _pressFunc;
  callbackFunction _longPressStartFunc;
  callbackFunction _longPressStopFunc;
  callbackFunction _duringLongPressFunc;
  callbackFunction _patternStartFunc;
  callbackFunction _patternEndFunc;

  // These variables that hold information across the upcoming tick calls.
  // They are initialized once on program start and are updated every time the tick function is called.
  int _state;
  unsigned long _startTime; // will be set in state 1
  unsigned long _releaseTime;
  unsigned long _longPressLastCall;
};

#endif