laad/
mod.rs

1/*
2 * Copyright (c) 2024 Dominik Röttsches
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in all
12 * copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23//!
24//! # Laad
25//!
26//! This library decodes frames from the TBS battery monitor and TBS charger products.
27//!
28//! Example usage (see also **examples/laadreader/main.rs**):
29//!
30//! ```rust
31//! use tokio::sync::mpsc;
32//! use laad::{decoder::Decoder,frameparser::FrameParser,protocol::TbsPg,types::Bytes};
33//! #[tokio::main]
34//! async fn main() {
35//!   let (bytes_tx, bytes_rx) = mpsc::channel(5);
36//!   let (frames_tx, mut frames_rx) = mpsc::channel(5);
37//!
38//!   // Configure source and send send bytes to bytes_tx using bytes_tx.send(Bytes(bytes)).await.
39//!
40//!   let mut frame_parser = FrameParser::new();
41//!
42//!   tokio::spawn(async move {
43//!       frame_parser.parse_frames(bytes_rx, frames_tx).await;
44//!   });
45//!
46//!   # // Avoid stalling in doctests.
47//!   # tokio::spawn(async move {
48//!   #   std::process::exit(0);
49//!   # });
50//!   while let Some(frame) = frames_rx.recv().await {
51//!       let decoder = Decoder::new();
52//!       let decoded = decoder.decode_frame(frame);
53//!       match decoded {
54//!           TbsPg::Unknown => {
55//!               println!("Received unknown frame");
56//!           }
57//!           _ => {
58//!               println!("Decoded frame: {:?}", decoded);
59//!           }
60//!       }
61//!   }
62//!
63//! }
64//! ```
65
66/// Decoder decodes frames into protocol types.
67pub mod decoder;
68/// FrameParser identifies frames in a stream of bytes and sends the frames to a Tokio channel.
69pub mod frameparser;
70/// Protocol defines the TBS protocol and decoded information for frame types that are understood.
71pub mod protocol;
72/// Basic types for bytes and frames.
73pub mod types;
laad/mod.rs

laad/
mod.rs
