summaryrefslogtreecommitdiffstats
path: root/sensor_firmware/movingavg.py
blob: 2cbced3a6f3a73283c0790b9031f26f4b2c4f410 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# -*- coding: utf-8 -*-
#
# Moving average
#
# Copyright 2018-2020 Michael Buesch <m@bues.ch>
#
# 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
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#

__all__ = [
    "MovingAvg",
]

import micropython

class MovingAvg(object):
    __slots__ = (
        "__size",
        "__items",
        "__nrItems",
        "__beginPtr",
        "__endPtr",
        "__avgSum",
    )

    def __init__(self, size):
        assert size > 0
        self.__size = size
        self.__items = [0.0] * self.__size
        self.__nrItems = 0
        self.__beginPtr = 0
        self.__endPtr = 0
        self.__avgSum = 0

    @micropython.native
    def calculate(self, value):
        size = self.__size
        nrItems = self.__nrItems

        if nrItems >= size:
            # Get and remove the first element from the list.
            beginPtr = self.__beginPtr
            first = self.__items[beginPtr]
            beginPtr += 1
            if beginPtr >= size:
                beginPtr = 0
            self.__beginPtr = beginPtr

        # Append the new value to the list.
        endPtr = self.__endPtr
        self.__items[endPtr] = value
        endPtr += 1
        if endPtr >= size:
            endPtr = 0
        self.__endPtr = endPtr

        avgSum = self.__avgSum
        if nrItems >= size:
            # Subtract the removed value from the sum
            # and add the new value.
            avgSum -= first
            avgSum += value
        else:
            # The list is not fully populated, yet.
            avgSum += value
            self.__nrItems = nrItems = nrItems + 1
        self.__avgSum = avgSum

        return avgSum / nrItems

    __call__ = calculate

# vim: ts=4 sw=4 expandtab
bues.ch cgit interface