1.1.4

Author: joshnishikawa

README.md

@@ -1,14 +1,18 @@
-# Flicker
-* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
-FLICKER - A library for making capacitive touch easy to use.
+# Flicker 1.1.4
+### A library for making capacitive touch easy to use.
+######  - by Josh Nishikawa <github.com/joshnishikawa/Flicker>
+###### The "TouchSwitch" class was adapted from the Bounce library by: Thomas O Fredericks, Eric Lowry, Jim Schimpf and Tom Harkaway
+
 Includes all the functions found in the Bounce library, smoothes eratic values to make variable input more useful and includes functions for measuring velocity.
- - by Josh Nishikawa (github.com/joshnishikawa/Flicker)
- - The "TouchSwitch" class was adapted from the Bounce library by:
-   Thomas O Fredericks, Eric Lowry, Jim Schimpf and Tom Harkaway
-* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
-VERSION LOG
+___
+### VERSION LOG:
+
+1.1.4 
+- Added previousDuration() function that can be used on rising/falling edge to return the length of the input's previous state.
+- Added rose() and fell(). risingEdge() and fallingEdge() still work.
+- Now using bool data type where appropriate.
 
-1.0.4 (current)
+1.0.4 
    - created a library.properties file
    - made the version number semver compliant (1.0.4 is the first official release)
    - moved source files into src/
@@ -27,7 +31,7 @@ VERSION LOG
   - Added the TouchVariable class for stable reading of ranges of input.
   - Added the TouchVelocity class for detecting velocity of changes in input.
   - Started keeping this version log.
-* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+___
  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 2 of the License, or

examples/on-off_stable/on-off_stable.ino

@@ -3,7 +3,7 @@
 // If you hold your finger on the input,
 // something will happen.
 
-const uint8_t touchPin = 17; // CHOOSE A TOUCH PIN
+const uint8_t touchPin = 0; // CHOOSE A TOUCH PIN
 const uint8_t ledPin = 13;
 TouchSwitch myInput(touchPin);
 
@@ -19,11 +19,13 @@ void setup() {
 
 void loop() {
   myInput.update();
-  if (myInput.risingEdge()){
-    Serial.println("rose");
+
+  if (myInput.rose()){
+    Serial.print("rose");
   }
-  if (myInput.fallingEdge()){
+  if (myInput.fell()){
     Serial.println("fell");
   }
+
   digitalWrite(ledPin, myInput.read());
 }

examples/switch_previousDuration/switch_previousDuration.ino

@@ -0,0 +1,28 @@
+#include <Flicker.h>
+
+// This will tell you how long the input stayed in its PREVIOUS state.
+// It may be useful to call this within rose() or fell().
+
+const uint8_t touchPin = 15; // CHOOSE A TOUCH PIN
+const uint8_t ledPin = 13;
+TouchSwitch myInput(touchPin);
+
+void setup() {
+  pinMode(ledPin, OUTPUT);
+
+  // WARNING! if you setThreshold with no argument,
+  // the threshold is calculated based on a call to
+  // touchRead() so DON'T touch the input during setup()
+  myInput.setThreshold(); 
+}
+
+void loop() {
+  myInput.update();
+
+  if (myInput.fell()){
+    // After the input was released, print how long it was held.
+    Serial.println( myInput.previousDuration() );
+  }
+
+  digitalWrite(ledPin, myInput.read());
+}

examples/velocity_MIDI/velocity_MIDI.ino

@@ -21,7 +21,7 @@ void loop(){
   if (velocity >= 1){
     usbMIDI.sendNoteOn(noteNumber, velocity, 0);
   }
-  if (myInput.fallingEdge()){
+  if (myInput.fell()){
     usbMIDI.sendNoteOff(noteNumber, 0, 0);
   }
 }

examples/velocity_basic/velocity_basic.ino

@@ -21,10 +21,10 @@ void setup() {
 
 void loop(){
   int velocity = myInput.read();
-  if (myInput.fallingEdge()){
+  if (myInput.fell()){
     digitalWrite(LED, HIGH);
   }
-  if (myInput.risingEdge()){
+  if (myInput.rose()){
     digitalWrite(LED, LOW);
   }
   if (velocity >= 1){

library.properties

@@ -1,5 +1,5 @@
 name=Flicker
-version=1.0.4
+version=1.1.4
 author=Josh Nishikawa <joshnishikawa@gmail.com>
 maintainer=Josh Nishikawa <joshnishikawa@gmail.com>
 sentence=A library for making capacitive touch easy to use.

src/TouchSwitch.cpp

@@ -62,9 +62,9 @@ int TouchSwitch::read(){
 }
 
 
-byte TouchSwitch::risingEdge() {return stateChanged && state; }
+byte TouchSwitch::rose() {return stateChanged && state; }
 
-byte TouchSwitch::fallingEdge() {return stateChanged && !state; }
+byte TouchSwitch::fell() {return stateChanged && !state; }
 
 
 unsigned long TouchSwitch::duration(){
@@ -82,17 +82,23 @@ void TouchSwitch::interval(unsigned long interval_millis){
   retrigger_millis = 0;
 }
 
+unsigned long TouchSwitch::previousDuration()
+{
+  return durationOfPreviousState;
+}
 
 // Protected: triggers the pin
 int TouchSwitch::trigger(){
   int newValue = touchRead(pin);
+  int current_millis = millis();
 
   if(latched){ // LATCH behavior
     if (newValue >= onThreshold){
       if (waiting && held_millis >= interval_millis){
         state = !state;
         waiting = false;
-        previous_millis = millis();
+        durationOfPreviousState = current_millis - previous_millis;
+        previous_millis = current_millis;
         return 1;
       }
       else{return 0;}
@@ -112,7 +118,8 @@ int TouchSwitch::trigger(){
       if (waiting && held_millis >= interval_millis){
         if (!state){
           state = true;
-          previous_millis = millis();
+          durationOfPreviousState = current_millis - previous_millis;
+          previous_millis = current_millis;
           return 1;
         }
         else{
@@ -132,7 +139,8 @@ int TouchSwitch::trigger(){
       if(waiting && held_millis >= interval_millis){
         if (state){
           state = false;
-          previous_millis = millis();
+          durationOfPreviousState = current_millis - previous_millis;
+          previous_millis = current_millis;
           return 1;
         }
         else{
@@ -145,8 +153,7 @@ int TouchSwitch::trigger(){
           waiting = true;
           return 0;
         }
-        else{return 0;
-        }
+        else{return 0;}
       }
     }
     else{

src/TouchSwitch.h

@@ -38,11 +38,13 @@ class TouchSwitch{
     // Returns the updated pin state.
     int read();
 
-    // risingEdge() is true for 1 scan after input goes above the threshold.
-    byte risingEdge();
+    // rose() is true for 1 scan after input goes above the threshold.
+    byte rose();
+    byte risingEdge(){return rose();}
 
-    // fallingEdge() is true for 1 scan after input goes below the threshold.
-    byte fallingEdge();
+    // fell() is true for 1 scan after input goes below the threshold.
+    byte fell();
+    byte fallingEdge(){return fell();}
 
     // Returns the number of milliseconds the pin has been in the current state.
     unsigned long duration();
@@ -55,6 +57,8 @@ class TouchSwitch{
    	// A 'debounce' interval isn't really needed but, if you want one...
     void interval(unsigned long interval_millis); 
 
+    unsigned long previousDuration();
+
   protected:
     int trigger();
     byte state = 0;
@@ -64,10 +68,11 @@ class TouchSwitch{
     unsigned long previous_millis = 0;
     unsigned long interval_millis = 0;
     unsigned long retrigger_millis = 0;
+    unsigned long durationOfPreviousState;
     byte pin = 0;
-    byte latched = false;
-    byte waiting = false;
-    byte stateChanged = false;
+    bool latched = false;
+    bool waiting = false;
+    bool stateChanged = false;
 };
 
 #endif

src/TouchVariable.h

@@ -44,8 +44,8 @@ class TouchVariable{
 
   protected:
     byte pin = 0;
-    byte mapped = false; // true maps input to a predetermined output range
-    byte adjustInHi = true;//false if using setInputRange(int inLo, int inHi)
+    bool mapped = false; // true maps input to a predetermined output range
+    bool adjustInHi = true;//false if using setInputRange(int inLo, int inHi)
 
     int buffer = 0;   /* Think of this variable as a container like a capacitor
                         acting as a low-pass filter. */

src/TouchVelocity.h

@@ -60,7 +60,7 @@ class TouchVelocity{
 
   protected:
     byte pin;
-    byte stateChanged;
+    bool stateChanged;
     int inHi, state, peak;
     int outLo = 1;
     int outHi = 127;