alexandrehiroyuki/movingaverageplus

Moving Average Plus is a C++ library that implements a moving average on the Arduino platform. Performance and usability are the two focuses I thought of when creating this library, so every improvement tip is welcome. It is useful for filtering noisy data from sensors, for example.

Hey, you can call me Hiro! 🤝

私は宏之です。よろしくおねがいします！

Featured Repositories ✨

movingaverageplus's Issues

Upgrade the array to allow the use of objects

Receive a function pointer on a parameter as a instruction about how to access the value used to calculate the average.

Make it possible to change the sum type

Make it possible to customize the sum type in case a more extensive memory type is needed.

Add a Partials example code

Add front method docs

Add back method docs

Add size method docs

Add fill method docs

Try implementing the library with a linked list instead of an array

Try implementing the library with a linked list instead of an array and compare performances.

Add clear method docs

Add constructor docs

Memory allocation

I'm using MA w/ Arduino 1.8.16. It appears to me that memory for the MA is not allocated in static RAM, but in heap or stack. At least changing the numbers in "MovingAveragePlus <uint16_t> press_L(20);" has no effect on RAM allocation. Compiler always states "678 Bytes (33%)" dyn memory. That clashs w/ Stack size and the program becomes non executable w/out any error msg. at compilation.

I think this library will be great if ...

Hi, Thanks for creating an awesome library.
I just want to give you a suggest, I think this library will be great if added with other statistical function such as standard deviation of samples, variance, etc. That's all. Best regards, Octa.

Add get method docs

Upgrade fill method to receive an array

Upgrade MovingAverage constructor to receive an array as a initializer value

Add atIndex method docs

Automated releases

Do automated releases using GitHub workflows.

Add operator[] docs

Extend Get() to receive average for the last x datapoints

I would like to determine the average of the last 30 values. In parallel, I would like the average of the last 10 values.
To achieve this, I would have to create two MovingAverage and feed them with the same data.

MovingAverage<unsigned int> slowSensor(30);
MovingAverage<unsigned int> fastSensor(10);

slowSensor.push(sensorData);
fastSensor.push(sensorData);

By extending the get() with an optional parameter, it would be possible to solve this issue with one MovingAverage object

for example:

int slowSensorMovingAvg = slowSensor.get(); // average of 30 datapoints
int fastSensorMovingAvg = slowSensor.get(10); // average of 10 datapoints

Upgrade push method to receive an array

Average of an incomplete filled MovingAverage object

By default all positions will be initialized with 0. If I create a MovingAverage<unsigned int> fooAvg(10); and fill it with only 5 values, then the average should also only be calculated from these 5 values.

Add resize method docs

Remake the docs using some web framework

I want to make the documentation less dependent on Notion's host and tools.

Possible tools:

• https://docusaurus.io

New Docs repository:

• https://github.com/AlexandreHiroyuki/MovingAveragePlusDocs
• https://alexandrehiroyuki.github.io/MovingAveragePlusDocs/

Unit testing

Index order incorrect

When pushing into the moving average, the number is added at the end of the array. It should be pushed into the front.

Add push method docs

Create docs

Add reset method docs

v5.0.0

Changelog

• added unit tests to MovingAveragePlus
• fix back() method
• fix resize() method