Skip to content
This repository has been archived by the owner on Dec 27, 2023. It is now read-only.

Commit

Permalink
Prepare to release version 2.
Browse files Browse the repository at this point in the history
  • Loading branch information
ceekdee committed Jun 26, 2023
1 parent 6efaaa8 commit 994159e
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
13 changes: 11 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]

## [v2.0.0] - 2023-06-25

### Changed
- Implement lora-phy API changes, requiring a new major version.
- For receive single packet, poll for interrupts to support LoRa chips that would require more than one DIO pin to support timeout IRQs.
- For receive single packet, depend on symbol timeout to prevent window duration timeouts from voiding reception of a packet that needs additional time to be received. This is useful for LoRaWAN Rx1/Rx2 windowing.
- Improve cold start after sleep processing, to prolong battery life between transmissions.
- Provide further flexibility to support custom boards through proprietary RadioKind implementations.

## [v1.2.0] - 2023-06-01

### Added
Expand All @@ -17,7 +26,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Remove unnecessary static trait bounds.
- Change read status error handling on IRQ flags to ensure actual Rx timeout flags are cleared appropriately.


## [v1.1.0] - 2023-05-14

### Added
Expand All @@ -43,7 +51,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- first release to crates.io.


[Unreleased]: https://github.com/embassy-rs/lora-phy/compare/v1.2.0...HEAD
[Unreleased]: https://github.com/embassy-rs/lora-phy/compare/v2.0.0...HEAD
[v2.0.0]: https://github.com/embassy-rs/lora-phy/compare/v1.2.0...v2.0.0
[v1.2.0]: https://github.com/embassy-rs/lora-phy/compare/v1.1.0...v1.2.0
[v1.1.0]: https://github.com/embassy-rs/lora-phy/compare/v1.0.2...v1.1.0
[v1.0.2]: https://github.com/embassy-rs/lora-phy/compare/v1.0.1...v1.0.2
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "lora-phy"
version = "1.2.0"
version = "2.0.0"
edition = "2021"
license = "MIT OR Apache-2.0"
repository = "https://github.com/embassy-rs/lora-phy"
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@

## LoRa physical layer API

For users wishing to implement a LoRaWAN or P2P solution, the following implementation files provide the necessary context:
For users wishing to implement a LoRaWAN or P2P solution, the following implementation files provide the necessary context for lora-phy version 1.
lora-phy version 2 includes minor API updates, as outlined in the change log, which have not been applied to Embassy yet.

- <a href="https://github.com/embassy-rs/lora-phy/blob/main/src/lib.rs">the API itself</a>;
- <a href="https://github.com/embassy-rs/lora-phy/blob/main/src/mod_params.rs">pertinent ancillary information</a>.
Expand Down

0 comments on commit 994159e

Please sign in to comment.