foxess 1.1.0

Rust library for communication with FoxESS Cloud
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

//! This module hosts the [FoxWorkModes] enumeration mainly used when managing scheduler work modes.
//!
//! More might be added over time, hence the [FoxWorkModes] enumeration is derived non-exhaustive.
//!

use std::str::FromStr;

/// An enumeration representing the available scheduler work modes from FoxESS cloud.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum FoxWorkModes {
    /// Forces the battery to discharge.
    ForceDischarge,
    /// Peak shaving mode.
    PeakShaving,
    /// Feed-in mode.
    Feedin,
    /// Backup mode.
    Backup,
    /// Self-use mode.
    SelfUse,
    /// Forces the battery to charge.
    ForceCharge,
    /// Unknown work mode.
    Unknown,
}

impl FoxWorkModes {
    /// Returns the string representation of the `FoxWorkModes` enum variant.
    ///
    /// This string matches the key used by the FoxESS cloud API.
    ///
    /// # Returns
    /// * `&'static str` - The string representation of the work mode.
    pub const fn as_str(&self) -> &'static str {
        match self {
            FoxWorkModes::ForceDischarge => "ForceDischarge",
            FoxWorkModes::PeakShaving => "PeakShaving",
            FoxWorkModes::Feedin => "Feedin",
            FoxWorkModes::Backup => "Backup",
            FoxWorkModes::SelfUse => "SelfUse",
            FoxWorkModes::ForceCharge => "ForceCharge",
            FoxWorkModes::Unknown => "Unknown",
        }
    }
}

impl FromStr for FoxWorkModes {
    type Err = ();

    /// Parses a string into a `FoxWorkModes` enum variant.
    ///
    /// # Arguments
    /// * `s` - A string slice representing the work mode.
    ///
    /// # Returns
    /// * `Result<Self, Self::Err>` - The parsed work mode or an error if the string is invalid.
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "ForceDischarge" => Ok(FoxWorkModes::ForceDischarge),
            "PeakShaving" => Ok(FoxWorkModes::PeakShaving),
            "Feedin" => Ok(FoxWorkModes::Feedin),
            "Backup" => Ok(FoxWorkModes::Backup),
            "SelfUse" => Ok(FoxWorkModes::SelfUse),
            "ForceCharge" => Ok(FoxWorkModes::ForceCharge),
            _ => Ok(FoxWorkModes::Unknown),
        }
    }
}