Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 2.28 KB

CHANGELOG.md

File metadata and controls

50 lines (38 loc) · 2.28 KB
Raw

Changelog

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 - ReleaseDate

1.0.0 - 2024-09-23

Added

  • Add a current_standby() method to check if the driver is currently in standby mode.
  • MotorError and Tb6612fngError now implement core::error::Error (newly stabilised in Rust 1.81)

Changed

  • Motor::new() and Driver::new() methods now set the outputs upon their initialisation to the documented defaults.
  • Motor::new() and Driver::new() methods now also return errors if they fail to set their outputs upon initialisation.
  • Breaking: update to embedded-hal 1.0
  • Breaking: Renamed error types to their struct names
  • Breaking: Renamed DriveCommand::Backwards to DriveCommand::Backward to match DriveCommand::Forward
  • The MSRV has been updated to 1.81.0 due to core::error::Error being implemented

Removed

  • Removed the drive_forward, drive_backward, stop and brake functions as they are duplicates to the drive function with the different enum variants and make the API surface larger
  • Removed the defmt feature: it was only used for debugging and since the enums & structs implement Debug consuming code can use defmt::Debug2Format when needed. The single defmt::debug! statement in Motor::drive was not very helpful anyway if two motors were connected

0.2.0 - 2023-11-28

Changed

  • Due to dependency updates the MSRV has been updated from 1.60 to 1.63. This should only be relevant if you use the defmt feature, but we now only test with 1.63 and not older releases, so it's not guaranteed to work otherwise.
  • Breaking: the API was migrated from embedded-hal:0.2 to embedded-hal:1.0.0-rc1. If your HAL does not yet implement this, then please use the previous release of the library.