Folder structure according Arduino IDE 1.5 Library specification

2018-05-22 15:48:01 +03:00
parent 7091ec8bf9
commit b061fcf83e
8 changed files with 5 additions and 1 deletions
@@ -0,0 +1,125 @@
+// Please read Bounce2.h for information about the liscence and authors
+
+
+#include "Bounce2.h"
+
+static const uint8_t DEBOUNCED_STATE = 0b00000001;
+static const uint8_t UNSTABLE_STATE  = 0b00000010;
+static const uint8_t CHANGED_STATE   = 0b00000100;
+
+
+Bounce::Bounce()
+    : previous_millis(0)
+    , interval_millis(10)
+    , state(0)
+    , pin(0)
+{}
+
+void Bounce::attach(int pin) {
+    this->pin = pin;
+    state = 0;
+    if (readCurrentState()) {
+        setStateFlag(DEBOUNCED_STATE | UNSTABLE_STATE);
+    }
+#ifdef BOUNCE_LOCK_OUT
+    previous_millis = 0;
+#else
+    previous_millis = millis();
+#endif
+}
+
+void Bounce::attach(int pin, int mode){
+    setPinMode(pin, mode);
+    this->attach(pin);
+}
+
+void Bounce::interval(uint16_t interval_millis)
+{
+    this->interval_millis = interval_millis;
+}
+
+bool Bounce::update()
+{
+
+    unsetStateFlag(CHANGED_STATE);
+#ifdef BOUNCE_LOCK_OUT
+    
+    // Ignore everything if we are locked out
+    if (millis() - previous_millis >= interval_millis) {
+        bool currentState = readCurrentState();
+        if ( currentState != getStateFlag(DEBOUNCED_STATE) ) {
+            previous_millis = millis();
+            toggleStateFlag(DEBOUNCED_STATE);
+            setStateFlag(CHANGED_STATE);
+        }
+    }
+    
+
+#elif defined BOUNCE_WITH_PROMPT_DETECTION
+    // Read the state of the switch port into a temporary variable.
+    bool readState = readCurrentState();
+
+
+    if ( readState != getStateFlag(DEBOUNCED_STATE) ) {
+      // We have seen a change from the current button state.
+
+      if ( millis() - previous_millis >= interval_millis ) {
+	// We have passed the time threshold, so a new change of state is allowed.
+	// set the STATE_CHANGED flag and the new DEBOUNCED_STATE.
+	// This will be prompt as long as there has been greater than interval_misllis ms since last change of input.
+	// Otherwise debounced state will not change again until bouncing is stable for the timeout period.
+	 toggleStateFlag(DEBOUNCED_STATE);
+     setStateFlag(CHANGED_STATE );
+      }
+    }
+
+    // If the readState is different from previous readState, reset the debounce timer - as input is still unstable
+    // and we want to prevent new button state changes until the previous one has remained stable for the timeout.
+    if ( readState != getStateFlag(UNSTABLE_STATE) ) {
+	// Update Unstable Bit to macth readState
+        toggleStateFlag(UNSTABLE_STATE);
+        previous_millis = millis();
+    }
+    
+    
+#else
+    // Read the state of the switch in a temporary variable.
+    bool currentState = readCurrentState();
+    
+
+    // If the reading is different from last reading, reset the debounce counter
+    if ( currentState != getStateFlag(UNSTABLE_STATE) ) {
+        previous_millis = millis();
+         toggleStateFlag(UNSTABLE_STATE);
+    } else
+        if ( millis() - previous_millis >= interval_millis ) {
+            // We have passed the threshold time, so the input is now stable
+            // If it is different from last state, set the STATE_CHANGED flag
+            if (currentState != getStateFlag(DEBOUNCED_STATE) ) {
+                previous_millis = millis();
+                 toggleStateFlag(DEBOUNCED_STATE);
+                 setStateFlag(CHANGED_STATE) ;
+            }
+        }
+
+    
+#endif
+
+return  getStateFlag(CHANGED_STATE); 
+
+}
+
+bool Bounce::read()
+{
+    return  getStateFlag(DEBOUNCED_STATE);
+}
+
+bool Bounce::rose()
+{
+    return getStateFlag(DEBOUNCED_STATE) && getStateFlag(CHANGED_STATE);
+}
+
+bool Bounce::fell()
+{
+    return  !getStateFlag(DEBOUNCED_STATE) && getStateFlag(CHANGED_STATE);
+}
@@ -0,0 +1,110 @@
+/*
+  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>
+
+/*
+#ifndef _BV
+#define _BV(n) (1<<(n))
+#endif
+*/
+
+class Bounce
+{
+ public:
+    // Create an instance of the bounce library
+    Bounce();
+
+    // Attach to a pin (and also sets initial state)
+    void attach(int pin);
+    
+    // Attach to a pin (and also sets initial state) and sets pin to mode (INPUT/INPUT_PULLUP/OUTPUT)
+    void attach(int pin, int mode);
+
+    // Sets the debounce interval
+    void interval(uint16_t interval_millis);
+
+    // Updates the pin
+    // Returns 1 if the state changed
+    // Returns 0 if the state did not change
+    bool update();
+
+    // Returns the updated pin state
+    bool read();
+
+    // Returns the falling pin state
+    bool fell();
+
+    // Returns the rising pin state
+    bool rose();
+
+    // Partial compatibility for programs written with Bounce version 1
+    bool risingEdge() { return rose(); }
+    bool fallingEdge() { return fell(); }
+    Bounce(uint8_t pin, unsigned long interval_millis ) : Bounce() {
+        attach(pin);
+        interval(interval_millis);
+    }
+
+ protected:
+    unsigned long previous_millis;
+    uint16_t interval_millis;
+    uint8_t state;
+    uint8_t pin;
+    virtual bool readCurrentState() { return digitalRead(pin); }
+    virtual void setPinMode(int pin, int mode) {
+#if defined(ARDUINO_STM_NUCLEO_F103RB) || defined(ARDUINO_GENERIC_STM32F103C)
+        pinMode(pin, (WiringPinMode)mode);
+#else
+        pinMode(pin, mode);
+#endif
+    }
+
+  private:
+    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);}
+};
+
+#endif