Written by: Rui Seixas Monteiro.
Create a new folder called "Versatile_RotaryEncoder" under the folder named "libraries" in your Arduino sketchbook folder. Create the folder "libraries" in case it does not exist yet. Place all the files in the "Versatile_RotaryEncoder" folder.
To use the library in your own sketch, select it from Sketch > Import Library.
The Versatile_RotaryEncoder library allows the callback of up to 10 different functions representing the same number of different encoder events. These different functions can be associated with events like press rotate and long press among many others.
#include <Versatile_RotaryEncoder.h>
void setup(){
}
void loop(){
}Versatile_RotaryEncoder(clk, dt, sw)This function returns a pointer to an object of type Versatile_RotaryEncoder to be used as function calls and sets.
This function sets the handle function for the rotation of the encoder.
Its only parameter is the handle function as void (*)(int8_t rotation) that would be used to process the rotation value.
This function sets the handle function for the rotation of the encoder while being pressed.
Its only parameter is the handle function as void (*)(int8_t rotation) that would be used to process the rotation value.
This function sets the handle function for the rotation of the encoder after being long pressed while held.
Its only parameter is the handle function as void (*)(int8_t rotation) that would be used to process the rotation value.
This function sets the handle function for the button press of the encoder.
Its only parameter is the handle function as void (*)() that would be used to process the pressed encoder switch.
This function sets the handle function for the button double press of the encoder.
Its only parameter is the handle function as void (*)() that would be used to process the double pressed encoder switch.
Giving the function value of 'nullptr' will completly disable the double press feature!
This function sets the handle function for the button release of the encoder.
Its only parameter is the handle function as void (*)() that would be used to process the released encoder switch.
This function sets the handle function for the button long press of the encoder.
Its only parameter is the handle function as void (*)() that would be used to process the long pressed encoder switch.
This function sets the handle function for the button long press released of the encoder.
Its only parameter is the handle function as void (*)() that would be used to process the release of the long pressed encoder switch.
This function sets the handle function for the button release of the encoder after being press rotated.
Its only parameter is the handle function as void (*)() that would be used to process the release encoder switch after being press rotated.
This function sets the handle function for the button release of the encoder after being long press and then rotated.
Its only parameter is the handle function as void (*)() that would be used to process the release encoder switch after being held rotated.
Versatile_RotaryEncoder.ReadEncoder()This function reads the encoder and runs all Handle functions accordingly. It returns a bool with true whenever any handle function is called.
Versatile_RotaryEncoder.setInvertedSwitch( bool invert_switch )By default the switch is triggered from vcc to ground (HIGH to LOW), using this function you can invert this behavior from LOW to HIGH.
Versatile_RotaryEncoder.setReadIntervalDuration( uint8_t duration )By default every 1 ms the encoder is readed, you can set a different value with this function.
Versatile_RotaryEncoder.setShortPressDuration( uint8_t duration )By default it's set 50 ms for the encoder switch debounce, you can set a different value with this function.
Versatile_RotaryEncoder.setLongPressDuration( unsigned int duration )By default it's set 1000 ms for the press be considered a long press, you can set a different value with this function.
Versatile_RotaryEncoder.setDoublePressDuration( unsigned int duration )By default it's set up to 250 ms for repeated presses be considered a double press, you can set a different value with this function.
Versatile_RotaryEncoder.getRotary()This function returns a short int with a positive 1 or negative 1 accordingly to the rotation of the encoder.
The purpose of this function is to allow a more specific use of the library.
Versatile_RotaryEncoder.getButton()This function returns a short unsigned int with a value related to released, holdup, switchup, switchdown, pressed, holddown or held respectively.
The purpose of this function is to allow a more specific use of the library.
Versatile_RotaryEncoder.getEncoder()This function returns a short unsigned int with a value related to inactive, release, press, hold, rotate, pressrotate or heldrotate respectively.
The purpose of this function is to allow a more specific use of the library.
Versatile_RotaryEncoder.getEncoderBits()This function returns a short unsigned int representing the last rotary bits set by the encoder.
The purpose of this function is to allow a more specific use of the library.
Versatile_RotaryEncoder.getButtonBits()This function returns a short unsigned int representing the last button bits set by the encoder.
The purpose of this function is to allow a more specific use of the library.
#include <Versatile_RotaryEncoder.h>
// SET READING PINS ACCORDINGLY TO YOUR ENCODER TO BOARD CONNECTIONS
// Set here your encoder reading pins (Ex.: EC11 with breakout board)
#define clk 17 // (A3)
#define dt 16 // (A2)
#define sw 18 // (A4)
// Functions prototyping to be handled on each Encoder Event
void handleRotate(int8_t rotation);
void handlePressRotate(int8_t rotation);
void handleHeldRotate(int8_t rotation);
void handlePress();
void handleDoublePress();
void handlePressRelease();
void handleLongPress();
void handleLongPressRelease();
void handlePressRotateRelease();
void handleHeldRotateRelease();
// Create a global pointer for the encoder object
Versatile_RotaryEncoder *versatile_encoder;
void setup() {
Serial.begin(9600);
versatile_encoder = new Versatile_RotaryEncoder(clk, dt, sw);
// Load to the encoder all nedded handle functions here (up to 10 functions)
versatile_encoder->setHandleRotate(handleRotate);
versatile_encoder->setHandlePressRotate(handlePressRotate);
versatile_encoder->setHandleHeldRotate(handleHeldRotate);
versatile_encoder->setHandlePress(handlePress);
versatile_encoder->setHandleDoublePress(handleDoublePress);
//versatile_encoder->setHandleDoublePress(nullptr); // Disables Double Press
versatile_encoder->setHandlePressRelease(handlePressRelease);
versatile_encoder->setHandleLongPress(handleLongPress);
versatile_encoder->setHandleLongPressRelease(handleLongPressRelease);
versatile_encoder->setHandlePressRotateRelease(handlePressRotateRelease);
versatile_encoder->setHandleHeldRotateRelease(handleHeldRotateRelease);
Serial.println("Ready!");
// set your own defualt values (optional)
// versatile_encoder->setInvertedSwitch(true); // inverts the switch behaviour from HIGH to LOW to LOW to HIGH
// versatile_encoder->setReadIntervalDuration(1); // set 2ms as long press duration (default is 1ms)
// versatile_encoder->setShortPressDuration(35); // set 35ms as short press duration (default is 50ms)
// versatile_encoder->setLongPressDuration(550); // set 550ms as long press duration (default is 1000ms)
// versatile_encoder->setDoublePressDuration(350); // set 350ms as double press duration (default is 250ms)
}
void loop() {
// Do the encoder reading and processing
if (versatile_encoder->ReadEncoder()) {
// Do something here whenever an encoder action is read
}
}
// Implement your functions here accordingly to your needs
void handleRotate(int8_t rotation) {
Serial.print("#1 Rotated: ");
if (rotation > 0)
Serial.println("Right");
else
Serial.println("Left");
}
void handlePressRotate(int8_t rotation) {
Serial.print("#2 Pressed and rotated: ");
if (rotation > 0)
Serial.println("Right");
else
Serial.println("Left");
}
void handleHeldRotate(int8_t rotation) {
Serial.print("#3 Held and rotated: ");
if (rotation > 0)
Serial.println("Right");
else
Serial.println("Left");
}
void handlePress() {
Serial.println("#4.1 Pressed");
}
void handleDoublePress() {
Serial.println("#4.2 Double Pressed");
}
void handlePressRelease() {
Serial.println("#5 Press released");
}
void handleLongPress() {
Serial.println("#6 Long pressed");
}
void handleLongPressRelease() {
Serial.println("#7 Long press released");
}
void handlePressRotateRelease() {
Serial.println("#8 Press rotate released");
}
void handleHeldRotateRelease() {
Serial.println("#9 Held rotate released");
}