sunspec 0.8.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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
//! Secure Dataset Read Response
/// Secure Dataset Read Response
///
/// Compute a digital signature over a specified set of data registers
#[derive(Debug)]
#[cfg_attr(feature = "serde", derive(::serde::Serialize, ::serde::Deserialize))]
pub struct Model4 {
    /// Request Sequence
    ///
    /// Sequence number from the request
    pub rq_seq: u16,
    /// Status
    ///
    /// Status of last read operation
    pub sts: Sts,
    /// X
    ///
    /// Number of values from the request
    ///
    /// Notes: A max of 50 values are allocated
    pub x: u16,
    /// Value1
    ///
    /// Copy of value from register Off1.
    ///
    /// Notes: Unused values shall return 0xFFFF (unimplemented)
    pub val1: u16,
    #[allow(missing_docs)]
    pub val2: u16,
    #[allow(missing_docs)]
    pub val3: u16,
    #[allow(missing_docs)]
    pub val4: u16,
    #[allow(missing_docs)]
    pub val5: u16,
    #[allow(missing_docs)]
    pub val6: u16,
    #[allow(missing_docs)]
    pub val7: u16,
    #[allow(missing_docs)]
    pub val8: u16,
    #[allow(missing_docs)]
    pub val9: u16,
    #[allow(missing_docs)]
    pub val10: u16,
    #[allow(missing_docs)]
    pub val11: u16,
    #[allow(missing_docs)]
    pub val12: u16,
    #[allow(missing_docs)]
    pub val13: u16,
    #[allow(missing_docs)]
    pub val14: u16,
    #[allow(missing_docs)]
    pub val15: u16,
    #[allow(missing_docs)]
    pub val16: u16,
    #[allow(missing_docs)]
    pub val17: u16,
    #[allow(missing_docs)]
    pub val18: u16,
    #[allow(missing_docs)]
    pub val19: u16,
    #[allow(missing_docs)]
    pub val20: u16,
    #[allow(missing_docs)]
    pub val21: u16,
    #[allow(missing_docs)]
    pub val22: u16,
    #[allow(missing_docs)]
    pub val23: u16,
    #[allow(missing_docs)]
    pub val24: u16,
    #[allow(missing_docs)]
    pub val25: u16,
    #[allow(missing_docs)]
    pub val26: u16,
    #[allow(missing_docs)]
    pub val27: u16,
    #[allow(missing_docs)]
    pub val28: u16,
    #[allow(missing_docs)]
    pub val29: u16,
    #[allow(missing_docs)]
    pub val30: u16,
    #[allow(missing_docs)]
    pub val31: u16,
    #[allow(missing_docs)]
    pub val32: u16,
    #[allow(missing_docs)]
    pub val33: u16,
    #[allow(missing_docs)]
    pub val34: u16,
    #[allow(missing_docs)]
    pub val35: u16,
    #[allow(missing_docs)]
    pub val36: u16,
    #[allow(missing_docs)]
    pub val37: u16,
    #[allow(missing_docs)]
    pub val38: u16,
    #[allow(missing_docs)]
    pub val39: u16,
    #[allow(missing_docs)]
    pub val40: u16,
    #[allow(missing_docs)]
    pub val41: u16,
    #[allow(missing_docs)]
    pub val42: u16,
    #[allow(missing_docs)]
    pub val43: u16,
    #[allow(missing_docs)]
    pub val44: u16,
    #[allow(missing_docs)]
    pub val45: u16,
    #[allow(missing_docs)]
    pub val46: u16,
    #[allow(missing_docs)]
    pub val47: u16,
    #[allow(missing_docs)]
    pub val48: u16,
    #[allow(missing_docs)]
    pub val49: u16,
    #[allow(missing_docs)]
    pub val50: u16,
    /// Timestamp
    ///
    /// Timestamp value is the number of seconds since January 1, 2000
    pub ts: u32,
    /// Milliseconds
    ///
    /// Millisecond counter 0-999
    pub ms: u16,
    /// Sequence
    ///
    /// Sequence number of response
    ///
    /// Notes: Shall be advanced for each response
    pub seq: u16,
    /// Alarm
    ///
    /// Bitmask alarm code
    pub alm: Alm,
    /// Algorithm
    ///
    /// Algorithm used to compute the digital signature
    ///
    /// Notes: For future proof
    pub alg: Alg,
    /// N
    ///
    /// Number of registers comprising the digital signature.
    ///
    /// Notes: The value of N must be at least 4 (64 bits)
    pub n: u16,
}
#[allow(missing_docs)]
impl Model4 {
    pub const RQ_SEQ: crate::Point<Self, u16> = crate::Point::new(0, 1, false);
    pub const STS: crate::Point<Self, Sts> = crate::Point::new(1, 1, false);
    pub const X: crate::Point<Self, u16> = crate::Point::new(2, 1, false);
    pub const VAL1: crate::Point<Self, u16> = crate::Point::new(3, 1, false);
    pub const VAL2: crate::Point<Self, u16> = crate::Point::new(4, 1, false);
    pub const VAL3: crate::Point<Self, u16> = crate::Point::new(5, 1, false);
    pub const VAL4: crate::Point<Self, u16> = crate::Point::new(6, 1, false);
    pub const VAL5: crate::Point<Self, u16> = crate::Point::new(7, 1, false);
    pub const VAL6: crate::Point<Self, u16> = crate::Point::new(8, 1, false);
    pub const VAL7: crate::Point<Self, u16> = crate::Point::new(9, 1, false);
    pub const VAL8: crate::Point<Self, u16> = crate::Point::new(10, 1, false);
    pub const VAL9: crate::Point<Self, u16> = crate::Point::new(11, 1, false);
    pub const VAL10: crate::Point<Self, u16> = crate::Point::new(12, 1, false);
    pub const VAL11: crate::Point<Self, u16> = crate::Point::new(13, 1, false);
    pub const VAL12: crate::Point<Self, u16> = crate::Point::new(14, 1, false);
    pub const VAL13: crate::Point<Self, u16> = crate::Point::new(15, 1, false);
    pub const VAL14: crate::Point<Self, u16> = crate::Point::new(16, 1, false);
    pub const VAL15: crate::Point<Self, u16> = crate::Point::new(17, 1, false);
    pub const VAL16: crate::Point<Self, u16> = crate::Point::new(18, 1, false);
    pub const VAL17: crate::Point<Self, u16> = crate::Point::new(19, 1, false);
    pub const VAL18: crate::Point<Self, u16> = crate::Point::new(20, 1, false);
    pub const VAL19: crate::Point<Self, u16> = crate::Point::new(21, 1, false);
    pub const VAL20: crate::Point<Self, u16> = crate::Point::new(22, 1, false);
    pub const VAL21: crate::Point<Self, u16> = crate::Point::new(23, 1, false);
    pub const VAL22: crate::Point<Self, u16> = crate::Point::new(24, 1, false);
    pub const VAL23: crate::Point<Self, u16> = crate::Point::new(25, 1, false);
    pub const VAL24: crate::Point<Self, u16> = crate::Point::new(26, 1, false);
    pub const VAL25: crate::Point<Self, u16> = crate::Point::new(27, 1, false);
    pub const VAL26: crate::Point<Self, u16> = crate::Point::new(28, 1, false);
    pub const VAL27: crate::Point<Self, u16> = crate::Point::new(29, 1, false);
    pub const VAL28: crate::Point<Self, u16> = crate::Point::new(30, 1, false);
    pub const VAL29: crate::Point<Self, u16> = crate::Point::new(31, 1, false);
    pub const VAL30: crate::Point<Self, u16> = crate::Point::new(32, 1, false);
    pub const VAL31: crate::Point<Self, u16> = crate::Point::new(33, 1, false);
    pub const VAL32: crate::Point<Self, u16> = crate::Point::new(34, 1, false);
    pub const VAL33: crate::Point<Self, u16> = crate::Point::new(35, 1, false);
    pub const VAL34: crate::Point<Self, u16> = crate::Point::new(36, 1, false);
    pub const VAL35: crate::Point<Self, u16> = crate::Point::new(37, 1, false);
    pub const VAL36: crate::Point<Self, u16> = crate::Point::new(38, 1, false);
    pub const VAL37: crate::Point<Self, u16> = crate::Point::new(39, 1, false);
    pub const VAL38: crate::Point<Self, u16> = crate::Point::new(40, 1, false);
    pub const VAL39: crate::Point<Self, u16> = crate::Point::new(41, 1, false);
    pub const VAL40: crate::Point<Self, u16> = crate::Point::new(42, 1, false);
    pub const VAL41: crate::Point<Self, u16> = crate::Point::new(43, 1, false);
    pub const VAL42: crate::Point<Self, u16> = crate::Point::new(44, 1, false);
    pub const VAL43: crate::Point<Self, u16> = crate::Point::new(45, 1, false);
    pub const VAL44: crate::Point<Self, u16> = crate::Point::new(46, 1, false);
    pub const VAL45: crate::Point<Self, u16> = crate::Point::new(47, 1, false);
    pub const VAL46: crate::Point<Self, u16> = crate::Point::new(48, 1, false);
    pub const VAL47: crate::Point<Self, u16> = crate::Point::new(49, 1, false);
    pub const VAL48: crate::Point<Self, u16> = crate::Point::new(50, 1, false);
    pub const VAL49: crate::Point<Self, u16> = crate::Point::new(51, 1, false);
    pub const VAL50: crate::Point<Self, u16> = crate::Point::new(52, 1, false);
    pub const TS: crate::Point<Self, u32> = crate::Point::new(53, 2, false);
    pub const MS: crate::Point<Self, u16> = crate::Point::new(55, 1, false);
    pub const SEQ: crate::Point<Self, u16> = crate::Point::new(56, 1, false);
    pub const ALM: crate::Point<Self, Alm> = crate::Point::new(57, 1, false);
    pub const ALG: crate::Point<Self, Alg> = crate::Point::new(58, 1, false);
    pub const N: crate::Point<Self, u16> = crate::Point::new(59, 1, false);
}
impl crate::Model for Model4 {
    const ID: u16 = 4;
    fn from_data(data: &[u16]) -> Result<Self, crate::DecodeError> {
        Ok(Self {
            rq_seq: Self::RQ_SEQ.from_data(data)?,
            sts: Self::STS.from_data(data)?,
            x: Self::X.from_data(data)?,
            val1: Self::VAL1.from_data(data)?,
            val2: Self::VAL2.from_data(data)?,
            val3: Self::VAL3.from_data(data)?,
            val4: Self::VAL4.from_data(data)?,
            val5: Self::VAL5.from_data(data)?,
            val6: Self::VAL6.from_data(data)?,
            val7: Self::VAL7.from_data(data)?,
            val8: Self::VAL8.from_data(data)?,
            val9: Self::VAL9.from_data(data)?,
            val10: Self::VAL10.from_data(data)?,
            val11: Self::VAL11.from_data(data)?,
            val12: Self::VAL12.from_data(data)?,
            val13: Self::VAL13.from_data(data)?,
            val14: Self::VAL14.from_data(data)?,
            val15: Self::VAL15.from_data(data)?,
            val16: Self::VAL16.from_data(data)?,
            val17: Self::VAL17.from_data(data)?,
            val18: Self::VAL18.from_data(data)?,
            val19: Self::VAL19.from_data(data)?,
            val20: Self::VAL20.from_data(data)?,
            val21: Self::VAL21.from_data(data)?,
            val22: Self::VAL22.from_data(data)?,
            val23: Self::VAL23.from_data(data)?,
            val24: Self::VAL24.from_data(data)?,
            val25: Self::VAL25.from_data(data)?,
            val26: Self::VAL26.from_data(data)?,
            val27: Self::VAL27.from_data(data)?,
            val28: Self::VAL28.from_data(data)?,
            val29: Self::VAL29.from_data(data)?,
            val30: Self::VAL30.from_data(data)?,
            val31: Self::VAL31.from_data(data)?,
            val32: Self::VAL32.from_data(data)?,
            val33: Self::VAL33.from_data(data)?,
            val34: Self::VAL34.from_data(data)?,
            val35: Self::VAL35.from_data(data)?,
            val36: Self::VAL36.from_data(data)?,
            val37: Self::VAL37.from_data(data)?,
            val38: Self::VAL38.from_data(data)?,
            val39: Self::VAL39.from_data(data)?,
            val40: Self::VAL40.from_data(data)?,
            val41: Self::VAL41.from_data(data)?,
            val42: Self::VAL42.from_data(data)?,
            val43: Self::VAL43.from_data(data)?,
            val44: Self::VAL44.from_data(data)?,
            val45: Self::VAL45.from_data(data)?,
            val46: Self::VAL46.from_data(data)?,
            val47: Self::VAL47.from_data(data)?,
            val48: Self::VAL48.from_data(data)?,
            val49: Self::VAL49.from_data(data)?,
            val50: Self::VAL50.from_data(data)?,
            ts: Self::TS.from_data(data)?,
            ms: Self::MS.from_data(data)?,
            seq: Self::SEQ.from_data(data)?,
            alm: Self::ALM.from_data(data)?,
            alg: Self::ALG.from_data(data)?,
            n: Self::N.from_data(data)?,
        })
    }
    fn addr(models: &crate::Models) -> crate::ModelAddr<Self> {
        models.m4
    }
}
/// Status
///
/// Status of last read operation
#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::FromRepr)]
#[cfg_attr(feature = "serde", derive(::serde::Serialize, ::serde::Deserialize))]
#[repr(u16)]
pub enum Sts {
    #[allow(missing_docs)]
    Success = 0,
    #[allow(missing_docs)]
    Ds = 1,
    /// Notes: One or more registers were not writable by this role
    Acl = 2,
    /// Notes: Offset out of range or missing from multi-register value
    Off = 3,
}
impl crate::Value for Sts {
    fn decode(data: &[u16]) -> Result<Self, crate::DecodeError> {
        let value = u16::decode(data)?;
        Self::from_repr(value).ok_or(crate::DecodeError::InvalidEnumValue)
    }
    fn encode(self) -> Box<[u16]> {
        (self as u16).encode()
    }
}
impl crate::Value for Option<Sts> {
    fn decode(data: &[u16]) -> Result<Self, crate::DecodeError> {
        let value = u16::decode(data)?;
        if value != 65535 {
            Ok(Some(
                Sts::from_repr(value).ok_or(crate::DecodeError::InvalidEnumValue)?,
            ))
        } else {
            Ok(None)
        }
    }
    fn encode(self) -> Box<[u16]> {
        if let Some(value) = self {
            value.encode()
        } else {
            65535.encode()
        }
    }
}
/// Alarm
///
/// Bitmask alarm code
#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::FromRepr)]
#[cfg_attr(feature = "serde", derive(::serde::Serialize, ::serde::Deserialize))]
#[repr(u16)]
pub enum Alm {
    #[allow(missing_docs)]
    None = 0,
    /// Notes: Tampered
    Alm = 1,
}
impl crate::Value for Alm {
    fn decode(data: &[u16]) -> Result<Self, crate::DecodeError> {
        let value = u16::decode(data)?;
        Self::from_repr(value).ok_or(crate::DecodeError::InvalidEnumValue)
    }
    fn encode(self) -> Box<[u16]> {
        (self as u16).encode()
    }
}
impl crate::Value for Option<Alm> {
    fn decode(data: &[u16]) -> Result<Self, crate::DecodeError> {
        let value = u16::decode(data)?;
        if value != 65535 {
            Ok(Some(
                Alm::from_repr(value).ok_or(crate::DecodeError::InvalidEnumValue)?,
            ))
        } else {
            Ok(None)
        }
    }
    fn encode(self) -> Box<[u16]> {
        if let Some(value) = self {
            value.encode()
        } else {
            65535.encode()
        }
    }
}
/// Algorithm
///
/// Algorithm used to compute the digital signature
///
/// Notes: For future proof
#[derive(Copy, Clone, Debug, Eq, PartialEq, strum::FromRepr)]
#[cfg_attr(feature = "serde", derive(::serde::Serialize, ::serde::Deserialize))]
#[repr(u16)]
pub enum Alg {
    /// Notes: For test purposes only
    None = 0,
    #[allow(missing_docs)]
    AesGmac64 = 1,
    #[allow(missing_docs)]
    Ecc256 = 2,
}
impl crate::Value for Alg {
    fn decode(data: &[u16]) -> Result<Self, crate::DecodeError> {
        let value = u16::decode(data)?;
        Self::from_repr(value).ok_or(crate::DecodeError::InvalidEnumValue)
    }
    fn encode(self) -> Box<[u16]> {
        (self as u16).encode()
    }
}
impl crate::Value for Option<Alg> {
    fn decode(data: &[u16]) -> Result<Self, crate::DecodeError> {
        let value = u16::decode(data)?;
        if value != 65535 {
            Ok(Some(
                Alg::from_repr(value).ok_or(crate::DecodeError::InvalidEnumValue)?,
            ))
        } else {
            Ok(None)
        }
    }
    fn encode(self) -> Box<[u16]> {
        if let Some(value) = self {
            value.encode()
        } else {
            65535.encode()
        }
    }
}