redispatch-xml 0.5.0

Redispatch 2.0 XML/XSD format parsing and validation for the German electricity grid (CIM/ENTSO-E-based, per BDEW specifications)
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

//! `redispatch-xml` — Redispatch 2.0 XML/XSD format parsing and validation
//! for the German electricity grid (§§ 13, 13a, 14 EnWG).
//!
//! # Domain background
//!
//! **Redispatch 2.0** entered into force on **1 October 2021** via the
//! Netzausbaubeschleunigungsgesetz (NABEG) and requires all German grid
//! operators to coordinate congestion management across transmission and
//! distribution networks. It covers:
//!
//! - All renewable-energy (EE) and combined heat-and-power (KWK) plants
//!   with ≥ 100 kW installed capacity
//! - All installations permanently remote-controllable by a grid operator
//!   (e.g. via Smart-Meter-Gateway)
//!
//! # Format family
//!
//! Redispatch 2.0 uses CIM/IEC 62325-based XML documents for the primary data
//! exchange between TSOs, DSOs, and balance responsible parties. Documents are
//! validated against BDEW-published XSD schemas (topicGroupId 25 in the BDEW
//! MaKo document API).
//!
//! | Document type | XSD version | Valid from |
//! |---|---|---|
//! | `ActivationDocument` | 1.1f | 2025-10-01 |
//! | `PlannedResourceScheduleDocument` | 1.0f | 2025-10-01 |
//! | `AcknowledgementDocument` | 1.0f | 2025-10-01 |
//! | `Stammdaten` | 1.4b | 2025-10-01 |
//! | `StatusRequest_MarketDocument` | 1.1 | 2025-10-01 |
//! | `Unavailability_MarketDocument` | 1.1b | 2025-10-01 |
//! | `Kaskade` | 1.0 | 2025-10-01 |
//! | `NetworkConstraintDocument` | 1.1b | 2025-10-01 |
//! | `Kostenblatt` | 1.0d | 2025-10-01 |
//!
//! These are **not** EDIFACT. IFTSTA status messages for the Redispatch 2.0
//! workflow are handled separately by the `edi-energy` crate.
//!
//! # Market roles
//!
//! | Role | Abbrev. | Description |
//! |------|---------|-------------|
//! | Übertragungsnetzbetreiber | ÜNB | Transmission system operator |
//! | Verteilnetzbetreiber | VNB | Distribution system operator |
//! | Anlagenbetreiber | ANB | Generation asset operator |
//! | Direktvermarkter | DV | Direct marketer of renewable energy |
//! | Bilanzkreisverantwortlicher | BKV | Balance responsible party |
//!
//! # Quick start
//!
//! ```rust,no_run
//! use redispatch_xml::{parse, Document};
//!
//! let xml: &[u8] = b"<ActivationDocument xmlns=\"urn:entsoe.eu:wgedi:errp:activationdocument:5:0\">...</ActivationDocument>";
//! match parse(xml) {
//!     Ok(Document::Activation(doc)) => println!("Got ACO/ACR/AAR: {:?}", doc.document_type),
//!     Ok(other) => println!("Other document type: {:?}", other.document_type()),
//!     Err(e) => eprintln!("Parse error: {e}"),
//! }
//! ```
//!
//! # Regulatory references
//!
//! - **§§ 13, 13a, 14 EnWG** — statutory basis for grid congestion management
//! - **NABEG 2019** — introduced Redispatch 2.0, effective 1 October 2021
//! - **BNetzA BK6-20-059/060/061** — three BNetzA rulings governing billing
//!   balance, grid operator coordination, and information provision
//! - **BDEW XML-Datenformate Redispatch 2.0** — XSD schemas and application
//!   guidelines published on [bdew-mako.de](https://www.bdew-mako.de)

#![deny(unsafe_code)]

pub mod documents;
pub mod error;
mod parse;
mod serialize;
pub mod types;
pub mod validation;

// ── Top-level re-exports ──────────────────────────────────────────────────────

pub use documents::{
    AcknowledgementDocument, ActivationDocument, DocumentType, Kaskade, Kostenblatt,
    NetworkConstraintDocument, PlannedResourceScheduleDocument, Stammdaten,
    StatusRequestMarketDocument, UnavailabilityMarketDocument,
};
pub use error::RedispatchXmlError;
pub use parse::{Document, detect, parse, parse_and_validate, parse_as};
pub use serialize::{serialize, serialize_as};
pub use validation::{ValidationResult, ValidationWarning, validate};