vail-adapter/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
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/**
 * @todo Make Bounce2 more abstract. Split it from the hardware layer.
 * @body Remove deboucing code from Bounce2 and make a new Debounce class from that code. 
 * Bounce2 should extend Debounce. 
 */


#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>

/**
    @example bounce.ino
    Simple example of the Bounce library that switches the debug LED when a button is pressed.
*/

/**
    @example change.ino
    This example toggles the debug LED (pin 13) on or off when a button on pin 2 is pressed.
*/

/**
    @example bounce_multiple.ino
    Detect the falling edge of multiple buttons. Eight buttons with internal pullups. Toggles a 
    LED when any button is pressed. Buttons on pins 2,3,4,5,6,7,8,9
*/

/**
    @example bounce2buttons.ino
     Example of two instances of the Bounce class that switches the debug LED when either one of 
     the two buttons is pressed.
 */

static const uint8_t DEBOUNCED_STATE = 0b00000001;
static const uint8_t UNSTABLE_STATE  = 0b00000010;
static const uint8_t CHANGED_STATE   = 0b00000100;

/**
     The Bounce class.
     */
class Bounce
{
 public:

/*!
    @brief  Create an instance of the Bounce class.

    @code

    // Create an instance of the Bounce class.
    Bounce() button;

    @endcode
*/
    Bounce();


/*!
    @brief  Attach to a pin and sets that pin's mode (INPUT, INPUT_PULLUP or OUTPUT).
            
    @param    pin
              The pin that is to be debounced.
    @param    mode
              A valid Arduino pin mode (INPUT, INPUT_PULLUP or OUTPUT).
*/
    void attach(int pin, int mode);

    /**
    Attach to a pin for advanced users. Only attach the pin this way once you have previously 
    set it up. Otherwise use attach(int pin, int mode).
    */
    void attach(int pin);
    

    /**
    @brief  Sets the debounce interval in milliseconds.
            
    @param    interval_millis
    		The interval time in milliseconds.
     
     */
    void interval(uint16_t interval_millis);


/*!
    @brief   Updates the pin's state. 

    Because Bounce does not use interrupts, you have to "update" the object before reading its 
    value and it has to be done as often as possible (that means to include it in your loop()).
    Only call update() once per loop().

    @return True if the pin changed state.
*/

    bool update();

    /**
     @brief Returns the pin's state (HIGH or LOW).

     @return HIGH or LOW.
     */
    bool read();

    /**
    @brief Returns true if pin signal transitions from high to low.
    */
    bool fell();

    /**
    @brief Returns true if pin signal transitions from low to high.
    */
    bool rose();

     
     /**
    @brief Deprecated (i.e. do not use). Included for partial compatibility for programs written 
    with Bounce version 1
    */
    bool risingEdge() { return rose(); }
     /**
    @brief Deprecated (i.e. do not use). Included for partial compatibility for programs written 
    with Bounce version 1
    */
    bool fallingEdge() { return fell(); }
     /**
    @brief Deprecated (i.e. do not use). Included for partial compatibility for programs written 
    with Bounce version 1
    */
     Bounce(uint8_t pin, unsigned long interval_millis ) : Bounce() {
        attach(pin);
        interval(interval_millis);
    }
    
    /**
     @brief Returns the duration in milliseconds of the current state. 

     Is reset to 0 once the pin rises ( rose() ) or falls ( fell() ).
    
      @return The duration in milliseconds (unsigned long) of the current state.
     */

    unsigned long duration();

  /**
     @brief Returns the duration in milliseconds of the previous state. 

     Takes the values of duration() once the pin changes state.
    
      @return The duration in milliseconds (unsigned long) of the previous state. 
     */
    unsigned long previousDuration();     

 protected:
    unsigned long previous_millis;
    uint16_t interval_millis;
    uint8_t state;
    uint8_t pin;
    unsigned long stateChangeLastTime;
    unsigned long durationOfPreviousState;
    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
    }

  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)    {return((state & flag) != 0);}
 
  public:
    bool changed( ) { return getStateFlag(CHANGED_STATE); }

};

#endif