File: TESTING.md

package info (click to toggle)
rust-serialport 4.8.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 844 kB
  • sloc: makefile: 2
file content (33 lines) | stat: -rw-r--r-- 1,045 bytes parent folder | download
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
How to test `serialport-rs` for development.

Without hardware:

 1. Compilation
 2. `cargo test`

With a single unconnected device:

`cargo run --example hardware_check <DEVICE>`

And when wired in a physical loopback mode:

`cargo run --example hardware_check <DEVICE> --loopback`

With two devices connected to each other:

 * `cargo run --example hardware_check <DEVICE1> --loopback-port <DEVICE2>`
 * Also `cargo run --example heartbeat <DEVICE1> <BAUD>` in one terminal and
   `cargo run --example receive_data <DEVICE2> <BAUD>` in another
 * Running tests with test cases requiring hardware devices enabled:
     ```
     $ export SERIALPORT_TEST_PORT_1=$(realpath /dev/ttyX)
     $ export SERIALPORT_TEST_PORT_2=$(realpath /dev/ttyY)
     $ cargo test --features hardware-tests
     ```

Can also verify trickier settings (like non-standard baud rates) using serial terminal programs
like:

  * `screen` (POSIX)
  * [CoolTerm](http://freeware.the-meiers.org/) (macOS)
  * [RealTerm](https://sourceforge.net/projects/realterm/) (Windows)