sma-proto 1.1.1

A Rust implementation of the SMA Speedwire protocol
Documentation 
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

/******************************************************************************\
    sma-proto - A SMA Speedwire protocol library
    Copyright (C) 2024 Max Maisel

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
\******************************************************************************/
#[cfg(not(feature = "std"))]
use core::{
    clone::Clone,
    cmp::{Eq, PartialEq},
    fmt::Debug,
    prelude::rust_2021::derive,
    result::Result::Ok,
};

use byteorder_cursor::{Cursor, LittleEndian};

use super::{Result, SmaSerde};

/// Total inverter energy production at a given timestamp.
/// May contain invalid "NaN" values.
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct SmaInvMeterValue {
    /// Unix timestamp of the meter value.
    pub timestamp: u32,
    /// Total energy production in Wh.
    pub energy_wh: u64,
}

impl SmaInvMeterValue {
    pub const LENGTH: usize = 12;

    /// Returns true if the contained value is a valid number.
    pub fn is_valid(&self) -> bool {
        self.energy_wh != 0xFFFF_FFFF_FFFF_FFFF
    }
}

impl SmaSerde for SmaInvMeterValue {
    fn serialize(&self, buffer: &mut Cursor<&mut [u8]>) -> Result<()> {
        buffer.check_remaining(Self::LENGTH)?;

        buffer.write_u32::<LittleEndian>(self.timestamp);
        buffer.write_u64::<LittleEndian>(self.energy_wh);

        Ok(())
    }

    fn deserialize(buffer: &mut Cursor<&[u8]>) -> Result<Self> {
        buffer.check_remaining(Self::LENGTH)?;

        let timestamp = buffer.read_u32::<LittleEndian>();
        let energy_wh = buffer.read_u64::<LittleEndian>();

        Ok(Self {
            timestamp,
            energy_wh,
        })
    }
}