serial_frame 0.3.0

Sends byte chunks over a channel, split using given delimiter
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

use crate::Result;
use crate::{SerialFrameError, SerialFrameStopper};
use core::convert::TryFrom;
use crossbeam_channel::{unbounded, Receiver};
use derive_more::*;
use serialport::prelude::*;

#[derive(Display, Debug, Into, From, PartialEq, Eq)]
pub struct Line(pub String);

impl TryFrom<Vec<u8>> for Line {
    type Error = crate::SerialFrameError;
    fn try_from(input: Vec<u8>) -> Result<Self> {
        let inputstr = String::from_utf8(input.clone())
            .map_err(|_e| SerialFrameError::FailedConversion(input))?;
        Ok(Self(inputstr))
    }
}

/// Returns a Reciever that receives strings that ends with newlines from the specified serial port
pub fn create_line_sender(
    serialport: Box<dyn SerialPort>,
) -> Result<(Receiver<Line>, SerialFrameStopper)> {
    let (tx, rx) = unbounded();
    let sender = crate::SerialFrameSender::new(b'\n', serialport);
    let stopper = sender.start(tx)?;
    Ok((rx, stopper))
}

/// Returns a Receiver that receives u8 vectors that ends with bytevalue 0
pub fn create_cobs_sender(
    serialport: Box<dyn SerialPort>,
) -> Result<(Receiver<Vec<u8>>, SerialFrameStopper)> {
    let (tx, rx) = unbounded();
    let sender = crate::SerialFrameSender::new(0, serialport);
    let stopper = sender.start(tx)?;
    Ok((rx, stopper))
}