https://github.com/berkowski/tokio-serial

A serial port implementation for tokio
https://github.com/berkowski/tokio-serial

Last synced: 2 months ago
JSON representation

A serial port implementation for tokio

• Host: GitHub
• URL: https://github.com/berkowski/tokio-serial
• Owner: berkowski
• License: mit
• Created: 2017-02-02T03:49:08.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-03-30T17:42:57.000Z (10 months ago)
• Last Synced: 2024-08-10T11:07:41.899Z (5 months ago)
• Language: Rust
• Size: 322 KB
• Stars: 194
• Watchers: 17
• Forks: 67
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Crates.io][crates-badge]][crates-url]

[![MIT licensed][mit-badge]][mit-url]

[![Build Status][actions-badge]][actions-url]

[crates-badge]: https://img.shields.io/crates/v/tokio-serial.svg

[crates-url]: https://crates.io/crates/tokio-serial

[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg

[mit-url]: https://github.com/berkowski/tokio-serial/blob/master/LICENSE

[actions-badge]: https://github.com/berkowski/tokio-serial/actions/workflows/github-ci.yml/badge.svg

[actions-url]: https://github.com/berkowski/tokio-serial/actions?query=workflow%3Agithub-ci+branch%3Amaster

# tokio-serial

An implementation of  serialport I/O for Tokio, an async framework for rust.

## MSRV

The Minimum Supported Rust Version is **1.46.0** as found using [cargo-msrv](https://crates.io/crates/cargo-msrv)

## Usage

Add `tokio-serial` to you `Cargo.toml`:

```toml

[dependencies]

tokio-serial = "5.4.1"

```

## Tests

Useful tests for serial ports require... serial ports, and serial ports are not often provided by online CI providers.

As so, automated build testing are really only check whether the code compiles, not whether it works.

Integration tests are in the `tests/` directory and typically require two serial ports to run.

The names of the serial ports can be configured at run time by setting the `TEST_PORT_NAMES` environment variable

to a semi-colon delimited string with the two serial port names.  The default values are:

- For Unix: `TEST_PORT_NAMES=/dev/ttyUSB0;/dev/ttyUSB1`

- For Windows: `TEST_PORT_NAMES=COM1;COM2`

**IMPORTANT** To prevent multiple tests from talking to the same ports at the same time make sure to limit the number

of test threads to 1 using:

```sh

cargo test -j1 -- --test-threads=1

```

## Resources

[tokio.rs](https://tokio.rs)

[serialport-rs](https://gitlab.com/susurrus/serialport-rs)