obd2/src/device/serial_comm.rs
Nicholas Orlowsky 11e87eafaf
Various changes
- allow communication to elm327 device via a serialport
- allow creation of elm327 device without requiring unwrap()
- added some extra documentation
- add fuel_level obd-ii command
- expose reset() functionality of device
2025-03-20 14:09:37 -04:00

95 lines
2.5 KiB
Rust

use super::Result;
use std::io::{Read, Write};
use std::time::Duration;
const DEFAULT_BAUD_RATE: u32 = 38_400;
/// An API to communicate with a serial device
pub trait SerialComm {
fn write_all(&mut self, data: &[u8]) -> Result<()>;
fn read(&mut self, data: &mut [u8]) -> Result<usize>;
fn set_baud_rate(&mut self, baud_rate: u32) -> Result<()>;
fn purge_buffers(&mut self) -> Result<()>;
}
/// Communicate with a serial device using the
/// serialport library
///
/// /dev/tty* or similar on unix-like systems
/// COM devices on Windows systems
pub struct SerialPort {
device: Box<dyn serialport::SerialPort>,
}
impl SerialPort {
/// Creates a new instance of a SerialPort
pub fn new(path: &str) -> Result<Self> {
let device = serialport::new(path, DEFAULT_BAUD_RATE)
.timeout(Duration::from_millis(10))
.parity(serialport::Parity::None)
.data_bits(serialport::DataBits::Eight)
.stop_bits(serialport::StopBits::One)
.path(path)
.open()?;
Ok(Self { device })
}
}
impl SerialComm for SerialPort {
fn write_all(&mut self, data: &[u8]) -> Result<()> {
Ok(self.device.write_all(data)?)
}
fn read(&mut self, data: &mut [u8]) -> Result<usize> {
Ok(self.device.read(data)?)
}
fn set_baud_rate(&mut self, baud_rate: u32) -> Result<()> {
Ok(self.device.set_baud_rate(baud_rate)?)
}
fn purge_buffers(&mut self) -> Result<()> {
Ok(self.device.clear(serialport::ClearBuffer::All)?)
}
}
/// Communicate with a USB to Serial FTDI device
/// with the FTDI library
pub struct FTDIDevice {
device: ftdi::Device,
}
impl FTDIDevice {
/// Creates a new instance of an FTDIDevice
pub fn new() -> Result<Self> {
let mut device = ftdi::find_by_vid_pid(0x0404, 0x6001)
.interface(ftdi::Interface::A)
.open()?;
device.set_baud_rate(DEFAULT_BAUD_RATE)?;
device.configure(ftdi::Bits::Eight, ftdi::StopBits::One, ftdi::Parity::None)?;
device.usb_reset()?;
Ok(Self { device })
}
}
impl SerialComm for FTDIDevice {
fn write_all(&mut self, data: &[u8]) -> Result<()> {
Ok(self.device.write_all(data)?)
}
fn read(&mut self, data: &mut [u8]) -> Result<usize> {
Ok(self.device.read(data)?)
}
fn set_baud_rate(&mut self, baud_rate: u32) -> Result<()> {
Ok(self.device.set_baud_rate(baud_rate)?)
}
fn purge_buffers(&mut self) -> Result<()> {
Ok(self.device.usb_purge_buffers()?)
}
}