Added running average methods to determine if we should send temperature / humidity reports

2015-05-12 21:23:09 +02:00
parent 941afb30e9
commit 7fcdbb32d8
8 changed files with 431 additions and 41 deletions
@@ -0,0 +1,101 @@
+//
+//    FILE: RunningAverage.cpp
+//  AUTHOR: Rob Tillaart
+// VERSION: 0.2.08
+//    DATE: 2015-apr-10
+// PURPOSE: RunningAverage library for Arduino
+//
+// The library stores N individual values in a circular buffer,
+// to calculate the running average.
+//
+// HISTORY:
+// 0.1.00 - 2011-01-30 initial version
+// 0.1.01 - 2011-02-28 fixed missing destructor in .h
+// 0.2.00 - 2012-??-?? Yuval Naveh added trimValue (found on web)
+//          http://stromputer.googlecode.com/svn-history/r74/trunk/Arduino/Libraries/RunningAverage/RunningAverage.cpp
+// 0.2.01 - 2012-11-21 refactored
+// 0.2.02 - 2012-12-30 refactored trimValue -> fillValue
+// 0.2.03 - 2013-11-31 getElement
+// 0.2.04 - 2014-07-03 added memory protection
+// 0.2.05 - 2014-12-16 changed float -> double
+// 0.2.06 - 2015-03-07 all size uint8_t
+// 0.2.07 - 2015-03-16 added getMin() and getMax() functions (Eric Mulder)
+// 0.2.08 - 2015-04-10 refactored getMin() and getMax() implementation
+//
+// Released to the public domain
+//
+
+#include "RunningAverage.h"
+#include <stdlib.h>
+
+RunningAverage::RunningAverage(uint8_t size)
+{
+    _size = size;
+    _ar = (double*) malloc(_size * sizeof(double));
+    if (_ar == NULL) _size = 0;
+    clear();
+}
+
+RunningAverage::~RunningAverage()
+{
+    if (_ar != NULL) free(_ar);
+}
+
+// resets all counters
+void RunningAverage::clear()
+{
+    _cnt = 0;
+    _idx = 0;
+    _sum = 0.0;
+    _min = NAN;
+    _max = NAN;
+    for (uint8_t i = 0; i < _size; i++)
+    {
+        _ar[i] = 0.0; // keeps addValue simple
+    }
+}
+
+// adds a new value to the data-set
+void RunningAverage::addValue(double value)
+{
+    if (_ar == NULL) return;  // allocation error
+    _sum -= _ar[_idx];
+    _ar[_idx] = value;
+    _sum += _ar[_idx];
+    _idx++;
+    if (_idx == _size) _idx = 0;  // faster than %
+    // handle min max
+    if (_cnt == 0) _min = _max = value;
+    else if (value < _min) _min = value;
+    else if (value > _max) _max = value;
+    // update count as last otherwise if( _cnt == 0) above will fail
+    if (_cnt < _size) _cnt++;
+}
+
+// returns the average of the data-set added sofar
+double RunningAverage::getAverage()
+{
+    if (_cnt == 0) return NAN;
+    return _sum / _cnt;
+}
+
+// returns the value of an element if exist, NAN otherwise
+double RunningAverage::getElement(uint8_t idx)
+{
+    if (idx >=_cnt ) return NAN;
+    return _ar[idx];
+}
+
+// fill the average with a value
+// the param number determines how often value is added (weight)
+// number should preferably be between 1 and size
+void RunningAverage::fillValue(double value, uint8_t number)
+{
+    clear(); // TODO conditional?  if (clr) clear();
+
+    for (uint8_t i = 0; i < number; i++)
+    {
+        addValue(value);
+    }
+}
+// END OF FILE
@@ -0,0 +1,56 @@
+//
+//    FILE: RunningAverage.h
+//  AUTHOR: Rob dot Tillaart at gmail dot com
+// VERSION: 0.2.08
+//    DATE: 2015-apr-10
+// PURPOSE: RunningAverage library for Arduino
+//     URL: http://arduino.cc/playground/Main/RunningAverage
+// HISTORY: See RunningAverage.cpp
+//
+// Released to the public domain
+//
+// backwards compatibility
+// clr()   clear()
+// add(x)  addValue(x)
+// avg()   getAverage()
+
+#ifndef RunningAverage_h
+#define RunningAverage_h
+
+#define RUNNINGAVERAGE_LIB_VERSION "0.2.08"
+
+#include "Arduino.h"
+
+class RunningAverage
+{
+public:
+    RunningAverage(void);
+    RunningAverage(uint8_t);
+    ~RunningAverage();
+
+    void clear();
+    void addValue(double);
+    void fillValue(double, uint8_t);
+
+    double getAverage();
+    // returns lowest value added to the data-set since last clear
+    double getMin() { return _min; };
+    // returns highest value added to the data-set since last clear
+    double getMax() { return _max; };
+
+    double getElement(uint8_t idx);
+    uint8_t getSize() { return _size; }
+    uint8_t getCount() { return _cnt; }
+
+protected:
+    uint8_t _size;
+    uint8_t _cnt;
+    uint8_t _idx;
+    double _sum;
+    double * _ar;
+    double _min;
+    double _max;
+};
+
+#endif
+// END OF FILE
@@ -0,0 +1,38 @@
+//
+//    FILE: fillValue.pde
+//  AUTHOR: Rob Tillaart
+//    DATE: 2012-12-30
+//
+// PUPROSE: show working of fillValue
+//
+
+#include "RunningAverage.h"
+
+RunningAverage myRA(10);
+int samples = 0;
+
+void setup(void) 
+{
+  Serial.begin(115200);
+  Serial.print("Demo RunningAverage lib - fillValue ");
+  Serial.print("Version: ");
+  Serial.println(RUNNINGAVERAGE_LIB_VERSION);
+ 
+  myRA.fillValue(100,5);
+}
+
+void loop(void) 
+{
+  long rn = random(0, 100);
+  myRA.addValue(rn/100.0);
+  samples++;
+  Serial.print("Running Average: ");
+  Serial.println(myRA.getAverage(), 4);
+  
+  if (samples == 300)
+  {
+    samples = 0;
+    myRA.fillValue(100, 10);
+  }
+  delay(100);
+}
@@ -0,0 +1,46 @@
+//
+//    FILE: runningAverageMinMaxTest.ino
+//  AUTHOR: Rob Tillaart
+// VERSION: 0.1.00
+//    DATE: 2015-apr-10
+//
+// PUPROSE: demo
+//
+
+#include "RunningAverage.h"
+
+RunningAverage myRA(10);
+int samples = 0;
+
+void setup(void)
+{
+  Serial.begin(115200);
+  Serial.println("\nDemo runningAverageMinMaxTest");
+  Serial.print("Version: ");
+  Serial.println(RUNNINGAVERAGE_LIB_VERSION);
+  myRA.clear(); // explicitly start clean
+
+  Serial.println("\nCNT\tMIN\tAVG\tMAX");
+}
+
+void loop(void)
+{
+  long rn = random(0, 1000);
+  myRA.addValue(rn * 0.001);
+  samples++;
+  Serial.print(samples);
+  Serial.print("\t");
+  Serial.print(myRA.getMin(), 3);
+  Serial.print("\t");
+  Serial.print(myRA.getAverage(), 3);
+  Serial.print("\t");
+  Serial.println(myRA.getMax(), 3);
+
+  if (samples == 100)
+  {
+    samples = 0;
+    myRA.clear();
+    Serial.println("\nCNT\tMIN\tAVG\tMAX");
+  }
+  delay(10);
+}
@@ -0,0 +1,40 @@
+//
+//    FILE: runningAverageHour.pde
+//  AUTHOR: Rob Tillaart
+//    DATE: 2012-12-30
+//
+// PUPROSE: show working of runningAverage per hour 
+//          in 2 steps - last minute + last hour
+//          3 or more steps also possible
+//
+
+#include "RunningAverage.h"
+
+RunningAverage raMinute(60);
+RunningAverage raHour(60);
+
+int samples = 0;
+
+void setup(void) 
+{
+  Serial.begin(115200);
+  Serial.println("Demo RunningAverage lib - average per minute & hour");
+  Serial.print("Version: ");
+  Serial.println(RUNNINGAVERAGE_LIB_VERSION);
+  raHour.clear();
+  raMinute.clear();
+}
+
+void loop(void) 
+{
+  long rn = random(0, 100);
+  raMinute.addValue(rn);
+  samples++;
+  
+  if (samples % 60 == 0) raHour.addValue(raMinute.getAverage());
+  
+  Serial.print("  raMinute: ");
+  Serial.print(raMinute.getAverage(), 4);
+  Serial.print("  raHour: ");
+  Serial.println(raHour.getAverage(), 4);
+}
@@ -0,0 +1,40 @@
+//
+//    FILE: runningAverageTest.pde
+//  AUTHOR: Rob Tillaart
+// VERSION: 0.1.01
+//    DATE: 2012-12-30
+//
+// PUPROSE: show working of runningAverage
+//
+
+#include "RunningAverage.h"
+
+RunningAverage myRA(10);
+int samples = 0;
+
+void setup(void) 
+{
+  Serial.begin(115200);
+  Serial.println("Demo RunningAverage lib");
+  Serial.print("Version: ");
+  Serial.println(RUNNINGAVERAGE_LIB_VERSION);
+  myRA.clear(); // explicitly start clean
+}
+
+void loop(void) 
+{
+  long rn = random(0, 1000);
+  myRA.addValue(rn * 0.001);
+  samples++;
+  Serial.print(samples);
+  Serial.print("\t Running Average: ");
+  Serial.println(myRA.getAverage(), 3);
+  
+  if (samples == 300)
+  {
+    samples = 0;
+    myRA.clear();
+    Serial.println();
+  }
+  delay(10);
+}
@@ -0,0 +1,32 @@
+#######################################
+# Syntax Coloring Map For RunningAverage
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+RunningAverage	KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+clear	KEYWORD2
+addValue	KEYWORD2
+getAverage	KEYWORD2
+getMin  KEYWORD2
+getMax  KEYWORD2
+fillValue	KEYWORD2
+getElement	KEYWORD2
+getSize	KEYWORD2
+getCount	KEYWORD2
+
+#######################################
+# Instances (KEYWORD2)
+#######################################
+
+
+#######################################
+# Constants (LITERAL1)
+#######################################