Skip to main content

zwave_serial/
port.rs

1//! Opening the link to a controller: a local serial device, or a TCP socket
2//! for sticks shared over the network (ser2net, socat, a simulator).
3
4use tokio::io::{AsyncRead, AsyncWrite};
5
6/// A bidirectional byte stream to a controller.
7pub trait Port: AsyncRead + AsyncWrite + Send + Unpin + 'static {}
8impl<T: AsyncRead + AsyncWrite + Send + Unpin + 'static> Port for T {}
9
10/// The Serial API's fixed line settings: 115200 baud, 8N1, no flow control.
11pub const BAUD_RATE: u32 = 115_200;
12
13/// Opens `path`: `tcp://host:port` for a network link, anything else as a
14/// local serial device.
15pub async fn open(path: &str) -> std::io::Result<Box<dyn Port>> {
16    if let Some(addr) = path.strip_prefix("tcp://") {
17        let s = tokio::net::TcpStream::connect(addr).await?;
18        s.set_nodelay(true)?;
19        return Ok(Box::new(s));
20    }
21    open_serial(path)
22}
23
24#[cfg(feature = "serialport")]
25fn open_serial(path: &str) -> std::io::Result<Box<dyn Port>> {
26    use tokio_serial::SerialPortBuilderExt;
27    let port = tokio_serial::new(path, BAUD_RATE)
28        .data_bits(tokio_serial::DataBits::Eight)
29        .parity(tokio_serial::Parity::None)
30        .stop_bits(tokio_serial::StopBits::One)
31        .flow_control(tokio_serial::FlowControl::None)
32        .open_native_async()
33        .map_err(std::io::Error::other)?;
34    Ok(Box::new(port))
35}
36
37#[cfg(not(feature = "serialport"))]
38fn open_serial(path: &str) -> std::io::Result<Box<dyn Port>> {
39    Err(std::io::Error::new(
40        std::io::ErrorKind::Unsupported,
41        format!("{path}: built without serial port support; use tcp://"),
42    ))
43}