ds323x-rs/CHANGELOG.md

79 lines
2.5 KiB
Markdown
Raw Normal View History

2018-10-28 09:31:13 +00:00
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## [Unreleased]
2022-02-20 09:17:55 +00:00
### Changed
- [breaking-change] Update `rtcc` to version 0.3.
- [breaking-change] Remove `get_` from all public method names to comply with the Rust API guidelines.
2021-05-22 21:16:44 +00:00
## [0.4.0] - 2021-05-22
### Changed
- [breaking-change] Return `Error::InvalidDeviceState` if it was not possible to read the
date and/or time from the device because the state of the device corresponds to
an invalid date and/or time.
2020-05-02 10:59:31 +00:00
2021-02-22 09:55:04 +00:00
## [0.3.2] - 2021-02-22
### Fixed
- Day bounds on the `set_day()` method. Thanks to @jamesmunns. See:
[PR #5](https://github.com/eldruin/ds323x-rs/pull/5)
2020-07-10 20:25:41 +00:00
## [0.3.1] - 2020-07-10
### Added
- Added methods to set alarms 1 and 2 with a `chrono::NaiveTime`: `set_alarm1_hms()`
and `set_alarm2_hm()`.
### Changed
- Changed alarm setting methods to automatically correct invalid values to irrelevant
input parameters due to the selected matching strategy.
2020-05-02 10:59:31 +00:00
## [0.3.0] - 2020-05-02
2020-05-02 09:49:23 +00:00
### Changed
- [breaking-change] Renamed `is_busy()` and `is_running()` methods `busy()` and `running()`
due to Rust naming conventions.
- Implement trait from [`rtcc`] crate.
- Changed `get_datetime()` and `set_datetime()` parameter from `DateTime`
to `chrono::NaiveDateTime`.
### Added
- Methods to set and get date and time using `chrono::NaiveDate` and `chrono::NaiveTime`:
- `get_time()`
- `set_time()`
- `get_date()`
- `set_date()`
- [`chrono`] (through [`rtcc`]) dependency.
### Removed
- `DateTime` data structure was replaced by `chrono::NaiveDateTime`.
2018-11-16 17:36:39 +00:00
## [0.2.0] - 2018-11-16
2018-11-03 07:12:01 +00:00
### Added
2018-11-16 17:36:39 +00:00
- Support for configuration of alarms 1 and 2.
2018-10-28 09:31:13 +00:00
### Changed
- [breaking-change] `clear_has_been_stopped_flag()` always sets the value of the status register.
2018-10-31 10:18:20 +00:00
## 0.1.0 - 2018-10-31
This is the initial release to crates.io. All changes will be documented in
this CHANGELOG.
2020-05-02 09:49:23 +00:00
[`chrono`]: https://crates.io/crates/chrono
[`rtcc`]: https://crates.io/crates/rtcc
2021-05-22 21:16:44 +00:00
[Unreleased]: https://github.com/eldruin/ds323x-rs/compare/v0.4.0...HEAD
[0.4.0]: https://github.com/eldruin/ds323x-rs/compare/v0.3.2...v0.4.0
2021-02-22 09:55:04 +00:00
[0.3.2]: https://github.com/eldruin/ds323x-rs/compare/v0.3.1...v0.3.2
2020-07-10 20:25:41 +00:00
[0.3.1]: https://github.com/eldruin/ds323x-rs/compare/v0.3.0...v0.3.1
2020-05-02 10:59:31 +00:00
[0.3.0]: https://github.com/eldruin/ds323x-rs/compare/v0.2.0...v0.3.0
2018-11-16 17:36:39 +00:00
[0.2.0]: https://github.com/eldruin/ds323x-rs/compare/v0.1.0...v0.2.0