Compare commits

...

2 Commits

Author SHA1 Message Date
Diego Barrios Romero 7070810621 chore: Release ds323x version 0.7.0 2025-10-11 13:47:51 +02:00
Paul Bender 775f3288b1
Add defmt support behind the feature flag defmt. (#14)
* Add defmt support behind the feature flag defmt.

* Update rtcc dependency

* Updated changelog to reflect defmt support.

* Update CHANGELOG.md

* Update CHANGELOG.md

---------

Co-authored-by: Diego Barrios Romero <eldruin@gmail.com>
2025-10-11 13:40:24 +02:00
5 changed files with 31 additions and 4 deletions

View File

@ -8,6 +8,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
<!-- next-header -->
## [Unreleased] - ReleaseDate
## [0.7.0] - 2025-10-11
### Added
- Added `defmt` support behind a feature flag.
### Changed
- Updated `rtcc` to version 0.4.0, which has `defmt` support.
## [0.6.0] - 2025-01-02
### Changed
@ -91,7 +101,8 @@ this CHANGELOG.
[`rtcc`]: https://crates.io/crates/rtcc
<!-- next-url -->
[Unreleased]: https://github.com/eldruin/ds323x-rs/compare/v0.6.0...HEAD
[Unreleased]: https://github.com/eldruin/ds323x-rs/compare/v0.7.0...HEAD
[0.7.0]: https://github.com/eldruin/ds323x-rs/compare/v0.6.0...v0.7.0
[0.6.0]: https://github.com/eldruin/ds323x-rs/compare/v0.5.1...v0.6.0
[0.5.1]: https://github.com/eldruin/ds323x-rs/compare/v0.5.0...v0.5.1
[0.5.0]: https://github.com/eldruin/ds323x-rs/compare/v0.4.0...v0.5.0
@ -99,4 +110,4 @@ this CHANGELOG.
[0.3.2]: https://github.com/eldruin/ds323x-rs/compare/v0.3.1...v0.3.2
[0.3.1]: https://github.com/eldruin/ds323x-rs/compare/v0.3.0...v0.3.1
[0.3.0]: https://github.com/eldruin/ds323x-rs/compare/v0.2.0...v0.3.0
[0.2.0]: https://github.com/eldruin/ds323x-rs/compare/v0.1.0...v0.2.0
[0.2.0]: https://github.com/eldruin/ds323x-rs/compare/v0.1.0...v0.2.0

View File

@ -1,6 +1,6 @@
[package]
name = "ds323x"
version = "0.6.0"
version = "0.7.0"
authors = ["Diego Barrios Romero <eldruin@gmail.com>"]
repository = "https://github.com/eldruin/ds323x-rs"
license = "MIT OR Apache-2.0"
@ -20,9 +20,13 @@ include = [
]
edition = "2018"
[features]
defmt = ["dep:defmt", "rtcc/defmt"]
[dependencies]
embedded-hal = "1.0.0"
rtcc = "0.3"
rtcc = "0.4"
defmt = { version = "1.0.1", optional = true }
[dev-dependencies]
embedded-hal-mock = { version = "0.11.1", features = ["eh1"] }

View File

@ -15,6 +15,7 @@ use crate::{
/// - Second, minute and hour: 0
/// - Day: 1
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct DayAlarm1 {
/// Day of the month [1-31]
pub day: u8,
@ -34,6 +35,7 @@ pub struct DayAlarm1 {
/// - Second, minute and hour: 0
/// - Weekday: 1
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct WeekdayAlarm1 {
/// Weekday [1-7]
pub weekday: u8,
@ -47,6 +49,7 @@ pub struct WeekdayAlarm1 {
/// Alarm1 trigger rate
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum Alarm1Matching {
/// Alarm once per second.
OncePerSecond,
@ -68,6 +71,7 @@ pub enum Alarm1Matching {
/// - Minute and hour: 0
/// - Day: 1
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct DayAlarm2 {
/// Day of month [1-31]
pub day: u8,
@ -85,6 +89,7 @@ pub struct DayAlarm2 {
/// - Minute and hour: 0
/// - Weekday: 1
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct WeekdayAlarm2 {
/// Weekday [1-7]
pub weekday: u8,
@ -96,6 +101,7 @@ pub struct WeekdayAlarm2 {
/// Alarm2 trigger rate
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum Alarm2Matching {
/// Alarm once per minute. (00 seconds of every minute)
OncePerMinute,

View File

@ -5,12 +5,14 @@ use embedded_hal::{i2c, spi};
/// I2C interface
#[derive(Debug, Default)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct I2cInterface<I2C> {
pub(crate) i2c: I2C,
}
/// SPI interface
#[derive(Debug, Default)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct SpiInterface<SPI> {
pub(crate) spi: SPI,
}

View File

@ -377,6 +377,7 @@ pub const SPI_MODE_3: Mode = MODE_3;
/// All possible errors in this crate
#[derive(Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum Error<E> {
/// I²C/SPI bus error
Comm(E),
@ -391,6 +392,7 @@ pub enum Error<E> {
/// Square-wave output frequency
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum SqWFreq {
/// 1 Hz (default)
_1Hz,
@ -406,6 +408,7 @@ pub enum SqWFreq {
///
/// This is only available on the DS3232 and DS3234 devices.
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum TempConvRate {
/// Once every 64 seconds (default)
_64s,
@ -478,6 +481,7 @@ pub mod ic {
/// DS3231, DS3232 and DS3234 RTC driver
#[derive(Debug, Default)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct Ds323x<DI, IC> {
iface: DI,
control: u8,