hackdose-sml-parser 0.8.0

a parser for the smart message language spoken by smart meters
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

# Hackdose SML-parser

A parser for SML messages as emitted by ISKRA(tm) smart meters for instance.
It currently uses the `peg`-crate to express SML as a parser expression grammar.
It also contains a mapping for OBIS numbers.

# Usage

This crate comes in three different flavors

## Message-Stream

This is propably the most frequent application: Convert an async byte stream into a stream of SML
messages. See `examples/serial-stream.rs` for an example.

## Transport

This layer deals with streaming of SML messages from raw bytes.

## Application

The `application` module consumes readly-parsed bodies of SML messages.

Once you have obtained the data for your SML-speaking appliance (e.g. a smart meter), you can use the library as follows:

```rust
use hackdose_sml_parser::application::{
    domain::AnyValue, domain::SmlMessageEnvelope, obis::Obis, parser::parse_body,
};

pub fn find_total_power(body: &[u8]) -> Option<i32> {
    let result = parse_body(body);
    let result = result.ok()?;
    for list in result.messages {
        match list {
            SmlMessageEnvelope::GetOpenResponse(_) => continue,
            SmlMessageEnvelope::GetListResponse(body) => {
                let values = &body.value_list;
                let usage = values.iter().find(|value| {
                    value.object_name == Obis::SumActiveInstantaneousPower.obis_number()
                });

                if let Some(usage) = usage {
                    if let AnyValue::Signed(value) = usage.value {
                        return Some(value as i32);
                    }
                }
            }
            SmlMessageEnvelope::GetCloseResponse => continue,
        }
    }
    return None;
}
```

# Acknowledgements

Most of the work inside the library is actually performed by Kevin Mehall's `peg` crate.
I am also indebted to Stefan Weigert's great [blog post](http://www.stefan-weigert.de/php_loader/sml.php)
about the SML protocol which enabled me to develop the grammar incrementally rather than reading
the whole 80 page [specification](https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Publikationen/TechnischeRichtlinien/TR03109/TR-03109-1_Anlage_Feinspezifikation_Drahtgebundene_LMN-Schnittstelle_Teilb.pdf?__blob=publicationFile) in the first place.

# Contributions

Any contributions are highly appreciated. I published this library (which is part of the
[hackdose](https://github.com/torfmaster/hackdose-server)) to save everyone the work to implement yet another parser for this hard-to-read binary protocol
and to focus on more interesting tasks.

# License

This crate is dual-licensed under MIT and Apache 2 license at your choice.