sunspec 0.9.0

SunSpec 1.1 compliant library with tokio support
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
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

//! Nameplate
/// Type alias for [`Nameplate`].
pub type Model120 = Nameplate;
/// Nameplate
///
/// Inverter Controls Nameplate Ratings
///
/// Detail: Ref 3: 8.14.3.2, Ref 4: 17
#[derive(Debug)]
#[cfg_attr(feature = "serde", derive(::serde::Serialize, ::serde::Deserialize))]
pub struct Nameplate {
    /// DERTyp
    ///
    /// Type of DER device. Default value is 4 to indicate PV device.
    pub der_typ: DerTyp,
    /// WRtg
    ///
    /// Continuous power output capability of the inverter.
    pub w_rtg: u16,
    /// WRtg_SF
    ///
    /// Scale factor
    pub w_rtg_sf: i16,
    /// VARtg
    ///
    /// Continuous Volt-Ampere capability of the inverter.
    pub va_rtg: u16,
    /// VARtg_SF
    ///
    /// Scale factor
    pub va_rtg_sf: i16,
    /// VArRtgQ1
    ///
    /// Continuous VAR capability of the inverter in quadrant 1.
    pub v_ar_rtg_q1: i16,
    /// VArRtgQ2
    ///
    /// Continuous VAR capability of the inverter in quadrant 2.
    pub v_ar_rtg_q2: i16,
    /// VArRtgQ3
    ///
    /// Continuous VAR capability of the inverter in quadrant 3.
    pub v_ar_rtg_q3: i16,
    /// VArRtgQ4
    ///
    /// Continuous VAR capability of the inverter in quadrant 4.
    pub v_ar_rtg_q4: i16,
    /// VArRtg_SF
    ///
    /// Scale factor
    pub v_ar_rtg_sf: i16,
    /// ARtg
    ///
    /// Maximum RMS AC current level capability of the inverter.
    ///
    /// Detail: Sum of all connected phases.  Current rating under nominal voltage under nominal power factor.
    pub a_rtg: u16,
    /// ARtg_SF
    ///
    /// Scale factor
    pub a_rtg_sf: i16,
    /// PFRtgQ1
    ///
    /// Minimum power factor capability of the inverter in quadrant 1.
    ///
    /// Detail: EEI sign convention.
    pub pf_rtg_q1: i16,
    /// PFRtgQ2
    ///
    /// Minimum power factor capability of the inverter in quadrant 2.
    ///
    /// Detail: EEI sign convention.
    pub pf_rtg_q2: i16,
    /// PFRtgQ3
    ///
    /// Minimum power factor capability of the inverter in quadrant 3.
    ///
    /// Detail: EEI sign convention.
    pub pf_rtg_q3: i16,
    /// PFRtgQ4
    ///
    /// Minimum power factor capability of the inverter in quadrant 4.
    ///
    /// Detail: EEI sign convention.
    pub pf_rtg_q4: i16,
    /// PFRtg_SF
    ///
    /// Scale factor
    pub pf_rtg_sf: i16,
    /// WHRtg
    ///
    /// Nominal energy rating of storage device.
    pub wh_rtg: Option<u16>,
    /// WHRtg_SF
    ///
    /// Scale factor
    pub wh_rtg_sf: Option<i16>,
    /// AhrRtg
    ///
    /// The usable capacity of the battery.  Maximum charge minus minimum charge from a technology capability perspective (Amp-hour capacity rating).
    pub ahr_rtg: Option<u16>,
    /// AhrRtg_SF
    ///
    /// Scale factor for amp-hour rating.
    pub ahr_rtg_sf: Option<i16>,
    /// MaxChaRte
    ///
    /// Maximum rate of energy transfer into the storage device.
    pub max_cha_rte: Option<u16>,
    /// MaxChaRte_SF
    ///
    /// Scale factor
    pub max_cha_rte_sf: Option<i16>,
    /// MaxDisChaRte
    ///
    /// Maximum rate of energy transfer out of the storage device.
    pub max_dis_cha_rte: Option<u16>,
    /// MaxDisChaRte_SF
    ///
    /// Scale factor
    pub max_dis_cha_rte_sf: Option<i16>,
}
#[allow(missing_docs)]
impl Nameplate {
    pub const DER_TYP: crate::Point<Self, DerTyp> = crate::Point::new(0, 1, false);
    pub const W_RTG: crate::Point<Self, u16> = crate::Point::new(1, 1, false);
    pub const W_RTG_SF: crate::Point<Self, i16> = crate::Point::new(2, 1, false);
    pub const VA_RTG: crate::Point<Self, u16> = crate::Point::new(3, 1, false);
    pub const VA_RTG_SF: crate::Point<Self, i16> = crate::Point::new(4, 1, false);
    pub const V_AR_RTG_Q1: crate::Point<Self, i16> = crate::Point::new(5, 1, false);
    pub const V_AR_RTG_Q2: crate::Point<Self, i16> = crate::Point::new(6, 1, false);
    pub const V_AR_RTG_Q3: crate::Point<Self, i16> = crate::Point::new(7, 1, false);
    pub const V_AR_RTG_Q4: crate::Point<Self, i16> = crate::Point::new(8, 1, false);
    pub const V_AR_RTG_SF: crate::Point<Self, i16> = crate::Point::new(9, 1, false);
    pub const A_RTG: crate::Point<Self, u16> = crate::Point::new(10, 1, false);
    pub const A_RTG_SF: crate::Point<Self, i16> = crate::Point::new(11, 1, false);
    pub const PF_RTG_Q1: crate::Point<Self, i16> = crate::Point::new(12, 1, false);
    pub const PF_RTG_Q2: crate::Point<Self, i16> = crate::Point::new(13, 1, false);
    pub const PF_RTG_Q3: crate::Point<Self, i16> = crate::Point::new(14, 1, false);
    pub const PF_RTG_Q4: crate::Point<Self, i16> = crate::Point::new(15, 1, false);
    pub const PF_RTG_SF: crate::Point<Self, i16> = crate::Point::new(16, 1, false);
    pub const WH_RTG: crate::Point<Self, Option<u16>> = crate::Point::new(17, 1, false);
    pub const WH_RTG_SF: crate::Point<Self, Option<i16>> = crate::Point::new(18, 1, false);
    pub const AHR_RTG: crate::Point<Self, Option<u16>> = crate::Point::new(19, 1, false);
    pub const AHR_RTG_SF: crate::Point<Self, Option<i16>> = crate::Point::new(20, 1, false);
    pub const MAX_CHA_RTE: crate::Point<Self, Option<u16>> = crate::Point::new(21, 1, false);
    pub const MAX_CHA_RTE_SF: crate::Point<Self, Option<i16>> = crate::Point::new(22, 1, false);
    pub const MAX_DIS_CHA_RTE: crate::Point<Self, Option<u16>> = crate::Point::new(23, 1, false);
    pub const MAX_DIS_CHA_RTE_SF: crate::Point<Self, Option<i16>> = crate::Point::new(24, 1, false);
}
impl crate::Group for Nameplate {
    const LEN: u16 = 26;
}
impl Nameplate {
    fn parse_group(data: &[u16]) -> Result<(&[u16], Self), crate::DecodeError> {
        let nested_data = data
            .get(usize::from(<Self as crate::Group>::LEN)..)
            .unwrap_or(&[]);
        Ok((
            nested_data,
            Self {
                der_typ: Self::DER_TYP.from_data(data)?,
                w_rtg: Self::W_RTG.from_data(data)?,
                w_rtg_sf: Self::W_RTG_SF.from_data(data)?,
                va_rtg: Self::VA_RTG.from_data(data)?,
                va_rtg_sf: Self::VA_RTG_SF.from_data(data)?,
                v_ar_rtg_q1: Self::V_AR_RTG_Q1.from_data(data)?,
                v_ar_rtg_q2: Self::V_AR_RTG_Q2.from_data(data)?,
                v_ar_rtg_q3: Self::V_AR_RTG_Q3.from_data(data)?,
                v_ar_rtg_q4: Self::V_AR_RTG_Q4.from_data(data)?,
                v_ar_rtg_sf: Self::V_AR_RTG_SF.from_data(data)?,
                a_rtg: Self::A_RTG.from_data(data)?,
                a_rtg_sf: Self::A_RTG_SF.from_data(data)?,
                pf_rtg_q1: Self::PF_RTG_Q1.from_data(data)?,
                pf_rtg_q2: Self::PF_RTG_Q2.from_data(data)?,
                pf_rtg_q3: Self::PF_RTG_Q3.from_data(data)?,
                pf_rtg_q4: Self::PF_RTG_Q4.from_data(data)?,
                pf_rtg_sf: Self::PF_RTG_SF.from_data(data)?,
                wh_rtg: Self::WH_RTG.from_data(data)?,
                wh_rtg_sf: Self::WH_RTG_SF.from_data(data)?,
                ahr_rtg: Self::AHR_RTG.from_data(data)?,
                ahr_rtg_sf: Self::AHR_RTG_SF.from_data(data)?,
                max_cha_rte: Self::MAX_CHA_RTE.from_data(data)?,
                max_cha_rte_sf: Self::MAX_CHA_RTE_SF.from_data(data)?,
                max_dis_cha_rte: Self::MAX_DIS_CHA_RTE.from_data(data)?,
                max_dis_cha_rte_sf: Self::MAX_DIS_CHA_RTE_SF.from_data(data)?,
            },
        ))
    }
}
/// DERTyp
///
/// Type of DER device. Default value is 4 to indicate PV device.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(::serde::Serialize, ::serde::Deserialize))]
pub enum DerTyp {
    #[allow(missing_docs)]
    Pv,
    #[allow(missing_docs)]
    PvStor,
    /// Raw enum value not defined by the SunSpec model.
    Invalid(u16),
}
impl crate::EnumValue for DerTyp {
    type Repr = u16;
    const INVALID: Self::Repr = 65535;
    fn from_repr(value: Self::Repr) -> Self {
        match value {
            4 => Self::Pv,
            82 => Self::PvStor,
            value => Self::Invalid(value),
        }
    }
    fn to_repr(self) -> Self::Repr {
        match self {
            Self::Pv => 4,
            Self::PvStor => 82,
            Self::Invalid(value) => value,
        }
    }
}
impl crate::FixedSize for DerTyp {
    const SIZE: u16 = 1u16;
    const INVALID: Self = Self::Invalid(65535);
    fn is_invalid(&self) -> bool {
        matches!(self, Self::Invalid(_))
    }
}
impl crate::Model for Nameplate {
    const ID: u16 = 120;
    fn addr(models: &crate::Models) -> crate::ModelAddr<Self> {
        models.m120
    }
    fn parse(data: &[u16]) -> Result<Self, crate::ParseError<Self>> {
        let (_, model) = Self::parse_group(data)?;
        Ok(model)
    }
}