Skip to content

CHANGELOG.md

Latest commit

 

History

History
122 lines (82 loc) · 4.64 KB

CHANGELOG.md

File metadata and controls

122 lines (82 loc) · 4.64 KB

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

v1.0.0-alpha.1 - 2020-06-16

*** This is an alpha release with breaking changes (sorry) ***

Added

  • A nonblocking trait for interfacing with random number generation hardware.

Changed

  • All traits have been marked as proven (unproven feature has been removed).
  • All trait methods have been made fallible.
  • All trait methods have been renamed try_* (i.e. try_send) for consistency.
  • The Capture, Pwm, PwmPin and Qei traits have been moved into their own capture, pwm and qei modules for consistency.
  • Void has been replaced with core::convert::Infallible which should be used in trait implementations where methods cannot fail.
  • A new process has been adopted for the addition of traits to the embedded-hal.
  • The minimum supported Rust version is 1.35 due to this issue.

v0.2.3 - 2019-05-09

Added

  • A new version of the digital OutputPin, StatefulOutputPin, ToggleableOutputPin and InputPin traits has been added under digital::v2. These traits are now fallible and their methods now return a Result type as setting an output pin and reading an input pin could potentially fail. See here for more info.
  • Compatibility shims between digital::v1 and digital::v2 traits allowing v1 traits to be implicitly promoted to v2, and for v2 traits to be explicitly cast to v1 wrappers.

Changed

  • The current versions of the OutputPin, StatefulOutputPin, ToggleableOutputPin and InputPin traits have been marked as deprecated. Please use the new versions included in digital::v2. See here for more info.

v0.2.2 - 2018-11-03

Added

  • Added the Rust Code of Conduct to this repository
  • The first ADC-related trait. This is a simple trait for one-shot conversions.
  • Iterator-based blocking write and write+read traits have been added to I2C and SPI.
  • New helper constants for SPI modes.
  • A new trait for a cancellable countdown.
  • New traits for watchdog timer management, including startup, feeding, and stopping.

Changed

  • Updated docs to clarify I2C address bit widths and expectations.

v0.2.1 - 2018-05-14

Changed

  • Auto-generated documentation (docs.rs) now includes the unproven traits.

v0.2.0 - 2018-05-12

Added

  • A ToggeableOutputPin trait has been added. This trait contains a single method: toggle that can be used to toggle the state of a push-pull pin.

Changed

  • [breaking-change] The signature of CountDown.wait changed; it now returns nb::Result<(), Void>. Where Void is the stable alternative to the never type, !, provided by the stable void crate. Implementations of the CountDown trait will have to be updated to use the new signature. With this change this crate compiles on the stable and beta channels.

  • [breaking-change] the OutputPin.is_{low,high} methods have been moved into its own trait StatefulOutputPin and renamed to is_set_{low,high}.

  • It has been clarified in the documentation that OutputPin must be implemented for push-pull output pins (and e.g. not for open drain output pins).

[v0.1.3] - 2018-05-14

Changed

  • Re-export most / unchanged traits from embedded-hal v0.2.x to allow inter-operation between HAL implementations and drivers that are using different minor versions.

v0.1.2 - 2018-02-14

Added

  • Unproven blocking::serial::* traits

v0.1.1 - 2018-02-06

Added

  • Unproven digital::InputPin trait

v0.1.0 - 2018-01-16

Initial release