+ 0.1.02

+ readPrevious() + changed signatures + added comments + fix typo in sample
ruyan768 · Dec 7, 2014 · baa7e04 · baa7e04
1 parent 9d58c16
commit baa7e04
Showing 3 changed files with 37 additions and 24 deletions.
diff --git a/libraries/AnalogPin/AnalogPin.cpp b/libraries/AnalogPin/AnalogPin.cpp
@@ -1,9 +1,14 @@
 //
 //    FILE: AnalogPin.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.00
+// VERSION: 0.1.02
+//    DATE: 2014-10-05
 // PURPOSE: wrapper class for analogRead
-//     URL:
+//
+// HISTORY:
+// 0.1.00 - 2013-09-09 initial version
+// 0.1.01 - 2013-11-09 added some comments
+// 0.1.02 - 2014-10-05 changed signatures datatypes
 //
 // Released to the public domain
 //
@@ -16,22 +21,27 @@ AnalogPin::AnalogPin(uint8_t pin)
     _prevValue = analogRead(pin);
 }
 
-uint16_t AnalogPin::read(uint8_t noise)
+int AnalogPin::read(uint8_t noise)
 {
-    uint16_t value = analogRead(_pin);
+    int value = analogRead(_pin);
     if (noise == 0 || abs(value - _prevValue) > noise)
     {
         _prevValue = value;
     }
     return _prevValue;
 }
 
-uint16_t AnalogPin::readSmoothed(uint8_t alpha)
+int AnalogPin::readSmoothed(uint8_t alpha)
 {
-    alpha = constrain(alpha, 0, 32);
-    uint16_t value = analogRead(_pin);
+    alpha = constrain(alpha, 0, 31);
+    int value = analogRead(_pin);
     value = (alpha*_prevValue + (32-alpha)*value)/32;
     _prevValue = value;
     return value;
 }
+
+int AnalogPin::readPrevious()
+{
+    return _prevValue;
+}
 // -- END OF FILE --
diff --git a/libraries/AnalogPin/AnalogPin.h b/libraries/AnalogPin/AnalogPin.h
@@ -1,7 +1,8 @@
 //
 //    FILE: AnalogPin.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.00
+// VERSION: 0.1.02
+//    DATE: 2014-10-05
 // PURPOSE: wrapper class for analogRead
 //     URL:
 //
@@ -12,27 +13,29 @@
 #define AnalogPin_h
 
 #if defined(ARDUINO) && ARDUINO >= 100
-  #include "Arduino.h"
+#include "Arduino.h"
 #else
-  #include "WProgram.h"
+#include "WProgram.h"
 #endif
 
-#define ANALOGPIN_LIB_VERSION "0.1.00"
+#define ANALOGPIN_LIB_VERSION "0.1.02"
 
 class AnalogPin
 {
-  public:
-	AnalogPin(uint8_t);
-
-    // noise 0..256; in practice 0..4
-    uint16_t read(uint8_t noise = 0);
-
-    // alpha 0..32; 
-    uint16_t readSmoothed(uint8_t alpha = 0); 
-
-  private:
+public:
+    AnalogPin(uint8_t);
+
+    // noise 0..255; in practice 0..4
+    int read(uint8_t noise = 0);
+
+    // alpha 0..31;
+    int readSmoothed(uint8_t alpha = 0);
+
+    int readPrevious();
+
+private:
     uint8_t _pin;
-    uint16_t _prevValue;
+    int _prevValue;
 };
 
 #endif

diff --git a/libraries/AnalogPin/examples/AnalogPin/AnalogPin.ino b/libraries/AnalogPin/examples/AnalogPin/AnalogPin.ino
@@ -1,7 +1,7 @@
 //
 //    FILE: AnalogPin.ino
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.01
+// VERSION: 0.1.02
 // PURPOSE: example sketch
 //     URL:
 //
@@ -32,7 +32,7 @@ void loop()
   Serial.print(INA.readSmoothed(16));
   Serial.print('\t');
 
-  Serial.print(INA.readPrevious();
+  Serial.print(INA.readPrevious());
 
   Serial.println();
   delay(100);