Switch library

Arduino library for debouncing switches and buttons

Arduino library for debouncing switches and buttons - Arduino library for debouncing switches and buttons

Switches and push buttons need debouncing. It is straightforward to do this with software, using a library. The advantages of the Switch library are:

  • External pull-up resistors are not required.
  • Supports also long press and double clicks.
  • Performs not just de-bouncing, but also de-glitching against EMC pulses.

Questions

Post questions on the Arduino board and let me know, I will reply there.
Arduino forum

New: software deglitch

Normally, just debouncing is used. But debouncing doesn't make the software insensitive to noise pulses, which could lead to dangerous situations: if there is a poll() at the moment of a noise pulse, the software can detect an activated switch. To prevent this, a deglitch function is added now: during a "deglitchPeriod", all input values have to be equal.

Connecting switches to the Arduino

There is nothing needed beyond the switches, just connect the switches between the ground and a digital pin:

Switch between GND and digital pin

This is technically speaking the best solution and is taken by the library as default. An external pull-up resistor is not needed but allowed.

Switch between 5V and digital pin

For switches connected to the Arduino power supply, the settings are: polarity = HIGH and pinmode = INPUT, which disables the internal pull-up resistor. Note that we need external pull-down resistors of about 10k here.

Using the Switch library

All switched have to be polled individually to update the status. Each switch-status has its own get function:

  • pushed()
    Use only for push buttons. It returns "true" if a button was pushed after the poll() instruction was executed.
  • released()
    It returns "true" if a push button was released, this will however rarely be used.
  • on()
    Use only for toggle switches. It returns "true" as long as the switch is in the "on" position. The polarity of the switch in the "on" position has to be filled in correctly. There is no off() function, this is simply !on().
  • longPress()
    It returns "true" if a push button is pressed longer than 300ms.
  • doubleClick()
    It returns "true" if a push button is double clicked within 250ms.
#if ARDUINO >= 100 
  #include "Arduino.h"
#else
  #include "WProgram.h"
#endif
 
#include <Streaming.h>
#include "Switch.h"
 
const byte toggleSwitchpin = 3; // (right button)
const byte buttonGNDpin = 4; // (left button)
const byte ButtonVCCpin = 6; 
const byte Button10mspin = 8; 
int i;
 
Switch buttonGND = Switch(buttonGNDpin); // button to GND, use internal 20K pullup resistor
Switch toggleSwitch = Switch(toggleSwitchpin); 
Switch buttonVCC = Switch(ButtonVCCpin, INPUT, HIGH); // button to VCC, 10k pull-down resistor, no internal pull-up resistor, HIGH polarity
Switch button10ms = Switch(Button10mspin, INPUT_PULLUP, LOW, 1); // debounceTime 1ms
 
void setup() 
{ Serial.begin(9600);  
}
 
void loop() 
{ buttonGND.poll();  
  if(buttonGND.switched()) Serial << "switched ";   
  if(buttonGND.pushed()) Serial << "pushed " << ++i << " ";
  if(buttonGND.released()) Serial << "released\n";
  
  if(toggleSwitch.poll()) Serial << toggleSwitch.on() << endl; 
  if(toggleSwitch.longPress()) Serial << "longPress1 ";
  if(toggleSwitch.longPress()) Serial << "longPress2\n";
  if(toggleSwitch.doubleClick()) Serial << "doubleClick1 ";
  if(toggleSwitch.doubleClick()) Serial << "doubleClick2\n";
}

Notes

  • The poll instruction must be called at least 50 times per second, it takes about 20us.
  • The button states are saved till the next poll. Then all previous button states will be cleared, so the buttons must be read every poll interval.
  • Reading a button several times within a poll interval gives the same value, so reading doesn't clear the button state.

How to use successive button events

With the Switch library, you can use all button events at the same time with the same button. For example pushed(), released(), doubleClick() and longPress(). To see how several button events can be used together, run Windows Explorer: a single click selects a file and a double click opens it.

Button pushed event followed by a longPress event

A long-press generates first a pushed event and after 300ms the longPress event. This is not a shortcoming but a logical consequence. We can, of course, not always wait 300ms to see if a push might be a long push.

Button pushed event followed by a doubleClick event

The same happens with doubleClick, which also generates two pushed() events. When doubleClick is used, ignore the second pushed() result or don't call pushed(). When doubleClick is not needed, simply don't call doubleClick().

Software debounce, how does it work

Very poor switch contact bounce measured with Arduino oscilloscope

Very poor switch contact bounce measured with Arduino oscilloscope - Very poor switch contact bounce measured with Arduino oscilloscope

The software debounce algorithm is based on the following assumptions; the 50ms is the so-called debounce delay:

  • The switch bounce time is less than 50ms.
  • The time between successive keystrokes is larger than 50ms.
  • A reaction time of 50ms is acceptable.

If the above assumptions are met, the software debounce algorithm can be quite simple: a switch event is only accepted when the elapsed time since the last switch event is larger than the debounce delay.

A debounce delay of 50ms is a safe value; it doesn't hurt the reaction time, and will handle even bad switches. 

if((newlevel != level) & (millis() - _switchedTime >= debounceDelay))

Switch library

Copy the code below into a Switch.cpp and Switch.h file and place the two files into an Arduino library folder like this: \libraries\Switch. The debounce timing diagram is included in the Switch.cpp file.  

/*
Switch.cpp
Copyright (C) 2012  Albert van Dalen http://www.avdweb.nl
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License at http://www.gnu.org/licenses .

Version 20-4-2013
_debouncePeriod=50
Version 22-5-2013
Added longPress, doubleClick 
Version 1-12-2015
added process(input)
Version 15-1-2016 
added deglitching

..........................................DEGLITCHING..............................
                                          
                        ________________   _
               on      |                | | |    _                         
                       |                | | |   | |                                       
                       |                |_| |___| |__                                                            
 analog        off_____|_____________________________|____________________________   
                  
                        ________________   _     _
 input            _____|                |_| |___| |_______________________________                
           
 poll            ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^    

 equal           0 1 1 0 1 1 1 1 1 1 1 1 0 0 0 1 0 0 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

 deglitchPeriod          <--------><--   <--     <-  <--------><--------><--------
                                    ___________________________
 deglitched       _________________|                           |__________________ 

 deglitchTime            ^         ^     ^       ^   ^         ^        ^

 ..........................................DEBOUNCING.............................

 debouncePeriod                    <-------------------------------->     
                                    _________________________________
 debounced        _________________|                                 |____________   
                                    _                                 _
 _switched        _________________| |_______________________________| |__________        
                                                    
 switchedTime                      ^                                 ^  
 

**********************************************************************************
........................................DOUBLE CLICK..............................
                                        
                           __________         ______                            
 debounced        ________|          |_______|      |_____________________________   

 poll            ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^           
                           _                  _
 pushed          _________| |________________| |__________________________________        
                                                    
 pushedTime               ^                  ^  

 doubleClickPeriod         <------------------------------------->                      
                                              _
 _doubleClick     ___________________________| |__________________________________

                            
........................................LONG PRESS................................
                                         
                           ___________________________                                      
 debounced        ________|                           |___________________________         

 poll            ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^              
        
 longPressPeriod            <--------------->          
                            _                           _
 _switched        _________| |_________________________| |________________________        
                                              __________
 longPressDisable ___________________________|          |_________________________                                   
                                              _
 _longPress       ___________________________| |__________________________________         
 
*/

#include "Arduino.h"
#include "Switch.h"
              
Switch::Switch(byte _pin, byte PinMode, bool polarity, int debouncePeriod, int longPressPeriod, int doubleClickPeriod, int deglitchPeriod): 
pin(_pin), polarity(polarity), deglitchPeriod(deglitchPeriod), debouncePeriod(debouncePeriod), longPressPeriod(longPressPeriod), doubleClickPeriod(doubleClickPeriod) 
{ pinMode(pin, PinMode); 
  switchedTime = millis();
  debounced = digitalRead(pin);
}
 
bool Switch::poll()
{ input = digitalRead(pin);
  return process();
} 

bool Switch::process()
{ deglitch(); 
  debounce();
  calcDoubleClick();
  calcLongPress();
  return _switched;	
}

void inline Switch::deglitch()
{ ms = millis();
  if(input == lastInput) equal = 1;
  else
  { equal = 0;
    deglitchTime = ms;
  }
  if(equal & ((ms - deglitchTime) > deglitchPeriod)) // max 50ms, disable deglitch: 0ms
  { deglitched = input; 
    deglitchTime = ms;
  }
  lastInput = input;  
}

void inline Switch::debounce()
{ ms = millis();
  _switched = 0;
  if((deglitched != debounced) & ((ms - switchedTime) >= debouncePeriod)) 
  { switchedTime = ms;
    debounced = deglitched;
    _switched = 1;
    longPressDisable = false; 
  }
}

void inline Switch::calcDoubleClick()
{ _doubleClick = false;
  if(pushed())
  { _doubleClick = (ms - pushedTime) < doubleClickPeriod; // pushedTime of previous push
    pushedTime = ms; 
  } 
}

void inline Switch::calcLongPress()
{ _longPress = false;
  if(!longPressDisable)
  { _longPress = on() && ((ms - pushedTime) > longPressPeriod); // true just one time between polls
    longPressDisable = _longPress; // will be reset at next switch   
  }  
}

bool Switch::switched()
{ return _switched;
}

bool Switch::on()
{ return !(debounced^polarity);
}

bool Switch::pushed() 
{ return _switched && !(debounced^polarity); 
} 

bool Switch::released() 
{ return _switched && (debounced^polarity); 
} 

bool Switch::longPress() 
{ return _longPress;
} 

bool Switch::doubleClick() 
{ return _doubleClick;
} 

 

/* 
Switch.h
Copyright (C) 2012  Albert van Dalen http://www.avdweb.nl
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License at http://www.gnu.org/licenses .
*/

#ifndef SWITCH_H
#define SWITCH_H

class Switch
{
public:	
  Switch(byte _pin, byte PinMode=INPUT_PULLUP, bool polarity=LOW, int debouncePeriod=50, int longPressPeriod=300, int doubleClickPeriod=250, int deglitchPeriod=10);
  bool poll(); // Returns 1 if switched   
  bool switched(); // will be refreshed by poll()
  bool on(); 
  bool pushed(); // will be refreshed by poll()
  bool released(); // will be refreshed by poll()
  bool longPress(); // will be refreshed by poll()
  bool doubleClick(); // will be refreshed by poll()

  protected: 
  bool process(); // not inline, used in child class
  void inline deglitch();
  void inline debounce();
  void inline calcDoubleClick();
  void inline calcLongPress();

  unsigned long deglitchTime, switchedTime, pushedTime, ms;
  const byte pin; 
  const int deglitchPeriod, debouncePeriod, longPressPeriod, doubleClickPeriod;
  const bool polarity;
  bool input, lastInput, equal, deglitched, debounced, _switched, _longPress, longPressDisable, _doubleClick; 
};

#endif

Using an interrupt service routine for polling the buttons

Polling buttons has a high priority, slow functions such as Serial.print() may disrupt the timing. See here how to use an ISR for polling the buttons:

#include <Arduino.h>
#include "Switch.h"
#include <FrequencyTimer2.h>
 
Switch speedUpBtn(1);
Switch speedDownBtn(2);
Switch buttonLeft(3);
Switch buttonRight(4);
 
void setup(void) 
{ Serial.begin(9600);
  FrequencyTimer2::setPeriod(1000);
  FrequencyTimer2::setOnOverflow(timer2ISR);
}
 
void loop(void) 
{ printAll(); // run slow functions in loop()
}
 
void timer2ISR() 
{ pollAll(); // polling buttons has priority
  buttonActions();
}

Do you have any comments? Please let me know.
Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.