framed-serial
| Crates.io | framed-serial |
| lib.rs | framed-serial |
| version | 0.4.0 |
| source | src |
| created_at | 2017-01-25 13:26:53.594137 |
| updated_at | 2017-05-11 13:34:16.769415 |
| description | Add frames to serial connections. Useful for embedded devices. Can be built with no_std. |
| homepage | https://github.com/astraw/framed-serial |
| repository | https://github.com/astraw/framed-serial |
| max_upload_size | |
| id | 8221 |
| size | 35,979 |
Andrew Straw (astraw)
documentation
https://docs.rs/framed-serial/
README
framed-serial - Add frames to serial connections. Useful for embedded devices. Can be built with no_std. 
See the documentation.
Potential improvements
- use a more elaborate algorithm, such as COBS
- detect and recover from errors in the data received, e.g. with checksums
- base async code on futures-rs
Running the tests
If you have a device connected sending frames with FramedConnection, execute tests with:
cargo test --no-default-features --features device_connected -- --nocapture
License
Licensed under either of
- Apache License, Version 2.0, (./LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (./LICENSE-MIT or http://opensource.org/licenses/MIT) at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Code of conduct
Anyone who interacts with framed-serial in any space including but not limited to this GitHub repository is expected to follow our code of conduct