Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bring hardware_check.rs back into service #107

Merged
merged 4 commits into from
Aug 7, 2023
Merged

Bring hardware_check.rs back into service #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2163409
Factor out common dual port test code
sirhcel Mar 26, 2023
3d8ab43
Clear buffers and flush output for dual port tests
sirhcel Jun 11, 2023
d4f6d9a
Use some timeout for dual port tests
sirhcel Jun 11, 2023
fd1b710
Transmit test message back and forth
sirhcel Jun 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ scopeguard = "1.1"
serde = { version = "1.0", features = ["derive"], optional = true }

[dev-dependencies]
assert_hex = "0.2.2"
clap = { version = "3.1.6", features = ["derive"] }

[features]
Expand Down
154 changes: 52 additions & 102 deletions examples/hardware_check.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,13 @@ use std::io::Write;
use std::str;
use std::time::Duration;

use assert_hex::assert_eq_hex;
use clap::{Arg, Command};

use serialport::{ClearBuffer, DataBits, FlowControl, Parity, SerialPort, StopBits};

const TEST_MESSAGE: &[u8] = "Test Message".as_bytes();

fn main() {
let matches = Command::new("Serialport Example - Hardware Check")
.about("Test hardware capabilities of serial ports")
Expand Down Expand Up @@ -265,6 +268,26 @@ fn test_single_port(port: &mut dyn serialport::SerialPort, loopback: bool) {
}
}

fn check_test_message(sender: &mut dyn SerialPort, receiver: &mut dyn SerialPort) {
// Ignore any "residue" from previous tests.
sender.clear(ClearBuffer::All).unwrap();
receiver.clear(ClearBuffer::All).unwrap();

let send_buf = TEST_MESSAGE;
let mut recv_buf = [0u8; TEST_MESSAGE.len()];

sender.write_all(send_buf).unwrap();
sender.flush().unwrap();

match receiver.read_exact(&mut recv_buf) {
Ok(()) => {
assert_eq_hex!(recv_buf, send_buf, "Received message does not match sent",);
println!(" success");
}
Err(e) => println!("FAILED: {:?}", e),
}
}

fn test_dual_ports(port1: &mut dyn serialport::SerialPort, port2: &mut dyn serialport::SerialPort) {
println!(
"Testing paired ports '{}' and '{}':",
Expand All @@ -276,151 +299,76 @@ fn test_dual_ports(port1: &mut dyn serialport::SerialPort, port2: &mut dyn seria
set_defaults(port1);
set_defaults(port2);

let msg = "Test Message";
let mut buf = [0u8; 12];

// Test sending strings from port1 to port2
println!(
" Transmitting from {} to {}...",
port1.name().unwrap(),
port2.name().unwrap()
);

let baud_rate = 2_000_000;
print!(" At {},8,n,1,noflow...", baud_rate);
println!(" At {},8,n,1,noflow...", baud_rate);
std::io::stdout().flush().unwrap();
if port1.set_baud_rate(baud_rate).is_ok() && port2.set_baud_rate(baud_rate).is_ok() {
port1
.write_all(msg.as_bytes())
.expect("Unable to write bytes.");
if port2.read_exact(&mut buf).is_err() {
println!("FAILED");
} else {
assert_eq!(
str::from_utf8(&buf).unwrap(),
msg,
"Received message does not match sent"
);
println!("success");
}
check_test_message(port1, port2);
check_test_message(port2, port1);
} else {
println!("FAILED (does this platform & port support arbitrary baud rates?)");
}

let baud_rate = 115_200;
print!(" At {},8,n,1,noflow...", baud_rate);
println!(" At {},8,n,1,noflow...", baud_rate);
std::io::stdout().flush().unwrap();
if port1.set_baud_rate(baud_rate).is_ok() && port2.set_baud_rate(baud_rate).is_ok() {
port1
.write_all(msg.as_bytes())
.expect("Unable to write bytes.");
if port2.read_exact(&mut buf).is_err() {
println!("FAILED");
} else {
assert_eq!(
str::from_utf8(&buf).unwrap(),
msg,
"Received message does not match sent"
);
println!("success");
}
check_test_message(port1, port2);
check_test_message(port2, port1);
} else {
println!("FAILED");
}

let baud_rate = 57_600;
print!(" At {},8,n,1,noflow...", baud_rate);
println!(" At {},8,n,1,noflow...", baud_rate);
std::io::stdout().flush().unwrap();
if port1.set_baud_rate(baud_rate).is_ok() && port2.set_baud_rate(baud_rate).is_ok() {
port1
.write_all(msg.as_bytes())
.expect("Unable to write bytes.");
if port2.read_exact(&mut buf).is_err() {
println!("FAILED");
} else {
assert_eq!(
str::from_utf8(&buf).unwrap(),
msg,
"Received message does not match sent"
);
println!("success");
}
check_test_message(port1, port2);
check_test_message(port2, port1);
} else {
println!("FAILED");
}

let baud_rate = 10_000;
print!(" At {},8,n,1,noflow...", baud_rate);
println!(" At {},8,n,1,noflow...", baud_rate);
std::io::stdout().flush().unwrap();
if port1.set_baud_rate(baud_rate).is_ok() && port2.set_baud_rate(baud_rate).is_ok() {
port1
.write_all(msg.as_bytes())
.expect("Unable to write bytes.");
if port2.read_exact(&mut buf).is_err() {
println!("FAILED");
} else {
assert_eq!(
str::from_utf8(&buf).unwrap(),
msg,
"Received message does not match sent"
);
println!("success");
}
check_test_message(port1, port2);
check_test_message(port2, port1);
} else {
println!("FAILED (does this platform & port support arbitrary baud rates?)");
}
let baud_rate = 9600;
print!(" At {},8,n,1,noflow...", baud_rate);
println!(" At {},8,n,1,noflow...", baud_rate);
std::io::stdout().flush().unwrap();
if port1.set_baud_rate(baud_rate).is_ok() && port2.set_baud_rate(baud_rate).is_ok() {
port1
.write_all(msg.as_bytes())
.expect("Unable to write bytes.");
if port2.read_exact(&mut buf).is_err() {
println!("FAILED");
} else {
assert_eq!(
str::from_utf8(&buf).unwrap(),
msg,
"Received message does not match sent"
);
println!("success");
}
check_test_message(port1, port2);
check_test_message(port2, port1);
} else {
println!("FAILED");
}

// Test flow control
port1.set_flow_control(FlowControl::Software).unwrap();
port2.set_flow_control(FlowControl::Software).unwrap();
print!(" At 9600,8,n,1,softflow...");
println!(" At 9600,8,n,1,softflow...");
std::io::stdout().flush().unwrap();
port2
.write_all(msg.as_bytes())
.expect("Unable to write bytes.");
if port1.read_exact(&mut buf).is_err() {
println!("FAILED");
} else {
assert_eq!(
str::from_utf8(&buf).unwrap(),
msg,
"Received message does not match sent"
);
println!("success");
}
check_test_message(port1, port2);
check_test_message(port2, port1);

port1.set_flow_control(FlowControl::Hardware).unwrap();
port2.set_flow_control(FlowControl::Hardware).unwrap();
print!(" At 9600,8,n,1,hardflow...");
println!(" At 9600,8,n,1,hardflow...");
std::io::stdout().flush().unwrap();
port2
.write_all(msg.as_bytes())
.expect("Unable to write bytes.");
if port1.read_exact(&mut buf).is_err() {
println!("FAILED");
} else {
assert_eq!(
str::from_utf8(&buf).unwrap(),
msg,
"Received message does not match sent"
);
println!("success");
}
check_test_message(port1, port2);
check_test_message(port2, port1);
}

fn set_defaults(port: &mut dyn serialport::SerialPort) {
Expand All @@ -429,5 +377,7 @@ fn set_defaults(port: &mut dyn serialport::SerialPort) {
port.set_flow_control(FlowControl::Software).unwrap();
port.set_parity(Parity::None).unwrap();
port.set_stop_bits(StopBits::One).unwrap();
port.set_timeout(Duration::from_millis(0)).unwrap();
// TODO: Clean up timeouts and use a less-arbitrary value here. The previous timeout of 0 made
// test_dual_ports fail due to a timeout where having at least some some made them pass.
port.set_timeout(Duration::from_millis(1000)).unwrap();
}