From 1b3f6a2f6b6a636a688f01e2bae467bdd54c4010 Mon Sep 17 00:00:00 2001
From: Nicholas Orlowsky <nickorlow@nickorlow.com>
Date: Tue, 18 Mar 2025 21:15:38 -0400
Subject: [PATCH] prefmt

---
 src/device/serial_comm.rs | 95 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 95 insertions(+)
 create mode 100644 src/device/serial_comm.rs

diff --git a/src/device/serial_comm.rs b/src/device/serial_comm.rs
new file mode 100644
index 0000000..0ee1dd1
--- /dev/null
+++ b/src/device/serial_comm.rs
@@ -0,0 +1,95 @@
+use std::time::Duration;
+use super::Result;
+use std::io::{Read, Write};
+
+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()?)
+    }
+}
+