itsscb/embedded-hal
1
0
Fork 0
mirror of https://github.com/rust-embedded/embedded-hal.git synced 2025-10-02 15:14:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Don't recommend eh0.2

Browse Source
This commit is contained in:
Scott Mabin 2024-11-19 14:31:18 +00:00
parent 244abaa30a
commit 9cf0629c99
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/migrating-from-0.2-to-1.0.md
View File

@ -470,14 +470,15 @@ Here is the full listing of crates:
## Supporting both 0.2 and 1.0 in the same HAL ## Supporting both 0.2 and 1.0 in the same HAL
It is strongly recommended that HAL implementation crates provide implementations for both the `embedded-hal` v0.2 and v1.0 traits. It is not recommended to support 0.2 version of the HAL. Many of the traits are not fit for purpose which is already discussed in this document.
This allows users to use drivers using either version seamlessly.
If you wish to support both the 0.2 and 1.0 release it is recommended to support embedded-hal version 0.2 behind a feature flag named `embedded-hal-02`.
The way you do it is adding a dependency on both versions in `Cargo.toml` like this: The way you do it is adding a dependency on both versions in `Cargo.toml` like this:
```toml ```toml
[dependencies] [dependencies]
embedded-hal-02 = { package = "embedded-hal", version = "0.2.7", features = ["unproven"] } embedded-hal-02 = { package = "embedded-hal", version = "0.2.7", features = ["unproven"], optional = true }
embedded-hal-1 = { package = "embedded-hal", version = "1.0" } embedded-hal-1 = { package = "embedded-hal", version = "1.0" }
``` ```
@ -489,6 +490,7 @@ This allows you to refer to the v0.2 traits under the `embedded_hal_02` name, an
struct Input {...} struct Input {...}
/// Implement the v0.2 traits on the struct. /// Implement the v0.2 traits on the struct.
#[cfg(feature = "embedded-hal-02")]
impl embedded_hal_02::digital::v2::InputPin for Input { impl embedded_hal_02::digital::v2::InputPin for Input {
type Error = Infallible; type Error = Infallible;