Arduino/ESP library to simplify reading rotary encoder data.
Arduino/ESP library to simplify reading rotary encoder data.
This library allows you read out interactions with a rotary encoder and act on them. It uses callback functions to be notified when the rotary encoder changes.
It has been tested with Arduino, ESP8266 and ESP32 devices.
To see the latest changes to the library please take a look at the Changelog.
If you find this library helpful please consider giving it a ⭐️ at GitHub and/or buy me a ☕️. Thanks!
Some of the code based of this library is based on code from PJRC.
begin()
or the parameterized constructor to create a new instance of the classvoid setStepsPerClick(int steps)
int getStepsPerClick() const
void setChangedHandler(CallbackFunction f)
void setRightRotationHandler(CallbackFunction f)
void setLeftRotationHandler(CallbackFunction f)
void setUpperOverflowHandler(CallbackFunction f)
void setLowerOverflowHandler(CallbackFunction f)
void setUpperBound(int upper_bound)
void setLowerBound(int lower_bound)
int getUpperBound() const
int getLowerBound() const
retriggerEvent(false)
void triggerOnBounds(false)
int getPosition() const
byte getDirection() const
String directionToString(byte direction) const
void setIncrement(int inc)
int getIncrement() const
void setSpeedupInterval(int time)
void setSpeedupIncrement(int inc)
75ms
and the increment is set to 5
.int getSpeedupInterval() const
int getSpeedupIncrement() const
void enableSpeedup(bool enable)
bool isSpeedupEnabled() const
void setSpeedupStartedHandler(CallbackFunction f)
void setSpeedupEndedHandler(CallbackFunction f)
bool isInSpeedup() const
loop()
member function in your sketch's loop()
function.loop()
function.getID()
.setID(int newID)
to set a new one. But then you need to make sure that they are unique.==
operator to compare encodersThese are the constructor and the member functions the library provides:
ESPRotary();
ESPRotary(byte pin1, byte pin2, byte steps_per_click = 1, int lower_bound = INT16_MIN, int upper_bound = INT16_MAX, int iniital_pos = 0, int increment = 1);
void begin(byte pin1, byte pin2, byte steps_per_click = 1, int lower_bound = INT16_MIN, int upper_bound = INT16_MAX, int initial_pos = 0, int increment = 1);
int getPosition() const;
void resetPosition(int p = 0, bool fireCallback = true);
rotary_direction getDirection() const;
String directionToString(rotary_direction dir) const;
void setIncrement(int inc);
int getIncrement() const;
void triggerOnBounds(bool triggerEvents = true);
void enableSpeedup(bool enable);
void setSpeedupInterval(int time);
void setSpeedupIncrement(int inc);
bool isSpeedupEnabled() const;
int getSpeedupInterval() const;
int getSpeedupIncrement() const;
bool isInSpeedup() const;
rotary_event getLastEvent() const;
void retriggerEvent(bool retrigger);
void setUpperBound(int upper_bound);
void setLowerBound(int lower_bound);
int getUpperBound() const;
int getLowerBound() const;
void setStepsPerClick(int steps);
int getStepsPerClick() const;
void setChangedHandler(CallbackFunction f);
void setRightRotationHandler(CallbackFunction f);
void setLeftRotationHandler(CallbackFunction f);
void setUpperOverflowHandler(CallbackFunction f);
void setLowerOverflowHandler(CallbackFunction f);
void setSpeedupStartedHandler(CallbackFunction f);
void setSpeedupEndedHandler(CallbackFunction f);
int getID() const;
void setID(int newID);
bool operator == (ESPRotary &rhs);
void loop();
Open the Arduino IDE choose "Sketch > Include Library" and search for "ESP Rotary". Or download the ZIP archive (https://github.com/lennarthennigs/ESPRotary/zipball/master), and choose "Sketch > Include Library > Add .ZIP Library..." and select the downloaded file.
MIT License
Copyright (c) 2017-2023 Lennart Hennigs
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.