itsscb/embedded-hal
1
0
Fork 0
mirror of https://github.com/rust-embedded/embedded-hal.git synced 2026-04-21 05:57:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme: document that serial should use embedded-io.

Browse Source
This commit is contained in:
Dario Nieuwenhuis
2023-07-15 18:08:04 +02:00
parent baccfdbc5a
commit 994c6c92be
2 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
embedded-hal-async/README.md
View File

@@ -10,6 +10,13 @@ This crate contains asynchronous versions of the [`embedded-hal`](https://crates
This project is developed and maintained by the [HAL team](https://github.com/rust-embedded/wg#the-hal-team).
## Serial/UART traits
There is no serial traits in `embedded-hal-async`. Instead, use [`embedded-io-async`](https://crates.io/crates/embedded-io).
A serial port is essentially a byte-oriented stream, and that's what `embedded-io-async` models. Sharing the traits
with all byte streams has some advantages. For example, it allows generic code providing a command-line interface
or a console to operate either on hardware serial ports or on virtual ones like Telnet or USB CDC-ACM.
## Minimum Supported Rust Version (MSRV)
This crate requires Rust nightly newer than `nightly-2022-11-22`, due to requiring support for