Bounce2.h

/*
  The MIT License (MIT)
 
  Copyright (c) 2013 thomasfredericks
 
  Permission is hereby granted, free of charge, to any person obtaining a copy of
  this software and associated documentation files (the "Software"), to deal in
  the Software without restriction, including without limitation the rights to
  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
  the Software, and to permit persons to whom the Software is furnished to do so,
  subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
 
/* * * * * * * * * * * * * * * * * * * * * * * * * * * *
  Main code by Thomas O Fredericks (tof@t-o-f.info)
  Previous contributions by Eric Lowry, Jim Schimpf and Tom Harkaway
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
 
#ifndef Bounce2_h
#define Bounce2_h
 
#if defined(ARDUINO) && ARDUINO >= 100
#include "Arduino.h"
#else
#include "WProgram.h"
#endif
 
// Uncomment the following line for "LOCK-OUT" debounce method
//#define BOUNCE_LOCK_OUT
 
// Uncomment the following line for "BOUNCE_WITH_PROMPT_DETECTION" debounce method
//#define BOUNCE_WITH_PROMPT_DETECTION
 
#include <inttypes.h>
 
class Debouncer
{
 // Note : this is private as it migh change in the futur
private:
  static const uint8_t DEBOUNCED_STATE = 0b00000001; // Final returned calculated debounced state
  static const uint8_t UNSTABLE_STATE  = 0b00000010; // Actual last state value behind the scene
  static const uint8_t CHANGED_STATE   = 0b00000100; // The DEBOUNCED_STATE has changed since last update()
 
// Note : this is private as it migh change in the futur
private:
  inline void changeState();
  inline void setStateFlag(const uint8_t flag)       {state |= flag;}
  inline void unsetStateFlag(const uint8_t flag)     {state &= ~flag;}
  inline void toggleStateFlag(const uint8_t flag)    {state ^= flag;}
  inline bool getStateFlag(const uint8_t flag) const {return((state & flag) != 0);}
 
public:
    Debouncer();
 
    void interval(uint16_t interval_millis);
 
    bool update();
 
    bool read() const;
 
    bool fell() const;
 
    bool rose() const;
 
 
 
public:
  bool changed( ) const { return getStateFlag(CHANGED_STATE); }
  
  
  
 
  unsigned long currentDuration() const;
 
 
  unsigned long previousDuration() const;
  
    [[deprecated]]
    unsigned long duration() {
        return currentDuration();
    };
 
protected:
  void begin();
  virtual bool readCurrentState() =0;
  unsigned long previous_millis;
  uint16_t interval_millis;
  uint8_t state;
  unsigned long stateChangeLastTime;
  unsigned long durationOfPreviousState;
 
};
 
 
class Bounce : public Debouncer
{
 
 
public:
 
    Bounce();
 
 
    void attach(int pin, int mode);
 
    void attach(int pin);
 
  Bounce(uint8_t pin, unsigned long interval_millis ) : Bounce() {
    attach(pin);
    interval(interval_millis);
  }
 
 
  inline int getPin() const {
      return this->pin;
  };
 
  // Deprecated //
 
    [[deprecated]]
    bool risingEdge() const { return rose(); }
    [[deprecated]]
    bool fallingEdge() const { return fell(); }
protected:
 
 
    uint8_t pin;
 
    virtual bool readCurrentState() { return digitalRead(pin); }
    virtual void setPinMode(int pin, int mode) {
#if defined(ARDUINO_ARCH_STM32F1)
        pinMode(pin, (WiringPinMode)mode);
#else
        pinMode(pin, mode);
#endif
    }
 
 
 
};
 
namespace Bounce2 {
   // code declarations
 
class Button : public Bounce{
protected:
    bool stateForPressed = 1; // 
  public:
   Button(){ }
 
   void setPressedState(bool state){
    stateForPressed = state;
  }
 
  inline bool getPressedState() const {
    return stateForPressed;
  };
 
  inline bool isPressed() const {
    return read() == getPressedState();
  };
 
  inline bool pressed() const {
    return changed() && isPressed();
  };
 
  inline bool released() const {
    return  changed() && !isPressed();
  };
 
};
};
 
#endif