Skip to content

Commit fe99dae

Browse files
committed
Release embedded-hal{,-async,-nb} v1.0.0, embedded-hal-bus v0.1.0
1 parent d9efe5b commit fe99dae

File tree

11 files changed

+51
-26
lines changed

11 files changed

+51
-26
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
- uses: dtolnay/[email protected]
4646
- run: >
4747
cargo test
48-
-p embedded-hal:1.0.0-rc.3
48+
-p embedded-hal:1.0.0
4949
-p embedded-hal-bus
5050
-p embedded-hal-nb
5151
-p embedded-io

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
55
This project is developed and maintained by the [HAL team](https://github.com/rust-embedded/wg#the-hal-team).
66

7-
📣 `embedded-hal` v1.0 is now released! Check out the [announcement blog post](https://blog.rust-embedded.org/embedded-hal-v1/), the [API documentation](https://docs.rs/embedded-hal) and the [migration guide](docs/migrating-from-0.2-to-1.0.md).
7+
> [!IMPORTANT]
8+
> 📣 `embedded-hal` v1.0 is now released! Check out the [announcement blog post](https://blog.rust-embedded.org/embedded-hal-v1/), the [API documentation](https://docs.rs/embedded-hal) and the [migration guide](docs/migrating-from-0.2-to-1.0.md).
89
910
## Scope
1011

docs/migrating-from-0.2-to-1.0.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ For `embedded-hal` 1.0, we decided to drop the first goal, targeting only the se
4343
- The second goal delivers much more value. Being able to use any driver together with any HAL crate, out of the box, and across the entire Rust Embedded ecosystem, is just plain awesome.
4444

4545
This refocusing on drivers is the root cause of many of the changes between `embedded-hal` 0.2 and 1.0:
46-
- [Associated type compatibiilty](#removed-traits)
46+
- [Associated type compatibility](#removed-traits)
4747
- [Trait fragmentation](#trait-organization)
4848
- [Bus/device separation](#bus-device-separation)
4949
- [Fallibility](#fallibility)
@@ -93,7 +93,7 @@ These traits have been removed in the 1.0.0 release, with no replacement for now
9393
- [`watchdog::Watchdog`][watchdog]
9494

9595
Please find a general [roadmap with further guidance here][roadmap-rm-traits] about
96-
whether and how to get these traits back in a future release
96+
whether and how to get these traits back in a future release.
9797

9898
If you are a generic driver author and need one of them, we would like to hear from you. Please add your use case to the appropriate issue for the trait affected.
9999

@@ -361,18 +361,22 @@ experiment externally, and merge when some kind of feasibility had been proven.
361361

362362
## Companion crates
363363

364-
The `embedded-hal` project now spans several crates, where some functionality has been moved out from the main `embedded-hal` crate to separate crates as detailed above. Here is the full listing of crates:
364+
The `embedded-hal` project now spans several crates, where some functionality has been moved out from the main `embedded-hal` crate to separate crates as detailed above.
365+
366+
Different crates are released independently. The main `embedded-hal-*` trait crates have reached 1.0 maturity, others will become 1.0 as time passes.
367+
368+
Here is the full listing of crates:
365369

366370
| Crate | crates.io | Docs | |
367371
|-|-|-|-|
368-
| [embedded-hal](./embedded-hal) | [![crates.io](https://img.shields.io/crates/v/embedded-hal.svg)](https://crates.io/crates/embedded-hal) | [![Documentation](https://docs.rs/embedded-hal/badge.svg)](https://docs.rs/embedded-hal) | Core traits, blocking version |
369-
| [embedded-hal-async](./embedded-hal-async) | [![crates.io](https://img.shields.io/crates/v/embedded-hal-async.svg)](https://crates.io/crates/embedded-hal-async) | [![Documentation](https://docs.rs/embedded-hal-async/badge.svg)](https://docs.rs/embedded-hal-async) | Core traits, async version |
370-
| [embedded-hal-nb](./embedded-hal-nb) | [![crates.io](https://img.shields.io/crates/v/embedded-hal-nb.svg)](https://crates.io/crates/embedded-hal-nb) | [![Documentation](https://docs.rs/embedded-hal-nb/badge.svg)](https://docs.rs/embedded-hal-nb) | Core traits, polling version using the `nb` crate |
371-
| [embedded-hal-bus](./embedded-hal-bus) | [![crates.io](https://img.shields.io/crates/v/embedded-hal-bus.svg)](https://crates.io/crates/embedded-hal-bus) | [![Documentation](https://docs.rs/embedded-hal-bus/badge.svg)](https://docs.rs/embedded-hal-bus) | Utilities for sharing SPI and I2C buses |
372-
| [embedded-can](./embedded-can) | [![crates.io](https://img.shields.io/crates/v/embedded-can.svg)](https://crates.io/crates/embedded-can) | [![Documentation](https://docs.rs/embedded-can/badge.svg)](https://docs.rs/embedded-can) | Controller Area Network (CAN) traits |
373-
| [embedded-io](./embedded-io) | [![crates.io](https://img.shields.io/crates/v/embedded-io.svg)](https://crates.io/crates/embedded-io) | [![Documentation](https://docs.rs/embedded-io/badge.svg)](https://docs.rs/embedded-io) | I/O traits (read, write, seek, etc.), blocking and nonblocking version. |
374-
| [embedded-io-async](./embedded-io-async) | [![crates.io](https://img.shields.io/crates/v/embedded-io-async.svg)](https://crates.io/crates/embedded-io-async) | [![Documentation](https://docs.rs/embedded-io-async/badge.svg)](https://docs.rs/embedded-io-async) | I/O traits, async version |
375-
| [embedded-io-adapters](./embedded-io-adapters) | [![crates.io](https://img.shields.io/crates/v/embedded-io-adapters.svg)](https://crates.io/crates/embedded-io-adapters) | [![Documentation](https://docs.rs/embedded-io-adapters/badge.svg)](https://docs.rs/embedded-io-adapters) | Adapters between the [`embedded-io`](https://crates.io/crates/embedded-io) and [`embedded-io-async`](https://crates.io/crates/embedded-io-async) traits and other IO traits (`std`, `tokio`, `futures`...) |
372+
| [embedded-hal](../embedded-hal) | [![crates.io](https://img.shields.io/crates/v/embedded-hal.svg)](https://crates.io/crates/embedded-hal) | [![Documentation](https://docs.rs/embedded-hal/badge.svg)](https://docs.rs/embedded-hal) | Core traits, blocking version |
373+
| [embedded-hal-async](../embedded-hal-async) | [![crates.io](https://img.shields.io/crates/v/embedded-hal-async.svg)](https://crates.io/crates/embedded-hal-async) | [![Documentation](https://docs.rs/embedded-hal-async/badge.svg)](https://docs.rs/embedded-hal-async) | Core traits, async version |
374+
| [embedded-hal-nb](../embedded-hal-nb) | [![crates.io](https://img.shields.io/crates/v/embedded-hal-nb.svg)](https://crates.io/crates/embedded-hal-nb) | [![Documentation](https://docs.rs/embedded-hal-nb/badge.svg)](https://docs.rs/embedded-hal-nb) | Core traits, polling version using the `nb` crate |
375+
| [embedded-hal-bus](../embedded-hal-bus) | [![crates.io](https://img.shields.io/crates/v/embedded-hal-bus.svg)](https://crates.io/crates/embedded-hal-bus) | [![Documentation](https://docs.rs/embedded-hal-bus/badge.svg)](https://docs.rs/embedded-hal-bus) | Utilities for sharing SPI and I2C buses |
376+
| [embedded-can](../embedded-can) | [![crates.io](https://img.shields.io/crates/v/embedded-can.svg)](https://crates.io/crates/embedded-can) | [![Documentation](https://docs.rs/embedded-can/badge.svg)](https://docs.rs/embedded-can) | Controller Area Network (CAN) traits |
377+
| [embedded-io](../embedded-io) | [![crates.io](https://img.shields.io/crates/v/embedded-io.svg)](https://crates.io/crates/embedded-io) | [![Documentation](https://docs.rs/embedded-io/badge.svg)](https://docs.rs/embedded-io) | I/O traits (read, write, seek, etc.), blocking and nonblocking version. |
378+
| [embedded-io-async](../embedded-io-async) | [![crates.io](https://img.shields.io/crates/v/embedded-io-async.svg)](https://crates.io/crates/embedded-io-async) | [![Documentation](https://docs.rs/embedded-io-async/badge.svg)](https://docs.rs/embedded-io-async) | I/O traits, async version |
379+
| [embedded-io-adapters](../embedded-io-adapters) | [![crates.io](https://img.shields.io/crates/v/embedded-io-adapters.svg)](https://crates.io/crates/embedded-io-adapters) | [![Documentation](https://docs.rs/embedded-io-adapters/badge.svg)](https://docs.rs/embedded-io-adapters) | Adapters between the [`embedded-io`](https://crates.io/crates/embedded-io) and [`embedded-io-async`](https://crates.io/crates/embedded-io-async) traits and other IO traits (`std`, `tokio`, `futures`...) |
376380

377381
## Supporting both 0.2 and 1.0 in the same HAL
378382

embedded-hal-async/CHANGELOG.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
77

88
## [Unreleased]
99

10-
No unreleased changes
10+
No unreleased changes yet.
11+
12+
## [v1.0.0] - 2023-12-28
13+
14+
- Updated `embedded-hal` to version `1.0.0`.
1115

1216
## [v1.0.0-rc.3] - 2023-12-14
1317

@@ -86,7 +90,8 @@ No unreleased changes
8690
First release to crates.io
8791

8892

89-
[Unreleased]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-async-v1.0.0-rc.3...HEAD
93+
[Unreleased]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-async-v1.0.0...HEAD
94+
[v1.0.0]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-async-v1.0.0-rc.3...embedded-hal-async-v1.0.0
9095
[v1.0.0-rc.3]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-async-v1.0.0-rc.2...embedded-hal-async-v1.0.0-rc.3
9196
[v1.0.0-rc.2]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-async-v1.0.0-rc.1...embedded-hal-async-v1.0.0-rc.2
9297
[v1.0.0-rc.1]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-async-v0.2.0-alpha.2...embedded-hal-async-v1.0.0-rc.1

embedded-hal-async/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ license = "MIT OR Apache-2.0"
1111
name = "embedded-hal-async"
1212
readme = "README.md"
1313
repository = "https://github.com/rust-embedded/embedded-hal"
14-
version = "1.0.0-rc.3"
14+
version = "1.0.0"
1515
rust-version = "1.75"
1616

1717
[features]
1818
defmt-03 = ["dep:defmt-03", "embedded-hal/defmt-03"]
1919

2020
[dependencies]
21-
embedded-hal = { version = "=1.0.0-rc.3", path = "../embedded-hal" }
21+
embedded-hal = { version = "1.0.0", path = "../embedded-hal" }
2222
defmt-03 = { package = "defmt", version = "0.3", optional = true }

embedded-hal-bus/CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
99

1010
No unreleased changes
1111

12+
## [v0.1.0] - 2023-12-28
13+
14+
- Updated `embedded-hal` to version `1.0.0`.
15+
1216
## [v0.1.0-rc.3] - 2023-12-14
1317

1418
- Updated `embedded-hal` to version `1.0.0-rc.3`.
@@ -52,7 +56,8 @@ No unreleased changes
5256

5357
First release to crates.io
5458

55-
[Unreleased]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-bus-v0.1.0-rc.3...HEAD
59+
[Unreleased]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-bus-v0.1.0...HEAD
60+
[v0.1.0]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-bus-v0.1.0-rc.3...embedded-hal-bus-v0.1.0
5661
[v0.1.0-rc.3]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-bus-v0.1.0-rc.2...embedded-hal-bus-v0.1.0-rc.3
5762
[v0.1.0-rc.2]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-bus-v0.1.0-rc.1...embedded-hal-bus-v0.1.0-rc.2
5863
[v0.1.0-rc.1]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-bus-v0.1.0-alpha.3...embedded-hal-bus-v0.1.0-rc.1

embedded-hal-bus/Cargo.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ license = "MIT OR Apache-2.0"
1212
name = "embedded-hal-bus"
1313
readme = "README.md"
1414
repository = "https://github.com/rust-embedded/embedded-hal"
15-
version = "0.1.0-rc.3"
15+
version = "0.1.0"
1616

1717
[features]
1818
std = []
1919
async = ["dep:embedded-hal-async"]
2020
defmt-03 = ["dep:defmt-03", "embedded-hal/defmt-03", "embedded-hal-async?/defmt-03"]
2121

2222
[dependencies]
23-
embedded-hal = { version = "=1.0.0-rc.3", path = "../embedded-hal" }
24-
embedded-hal-async = { version = "=1.0.0-rc.3", path = "../embedded-hal-async", optional = true }
23+
embedded-hal = { version = "1.0.0", path = "../embedded-hal" }
24+
embedded-hal-async = { version = "1.0.0", path = "../embedded-hal-async", optional = true }
2525
critical-section = { version = "1.0" }
2626
defmt-03 = { package = "defmt", version = "0.3", optional = true }
2727

embedded-hal-nb/CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
99

1010
No unreleased changes
1111

12+
## [v1.0.0] - 2023-12-28
13+
14+
- Updated `embedded-hal` to version `1.0.0`.
15+
1216
## [v1.0.0-rc.3] - 2023-12-14
1317

1418
- Updated `embedded-hal` to version `1.0.0-rc.3`.
@@ -44,7 +48,8 @@ No unreleased changes
4448

4549
First release to crates.io
4650

47-
[Unreleased]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-nb-v1.0.0-rc.3...HEAD
51+
[Unreleased]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-nb-v1.0.0...HEAD
52+
[v1.0.0]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-nb-v1.0.0-rc.3...embedded-hal-nb-v1.0.0
4853
[v1.0.0-rc.3]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-nb-v1.0.0-rc.2...embedded-hal-nb-v1.0.0-rc.3
4954
[v1.0.0-rc.2]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-nb-v1.0.0-rc.1...embedded-hal-nb-v1.0.0-rc.2
5055
[v1.0.0-rc.1]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-nb-v1.0.0-alpha.3...embedded-hal-nb-v1.0.0-rc.1

embedded-hal-nb/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "embedded-hal-nb"
3-
version = "1.0.0-rc.3"
3+
version = "1.0.0"
44
edition = "2021"
55
rust-version = "1.56"
66

@@ -13,7 +13,7 @@ readme = "README.md"
1313
repository = "https://github.com/rust-embedded/embedded-hal"
1414

1515
[dependencies]
16-
embedded-hal = { version = "=1.0.0-rc.3", path = "../embedded-hal" }
16+
embedded-hal = { version = "1.0.0", path = "../embedded-hal" }
1717
nb = "1"
1818

1919
[dev-dependencies]

embedded-hal/CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
77

88
## [Unreleased]
99

10+
No unreleased changes yet.
11+
12+
## [v1.0.0] - 2023-12-28
13+
1014
- gpio: remove `ToggleableOutputPin`, move `toggle()` to `StatefulOutputPin`.
1115

1216
## [v1.0.0-rc.3] - 2023-12-14
@@ -314,7 +318,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
314318

315319
Initial release
316320

317-
[Unreleased]: https://github.com/rust-embedded/embedded-hal/compare/v1.0.0-rc.3...HEAD
321+
[Unreleased]: https://github.com/rust-embedded/embedded-hal/compare/v1.0.0...HEAD
322+
[v1.0.0]: https://github.com/rust-embedded/embedded-hal/compare/v1.0.0-rc.3...v1.0.0
318323
[v1.0.0-rc.3]: https://github.com/rust-embedded/embedded-hal/compare/v1.0.0-rc.2...v1.0.0-rc.3
319324
[v1.0.0-rc.2]: https://github.com/rust-embedded/embedded-hal/compare/v1.0.0-rc.1...v1.0.0-rc.2
320325
[v1.0.0-rc.1]: https://github.com/rust-embedded/embedded-hal/compare/v1.0.0-alpha.11...v1.0.0-rc.1

embedded-hal/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ license = "MIT OR Apache-2.0"
1414
name = "embedded-hal"
1515
readme = "README.md"
1616
repository = "https://github.com/rust-embedded/embedded-hal"
17-
version = "1.0.0-rc.3"
17+
version = "1.0.0"
1818

1919
[features]
2020
defmt-03 = ["dep:defmt-03"]

0 commit comments

Comments
 (0)