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
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
use messzelle::{
    MAX_VALUES_FOR_N_MINUTES,
    Messzelle,
    MesszelleError,
    MesszelleType,
};
use std::fmt;
use std::time::Duration;
use std::time::SystemTime;

// Die `pub` Public members sind nötig, da die Felder von den Konvertierungen (Configuration, RuntimInfo,
// und Api) gesetzt werden.
/// CO Messzelle eines 'RA-GAS GmbH CO/NO2 Kombisensor mit Modbus Interface'
///
#[derive(Debug)]
pub struct RaGasCOMod {
    pub messzelle_type: MesszelleType,
    pub values: Vec<(f64, SystemTime)>,
}

impl RaGasCOMod {
    /// Erstellt eine neue Messzelle
    ///
    /// # Examples
    ///
    /// ```rust
    /// use xmz_server::prelude::*;
    ///
    /// let messzelle = RaGasCOMod::new();
    /// ```
    pub fn new() -> Self {
        RaGasCOMod {
            messzelle_type: MesszelleType::RaGasCOMod,
            values: vec![],
        }
    }
}

impl Messzelle for RaGasCOMod {
    /// Aktueller Messzelle Wert und Timestamp der Ermittlung
    ///
    /// # Examples
    ///
    /// ```rust
    /// use xmz_server::prelude::*;
    ///
    /// let messzelle = RaGasCOMod::new();
    /// assert!(messzelle.get_value().is_none());
    /// ```
    fn get_value(&self) -> Option<&(f64, SystemTime)> {
        self.values.last()
    }

    /// Liefert alle Werte der Messzelle
    ///
    /// # Examples
    ///
    /// ```rust
    /// use xmz_server::prelude::*;
    ///
    /// let messzelle = RaGasCOMod::new();
    /// assert_eq!(messzelle.get_values().len(), 0);
    /// ```
    fn get_values(&self) -> Vec<(f64, SystemTime)> {
        self.values.clone()
    }

    /// Liefert den Typ der Messzelle
    ///
    /// # Examples
    ///
    /// ```rust
    /// use xmz_server::prelude::*;
    ///
    /// let messzelle = RaGasCOMod::new();
    /// assert_eq!(messzelle.get_messzelle_type(), MesszelleType::RaGasCOMod);
    /// ```
    fn get_messzelle_type(&self) -> MesszelleType {
        self.messzelle_type.clone()
    }

    /// Mittelwert der letzten `min` Minuten
    ///
    /// # Examples
    ///
    /// ```rust
    /// use xmz_server::prelude::*;
    ///
    /// let messzelle = RaGasCOMod::new();
    /// ```
    fn average(&self, minutes: u64) -> Result<f64, MesszelleError> {
        let mut values = self.values.clone();
        // Index ermitteln
        if let Some(index) = values.iter().position(|&(_value, timestamp)| {
            timestamp.elapsed().unwrap() < Duration::from_secs(minutes)
        }) {
            values = values.split_off(index);
        }

        // Spezialfall, nur noch ein Wert vorhanden. Hier muss nun geprüft werden ob dieser
        // veraltet ist.
        if values.len() == 1 {
            if let Some(&(_value, timestamp)) = values.get(0) {
                if let Ok(duration) = timestamp.elapsed() {
                    if duration > Duration::from_secs(minutes) {
                        values.clear();
                    }
                }
            }
        }

        // Anzahl der verbleibenden Wertepaare
        let len = values.len() as f64;
        // Addieren
        let sum = values
            .iter()
            .fold(0.0, |acc, &(value, _timestamp)| acc + value);
        // durch Anzahl teilen um Mittelwert zu erhalten
        let avg = sum / len;
        // Floting Point kann NaN (Not a Number) ergeben, in diesem Fall Fehler zurück
        if avg.is_nan() {
            Err(MesszelleError::NoAverage)
        } else {
            Ok(avg)
        }
    }

    /// Aktuellen Messzellewert ermitteln und speichern.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use xmz_server::prelude::*;
    ///
    /// let messzelle = RaGasCOMod::new();
    /// ```
    fn update(&mut self) {
        let last_value = match self.get_value() {
            Some(&(value, _timestamp)) => value,
            None => 0.0,
        };
        self.values.push((last_value + 1.0, SystemTime::now()));
        self.shrink_values();
        debug!("|-- Update Messzelle: '{}'", &self);
    }

    /// Entfernt alle Wert/Zeistempel Paare die älter als `Messzelle::MAX_VALUES_FOR_N_MINUTES` sind.
    ///
    /// Diese Funktion besteht aus 2 Tests. Der erste Spezialfall tritt ein wenn nur ein
    /// Wert/Zeitstempel Paar vorhanden ist. Hier muss getestet werden ob dieses veraltete Daten
    /// enthält. Ist dem so werden alle Werte/Zeitstempel gelöscht.
    /// Der zweite Test sucht aus der Liste den Index Wert ab dem veraltet Wert/Zeitstempel
    /// Paare auftreten. Anschließend wird dieser Index Wert verwendet um den Wert/Zeitstempel
    /// Vector an dieser Stelle zu teilen. Altere Werte werden dabei verworfen.
    ///
    ///
    /// # Examples
    ///
    /// ```rust
    /// use xmz_server::prelude::*;
    ///
    /// let messzelle = RaGasCOMod::new();
    /// ```
    fn shrink_values(&mut self) {
        // 1. Spezialfall, ist nur ein Wert/Zeitstempel Paar vorhanden muss dieses zuerst
        // geprüft werden. Ist der Wert dieses Wert/Zeitstempel Paares veraltet dann wird das
        // Paar entfernt, der `values` Vector ist dann leer. Der folgende Test wird in diesem
        // Falle nicht ausgeführt, da kein Index mehr gefunden werden kann.
        if self.values.len() == 1 {
            if let Some(&(_value, timestamp)) = self.values.get(0) {
                if let Ok(duration) = timestamp.elapsed() {
                    if duration > Duration::from_secs(MAX_VALUES_FOR_N_MINUTES) {
                        self.values.clear();
                    }
                }
            }
        }

        // 2. Test, mind. ein aktuelles Wert/Zeitstempel Paar ist vorhanden.

        // Die [`position()`](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.position)
        // Funktion sucht in einem Iterator nach einem Element und liefert dessen Index Wert.
        // Dieser Index wird benutzt um die Liste der Liste der Wert/Zeitstempel Paare
        // mit der Funktion [`split_off()`](https://doc.rust-lang.org/std/vec/struct.Vec.html#method.split_off)
        // zu teilen.
        if let Some(index) = self.values.iter().position(|&(_value, timestamp)| {
            timestamp.elapsed().unwrap() < Duration::from_secs(MAX_VALUES_FOR_N_MINUTES)
        }) {
            // Mit `split_off()` wird der Vector geteilt, es bleiben nur noch die
            // Wert/Zeitstempel Paare der letzten `MAX_VALUES_FOR_N_MINUTES` Minuten übrig.
            //
            // **Dieser Rest wird wieder als `values` übernommen, alle "alten" Werte werden so verworfen.**
            self.values = self.values.split_off(index);
        }
    }
}

impl fmt::Display for RaGasCOMod {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "RA-GAS GmbH CO")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn new() {
        let messzelle = RaGasCOMod::new();
        assert_eq!(messzelle.values.len(), 0);
    }

    #[test]
    fn get_value() {
        let messzelle = RaGasCOMod::new();
        assert!(messzelle.get_value().is_none());
    }

    #[test]
    fn get_values() {
        let messzelle = RaGasCOMod::new();
        assert_eq!(messzelle.get_values().len(), 0);
    }

    #[test]
    fn average() {
        let messzelle = RaGasCOMod::new();
        assert!(messzelle.average(15).is_err());
    }

    #[test]
    fn update() {
        let mut messzelle = RaGasCOMod::new();
        assert_eq!(messzelle.values.len(), 0);
        messzelle.update();
        assert_eq!(messzelle.values.len(), 1);
    }

}