dnp3 1.6.0

Rust implementation of DNP3 (IEEE 1815) with idiomatic bindings for C, C++, .NET, and Java
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
/// Enum representing all possible `BinaryInput` event variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum EventBinaryInputVariation {
    /// Binary Input Event - without time
    Group2Var1,
    /// Binary Input Event - with Absolute time
    Group2Var2,
    /// Binary Input Event - with Relative time
    Group2Var3,
}

/// Enum representing all possible `BinaryOutputStatus` event variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum EventBinaryOutputStatusVariation {
    /// Binary Output Event - Output Status without time
    Group11Var1,
    /// Binary Output Event - Output Status with time
    Group11Var2,
}

/// Enum representing all possible `DoubleBitBinaryInput` event variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum EventDoubleBitBinaryInputVariation {
    /// Double-bit Binary Input Event - without time
    Group4Var1,
    /// Double-bit Binary Input Event - with Absolute time
    Group4Var2,
    /// Double-bit Binary Input Event - with Relative time
    Group4Var3,
}

/// Enum representing all possible `Counter` event variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum EventCounterVariation {
    /// Counter Event - 32-bit with flag
    Group22Var1,
    /// Counter Event - 16-bit with flag
    Group22Var2,
    /// Counter Event - 32-bit with flag and time
    Group22Var5,
    /// Counter Event - 16-bit with flag and time
    Group22Var6,
}

/// Enum representing all possible `FrozenCounter` event variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum EventFrozenCounterVariation {
    /// Frozen Counter Event - 32-bit with flag
    Group23Var1,
    /// Frozen Counter Event - 16-bit with flag
    Group23Var2,
    /// Frozen Counter Event - 32-bit with flag and time
    Group23Var5,
    /// Frozen Counter Event - 16-bit with flag and time
    Group23Var6,
}

/// Enum representing all possible `AnalogInput` event variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum EventAnalogInputVariation {
    /// Analog Input Event - 32-bit with flag
    Group32Var1,
    /// Analog Input Event - 16-bit with flag
    Group32Var2,
    /// Analog Input Event - 32-bit with flag and time
    Group32Var3,
    /// Analog Input Event - 16-bit with flag and time
    Group32Var4,
    /// Analog Input Event - Single-precision with flag
    Group32Var5,
    /// Analog Input Event - Double-precision with flag
    Group32Var6,
    /// Analog Input Event - Single-precision with flag and time
    Group32Var7,
    /// Analog Input Event - Double-precision with flag and time
    Group32Var8,
}

/// Enum representing all possible `FrozenAnalogInput` event variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum EventFrozenAnalogInputVariation {
    /// Frozen Analog Input Event - 32-bit with flag
    Group33Var1,
    /// Frozen Analog Input Event - 16-bit with flag
    Group33Var2,
    /// Frozen Analog Input Event - 32-bit with flag and time
    Group33Var3,
    /// Frozen Analog Input Event - 16-bit with flag and time
    Group33Var4,
    /// Frozen Analog Input Event - Single-precision with flag
    Group33Var5,
    /// Frozen Analog Input Event - Double-precision with flag
    Group33Var6,
    /// Frozen Analog Input Event - Single-precision with flag and time
    Group33Var7,
    /// Frozen Analog Input Event - Double-precision with flag and time
    Group33Var8,
}

/// Enum representing all possible `AnalogOutputStatus` event variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum EventAnalogOutputStatusVariation {
    /// Analog Output Event - 32-bit with flag
    Group42Var1,
    /// Analog Output Event - 16-bit with flag
    Group42Var2,
    /// Analog Output Event - 32-bit with flag and time
    Group42Var3,
    /// Analog Output Event - 16-bit with flag and time
    Group42Var4,
    /// Analog Output Event - Single-precision with flag
    Group42Var5,
    /// Analog Output Event - Double-precision with flag
    Group42Var6,
    /// Analog Output Event - Single-precision with flag and time
    Group42Var7,
    /// Analog Output Event - Double-precision with flag and time
    Group42Var8,
}

// This is always g111vX
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub(crate) struct EventOctetStringVariation;

/// Enum representing all possible `BinaryInput` static variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum StaticBinaryInputVariation {
    /// Binary Input - Packed Format
    Group1Var1,
    /// Binary Input - with flags
    Group1Var2,
}

/// Enum representing all possible `BinaryOutputStatus` static variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum StaticBinaryOutputStatusVariation {
    /// Binary Output - Packed Format
    Group10Var1,
    /// Binary Output - Output Status with flags
    Group10Var2,
}

/// Enum representing all possible `DoubleBitBinaryInput` static variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum StaticDoubleBitBinaryInputVariation {
    /// Double-bit Binary Input - Packed Format
    Group3Var1,
    /// Double-bit Binary Input - with flags
    Group3Var2,
}

/// Enum representing all possible `Counter` static variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum StaticCounterVariation {
    /// Counter - 32-bit with flag
    Group20Var1,
    /// Counter - 16-bit with flag
    Group20Var2,
    /// Counter - 32-bit without flag
    Group20Var5,
    /// Counter - 16-bit without flag
    Group20Var6,
}

/// Enum representing all possible `FrozenCounter` static variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum StaticFrozenCounterVariation {
    /// Frozen Counter - 32-bit with flag
    Group21Var1,
    /// Frozen Counter - 16-bit with flag
    Group21Var2,
    /// Frozen Counter - 32-bit with flag and time
    Group21Var5,
    /// Frozen Counter - 16-bit with flag and time
    Group21Var6,
    /// Frozen Counter - 32-bit without flag
    Group21Var9,
    /// Frozen Counter - 16-bit without flag
    Group21Var10,
}

/// Enum representing all possible `AnalogInput` static variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum StaticAnalogInputVariation {
    /// Analog Input - 32-bit with flag
    Group30Var1,
    /// Analog Input - 16-bit with flag
    Group30Var2,
    /// Analog Input - 32-bit without flag
    Group30Var3,
    /// Analog Input - 16-bit without flag
    Group30Var4,
    /// Analog Input - Single-precision with flag
    Group30Var5,
    /// Analog Input - Double-precision with flag
    Group30Var6,
}

/// Enum representing all possible `FrozenAnalogInput` static variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum StaticFrozenAnalogInputVariation {
    /// Frozen Analog Input - 32-bit with flag
    Group31Var1,
    /// Frozen Analog Input - 16-bit with flag
    Group31Var2,
    /// Frozen Analog Input - 32-bit with flag and time-of-freeze
    Group31Var3,
    /// Frozen Analog Input - 32-bit with flag and time-of-freeze
    Group31Var4,
    /// Frozen Analog Input - 32-bit without flag
    Group31Var5,
    /// Frozen Analog Input - 16-bit without flag
    Group31Var6,
    /// Frozen Analog Input - Single-precision with flag
    Group31Var7,
    /// Frozen Analog Input - Double-precision with flag
    Group31Var8,
}

/// Enum representing all possible `AnalogOutputStatus` static variations
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub enum StaticAnalogOutputStatusVariation {
    /// Analog Output Status - 32-bit with flag
    Group40Var1,
    /// Analog Output Status - 16-bit with flag
    Group40Var2,
    /// Analog Output Status - Single-precision with flag
    Group40Var3,
    /// Analog Output Status - Double-precision with flag
    Group40Var4,
}

/// this is not currently public, but it could be a future release
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub(crate) enum AnalogInputDeadBandVariation {
    /// Analog Input Dead-band - 16-bit
    Group34Var1,
    /// Analog Input Dead-band - 32-bit
    Group34Var2,
    /// Analog Input Dead-band - Single-precision floating-point
    Group34Var3,
}

// This is always g110vX
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub(crate) struct StaticOctetStringVariation;

/// configuration for a `BinaryInput` point
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub struct BinaryInputConfig {
    /// default static variation
    pub s_var: StaticBinaryInputVariation,
    /// default event variation
    pub e_var: EventBinaryInputVariation,
}

/// configuration for a `DoubleBitBinaryInput` point
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub struct DoubleBitBinaryInputConfig {
    /// default static variation
    pub s_var: StaticDoubleBitBinaryInputVariation,
    /// default event variation
    pub e_var: EventDoubleBitBinaryInputVariation,
}

/// configuration for a `BinaryOutputStatus` point
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub struct BinaryOutputStatusConfig {
    /// default static variation
    pub s_var: StaticBinaryOutputStatusVariation,
    /// default event variation
    pub e_var: EventBinaryOutputStatusVariation,
}

/// configuration for a `Counter` point
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub struct CounterConfig {
    /// default static variation
    pub s_var: StaticCounterVariation,
    /// default event variation
    pub e_var: EventCounterVariation,
    /// deadband - value of 0 means that any change will trigger an event
    pub deadband: u32,
}

/// configuration for a `FrozenCounter` point
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub struct FrozenCounterConfig {
    /// default static variation
    pub s_var: StaticFrozenCounterVariation,
    /// default event variation
    pub e_var: EventFrozenCounterVariation,
    /// deadband - value of 0 means that any change will trigger an event
    pub deadband: u32,
}

/// configuration for an `AnalogInput` point
#[derive(Copy, Clone, Debug, PartialEq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub struct AnalogInputConfig {
    /// default static variation
    pub s_var: StaticAnalogInputVariation,
    /// default event variation
    pub e_var: EventAnalogInputVariation,
    /// deadband - value of 0 means that any change will trigger an event
    pub deadband: f64,
}

/// configuration for an `AnalogOutputStatus` point
#[derive(Copy, Clone, Debug, PartialEq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub struct AnalogOutputStatusConfig {
    /// default static variation
    pub s_var: StaticAnalogOutputStatusVariation,
    /// default event variation
    pub e_var: EventAnalogOutputStatusVariation,
    /// deadband - value of 0 means that any change will trigger an event
    pub deadband: f64,
}

/// Octet strings don't actually need any configuration b/c the transmitted variation is determined
/// by the size. This struct is more of a placeholder required by a couple of internal traits.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub struct OctetStringConfig;

impl BinaryInputConfig {
    /// construct a `BinaryConfig` from its fields
    pub fn new(s_var: StaticBinaryInputVariation, e_var: EventBinaryInputVariation) -> Self {
        Self { s_var, e_var }
    }
}

impl DoubleBitBinaryInputConfig {
    /// construct a `DoubleBitBinaryConfig` from its fields
    pub fn new(
        s_var: StaticDoubleBitBinaryInputVariation,
        e_var: EventDoubleBitBinaryInputVariation,
    ) -> Self {
        Self { s_var, e_var }
    }
}

impl BinaryOutputStatusConfig {
    /// construct a `BinaryOutputStatusConfig` from its fields
    pub fn new(
        s_var: StaticBinaryOutputStatusVariation,
        e_var: EventBinaryOutputStatusVariation,
    ) -> Self {
        Self { s_var, e_var }
    }
}

impl CounterConfig {
    /// construct a `CounterConfig` from its fields
    pub fn new(s_var: StaticCounterVariation, e_var: EventCounterVariation, deadband: u32) -> Self {
        Self {
            s_var,
            e_var,
            deadband,
        }
    }
}

impl FrozenCounterConfig {
    /// construct a `FrozenCounterConfig` from its fields
    pub fn new(
        s_var: StaticFrozenCounterVariation,
        e_var: EventFrozenCounterVariation,
        deadband: u32,
    ) -> Self {
        Self {
            s_var,
            e_var,
            deadband,
        }
    }
}

impl AnalogInputConfig {
    /// construct an `AnalogConfig` from its fields
    pub fn new(
        s_var: StaticAnalogInputVariation,
        e_var: EventAnalogInputVariation,
        deadband: f64,
    ) -> Self {
        Self {
            s_var,
            e_var,
            deadband,
        }
    }
}

impl AnalogOutputStatusConfig {
    /// construct an `AnalogOutputStatusConfig` from its fields
    pub fn new(
        s_var: StaticAnalogOutputStatusVariation,
        e_var: EventAnalogOutputStatusVariation,
        deadband: f64,
    ) -> Self {
        Self {
            s_var,
            e_var,
            deadband,
        }
    }
}

impl Default for BinaryInputConfig {
    fn default() -> Self {
        Self::new(
            StaticBinaryInputVariation::Group1Var1,
            EventBinaryInputVariation::Group2Var1,
        )
    }
}

impl Default for DoubleBitBinaryInputConfig {
    fn default() -> Self {
        Self::new(
            StaticDoubleBitBinaryInputVariation::Group3Var1,
            EventDoubleBitBinaryInputVariation::Group4Var1,
        )
    }
}

impl Default for BinaryOutputStatusConfig {
    fn default() -> Self {
        Self::new(
            StaticBinaryOutputStatusVariation::Group10Var1,
            EventBinaryOutputStatusVariation::Group11Var2,
        )
    }
}

impl Default for CounterConfig {
    fn default() -> Self {
        Self::new(
            StaticCounterVariation::Group20Var1,
            EventCounterVariation::Group22Var1,
            0,
        )
    }
}

impl Default for FrozenCounterConfig {
    fn default() -> Self {
        Self::new(
            StaticFrozenCounterVariation::Group21Var1,
            EventFrozenCounterVariation::Group23Var1,
            0,
        )
    }
}

impl Default for AnalogInputConfig {
    fn default() -> Self {
        Self::new(
            StaticAnalogInputVariation::Group30Var1,
            EventAnalogInputVariation::Group32Var1,
            0.0,
        )
    }
}

impl Default for AnalogOutputStatusConfig {
    fn default() -> Self {
        Self::new(
            StaticAnalogOutputStatusVariation::Group40Var1,
            EventAnalogOutputStatusVariation::Group42Var1,
            0.0,
        )
    }
}