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.
0.6.1 - 2026-11-22
Added
0.6.0 - 2026-11-20
Added
- Thread safety: the driver can be called from multiple FreeRTOS tasks without extra locking in the application.
- DS3231_LOCK_TIMEOUT_MS. Functions that perform a read-modify-write operations return ESP_ERR_TIMEOUT if the internal mutex cannot be taken in this time.
0.5.0 - 2026-11-11
Added
- ds3231_get_time() fills tm_yday now (day of the year, 0..365).
- ds3231_get_time() fills tm_isdst now. It's always set to 0, because the driver treats the time stored in the RTC as UTC.
0.4.0 - 2026-10-26
Added
Changed
Fixed
- ds3231_set_time() and the 32 kHz output functions no longer clear alarm flags that are set while the status register is being updated.
0.3.0 - 2026-10-20
Added
0.2.0 - 2026-10-19
Added
0.1.1 - 2026-10-18
Added
- README.
- GitHub Actions workflow that uploads the component to the ESP Component Registry on tag.
Fixed
- NULL checks for arguments and range check for tm_hour.
0.1.0 - 2026-10-18
Added
- First release: read and set time, 12/24-hour format, oscillator stop flag, oscillator control on battery.
- Examples basic_12h and basic_24h.