serial-capture 0.1.0

Cross-platform USB virtual COM port capture (CH340, FT232, FT2232, PL2303, CDC-ACM)
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
39
40
41
42

#[derive(Debug, Clone, Copy)]
pub struct PortInfo {
    pub bus: u16,
    pub devnum: u8,
    pub vid: u16,
    pub pid: u16,
    pub interface_number: Option<u8>,
    /// Bulk IN endpoint address (bit 7 = 1). None if not discoverable.
    pub bulk_in_ep: Option<u8>,
    /// Bulk OUT endpoint address (bit 7 = 0). None if not discoverable.
    pub bulk_out_ep: Option<u8>,
    /// wMaxPacketSize of the bulk IN endpoint — needed by the FTDI decoder.
    pub bulk_in_max_packet: Option<u16>,
}

#[derive(Debug, Clone)]
pub struct ListedPort {
    /// "/dev/ttyUSB0" on Linux, "COM4" on Windows.
    pub path: String,
    pub vid: u16,
    pub pid: u16,
}

#[cfg(target_os = "linux")]
mod linux;
#[cfg(target_os = "linux")]
pub use linux::{list_ports, resolve};

#[cfg(target_os = "windows")]
mod win;
#[cfg(target_os = "windows")]
pub use win::{list_ports, resolve};

#[cfg(not(any(target_os = "linux", target_os = "windows")))]
pub fn resolve(_port: &str) -> anyhow::Result<PortInfo> {
    unreachable!("platform guard should have exited before this point");
}

#[cfg(not(any(target_os = "linux", target_os = "windows")))]
pub fn list_ports() -> anyhow::Result<Vec<ListedPort>> {
    unreachable!("platform guard should have exited before this point");
}