https://github.com/totalkrill/serial_frame

Simple serial framer built in rust
https://github.com/totalkrill/serial_frame

Last synced: 12 months ago
JSON representation

Simple serial framer built in rust

• Host: GitHub
• URL: https://github.com/totalkrill/serial_frame
• Owner: TotalKrill
• Created: 2019-12-03T10:01:29.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-01-13T12:08:49.000Z (over 6 years ago)
• Last Synced: 2025-06-30T17:08:01.790Z (about 1 year ago)
• Language: Rust
• Size: 4.88 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          

# SerialFrame

[![Latest version](https://img.shields.io/crates/v/serial_frame.svg)](https://crates.io/crates/serial_frame)

![License](https://img.shields.io/crates/l/serial_frame.svg)

Simple serialport frame reciever, that asynchrounous sends chunks of bytes over an mpsc channel.

the chunks are sent with the chosen delimiter.

Can be used to recieve lines over serialports in an asynchronous manner, or to recieve cobs messages, or custom parsing to whatever type you want from the chunks

See the example for an example usage for just receiving lines

## Example

```rust

use serialport::prelude::*;

use simple_logger;

use std::sync::mpsc::*;

use std::time::Duration;

use serial_frame::{create_line_sender, Line, SerialFrameError, SerialFrameSender};

fn main() {

    // Setup the serialport to act on

    let serialport: Box = init();

    // get a Reciever for strings that all end with a newline

    let (rx, linestop) = create_line_sender(serialport).unwrap();

    // Recieve the lines, stop if timeout

    while let Ok(line) = rx.recv_timeout(Duration::from_secs(2)) {

        // Inspect the received line

        match line {

            Ok(line) => {

                println!("line is: {}", line);

            }

            Err(e) => {

                println!("Error: {:?}", e);

            }

        }

    }

    // This will end the thread if it not stopped

    let e = linestop.stop();

    println!("Stop: {:?}", e);

}

fn init() -> Box {

    simple_logger::init_with_level(log::Level::Debug).unwrap();

    let mut settings: SerialPortSettings = Default::default();

    settings.timeout = Duration::from_millis(100);

    let baudrate = 115200;

    settings.baud_rate = baudrate;

    let serialport = serialport::open_with_settings("/dev/ttyACM0", &settings).unwrap();

    serialport

}

```