Skip to content

Latest commit

 

History

History
132 lines (90 loc) · 5.83 KB

CHANGELOG.md

File metadata and controls

132 lines (90 loc) · 5.83 KB
Raw

Changelog

Unreleased

  • none

Note: Unreleased changes are checked in but not part of an official release (available through the Arduino IDE or PlatfomIO) yet. This allows you to test WiP features and give feedback to them.

[2.1.1] - 2023-04-27

  • fixed bug in setIncrement() as pointed out by WJurasek-KV
  • updated SimpleCounter.ino example

[2.1.0] - 2023-04-13

  • updated enums with class feature
  • Added triggerOnBounds(bool triggerEvents = true) method to be able to suppress rotate events when the boundaries are reached
  • Made now and time related attributes to unsigned long
  • Replaced cases with lookup table to simplify loop()
  • Simplified state change in the loop()
  • Positions are only set within the defined boundaries
  • some refactoring suggested by GPT-4

Most changes were suggested in #43 by Alex Herman. Thank you.

[2.0.0] - 2022-12-27

  • added speedup functionality as suggested in #37

    void setSpeedupInterval(int time);
void setSpeedupIncrement(int inc);
void enableSpeedup(bool enable);

bool isSpeedupEnabled() const;
int getSpeedupInterval() const;
int getSpeedupIncrement() const;

void setSpeedupStartedHandler(CallbackFunction f);
void setSpeedupEndedHandler(CallbackFunction f);
bool isInSpeedup() const;

  • multiple similar events can now be surpressed

    • retriggerEvent(bool retrigger)

  • Added ESP8266 and ESP32 interrupt examples

  • refactored loop and event triggering

  • fixed bug with ID

[1.6.1] - 2022-12-24

  • replaced direction constants with enum, now use it like this: rotary_direction::right
  • refactored loop()

[1.6.0] - 2022-05-26

[1.5.0] - 2021-06-22

  • Added option to define increment as suggested by sblaisot in pull request #32
  • Added a begin() function and a default constructor the be able to instantiate an object within a function
  • Updated the RangedCounter and SimpleCounterWithButton examples. They now use begin()
  • Added getter and setter functions for the upper and lower bounds
    • void setUpperBound(int upper_bound);
    • void setLowerBound(int lower_bound);
    • int getUpperBound();
    • int getLowerBound();

[1.4.2] - 2020-11-29

  • remove unused variable last_read_ms as pointed out by ornea in #26
  • cleaned up the protected vars as suggested by Jim-2249 in #30
  • simplified the loop() function

[1.4.1] - 2020-11-29

  • reordered the constructor parameters to mitigate a code breaking change as suggested by ab-it in pull request #25
  • made resetPosition() callback trigger optional as suggested by ab-it
  • fixed bug in directionToString() introduced in the 1.4 version, found by ab-it

[1.4] - 2020-11-26

  • added callback to resetPosition() as suggested by ab-it in #17
  • Fixed warning in directionToString() as suggested by ab-it in #18
  • Added option to define initial value in the constructor as suggested by ab-it in #20
  • Fixed upper_bound overflow preventing exemple to work on arduino Uno as suggested by sblaisot in pull request #22
  • Avoid triggering change_cb after resetPosition to other position than 0

[1.3] - 2020-06-05

  • Fixed typo in example
  • updated README.md
  • added function setStepsPerClick(), as requested by asalillo in #12
  • Fixed bug #13 in resetPosition(), as pointed out by jjarp
  • removed #pragma message for moves_per_click constructor parameter
  • renamed variable moves_per_click to steps_per_click

[1.2.1] - 2020-04-20

  • Fixed bug related to minimum and maximum bounds
  • Added RangedCounter.ino example
  • Added optional parameter to resetPosition()

[1.2.0] - 2020-04-20

  • Created and added CHANGELOG.md
  • Added optional minimum and maximum bounds to constructor (as suggested by cornfeedhobo in issue #9)

[1.1.2] - 2020-03-31

  • Simplified example

[1.1.1] - 2020-03-30

  • Removed yield() in main loop() since it caused some problems

[1.1.0] - 2020-03-27

  • Added yield() to the main loop()
  • Updated the example (as suggested by per1234)

[1.0.0] - 2017-11-14

  • Added option to set number of clicks to constructor (as suggested by svititom)

Note

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.