https://github.com/rust-embedded-community/embedded-nal

An Embedded Network Abstraction Layer
https://github.com/rust-embedded-community/embedded-nal

Last synced: about 1 month ago
JSON representation

An Embedded Network Abstraction Layer

• Host: GitHub
• URL: https://github.com/rust-embedded-community/embedded-nal
• Owner: rust-embedded-community
• License: apache-2.0
• Created: 2020-01-23T21:32:45.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-22T08:47:42.000Z (3 months ago)
• Last Synced: 2024-05-01T12:34:03.027Z (2 months ago)
• Language: Rust
• Size: 105 KB
• Stars: 172
• Watchers: 13
• Forks: 26
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Lists

• awesome-embedded-rust - `embedded-nal` -  (Component abstraction crates / Other)
• awesome-embedded-rust - `embedded-nal` -  (Component abstraction crates / Other)

README

        
# embedded-nal

> An Embedded Network Abstraction Layer

This crate defines a simple set of traits that can be implemented by almost any TCP/IP stack. This might be an on-chip stack like smoltcp, or it could be an off-chip TCP/IP stack on an AT modem.

## [API reference]

[API reference]: https://docs.rs/embedded-nal

## How-to: add a new trait

This is the suggested approach to adding a new trait to `embedded-nal`

### Research / Discussion

Ideally, before proposing a new trait, or set of traits, you should check for an existing issue

suggesting the need for the trait, as well as any related works / use cases / requirements that

are useful to consider in the design of the trait.

These issues will be labeled as `discussion` in the issue tracker.

### Implementation / Demonstration

Proposed traits should then be implemented and demonstrated, either by forking `embedded-nal` or by creating a new crate with the intent of integrating this into `embedded-nal` once the traits have stabilized. You may find [cargo workspaces](https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html) and [patch](https://doc.rust-lang.org/edition-guide/rust-2018/cargo-and-crates-io/replacing-dependencies-with-patch.html) useful for the forking approach.

### Proposing a trait

Once the trait has been demonstrated a PR should be opened to merge the new trait(s) into `embedded-nal`. This should include a link to the previous discussion issue.

If there is determined to be more than one alternative then there should be further discussion to

try to single out the best option. Once there is consensus this will be merged into the `embedded-nal` repository.

These issues / PRs will be labeled as `proposal`s in the issue tracker.

## Minimum Supported Rust Version (MSRV)

This crate is guaranteed to compile on stable Rust 1.77.0 and up. It _might_

compile with older versions but that may change in any new patch release.

## License

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or

  http://www.apache.org/licenses/LICENSE-2.0)

- MIT license ([LICENSE-MIT](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.