Skip to content

CHANGELOG.md

Latest commit

 

History

History
56 lines (31 loc) · 2.25 KB

CHANGELOG.md

File metadata and controls

56 lines (31 loc) · 2.25 KB

Changelog

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

[1.6.0] -- 2026-02-21

  • Added inline documentation to RotaryEncoder.cpp explaining encoder initialization and tick processing

  • New constructor RotaryEncoder(LatchMode mode) for software-only initialization without hardware pin configuration.

  • See pull request #45 and #47

  • New since 1.5.2

    • ADD: Optional debounce support (setDebounceMillis()) to filter contact bounce without external components.
    • ADD: New example sketches: RotaryWithButton and AcceleratedRotatorAdvanced (showing debounce and acceleration together).
    • CI: Expanded unit/integration tests and updated CI configuration for newer Arduino cores and PlatformIO.
    • DOCS: Updated README and examples for IDE 2.x and core compatibility; clarified LatchMode behavior.
    • Added ESP32 support with default pins in examples

  • Fixes and improvements since 1.5.2

    • FIX: Robust interrupt handling across cores (AVR, SAMD, ESP32, ESP8266) — consistent use of digitalPinToInterrupt() and edge configuration to avoid missed steps on non‑AVR boards.
    • FIX: Race conditions when reading counts from ISR — atomic access and reduced critical sections.
    • FIX: Reduced CPU usage in ISR and polling paths (lower interrupt overhead).
    • CHANGE: Improved API stability notes and migration guide in README.

  • copilot-instructions.md added

[1.5.2] - 2021-07-04

minor fixes found in ci integration.

[1.5.1] - 2021-04-23

FIX: attachInterrupt() with digitalPinToInterrupt() required for Arduino UNO etc.

[1.5.0] - 2021-02-06

  • CHANGELOG created.

  • Many thanks to the improvements included from @deltaphi (#12), @rprediger (#22) and @giupo (#24)

  • The function getMillisBetweenRotations() was added. See example AcceleratedRotator.

  • The function getRPM() was added.

Examples

  • The examples also compile with ESP8266 and Every boards. (the library worked already).

  • new LatchMode in initialization supporting rotary encoders with 2 state changes from one latch to the next (LatchMode).

  • The InterruptRotator example now uses attachInterrupt() instead of ATMega registers and ISR. (The old code is still in comments).