rust-ocpp 3.0.4

ocpp 1.6, 2.0.1 and 2.1 libraries
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
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
use serde::{Deserialize, Serialize};
use validator::Validate;

use crate::v2_1::datatypes::{
    component::ComponentType, custom_data::CustomDataType,
    set_monitoring_data::SetMonitoringDataType, status_info::StatusInfoType,
    variable::VariableType,
};
use crate::v2_1::enumerations::monitor::MonitorEnumType;

/// Status returned in response to SetVariableMonitoring request.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum SetMonitoringStatusEnumType {
    Accepted,
    UnknownComponent,
    UnknownVariable,
    UnsupportedMonitorType,
    Rejected,
    Duplicate,
}

/// Class to hold result of SetVariableMonitoring request.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Validate)]
#[serde(rename_all = "camelCase")]
pub struct SetMonitoringResultType {
    /// Custom data from the Charging Station.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom_data: Option<CustomDataType>,

    /// Id given to the VariableMonitor by the Charging Station.
    /// The Id is only returned when status is accepted.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[validate(range(min = 0))]
    pub id: Option<i32>,

    /// Detailed status information.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[validate(nested)]
    pub status_info: Option<StatusInfoType>,

    /// Required. The status of the monitoring setting.
    pub status: SetMonitoringStatusEnumType,

    /// Required. The type of this monitor.
    #[serde(rename = "type")]
    pub kind: MonitorEnumType,

    /// Required. Component for which a variable is monitored.
    #[validate(nested)]
    pub component: ComponentType,

    /// Required. Variable that is monitored.
    #[validate(nested)]
    pub variable: VariableType,

    /// Required. The severity that will be assigned to an event that is triggered by this monitor.
    /// The severity range is 0-9, with 0 as the highest and 9 as the lowest severity level.
    #[validate(range(min = 0, max = 9))]
    pub severity: i32,
}

/// Request to set monitoring parameters for a variable.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Validate)]
#[serde(rename_all = "camelCase")]
pub struct SetVariableMonitoringRequest {
    /// Custom data from the CSMS.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom_data: Option<CustomDataType>,

    /// Required. List of monitoring settings to configure.
    #[validate(length(min = 1), nested)]
    pub set_monitoring_data: Vec<SetMonitoringDataType>,
}

/// Response to SetVariableMonitoring request.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Validate)]
#[serde(rename_all = "camelCase")]
pub struct SetVariableMonitoringResponse {
    /// Custom data from the Charging Station.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom_data: Option<CustomDataType>,

    /// Required. List of result statuses per monitoring setting.
    #[validate(length(min = 1), nested)]
    pub set_monitoring_result: Vec<SetMonitoringResultType>,
}

impl SetMonitoringResultType {
    /// Creates a new `SetMonitoringResultType` with required fields.
    ///
    /// # Arguments
    ///
    /// * `status` - Status of the monitoring setting
    /// * `kind` - Type of the monitor
    /// * `component` - Component for which a variable is monitored
    /// * `variable` - Variable that is monitored
    /// * `severity` - Severity level assigned to events triggered by this monitor
    ///
    /// # Returns
    ///
    /// A new instance of `SetMonitoringResultType` with optional fields set to `None`
    pub fn new(
        status: SetMonitoringStatusEnumType,
        kind: MonitorEnumType,
        component: ComponentType,
        variable: VariableType,
        severity: i32,
    ) -> Self {
        Self {
            custom_data: None,
            id: None,
            status_info: None,
            status: status.clone(),
            kind,
            component,
            variable,
            severity,
        }
    }

    /// Sets the custom data.
    ///
    /// # Arguments
    ///
    /// * `custom_data` - Custom data for this result
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn with_custom_data(mut self, custom_data: CustomDataType) -> Self {
        self.custom_data = Some(custom_data);
        self
    }

    /// Sets the monitor ID.
    ///
    /// # Arguments
    ///
    /// * `id` - ID given to the variable monitor
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn with_id(mut self, id: i32) -> Self {
        self.id = Some(id);
        self
    }

    /// Sets the status info.
    ///
    /// # Arguments
    ///
    /// * `status_info` - Detailed status information
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn with_status_info(mut self, status_info: StatusInfoType) -> Self {
        self.status_info = Some(status_info);
        self
    }

    /// Gets the custom data.
    ///
    /// # Returns
    ///
    /// An optional reference to the custom data
    pub fn custom_data(&self) -> Option<&CustomDataType> {
        self.custom_data.as_ref()
    }

    /// Sets the custom data.
    ///
    /// # Arguments
    ///
    /// * `custom_data` - Custom data for this result, or None to clear
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn set_custom_data(&mut self, custom_data: Option<CustomDataType>) -> &mut Self {
        self.custom_data = custom_data;
        self
    }

    /// Gets the ID of the monitor.
    ///
    /// # Returns
    ///
    /// The optional ID of the monitor
    pub fn id(&self) -> Option<i32> {
        self.id
    }

    /// Sets the ID of the monitor.
    ///
    /// # Arguments
    ///
    /// * `id` - The ID of the monitor, or None to clear
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn set_id(&mut self, id: Option<i32>) -> &mut Self {
        self.id = id;
        self
    }

    /// Gets the status info.
    ///
    /// # Returns
    ///
    /// Optional reference to the status info
    pub fn status_info(&self) -> Option<&StatusInfoType> {
        self.status_info.as_ref()
    }

    /// Sets the status info.
    ///
    /// # Arguments
    ///
    /// * `status_info` - Status info to set, or None to clear
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn set_status_info(&mut self, status_info: Option<StatusInfoType>) -> &mut Self {
        self.status_info = status_info;
        self
    }

    /// Gets the status.
    ///
    /// # Returns
    ///
    /// Status of the monitoring setting
    pub fn status(&self) -> &SetMonitoringStatusEnumType {
        &self.status
    }

    /// Sets the status.
    ///
    /// # Arguments
    ///
    /// * `status` - Status of the monitoring setting
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn set_status(&mut self, status: SetMonitoringStatusEnumType) -> &mut Self {
        self.status = status;
        self
    }

    /// Gets the monitor type.
    ///
    /// # Returns
    ///
    /// Type of this monitor
    pub fn kind(&self) -> &MonitorEnumType {
        &self.kind
    }

    /// Sets the monitor type.
    ///
    /// # Arguments
    ///
    /// * `kind` - Type of this monitor
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn set_kind(&mut self, kind: MonitorEnumType) -> &mut Self {
        self.kind = kind;
        self
    }

    /// Gets the component.
    ///
    /// # Returns
    ///
    /// Reference to the component for which a variable is monitored
    pub fn component(&self) -> &ComponentType {
        &self.component
    }

    /// Sets the component.
    ///
    /// # Arguments
    ///
    /// * `component` - Component for which a variable is monitored
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn set_component(&mut self, component: ComponentType) -> &mut Self {
        self.component = component;
        self
    }

    /// Gets the variable.
    ///
    /// # Returns
    ///
    /// Reference to the variable that is monitored
    pub fn variable(&self) -> &VariableType {
        &self.variable
    }

    /// Sets the variable.
    ///
    /// # Arguments
    ///
    /// * `variable` - Variable that is monitored
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn set_variable(&mut self, variable: VariableType) -> &mut Self {
        self.variable = variable;
        self
    }

    /// Gets the severity.
    ///
    /// # Returns
    ///
    /// Severity level assigned to events triggered by this monitor
    pub fn severity(&self) -> i32 {
        self.severity
    }

    /// Sets the severity.
    ///
    /// # Arguments
    ///
    /// * `severity` - Severity level to assign to events triggered by this monitor
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn set_severity(&mut self, severity: i32) -> &mut Self {
        self.severity = severity;
        self
    }
}

impl SetVariableMonitoringRequest {
    /// Creates a new `SetVariableMonitoringRequest` with required fields.
    ///
    /// # Arguments
    ///
    /// * `set_monitoring_data` - List of monitoring settings to configure
    ///
    /// # Returns
    ///
    /// A new instance of `SetVariableMonitoringRequest` with optional fields set to `None`
    pub fn new(set_monitoring_data: Vec<SetMonitoringDataType>) -> Self {
        Self {
            custom_data: None,
            set_monitoring_data,
        }
    }

    /// Sets the custom data.
    ///
    /// # Arguments
    ///
    /// * `custom_data` - Custom data for this request
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn with_custom_data(mut self, custom_data: CustomDataType) -> Self {
        self.custom_data = Some(custom_data);
        self
    }

    /// Gets the custom data.
    ///
    /// # Returns
    ///
    /// An optional reference to the custom data
    pub fn custom_data(&self) -> Option<&CustomDataType> {
        self.custom_data.as_ref()
    }

    /// Sets the custom data.
    ///
    /// # Arguments
    ///
    /// * `custom_data` - Custom data for this request, or None to clear
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn set_custom_data(&mut self, custom_data: Option<CustomDataType>) -> &mut Self {
        self.custom_data = custom_data;
        self
    }

    /// Gets the monitoring data settings.
    ///
    /// # Returns
    ///
    /// Reference to the list of monitoring settings
    pub fn set_monitoring_data(&self) -> &Vec<SetMonitoringDataType> {
        &self.set_monitoring_data
    }

    /// Sets the monitoring data settings.
    ///
    /// # Arguments
    ///
    /// * `set_monitoring_data` - List of monitoring settings to configure
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn set_set_monitoring_data(
        &mut self,
        set_monitoring_data: Vec<SetMonitoringDataType>,
    ) -> &mut Self {
        self.set_monitoring_data = set_monitoring_data;
        self
    }
}

impl SetVariableMonitoringResponse {
    /// Creates a new `SetVariableMonitoringResponse` with required fields.
    ///
    /// # Arguments
    ///
    /// * `set_monitoring_result` - List of result statuses per monitoring setting
    ///
    /// # Returns
    ///
    /// A new instance of `SetVariableMonitoringResponse` with optional fields set to `None`
    pub fn new(set_monitoring_result: Vec<SetMonitoringResultType>) -> Self {
        Self {
            custom_data: None,
            set_monitoring_result,
        }
    }

    /// Sets the custom data.
    ///
    /// # Arguments
    ///
    /// * `custom_data` - Custom data for this response
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn with_custom_data(mut self, custom_data: CustomDataType) -> Self {
        self.custom_data = Some(custom_data);
        self
    }

    /// Gets the custom data.
    ///
    /// # Returns
    ///
    /// An optional reference to the custom data
    pub fn custom_data(&self) -> Option<&CustomDataType> {
        self.custom_data.as_ref()
    }

    /// Sets the custom data.
    ///
    /// # Arguments
    ///
    /// * `custom_data` - Custom data for this response, or None to clear
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn set_custom_data(&mut self, custom_data: Option<CustomDataType>) -> &mut Self {
        self.custom_data = custom_data;
        self
    }

    /// Gets the monitoring result settings.
    ///
    /// # Returns
    ///
    /// Reference to the list of result statuses
    pub fn set_monitoring_result(&self) -> &Vec<SetMonitoringResultType> {
        &self.set_monitoring_result
    }

    /// Sets the monitoring result settings.
    ///
    /// # Arguments
    ///
    /// * `set_monitoring_result` - List of result statuses per monitoring setting
    ///
    /// # Returns
    ///
    /// Self reference for method chaining
    pub fn set_set_monitoring_result(
        &mut self,
        set_monitoring_result: Vec<SetMonitoringResultType>,
    ) -> &mut Self {
        self.set_monitoring_result = set_monitoring_result;
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::v2_1::enumerations::monitor::MonitorEnumType;
    use rust_decimal::prelude::*;
    use serde_json::json;

    #[test]
    fn test_set_monitoring_result_type() {
        let component = ComponentType::new("component1".to_string());
        let variable =
            VariableType::new_with_instance("variable1".to_string(), "instance1".to_string());
        let kind = MonitorEnumType::UpperThreshold;
        let severity = 2;
        let status = SetMonitoringStatusEnumType::Accepted;

        let result = SetMonitoringResultType::new(
            status.clone(),
            kind.clone(),
            component.clone(),
            variable.clone(),
            severity,
        );

        assert_eq!(result.status(), &status);
        assert_eq!(result.kind(), &kind);
        assert_eq!(result.component(), &component);
        assert_eq!(result.variable(), &variable);
        assert_eq!(result.severity(), severity);
        assert_eq!(result.id(), None);
        assert_eq!(result.status_info(), None);
        assert_eq!(result.custom_data(), None);
    }

    #[test]
    fn test_set_variable_monitoring_request() {
        let component = ComponentType::new("component1".to_string());
        let variable =
            VariableType::new_with_instance("variable1".to_string(), "instance1".to_string());
        let value = Decimal::from_str("100.0").unwrap();
        let kind = MonitorEnumType::UpperThreshold;
        let severity = 2;

        let monitoring_data = SetMonitoringDataType::new(
            value,
            kind.clone(),
            severity,
            component.clone(),
            variable.clone(),
        );

        let request = SetVariableMonitoringRequest::new(vec![monitoring_data.clone()]);

        assert_eq!(request.set_monitoring_data().len(), 1);
        assert_eq!(request.set_monitoring_data()[0], monitoring_data);
        assert_eq!(request.custom_data(), None);
    }

    #[test]
    fn test_set_variable_monitoring_response() {
        let component = ComponentType::new("component1".to_string());
        let variable =
            VariableType::new_with_instance("variable1".to_string(), "instance1".to_string());
        let kind = MonitorEnumType::UpperThreshold;
        let severity = 2;
        let status = SetMonitoringStatusEnumType::Accepted;

        let result = SetMonitoringResultType::new(
            status,
            kind.clone(),
            component.clone(),
            variable.clone(),
            severity,
        );

        let response = SetVariableMonitoringResponse::new(vec![result.clone()]);

        assert_eq!(response.set_monitoring_result().len(), 1);
        assert_eq!(response.set_monitoring_result()[0], result);
        assert_eq!(response.custom_data(), None);
    }

    #[test]
    fn test_with_methods() {
        let component = ComponentType::new("component1".to_string());
        let variable =
            VariableType::new_with_instance("variable1".to_string(), "instance1".to_string());
        let kind = MonitorEnumType::UpperThreshold;
        let severity = 2;
        let status = SetMonitoringStatusEnumType::Accepted;
        let id = 42;
        let custom_data = CustomDataType::new("VendorX".to_string());
        let status_info = StatusInfoType::new("Info".to_string());

        let result = SetMonitoringResultType::new(
            status.clone(),
            kind.clone(),
            component.clone(),
            variable.clone(),
            severity,
        )
        .with_id(id)
        .with_custom_data(custom_data.clone())
        .with_status_info(status_info.clone());

        assert_eq!(result.status(), &status);
        assert_eq!(result.kind(), &kind);
        assert_eq!(result.component(), &component);
        assert_eq!(result.variable(), &variable);
        assert_eq!(result.severity(), severity);
        assert_eq!(result.id(), Some(id));
        assert_eq!(result.status_info(), Some(&status_info));
        assert_eq!(result.custom_data(), Some(&custom_data));
    }

    #[test]
    fn test_serialization() {
        let component = ComponentType::new("component1".to_string());
        let variable =
            VariableType::new_with_instance("variable1".to_string(), "instance1".to_string());
        let value = Decimal::from_str("100.0").unwrap();
        let kind = MonitorEnumType::UpperThreshold;
        let severity = 2;
        let status = SetMonitoringStatusEnumType::Accepted;
        let id = 42;
        let custom_data = CustomDataType::new("VendorX".to_string())
            .with_property("version".to_string(), json!("1.0"));

        let monitoring_data = SetMonitoringDataType::new(
            value,
            kind.clone(),
            severity,
            component.clone(),
            variable.clone(),
        );

        let request = SetVariableMonitoringRequest::new(vec![monitoring_data])
            .with_custom_data(custom_data.clone());

        let result = SetMonitoringResultType::new(status, kind, component, variable, severity)
            .with_id(id)
            .with_custom_data(custom_data);

        let response = SetVariableMonitoringResponse::new(vec![result]);

        let serialized_request = serde_json::to_string(&request).unwrap();
        let deserialized_request: SetVariableMonitoringRequest =
            serde_json::from_str(&serialized_request).unwrap();
        assert_eq!(request, deserialized_request);

        let serialized_response = serde_json::to_string(&response).unwrap();
        let deserialized_response: SetVariableMonitoringResponse =
            serde_json::from_str(&serialized_response).unwrap();
        assert_eq!(response, deserialized_response);
    }
}