#serial-port #serial-communication #serial #testing #simulation #baud-rate

virtual-serialport

Simulates serial ports for testing. Designed to work with the serialport crate for virtual serial communication.

3 releases

0.1.3 Oct 6, 2024
0.1.1 Aug 10, 2024
0.1.0 Aug 10, 2024

#714 in Hardware support

Download history 22/week @ 2024-08-14 13/week @ 2024-09-11 5/week @ 2024-09-18 21/week @ 2024-09-25 153/week @ 2024-10-02 37/week @ 2024-10-09

212 downloads per month
Used in simp_protocol

MIT/Apache

25KB
354 lines

Virtual Serial Port

Crates.io Docs.rs Actions MSRV Release License

The Serial Port Simulator (virtual port) is designed to work alongside the serialport crate. It supports reading from and writing to the port using internal buffers, with optional timeout functionality.

The simulator also allows configuring standard serial port parameters, such as:

  • baud rate
  • data bits
  • parity
  • stop bits
  • flow control

Documentation

Additional features include:

  • Control Signal Simulation: Simulates control signals (RTS/CTS, DTR/DSR/CD). Note that actual flow control based on these signals is not implemented.

  • Transmission Delay Simulation: When enabled, simulates transmission delay based on the baud rate. This is implemented in a simplified manner by adding a fixed delay for each symbol read (the delay is calculated according to the baud rate).

  • Noise Simulation: If enabled, simulates noise when the physical settings (baud rate, data bits, parity, and stop bits) of paired ports do not match. This helps test how the system handles corrupted or invalid data under mismatched configurations.

Example

use std::io::{Read, Write};

use virtual_serialport::VirtualPort;

let (mut port1, mut port2) = VirtualPort::pair(9600, 1024).unwrap();
let write_data = b"hello";
let mut read_data = [0u8; 5];

port1.write_all(write_data).unwrap();
port2.read_exact(&mut read_data).unwrap();
assert_eq!(&read_data, write_data);

More examples can be found in the examples folder in the root of this repository.

License

Licensed under either of Apache License, Version 2.0 (LICENSE-APACHE) or MIT license (LICENSE-MIT) at your option.

Dependencies

~2.5MB
~49K SLoC