dsmr-parse 0.4.2

Library for parsing DSMR telegrams
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

# dsmr-parse

[![Build Status](https://github.com/twistedfall/dsmr-parse/actions/workflows/dsmr-parse.yml/badge.svg)](https://github.com/twistedfall/dsmr-parse/actions/workflows/dsmr-parse.yml)
[![Documentation](https://docs.rs/dsmr-parse/badge.svg)](https://docs.rs/dsmr-parse)
[![Crates.io](https://img.shields.io/crates/v/dsmr-parse)](https://crates.io/crates/dsmr-parse)
![Maintenance](https://img.shields.io/badge/maintenance-passively--maintained-yellowgreen.svg)

[Support the project](https://github.com/sponsors/twistedfall) | [Documentation](https://docs.rs/dsmr-parse)


## Usage

Run:
```shell
cargo add dsmr-parse
```
Or add to your Cargo.toml:
```toml
[dependencies]
dsmr-parse = "0.4.2"
```

## dsmr-parse

A small library for parsing DSMR 5 (Dutch Smart Meter Requirements) telegrams from Dutch electricity meters.

The central struct is [Telegram] with its single method [Telegram::read_from]. Pass anything that implements `std::io::Read`
to it, and it will try to read a valid and conforming DSMR telegram with the correct CRC from it.

### Usage

#### Reading from a serial port

```rust
use dsmr_parse::Telegram;

// Open serial port (example path)
let port = serialport::new("/dev/ttyUSB0", 115_200);

// Parse telegram
match Telegram::read_from(port.open().unwrap()) {
    Ok(Some(telegram)) => println!("Read telegram: {telegram:?}"),
    Ok(None) => eprintln!("No complete telegram read"),
    Err(e) => eprintln!("Parse error: {e}"),
}
```

#### Reading from a byte slice

```rust
use dsmr_parse::Telegram;

let telegram_data = b"/XMX5LGBBFG1009394887\r\n\r\n1-3:0.2.8(42)\r\n0-0:1.0.0(190101125431W)\r\n1-0:1.8.1(004169.415*kWh)\r\n!1234\r\n";

match Telegram::read_from(telegram_data.as_slice()) {
    Ok(Some(telegram)) => println!("Read telegram: {telegram:?}"),
    Ok(None) => println!("No complete telegram in data"),
    Err(e) => eprintln!("Parse error: {e}"),
}
```

### Potential Pitfalls

- CRC Validation: telegrams with incorrect CRC checksums will be rejected. Ensure data integrity during transmission,
  especially when reading from serial ports with poor connections.
- Serial Port Configuration: DSMR meters typically use 115200 baud, 8N1: 8 data bits, no parity, 1 stop bit. Incorrect
  settings will result in garbled data and parse errors.

### Specification

[P1 Companion Standard 5.0.2](https://www.netbeheernederland.nl/publicatie/dsmr-502-p1-companion-standard)

## License

MIT OR Apache-2.0