m_bus_parser/
lib.rs

1//! Brief summary
2//! * is a library for parsing M-Bus frames and user data.
3//! * aims to be a modern, open source decoder for wired m-bus protocol decoder for EN 13757-2 physical and link layer, EN 13757-3 application layer of m-bus
4//! * was implemented using the publicly available documentation available at <https://m-bus.com/>
5//! # Example
6//! ```rust
7//!
8//! use m_bus_core::{FrameError, Function};
9//! use wired_mbus_link_layer::{Address, WiredFrame};
10//! use m_bus_parser::user_data::parse_application_layer;
11//! use m_bus_parser::mbus_data::MbusData;
12//!
13//! fn try_parse() -> Result<(), m_bus_parser::MbusError> {
14//!     let example = vec![
15//!         0x68, 0x4D, 0x4D, 0x68, 0x08, 0x01, 0x72, 0x01,
16//!         0x00, 0x00, 0x00, 0x96, 0x15, 0x01, 0x00, 0x18,
17//!         0x00, 0x00, 0x00, 0x0C, 0x78, 0x56, 0x00, 0x00,
18//!         0x00, 0x01, 0xFD, 0x1B, 0x00, 0x02, 0xFC, 0x03,
19//!         0x48, 0x52, 0x25, 0x74, 0x44, 0x0D, 0x22, 0xFC,
20//!         0x03, 0x48, 0x52, 0x25, 0x74, 0xF1, 0x0C, 0x12,
21//!         0xFC, 0x03, 0x48, 0x52, 0x25, 0x74, 0x63, 0x11,
22//!         0x02, 0x65, 0xB4, 0x09, 0x22, 0x65, 0x86, 0x09,
23//!         0x12, 0x65, 0xB7, 0x09, 0x01, 0x72, 0x00, 0x72,
24//!         0x65, 0x00, 0x00, 0xB2, 0x01, 0x65, 0x00, 0x00,
25//!         0x1F, 0xB3, 0x16
26//!     ];
27//!
28//!     // Parse the frame
29//!     let frame = WiredFrame::try_from(example.as_slice())?;
30//!
31//!     if let WiredFrame::LongFrame { function, address, data } = frame {
32//!         assert_eq!(function, Function::RspUd { acd: false, dfc: false });
33//!         assert_eq!(address, Address::Primary(1));
34//!         let application_layer = parse_application_layer(data)?;
35//!         if let Some(data_records) = application_layer.data_records() {
36//!             println!("data_records: {:#?}", data_records.collect::<Result<Vec<_>, _>>()?);
37//!         }
38//!     }
39//!
40//!     // Parse everything at once
41//!     let parsed_data = MbusData::<WiredFrame>::try_from(example.as_slice())?;
42//!     println!("parsed_data: {:#?}", parsed_data);
43//!     Ok(())
44//! }
45//! ```
46
47#![cfg_attr(not(feature = "std"), no_std)]
48
49#[cfg(feature = "std")]
50#[allow(clippy::indexing_slicing)]
51pub mod annotate;
52#[cfg(feature = "std")]
53pub mod manufacturers;
54pub mod mbus_data;
55#[cfg(feature = "std")]
56pub mod output;
57#[cfg(feature = "std")]
58mod rscada_xml;
59pub use m_bus_application_layer as user_data;
60
61pub use m_bus_core::decryption;
62use m_bus_core::ApplicationLayerError;
63// Re-export link layer types for convenience
64pub use m_bus_core::{FrameError, Function};
65pub use wired_mbus_link_layer::{Address, WiredFrame};
66pub use wireless_mbus_link_layer::{ManufacturerId, WirelessFrame};
67
68#[cfg(feature = "std")]
69pub use mbus_data::serialize_mbus_data;
70#[cfg(feature = "std")]
71pub use output::{
72    decode_bytes, decode_data_records, decode_data_records_hex, decode_hex, decode_hex_bytes,
73    render_bytes, render_hex, DecodeOptions, DecodedOutput, OutputError, OutputFormat,
74    RenderOptions,
75};
76
77#[derive(Debug, Clone, Copy, PartialEq)]
78#[cfg_attr(feature = "serde", derive(serde::Serialize))]
79#[non_exhaustive]
80pub enum MbusError {
81    FrameError(FrameError),
82    WirelessFrameError(wireless_mbus_link_layer::FrameError),
83    ApplicationLayerError(ApplicationLayerError),
84    DataRecordError(user_data::variable_user_data::DataRecordError),
85}
86
87#[cfg(feature = "std")]
88impl std::fmt::Display for MbusError {
89    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
90        match self {
91            MbusError::FrameError(e) => write!(f, "{e}"),
92            MbusError::WirelessFrameError(e) => write!(f, "{:?}", e),
93            MbusError::ApplicationLayerError(e) => write!(f, "{e}"),
94            MbusError::DataRecordError(e) => write!(f, "{e}"),
95        }
96    }
97}
98
99#[cfg(feature = "std")]
100impl std::error::Error for MbusError {}
101
102impl From<FrameError> for MbusError {
103    fn from(error: FrameError) -> Self {
104        Self::FrameError(error)
105    }
106}
107
108impl From<ApplicationLayerError> for MbusError {
109    fn from(error: ApplicationLayerError) -> Self {
110        Self::ApplicationLayerError(error)
111    }
112}
113
114impl From<user_data::variable_user_data::DataRecordError> for MbusError {
115    fn from(error: user_data::variable_user_data::DataRecordError) -> Self {
116        Self::DataRecordError(error)
117    }
118}
119
120impl From<wireless_mbus_link_layer::FrameError> for MbusError {
121    fn from(error: wireless_mbus_link_layer::FrameError) -> Self {
122        Self::WirelessFrameError(error)
123    }
124}
m_bus_parser/lib.rs

m_bus_parser/
lib.rs
