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
/*
* Copyright (c) 2024 Dominik Röttsches
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
//!
//! # Laad
//!
//! This library decodes frames from the TBS battery monitor and TBS charger products.
//!
//! Example usage (see also **examples/laadreader/main.rs**):
//!
//! ```rust
//! use tokio::sync::mpsc;
//! use laad::{decoder::Decoder,frameparser::FrameParser,protocol::TbsPg,types::Bytes};
//! #[tokio::main]
//! async fn main() {
//! let (bytes_tx, bytes_rx) = mpsc::channel(5);
//! let (frames_tx, mut frames_rx) = mpsc::channel(5);
//!
//! // Configure source and send send bytes to bytes_tx using bytes_tx.send(Bytes(bytes)).await.
//!
//! let mut frame_parser = FrameParser::new();
//!
//! tokio::spawn(async move {
//! frame_parser.parse_frames(bytes_rx, frames_tx).await;
//! });
//!
//! # // Avoid stalling in doctests.
//! # tokio::spawn(async move {
//! # std::process::exit(0);
//! # });
//! while let Some(frame) = frames_rx.recv().await {
//! let decoder = Decoder::new();
//! let decoded = decoder.decode_frame(frame);
//! match decoded {
//! TbsPg::Unknown => {
//! println!("Received unknown frame");
//! }
//! _ => {
//! println!("Decoded frame: {:?}", decoded);
//! }
//! }
//! }
//!
//! }
//! ```
/// Decoder decodes frames into protocol types.
/// FrameParser identifies frames in a stream of bytes and sends the frames to a Tokio channel.
/// Protocol defines the TBS protocol and decoded information for frame types that are understood.
/// Basic types for bytes and frames.