├── library.properties ├── keywords.txt ├── examples ├── wrap │ └── wrap.ino ├── polling_longPress │ └── polling_longPress.ino ├── rotary_switch_logic │ └── rotary_switch_logic.ino ├── sensitive │ └── sensitive.ino ├── interrupts │ └── interrupts.ino ├── interrupts_longPress │ └── interrupts_longPress.ino ├── keyPressTime │ └── keyPressTime.ino └── interrupts_setPosition │ └── interrupts_setPosition.ino ├── README.md ├── src ├── FR_RotaryEncoder.h └── FR_RotaryEncoder.cpp └── LICENSE /library.properties: -------------------------------------------------------------------------------- 1 | name=FR_RotaryEncoder 2 | version=0.0.1 3 | author=Ilias_Iliopoulos - info@fryktoria.com 4 | maintainer=Ilias_Iliopoulos - info@fryktoria.com 5 | sentence=Library that handles a KY-040 Rotary Encoder 6 | paragraph=Rotary Encoder library for a rotary Encoder with an integrated push button 7 | category=Signal Input/Output 8 | url=https://github.com/fryktoria/RotaryEncoder.git 9 | architectures=* 10 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | ########################################### 2 | # Syntax Coloring Map for TimedDigitalIO 3 | ########################################### 4 | 5 | ########################################### 6 | # Datatypes e.g. Classes (KEYWORD1) 7 | ########################################### 8 | 9 | RotaryEncoder KEYWORD1 10 | 11 | ########################################### 12 | # Methods and Functions (KEYWORD2) 13 | ########################################### 14 | 15 | RotaryEncoder KEYWORD2 16 | setRotaryLogic KEYWORD2 17 | enableInternalRotaryPullups KEYWORD2 18 | getDirection KEYWORD2 19 | getPosition KEYWORD2 20 | setPosition KEYWORD2 21 | setMaxValue KEYWORD2 22 | setMinValue KEYWORD2 23 | setWrapMode KEYWORD2 24 | getSwitchState KEYWORD2 25 | setSwitchDebounceDelay KEYWORD2 26 | setSwitchLogic KEYWORD2 27 | enableInternalSwitchPullup KEYWORD2 28 | setLongPressTime KEYWORD2 29 | update KEYWORD2 30 | rotaryUpdate KEYWORD2 31 | switchUpdate KEYWORD2 32 | setSensitive KEYWORD2 33 | setRotationalStep KEYWORD2 34 | setRotaryLimits KEYWORD2 35 | 36 | rotaryLogic KEYWORD2 37 | minValue KEYWORD2 38 | maxValue KEYWORD2 39 | wrapMode KEYWORD2 40 | sensitive KEYWORD2 41 | rotationalStep KEYWORD2 42 | keyPressedTime KEYWORD2 43 | 44 | ####################################### 45 | # Instances (KEYWORD2) 46 | ####################################### 47 | 48 | ########################################### 49 | # Constants (LITERAL1) 50 | ########################################### 51 | 52 | CCW LITERAL1 53 | CW LITERAL1 54 | NOT_MOVED LITERAL1 55 | SW_OFF LITERAL1 56 | SW_ON LITERAL1 57 | SW_LONG LITERAL1 58 | 59 | -------------------------------------------------------------------------------- /examples/wrap/wrap.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Rotary Encoder with Switch Example 3 | 4 | Copyright (c) 2019 by Ilias Iliopoulos info@fryktoria.com 5 | 6 | This file is part of "FR_RotaryEncoder". 7 | 8 | Licensed under GNU General Public License, version 3 of the License 9 | https://www.gnu.org/licenses/ 10 | 11 | 12 | Uses only polling, without any interrupts 13 | Demonstrates the rotation Wrap Mode. After rotating through maximum value, the position 14 | wraps up to the minimum value. 15 | Try also the counter clockwise direction. 16 | Demonstrates alse the rotational step setting. Notice the potential problem when 17 | one of the limits is not a multiple of the rotational step. 18 | 19 | Wiring of the KY-040 Rotary Encoder Module 20 | ------------------------------------------ 21 | Arduino KY-040 22 | 2 SCK 23 | 3 SW 24 | 4 DT 25 | +5V + 26 | GND GND 27 | 28 | 29 | */ 30 | 31 | #include "FR_RotaryEncoder.h" 32 | 33 | int pinSCK = 2; // Interrupt pin for rotary encoder. Can be 2 or 3 34 | int pinDT = 4; // Better select a pin from 4 to 7 35 | int pinSW = 3; // Interrupt pin for switch. Can be 2 or 3 36 | int rotaryMaximum = 10; 37 | int rotaryMinimum = -(rotaryMaximum - 1); 38 | bool rotaryWrapMode = true; // Set true to wrap up 39 | 40 | //----------------------------------------------------------------------------------- 41 | 42 | int lastSwitchState = 0; 43 | int lastPosition; 44 | 45 | RotaryEncoder rencoder(pinSCK, pinDT, pinSW); 46 | 47 | void setup() { 48 | Serial.begin(115200); 49 | Serial.println("Rotary Encoder example with Long Press and without interrupts."); 50 | 51 | // KY-040 does not have a pullup for the switch 52 | // so we must set one 53 | rencoder.enableInternalSwitchPullup(); // Also activates setSwitchLogic(false); 54 | Serial.println("Enabled internal pullup resistor for the switch"); 55 | 56 | rencoder.setRotaryLimits(rotaryMinimum, rotaryMaximum, rotaryWrapMode); 57 | rencoder.setRotationalStep(2); 58 | 59 | } 60 | 61 | 62 | void loop() { 63 | 64 | // Use update() both for switch and rotary 65 | rencoder.update(); 66 | 67 | // Code to present state changes. Same in all examples. 68 | 69 | // Rotary 70 | int currentPosition = rencoder.getPosition(); 71 | if (lastPosition != currentPosition) { 72 | lastPosition = currentPosition; 73 | Serial.print(currentPosition); Serial.print(" "); 74 | int direction = rencoder.getDirection(); 75 | printRotationalDirection(direction); 76 | Serial.println(); 77 | } 78 | 79 | // Switch 80 | int currentSwitchState = rencoder.getSwitchState(); 81 | if (lastSwitchState != currentSwitchState) { 82 | lastSwitchState = currentSwitchState; 83 | if (currentSwitchState == rencoder.SW_LONG) 84 | Serial.println("Switch Long ON"); 85 | else if (currentSwitchState == rencoder.SW_ON) 86 | Serial.println("Switch ON"); 87 | else 88 | Serial.println("Switch OFF"); 89 | } 90 | } 91 | 92 | 93 | void printRotationalDirection(int direction) { 94 | switch(direction) { 95 | case rencoder.CW: 96 | Serial.print("CW"); 97 | break; 98 | case rencoder.CCW: 99 | Serial.print("CCW"); 100 | break; 101 | case rencoder.NOT_MOVED: 102 | Serial.print("NOT_MOVED"); 103 | break; 104 | default: 105 | Serial.print("Unrecognized direction of rotation"); 106 | } 107 | } 108 | -------------------------------------------------------------------------------- /examples/polling_longPress/polling_longPress.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Rotary Encoder with Switch Example 3 | 4 | Copyright (c) 2019 by Ilias Iliopoulos info@fryktoria.com 5 | 6 | This file is part of "FR_RotaryEncoder". 7 | 8 | Licensed under GNU General Public License, version 3 of the License 9 | https://www.gnu.org/licenses/ 10 | 11 | 12 | Uses only polling, without any interrupts. 13 | Demonstrates 14 | - The rotary switch operation 15 | - The switch ON/OFF operation 16 | - The long-press operation of the switch. Press switch and keep pressed. 17 | - The debounce delay for the key press 18 | 19 | Wiring of the KY-040 Rotary Encoder Module 20 | ------------------------------------------ 21 | Arduino KY-040 22 | 2 SCK 23 | 3 SW 24 | 4 DT 25 | +5V + 26 | GND GND 27 | 28 | 29 | */ 30 | 31 | #include "FR_RotaryEncoder.h" 32 | 33 | int pinSCK = 2; // Interrupt pin for rotary encoder. Can be 2 or 3 34 | int pinDT = 4; // Better select a pin from 4 to 7 35 | int pinSW = 3; // Interrupt pin for switch. Can be 2 or 3 36 | int rotaryMaximum = 10; 37 | int rotaryMinimum = -(rotaryMaximum - 1); 38 | bool rotaryWrapMode = false; 39 | 40 | //----------------------------------------------------------------------------------- 41 | 42 | int lastSwitchState = 0; 43 | int lastPosition; 44 | 45 | RotaryEncoder rencoder(pinSCK, pinDT, pinSW); 46 | 47 | void setup() { 48 | Serial.begin(115200); 49 | Serial.println("Rotary Encoder example with Long Press and without interrupts."); 50 | 51 | // KY-040 does not have a pullup for the switch 52 | // so we must set one 53 | rencoder.enableInternalSwitchPullup(); // Also activates setSwitchLogic(false); 54 | Serial.println("Enabled internal pullup resistor for the switch"); 55 | 56 | rencoder.setRotaryLimits(rotaryMinimum, rotaryMaximum, rotaryWrapMode); 57 | 58 | //*********** Sets the time for the long press key to 1 sec 59 | rencoder.setLongPressTime(1000); 60 | 61 | //*********** Sets a debouncing time for the switch to 50 milliseconds 62 | rencoder.setSwitchDebounceDelay(50); 63 | 64 | } 65 | 66 | 67 | void loop() { 68 | 69 | //******* Use update() both for switch and rotary 70 | rencoder.update(); 71 | 72 | // Code to present state changes. Same in all examples. 73 | 74 | // Rotary 75 | int currentPosition = rencoder.getPosition(); 76 | if (lastPosition != currentPosition) { 77 | lastPosition = currentPosition; 78 | Serial.print(currentPosition); Serial.print(" "); 79 | int direction = rencoder.getDirection(); 80 | printRotationalDirection(direction); 81 | Serial.println(); 82 | } 83 | 84 | // Switch 85 | int currentSwitchState = rencoder.getSwitchState(); 86 | if (lastSwitchState != currentSwitchState) { 87 | lastSwitchState = currentSwitchState; 88 | if (currentSwitchState == rencoder.SW_LONG) 89 | Serial.println("Switch Long ON"); 90 | else if (currentSwitchState == rencoder.SW_ON) 91 | Serial.println("Switch ON"); 92 | else 93 | Serial.println("Switch OFF"); 94 | } 95 | } 96 | 97 | 98 | void printRotationalDirection(int direction) { 99 | switch(direction) { 100 | case rencoder.CW: 101 | Serial.print("CW"); 102 | break; 103 | case rencoder.CCW: 104 | Serial.print("CCW"); 105 | break; 106 | case rencoder.NOT_MOVED: 107 | Serial.print("NOT_MOVED"); 108 | break; 109 | default: 110 | Serial.print("Unrecognized direction of rotation"); 111 | } 112 | } 113 | -------------------------------------------------------------------------------- /examples/rotary_switch_logic/rotary_switch_logic.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Rotary Encoder with Switch Example 3 | 4 | Copyright (c) 2019 by Ilias Iliopoulos info@fryktoria.com 5 | 6 | This file is part of "FR_RotaryEncoder". 7 | 8 | Licensed under GNU General Public License, version 3 of the License 9 | https://www.gnu.org/licenses/ 10 | 11 | 12 | Uses only polling, without any interrupts. 13 | Demonstrates the control of the rotation direction with setRotaryLogic(). 14 | Used to invert the indication of the direction of rotation 15 | 16 | Also demonstrates the use of setSwitchLogic(). Used to match switch wiring (normally On 17 | or normally OFF) with the switch logic. 18 | 19 | Wiring of the KY-040 Rotary Encoder Module 20 | ------------------------------------------ 21 | Arduino KY-040 22 | 2 SCK 23 | 3 SW 24 | 4 DT 25 | +5V + 26 | GND GND 27 | 28 | 29 | */ 30 | 31 | #include "FR_RotaryEncoder.h" 32 | 33 | int pinSCK = 2; // Interrupt pin for rotary encoder. Can be 2 or 3 34 | int pinDT = 4; // Better select a pin from 4 to 7 35 | int pinSW = 3; // Interrupt pin for switch. Can be 2 or 3 36 | int rotaryMaximum = 10; 37 | int rotaryMinimum = -(rotaryMaximum - 1); 38 | bool rotaryWrapMode = false; 39 | 40 | //----------------------------------------------------------------------------------- 41 | 42 | int lastSwitchState = 0; 43 | int lastPosition; 44 | 45 | RotaryEncoder rencoder(pinSCK, pinDT, pinSW); 46 | 47 | void setup() { 48 | Serial.begin(115200); 49 | Serial.println("Rotary Encoder example with Long Press and without interrupts."); 50 | 51 | rencoder.setRotaryLimits(rotaryMinimum, rotaryMaximum, rotaryWrapMode); 52 | 53 | //*********** Reverses the CW - CCW direction 54 | rencoder.setRotaryLogic(true); 55 | 56 | // **** Only because test is performed with a KY-040 and we need the internal pull-up resistor 57 | rencoder.enableInternalSwitchPullup(); // Also activates setSwitchLogic(false); 58 | 59 | //*********** Reverses ON - OFF switch state 60 | // When the switch is wired with a pull down resistor. 61 | // This method does not change the internal pull-up resistor setting 62 | rencoder.setSwitchLogic(true); 63 | 64 | } 65 | 66 | 67 | void loop() { 68 | 69 | // Use update() both for switch and rotary 70 | rencoder.update(); 71 | 72 | // Code to present state changes. Same in all examples. 73 | 74 | // Rotary 75 | int currentPosition = rencoder.getPosition(); 76 | if (lastPosition != currentPosition) { 77 | lastPosition = currentPosition; 78 | Serial.print(currentPosition); Serial.print(" "); 79 | int direction = rencoder.getDirection(); 80 | printRotationalDirection(direction); 81 | Serial.println(); 82 | } 83 | 84 | // Switch 85 | int currentSwitchState = rencoder.getSwitchState(); 86 | if (lastSwitchState != currentSwitchState) { 87 | lastSwitchState = currentSwitchState; 88 | if (currentSwitchState == rencoder.SW_LONG) 89 | Serial.println("Switch Long ON"); 90 | else if (currentSwitchState == rencoder.SW_ON) 91 | Serial.println("Switch ON"); 92 | else 93 | Serial.println("Switch OFF"); 94 | } 95 | } 96 | 97 | 98 | void printRotationalDirection(int direction) { 99 | switch(direction) { 100 | case rencoder.CW: 101 | Serial.print("CW"); 102 | break; 103 | case rencoder.CCW: 104 | Serial.print("CCW"); 105 | break; 106 | case rencoder.NOT_MOVED: 107 | Serial.print("NOT_MOVED"); 108 | break; 109 | default: 110 | Serial.print("Unrecognized direction of rotation"); 111 | } 112 | } 113 | -------------------------------------------------------------------------------- /examples/sensitive/sensitive.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Rotary Encoder with Switch Example 3 | 4 | Uses only polling, without any interrupts. 5 | Demonstrates a feature to make rotations more sensitive. The position is updated on every rotational step. 6 | 7 | Copyright (c) 2019 by Ilias Iliopoulos info@fryktoria.com 8 | 9 | This file is part of "FR_RotaryEncoder". 10 | 11 | Licensed under GNU General Public License, version 3 of the License 12 | https://www.gnu.org/licenses/ 13 | 14 | 15 | 16 | Wiring of the KY-040 Rotary Encoder Module 17 | ------------------------------------------ 18 | Arduino KY-040 19 | 2 SCK 20 | 3 SW 21 | 4 DT 22 | +5V + 23 | GND GND 24 | 25 | 26 | */ 27 | 28 | #include "FR_RotaryEncoder.h" 29 | 30 | int pinSCK = 2; // Interrupt pin for rotary encoder. Can be 2 or 3 31 | int pinDT = 4; // Better select a pin from 4 to 7 32 | int pinSW = 3; // Interrupt pin for switch. Can be 2 or 3 33 | int rotaryMaximum = 10; 34 | int rotaryMinimum = -(rotaryMaximum - 1); 35 | bool rotaryWrapMode = false; 36 | 37 | //----------------------------------------------------------------------------------- 38 | 39 | int lastSwitchState = 0; 40 | int lastPosition; 41 | 42 | RotaryEncoder rencoder(pinSCK, pinDT, pinSW); 43 | 44 | void setup() { 45 | Serial.begin(115200); 46 | Serial.println("Rotary Encoder example with Long Press and without interrupts."); 47 | 48 | // KY-040 does not have a pullup for the switch 49 | // so we must set one 50 | rencoder.enableInternalSwitchPullup(); // Also activates setSwitchLogic(false); 51 | Serial.println("Enabled internal pullup resistor for the switch"); 52 | 53 | rencoder.setRotaryLimits(rotaryMinimum, rotaryMaximum, rotaryWrapMode); 54 | 55 | //*********** The position is updated on every rotational step instead of the default two 56 | // First CW transition requires two steps, which is good because, since the direction change requires 57 | // also two steps, the knob returns exactly to zero position. 58 | // Especially when the position is bound to only positive numbers, this is teh most consisent behaviour, 59 | // considering the design limitations below: 60 | // Notes: 61 | // 1. The debouncing procedure by design (using pulse transitions instead of states) 62 | // needs two steps in each change of direction 63 | // 2. Same reason for the first CCW transition to be performed at one single step. 64 | rencoder.setSensitive(true); 65 | 66 | } 67 | 68 | 69 | void loop() { 70 | 71 | // Use update() both for switch and rotary 72 | rencoder.update(); 73 | 74 | // Code to present state changes. Same in all examples. 75 | 76 | // Rotary 77 | int currentPosition = rencoder.getPosition(); 78 | if (lastPosition != currentPosition) { 79 | lastPosition = currentPosition; 80 | Serial.print(currentPosition); Serial.print(" "); 81 | int direction = rencoder.getDirection(); 82 | printRotationalDirection(direction); 83 | Serial.println(); 84 | } 85 | 86 | // Switch 87 | int currentSwitchState = rencoder.getSwitchState(); 88 | if (lastSwitchState != currentSwitchState) { 89 | lastSwitchState = currentSwitchState; 90 | if (currentSwitchState == rencoder.SW_LONG) 91 | Serial.println("Switch Long ON"); 92 | else if (currentSwitchState == rencoder.SW_ON) 93 | Serial.println("Switch ON"); 94 | else 95 | Serial.println("Switch OFF"); 96 | } 97 | } 98 | 99 | 100 | void printRotationalDirection(int direction) { 101 | switch(direction) { 102 | case rencoder.CW: 103 | Serial.print("CW"); 104 | break; 105 | case rencoder.CCW: 106 | Serial.print("CCW"); 107 | break; 108 | case rencoder.NOT_MOVED: 109 | Serial.print("NOT_MOVED"); 110 | break; 111 | default: 112 | Serial.print("Unrecognized direction of rotation"); 113 | } 114 | } 115 | -------------------------------------------------------------------------------- /examples/interrupts/interrupts.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Rotary Encoder with Switch Example 3 | 4 | Copyright (c) 2019 by Ilias Iliopoulos info@fryktoria.com 5 | 6 | This file is part of "FR_RotaryEncoder". 7 | 8 | Licensed under GNU General Public License, version 3 of the License 9 | https://www.gnu.org/licenses/ 10 | 11 | 12 | Uses interrupts. 13 | Demonstrates the usage of two interrupts to utilize the rotary and the switch at the same time. 14 | 15 | *** The long press functionality cannot be used in this method. 16 | 17 | Wiring of the KY-040 Rotary Encoder Module 18 | ------------------------------------------ 19 | Arduino KY-040 20 | 2 SCK 21 | 3 SW 22 | 4 DT 23 | +5V + 24 | GND GND 25 | 26 | 27 | */ 28 | 29 | #include "FR_RotaryEncoder.h" 30 | 31 | int pinSCK = 2; // Interrupt pin for rotary encoder. Can be 2 or 3 32 | int pinDT = 4; // Better select a pin from 4 to 7 33 | int pinSW = 3; // Interrupt pin for switch. Can be 2 or 3 34 | int rotaryMaximum = 10; 35 | int rotaryMinimum = -(rotaryMaximum - 1); 36 | bool rotaryWrapMode = false; 37 | 38 | //----------------------------------------------------------------------------------- 39 | 40 | int lastSwitchState = 0; 41 | int lastPosition; 42 | 43 | RotaryEncoder rencoder(pinSCK, pinDT, pinSW); 44 | 45 | void setup() { 46 | Serial.begin(115200); 47 | Serial.println("Rotary Encoder example with interrupts."); 48 | 49 | // KY-040 does not have a pullup for the switch 50 | // so we must set one 51 | rencoder.enableInternalSwitchPullup(); // Also activates setSwitchLogic(false); 52 | Serial.println("Enabled internal pullup resistor for the switch"); 53 | 54 | rencoder.setRotaryLimits(rotaryMinimum, rotaryMaximum, rotaryWrapMode); 55 | 56 | // One interrupt is required for the rotary 57 | attachInterrupt(digitalPinToInterrupt(pinSCK), ISRrotary, CHANGE); 58 | 59 | // A different interrupt is required for the switch. Pulse edge is set 60 | // to CHANGE because the library design allows both edges 61 | attachInterrupt(digitalPinToInterrupt(pinSW), ISRswitch, CHANGE); 62 | 63 | // ***** Prove that we know that no rotation has been performed yet 64 | int direction = rencoder.getDirection(); 65 | if (direction == rencoder.NOT_MOVED) { 66 | Serial.println("Current rotation direction is NOT_MOVED"); 67 | } 68 | 69 | } 70 | 71 | // Interrupt handling routine for the rotary 72 | void ISRrotary() { 73 | rencoder.rotaryUpdate(); 74 | } 75 | 76 | // Interrupt handling routine for the switch 77 | void ISRswitch() { 78 | rencoder.switchUpdate(); 79 | } 80 | 81 | void loop() { 82 | 83 | // Code to present state changes. Same in all examples. 84 | 85 | // Rotary 86 | int currentPosition = rencoder.getPosition(); 87 | if (lastPosition != currentPosition) { 88 | lastPosition = currentPosition; 89 | Serial.print(currentPosition); Serial.print(" "); 90 | int direction = rencoder.getDirection(); 91 | printRotationalDirection(direction); 92 | Serial.println(); 93 | } 94 | 95 | // Switch 96 | int currentSwitchState = rencoder.getSwitchState(); 97 | if (lastSwitchState != currentSwitchState) { 98 | lastSwitchState = currentSwitchState; 99 | if (currentSwitchState == rencoder.SW_LONG) 100 | Serial.println("Switch Long ON"); 101 | else if (currentSwitchState == rencoder.SW_ON) 102 | Serial.println("Switch ON"); 103 | else 104 | Serial.println("Switch OFF"); 105 | } 106 | } 107 | 108 | void printRotationalDirection(int direction) { 109 | switch(direction) { 110 | case rencoder.CW: 111 | Serial.print("CW"); 112 | break; 113 | case rencoder.CCW: 114 | Serial.print("CCW"); 115 | break; 116 | case rencoder.NOT_MOVED: 117 | Serial.print("NOT_MOVED"); 118 | break; 119 | default: 120 | Serial.print("Unrecognized direction of rotation"); 121 | } 122 | } 123 | -------------------------------------------------------------------------------- /examples/interrupts_longPress/interrupts_longPress.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Rotary Encoder with Switch Example 3 | 4 | Copyright (c) 2019 by Ilias Iliopoulos info@fryktoria.com 5 | 6 | This file is part of "FR_RotaryEncoder". 7 | 8 | Licensed under GNU General Public License, version 3 of the License 9 | https://www.gnu.org/licenses/ 10 | 11 | 12 | Uses interrupts. 13 | Demonstrates the usage of longPress switch functionality, alongside 14 | the interrupts. This can be used if immediate response to key press for On/Off is 15 | necessary, together with a long press functionality. 16 | On and Off, as well as the rotation, are handled by the interrupts 17 | and long press by the polling. 18 | 19 | *** The long press functionality cannot be used in this method. 20 | 21 | Wiring of the KY-040 Rotary Encoder Module 22 | ------------------------------------------ 23 | Arduino KY-040 24 | 2 SCK 25 | 3 SW 26 | 4 DT 27 | +5V + 28 | GND GND 29 | 30 | 31 | */ 32 | 33 | #include "FR_RotaryEncoder.h" 34 | 35 | int pinSCK = 2; // Interrupt pin for rotary encoder. Can be 2 or 3 36 | int pinDT = 4; // Better select a pin from 4 to 7 37 | int pinSW = 3; // Interrupt pin for switch. Can be 2 or 3 38 | int rotaryMaximum = 10; 39 | int rotaryMinimum = -(rotaryMaximum - 1); 40 | bool rotaryWrapMode = false; 41 | 42 | //----------------------------------------------------------------------------------- 43 | 44 | int lastSwitchState = 0; 45 | int lastPosition; 46 | 47 | RotaryEncoder rencoder(pinSCK, pinDT, pinSW); 48 | 49 | void setup() { 50 | Serial.begin(115200); 51 | Serial.println("Rotary Encoder example with interrupts."); 52 | 53 | // KY-040 does not have a pullup for the switch 54 | // so we must set one 55 | rencoder.enableInternalSwitchPullup(); // Also activates setSwitchLogic(false); 56 | Serial.println("Enabled internal pullup resistor for the switch"); 57 | 58 | rencoder.setRotaryLimits(rotaryMinimum, rotaryMaximum, rotaryWrapMode); 59 | 60 | // One interrupt is required for the rotary 61 | attachInterrupt(digitalPinToInterrupt(pinSCK), ISRrotary, CHANGE); 62 | 63 | // A different interrupt is required for the switch. Pulse edge is set 64 | // to CHANGE because the library design allows both edges 65 | attachInterrupt(digitalPinToInterrupt(pinSW), ISRswitch, CHANGE); 66 | 67 | //*************** Set the long press time to 2 seconds 68 | rencoder.setLongPressTime(2000); 69 | 70 | } 71 | 72 | // Interrupt handling routine for the rotary 73 | void ISRrotary() { 74 | rencoder.rotaryUpdate(); 75 | } 76 | 77 | // Interrupt handling routine for the switch 78 | void ISRswitch() { 79 | rencoder.switchUpdate(); 80 | } 81 | 82 | void loop() { 83 | 84 | //********* To enable polling of only the switches 85 | rencoder.switchUpdate(); 86 | 87 | // Code to present state changes. Same in all examples. 88 | 89 | // Rotary 90 | int currentPosition = rencoder.getPosition(); 91 | if (lastPosition != currentPosition) { 92 | lastPosition = currentPosition; 93 | Serial.print(currentPosition); Serial.print(" "); 94 | int direction = rencoder.getDirection(); 95 | printRotationalDirection(direction); 96 | Serial.println(); 97 | } 98 | 99 | // Switch 100 | int currentSwitchState = rencoder.getSwitchState(); 101 | if (lastSwitchState != currentSwitchState) { 102 | lastSwitchState = currentSwitchState; 103 | if (currentSwitchState == rencoder.SW_LONG) 104 | Serial.println("Switch Long ON"); 105 | else if (currentSwitchState == rencoder.SW_ON) 106 | Serial.println("Switch ON"); 107 | else 108 | Serial.println("Switch OFF"); 109 | } 110 | } 111 | 112 | 113 | void printRotationalDirection(int direction) { 114 | switch(direction) { 115 | case rencoder.CW: 116 | Serial.print("CW"); 117 | break; 118 | case rencoder.CCW: 119 | Serial.print("CCW"); 120 | break; 121 | case rencoder.NOT_MOVED: 122 | Serial.print("NOT_MOVED"); 123 | break; 124 | default: 125 | Serial.print("Unrecognized direction of rotation"); 126 | } 127 | } 128 | -------------------------------------------------------------------------------- /examples/keyPressTime/keyPressTime.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Rotary Encoder with Switch Example 3 | 4 | Copyright (c) 2019 by Ilias Iliopoulos info@fryktoria.com 5 | 6 | This file is part of "FR_RotaryEncoder". 7 | 8 | Licensed under GNU General Public License, version 3 of the License 9 | https://www.gnu.org/licenses/ 10 | 11 | 12 | Uses only polling, without any interrupts. 13 | Demonstrates 14 | - The rotary switch operation 15 | - The switch ON/OFF operation 16 | - The long-press operation of the switch. Press switch and keep pressed. 17 | - The debounce delay for the key press 18 | - The reading of the time while the key is pressed 19 | 20 | 21 | Wiring of the KY-040 Rotary Encoder Module 22 | ------------------------------------------ 23 | Arduino KY-040 24 | 2 SCK 25 | 3 SW 26 | 4 DT 27 | +5V + 28 | GND GND 29 | 30 | 31 | */ 32 | 33 | #include "FR_RotaryEncoder.h" 34 | 35 | int pinSCK = 2; // Interrupt pin for rotary encoder. Can be 2 or 3 36 | int pinDT = 4; // Better select a pin from 4 to 7 37 | int pinSW = 3; // Interrupt pin for switch. Can be 2 or 3 38 | int rotaryMaximum = 10; 39 | int rotaryMinimum = -(rotaryMaximum - 1); 40 | bool rotaryWrapMode = false; 41 | 42 | //----------------------------------------------------------------------------------- 43 | 44 | int lastSwitchState = 0; 45 | int lastPosition; 46 | unsigned long lastTimePressed = 1; 47 | 48 | RotaryEncoder rencoder(pinSCK, pinDT, pinSW); 49 | 50 | void setup() { 51 | Serial.begin(115200); 52 | Serial.println("Rotary Encoder example with Long Press and without interrupts."); 53 | 54 | // KY-040 does not have a pullup for the switch 55 | // so we must set one 56 | rencoder.enableInternalSwitchPullup(); // Also activates setSwitchLogic(false); 57 | Serial.println("Enabled internal pullup resistor for the switch"); 58 | 59 | rencoder.setRotaryLimits(rotaryMinimum, rotaryMaximum, rotaryWrapMode); 60 | 61 | //*********** Sets the time for the long press key to 500ms 62 | rencoder.setLongPressTime(500); 63 | 64 | //*********** Sets a debouncing time for the switch to 50 milliseconds 65 | rencoder.setSwitchDebounceDelay(50); 66 | 67 | } 68 | 69 | unsigned long timeThreshold = 100; 70 | 71 | void loop() { 72 | 73 | //******* Use update() both for switch and rotary 74 | rencoder.update(); 75 | 76 | unsigned long currentTimePressed = rencoder.keyPressedTime(); 77 | 78 | // Could use (rencoder.getSwitchState() == rencoder.SW_ON) 79 | if (rencoder.keyPressed()) { 80 | if (currentTimePressed > timeThreshold) { 81 | Serial.print("Pressed time: "); 82 | Serial.println(currentTimePressed); 83 | timeThreshold += 5; 84 | } else { 85 | 86 | } 87 | 88 | } 89 | if (rencoder.getSwitchState() == rencoder.SW_OFF) { 90 | timeThreshold = 100; 91 | } 92 | 93 | // Code to present state changes. Same in all examples. 94 | 95 | // Rotary 96 | int currentPosition = rencoder.getPosition(); 97 | if (lastPosition != currentPosition) { 98 | lastPosition = currentPosition; 99 | Serial.print(currentPosition); Serial.print(" "); 100 | int direction = rencoder.getDirection(); 101 | printRotationalDirection(direction); 102 | Serial.println(); 103 | } 104 | 105 | // Switch 106 | int currentSwitchState = rencoder.getSwitchState(); 107 | if (lastSwitchState != currentSwitchState) { 108 | lastSwitchState = currentSwitchState; 109 | if (currentSwitchState == rencoder.SW_LONG) 110 | Serial.println(" ********* Switch Long ON ******************"); 111 | else if (currentSwitchState == rencoder.SW_ON) 112 | Serial.println("Switch ON"); 113 | else 114 | Serial.println("Switch OFF"); 115 | } 116 | } 117 | 118 | 119 | void printRotationalDirection(int direction) { 120 | switch(direction) { 121 | case rencoder.CW: 122 | Serial.print("CW"); 123 | break; 124 | case rencoder.CCW: 125 | Serial.print("CCW"); 126 | break; 127 | case rencoder.NOT_MOVED: 128 | Serial.print("NOT_MOVED"); 129 | break; 130 | default: 131 | Serial.print("Unrecognized direction of rotation"); 132 | } 133 | } 134 | -------------------------------------------------------------------------------- /examples/interrupts_setPosition/interrupts_setPosition.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Rotary Encoder with Switch Example 3 | 4 | Copyright (c) 2019 by Ilias Iliopoulos info@fryktoria.com 5 | 6 | This file is part of "FR_RotaryEncoder". 7 | 8 | Licensed under GNU General Public License, version 3 of the License 9 | https://www.gnu.org/licenses/ 10 | 11 | 12 | Uses interrupts. 13 | Demonstrates the usage of setPosition(). 14 | When the key is pressed, the postion is reset to a fixed value. 15 | 16 | *** The long press functionality cannot be used in this method. 17 | 18 | Wiring of the KY-040 Rotary Encoder Module 19 | ------------------------------------------ 20 | Arduino KY-040 21 | 2 SCK 22 | 3 SW 23 | 4 DT 24 | +5V + 25 | GND GND 26 | 27 | 28 | */ 29 | 30 | #include "FR_RotaryEncoder.h" 31 | 32 | int pinSCK = 2; // Interrupt pin for rotary encoder. Can be 2 or 3 33 | int pinDT = 4; // Better select a pin from 4 to 7 34 | int pinSW = 3; // Interrupt pin for switch. Can be 2 or 3 35 | int rotaryMaximum = 10; 36 | int rotaryMinimum = -(rotaryMaximum - 1); 37 | bool rotaryWrapMode = false; 38 | 39 | //----------------------------------------------------------------------------------- 40 | 41 | int lastSwitchState = 0; 42 | int lastPosition; 43 | 44 | RotaryEncoder rencoder(pinSCK, pinDT, pinSW); 45 | 46 | void setup() { 47 | Serial.begin(115200); 48 | Serial.println("Rotary Encoder example with interrupts."); 49 | 50 | // KY-040 does not have a pullup for the switch 51 | // so we must set one 52 | rencoder.enableInternalSwitchPullup(); // Also activates setSwitchLogic(false); 53 | Serial.println("Enabled internal pullup resistor for the switch"); 54 | 55 | rencoder.setRotaryLimits(rotaryMinimum, rotaryMaximum, rotaryWrapMode); 56 | 57 | // One interrupt is required for the rotary 58 | attachInterrupt(digitalPinToInterrupt(pinSCK), ISRrotary, CHANGE); 59 | 60 | // A different interrupt is required for the switch. Pulse edge is set 61 | // to CHANGE because the library design allows both edges 62 | attachInterrupt(digitalPinToInterrupt(pinSW), ISRswitch, CHANGE); 63 | 64 | //*********** The position is updated on every rotational step instead of the default two 65 | rencoder.setSensitive(false); 66 | 67 | // ***** Prove that we know that no rotation has been performed yet 68 | int direction = rencoder.getDirection(); 69 | if (direction == rencoder.NOT_MOVED) { 70 | Serial.println("Current rotation direction is NOT_MOVED"); 71 | } 72 | 73 | // ****** Start with a set position 74 | rencoder.setPosition(5); 75 | } 76 | 77 | // Interrupt handling routine for the rotary 78 | void ISRrotary() { 79 | rencoder.rotaryUpdate(); 80 | } 81 | 82 | // Interrupt handling routine for the switch 83 | void ISRswitch() { 84 | rencoder.switchUpdate(); 85 | } 86 | 87 | void loop() { 88 | 89 | if (rencoder.keyPressed()) 90 | rencoder.setPosition(5); 91 | 92 | 93 | // Code to present state changes. Same in all examples. 94 | 95 | // Rotary 96 | int currentPosition = rencoder.getPosition(); 97 | if (lastPosition != currentPosition) { 98 | lastPosition = currentPosition; 99 | Serial.print(currentPosition); Serial.print(" "); 100 | int direction = rencoder.getDirection(); 101 | printRotationalDirection(direction); 102 | Serial.println(); 103 | } 104 | 105 | // Switch 106 | int currentSwitchState = rencoder.getSwitchState(); 107 | if (lastSwitchState != currentSwitchState) { 108 | lastSwitchState = currentSwitchState; 109 | if (currentSwitchState == rencoder.SW_LONG) 110 | Serial.println("Switch Long ON"); 111 | else if (currentSwitchState == rencoder.SW_ON) 112 | Serial.println("Switch ON"); 113 | else 114 | Serial.println("Switch OFF"); 115 | } 116 | } 117 | 118 | 119 | void printRotationalDirection(int direction) { 120 | switch(direction) { 121 | case rencoder.CW: 122 | Serial.print("CW"); 123 | break; 124 | case rencoder.CCW: 125 | Serial.print("CCW"); 126 | break; 127 | case rencoder.NOT_MOVED: 128 | Serial.print("NOT_MOVED"); 129 | break; 130 | default: 131 | Serial.print("Unrecognized direction of rotation"); 132 | } 133 | } 134 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # FR_RotaryEncoder 2 | An Arduino libray for Rotary Encoders (types KY-040/EC11 or similar) 3 | 4 | "FR_RotaryEncoder" is a library for using mechanical rotary encoders 5 | with a built-in push switch. 6 | 7 | Copyright (c) 2019 by Ilias Iliopoulos info@fryktoria.com 8 | 9 | This file is part of "FR_RotaryEncoder". 10 | 11 | Licensed under GNU General Public License, version 3 of the License 12 | https://www.gnu.org/licenses/ 13 | 14 | The part related to the debouncing of the rotary encoder is based on 15 | an idea documented in http://www.technoblogy.com/list?28Y4 16 | The article and code is copyrighted as: 17 | 18 | David Johnson-Davies - www.technoblogy.com - 7th July 2018 19 | Arduino/Genuino Uno 20 | CC BY 4.0 21 | Licensed under a Creative Commons Attribution 4.0 International license: 22 | http://creativecommons.org/licenses/by/4.0/ 23 | 24 | ============================================================================= 25 | 26 | The code supports: 27 | 28 | * Operation via interrupts or polling 29 | * Debouncing of the rotary encoder rotational movement with a method that 30 | does not utilize debouncing time, based on the work of David Johnson-Davies 31 | * Reading of the switch state and identification of Long Press 32 | * Setting of rotational sensitivity 33 | 34 | ============================================================================= 35 | 36 | This code is implemented with the Arduino IDE and has been tested with 37 | IDE 1.8.10, on an Arduino Nano. 38 | 39 | The code has been tested with a KY-040 rotary encoder module, having pull-up 40 | resistors at pins A and B and no pull-up at pin SW, such as: 41 | https://www.aliexpress.com/item/32648520888.html?spm=a2g0s.9042311.0.0.27424c4dMoxkCX 42 | 43 | ============================================================================= 44 | 45 | # Usage: 46 | 47 | 0. Include the library in your sketch 48 | 49 | ```c++ 50 | #include "FR_RotaryEncoder.h" 51 | ``` 52 | 53 | 1. Create an instance of the class and specify the pins used for A (SCK), B (DT) 54 | and the push-button/switch (SW). 55 | It is important to set A to pin 2 or 3 which supports interrupts. 56 | Also important is to set SW to pin 2 or 3, whichever actually of the pins 2 and 3 57 | is not connected to A. 58 | B can be any other Arduino I/O pin. 59 | The name `rencoder` below is arbitrary. You can name your class instance anyway you like. 60 | 61 | ```c++ 62 | RotaryEncoder rencoder(pinSCK, pinDT, pinSW); 63 | ``` 64 | 65 | 2. Check the wiring of the rotary encoder. By default, the Arduino inputs are 66 | configured **without** pull-ups. If the module has pull-up resistors 67 | in pins A and B, you do not have to do anything. But if there are no pull-ups, 68 | you have to set the manually using the internal MCU pull-ups: 69 | 70 | ```c++ 71 | rencoder.enableInternalRotaryPullups(); 72 | ``` 73 | 74 | If the module does not have a pull-up resistor for the switch, 75 | you have to activate a pull-up resistor inside the Arduino. Use: 76 | 77 | ```c++ 78 | rencoder.enableInternalSwitchPullup(); 79 | ``` 80 | 81 | 3. With pull-up resistors and a switch connecting to GND, the steady state (switch not pressed) 82 | is 1 and the active (switch pressed) is 0. If your hardware has a switch from pin to Vcc 83 | and a pull down resistor, 84 | you can invert the logic with: 85 | 86 | ```c++ 87 | rencoder.setSwitchLogic(true); 88 | ``` 89 | 90 | You may also use `rencoder.setRotaryLogic()` to invert the rotational direction. 91 | 92 | 4. Set the positive and negative limits of the rotational position, as well 93 | as the wrap-around mode, with: 94 | 95 | ```c++ 96 | rencoder.setRotaryLimits(rotaryMinimum, rotaryMaximum, rotaryWrapMode); 97 | ``` 98 | 99 | The **rotaryWrap** mode seems simple to understand but is a bit tricky. 100 | 101 | **false**: Increasing position will never be higher than the maximum value. 102 | Decreasing values cannot be lower than the minimum value. 103 | 104 | The tricky part is when this mode is used along with `setRotationalStep()` 105 | and the step is set to a value different than 1. Suppose you have set the 106 | limits to max=10 and min=-9 and the step to 2. In the counter-clockwise direction, 107 | the position may receive values 0, -2, -4, -6, -8 but the next step 108 | would be -10 which is lower than min. If it was allowed to take the value -9, 109 | the clockwise direction would subsequently take values -7, -5, -3, -1, 1 etc. which 110 | is probably not desirable. Therefore, the lowest position will be -8, 111 | regardless of the fact that the min is even lower. 112 | 113 | **true**: After increasing over the maximum value, the position will be set to the minimum 114 | value, regardless of the setting of the rotational step. Similarly for the other 115 | direction. 116 | 117 | 5. You can set any of the operating parameters using the methods documented in **FR_RotaryEncoder.h** 118 | 119 | 6. If you wish to use interrupts, you must create your interrupt handling routine(s) or Interrupt Service Routines (ISR), such as: 120 | 121 | ```c++ 122 | // Interrupt handling routine for the rotary 123 | void ISRrotary() { 124 | rencoder.rotaryUpdate(); 125 | } 126 | // Interrupt handling routine for the switch 127 | void ISRswitch() { 128 | rencoder.switchUpdate(); 129 | } 130 | ``` 131 | 132 | In `setup()` you must associate each interrupt pin with the 133 | relevant interrupt handling routine, such as: 134 | 135 | 136 | ```c++ 137 | attachInterrupt(digitalPinToInterrupt(pinSCK), ISRrotary, CHANGE); 138 | attachInterrupt(digitalPinToInterrupt(pinSW), ISRswitch, CHANGE); 139 | ``` 140 | 141 | 142 | If you do not want to use interrupts, but use the polling method instead, please note 143 | that you are not limited to use pins 2 and 3. Any other Arduino I/O pin will do. 144 | 145 | In such a case, you must place in the `loop()` the routines that handle the encoder. 146 | If you only use the rotary part and not the switch, you can use: 147 | 148 | ```c++ 149 | rencoder.rotaryUpdate(); 150 | ``` 151 | 152 | If you only use the switch, use: 153 | 154 | ```c++ 155 | rencoder.switchUpdate(); 156 | ``` 157 | 158 | If you use both, you can do both jobs at the same time by simply using: 159 | 160 | ```c++ 161 | rencoder.update(); 162 | ``` 163 | 164 | 7. If you wish to use the **Long Press** functionality, in order to identify if the 165 | switch has been pressed continouously, or to retrieve the time that the switch 166 | remains pressed with `rencoder.keyPressedTime()`, you need to place `rencoder.switchUpdate()` 167 | or `rencoder.update()` in the loop, **even if your code uses interrupts**. It 168 | becomes questionable, of course, why you should continue to use such a 169 | mixed interrupt/polling solution, but every design is different and, in any case, 170 | the library supports it. 171 | 172 | The library is accompanied with lots of examples which demonstrate most of the library 173 | features. 174 | 175 | For any issues, you can contact me at 176 | 177 | -------------------------------------------------------------------------------- /src/FR_RotaryEncoder.h: -------------------------------------------------------------------------------- 1 | /* 2 | ============================================================================= 3 | FR_RotaryEncoder.h 4 | ============================================================================= 5 | 6 | "FR_RotaryEncoder" is a library for using mechanical rotary encoders 7 | with a built-in push switch. 8 | 9 | Copyright (c) 2019 by Ilias Iliopoulos info@fryktoria.com 10 | 11 | This file is part of "FR_RotaryEncoder". 12 | 13 | "FR_RotaryEncoder" is free software: you can redistribute it and/or modify 14 | it under the terms of the GNU General Public License as published by 15 | the Free Software Foundation, version 3 of the License, or (at your option) 16 | any later version. 17 | 18 | "FR_RotaryEncoder" is distributed in the hope that it will be useful, 19 | but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | GNU General Public License for more details. 22 | 23 | You should have received a copy of the GNU General Public License 24 | along with FR_RotaryEncoder. If not, see . 25 | 26 | 27 | The part related to the debouncing of the rotary encoder is based on 28 | an idea documented in http://www.technoblogy.com/list?28Y4 29 | The article and code is copyrighted as: 30 | 31 | David Johnson-Davies - www.technoblogy.com - 7th July 2018 32 | Arduino/Genuino Uno 33 | CC BY 4.0 34 | Licensed under a Creative Commons Attribution 4.0 International license: 35 | http://creativecommons.org/licenses/by/4.0/ 36 | 37 | ============================================================================= 38 | */ 39 | 40 | #ifndef FR_ROTARYENCODER_H 41 | #define FR_ROTARYENCODER_H 42 | 43 | #if ARDUINO >= 100 44 | #include "Arduino.h" 45 | #else 46 | #include 47 | #endif 48 | 49 | // Default Rotational limits. Can be set with setRotaryLimits() 50 | #define DEFAULT_ROTARY_MIN -10 51 | #define DEFAULT_ROTARY_MAX 10 52 | 53 | // Rotary wrap-around mode 54 | // false Do not wrap-around 55 | // true Wrap-around at limits 56 | #define DEFAULT_WRAP_MODE false // Do not wrap-around 57 | 58 | // Set true to invert rotational direction 59 | #define DEFAULT_ROTARY_LOGIC false 60 | 61 | // Sets the sensitivity of rotation 62 | // false Two clicks are required per count 63 | // true One click is required per count (with first-click problem) 64 | #define DEFAULT_SENSITIVITY false 65 | 66 | // Boolean logic of the switch wiring 67 | // true means: switch ON if pin is 1, OFF if pin is 0 68 | // false means: switch OFF if pin is 1, ON if pin is 0 69 | // Usually, pull-up resistors are used and idle state is 1, so false must be set 70 | #define DEFAULT_SWITCH_LOGIC false 71 | 72 | // In milliseconds. Can be changed with setDebounceDelay() 73 | // For the switch only. Not used for rotary. 74 | #define DEFAULT_DEBOUNCE_DELAY 100 75 | 76 | // In milliseconds. Can be changed with setLongPressTime() 77 | #define DEFAULT_LONG_PRESS_TIME 700 78 | 79 | //========================================================================== 80 | 81 | class RotaryEncoder 82 | { 83 | public: 84 | // Constructor 85 | RotaryEncoder(int rotaryPinCLK, int rotaryPinDT, int switchPinSW); 86 | 87 | enum RotationDirection { 88 | CCW = -1, 89 | CW = 1, 90 | NOT_MOVED = 0, 91 | ROTARY_POSITION_UNKNOWN = 888 92 | }; 93 | 94 | enum SwitchState { 95 | SW_OFF = 0, 96 | SW_ON = 1, 97 | SW_LONG = 2 98 | }; 99 | 100 | // Sets the limits of the rotary encoder, as well as the wrap mode 101 | void setRotaryLimits(int rotaryMin, int rotaryMax, bool rotaryWrapMode); 102 | 103 | // Sets the rotary switch logic. 104 | // Used to invert the rotation direction 105 | void setRotaryLogic(bool logic); 106 | 107 | // Enable internal pullups resistors for the rotary 108 | void enableInternalRotaryPullups(); 109 | 110 | // Retrieves the rotation direction of the previous rotation 111 | // See enum RotationDirection 112 | // CW = Clockwise 113 | // CCW = Counter-clockwise 114 | // NOT_MOVED = Not moved since initialization or setPosition() 115 | int getDirection(); 116 | 117 | // Returns the current position of the rotary encoder 118 | int getPosition(); 119 | 120 | // Sets a starting position 121 | void setPosition(int newPosition); 122 | 123 | // Sets the maximum value of the rotation counter 124 | void setMaxValue(int newMaxValue); 125 | 126 | // Sets the minimum value of the rotation counter 127 | void setMinValue(int newMinValue); 128 | 129 | // Sets the wrap mode, if rotating in same direction exceeds min or max 130 | // true goes from maxValue to minValue 131 | // false stays at maxValue or minValue, if continued in the same direction 132 | void setWrapMode(bool newWrapMode); 133 | 134 | // Sets the sensitivity of rotation 135 | // false (default): Requires two clicks per transition 136 | // true: Requires one click per transition (except the first after setup 137 | // which depends on the initial switch position) 138 | void setSensitive(bool fast); 139 | 140 | // Sets the step that position changes in every transition 141 | void setRotationalStep(int step); 142 | 143 | // Updates only the encoder state. 144 | void rotaryUpdate(); 145 | 146 | // Switch 147 | 148 | // Enable internal pullup resistor for the switch 149 | void enableInternalSwitchPullup(); 150 | 151 | // Sets the switch logic. 152 | // true means: switch ON if pin is 1, OFF if pin is 0 153 | // false means: switch OFF if pin is 1, ON if pin is 0 154 | void setSwitchLogic(bool logic); 155 | 156 | // Sets the switch debouncing time in milliseconds 157 | void setSwitchDebounceDelay(unsigned long dd); 158 | 159 | // Returns the state of the switch 160 | // See enum SwitchState 161 | // SW_OFF OFF 162 | // SW_ON ON 163 | // SW_LONG Long press 164 | int getSwitchState(); 165 | 166 | // Set the minimum time after which a switch press is considered a Long Press 167 | void setLongPressTime(unsigned long longPress); 168 | 169 | // Returns true while switch is pressed 170 | bool keyPressed(); 171 | 172 | // Returns the time that the switch is pressed, in milliseconds 173 | unsigned long keyPressedTime(); 174 | 175 | // Updates the states of the internal values, both for the rotary and the switch. 176 | // Can be called either from loop or from interrupt. 177 | void update(); 178 | 179 | // Updates only the switch state. 180 | void switchUpdate(); 181 | 182 | 183 | private: 184 | 185 | // Rotary 186 | int pinA, pinB; // Pins used for the rotary encoder. 187 | void changeRotaryValue(bool up); 188 | 189 | // Set in the interrupt service routine and therefore 190 | // should be volatile 191 | volatile int direction = NOT_MOVED; 192 | volatile int rotaryPosition = 0; 193 | volatile int a0 = ROTARY_POSITION_UNKNOWN; 194 | volatile int b0 = ROTARY_POSITION_UNKNOWN; 195 | 196 | // Switch 197 | int pinSwitch; // Pin used for the switch 198 | bool switchLogic = DEFAULT_SWITCH_LOGIC; 199 | volatile bool switchPressed = false; 200 | volatile bool switchLongPress = false; 201 | volatile unsigned long lastPressedTime = 0; // the last time the switch has been pressed 202 | 203 | /* 204 | I hate to write get methods for each one of the following. 205 | If needed and no other issues are considered, move them to 206 | the public area, although this is not considered 207 | proper programming practice. 208 | */ 209 | // Rotary 210 | bool rotaryLogic = DEFAULT_ROTARY_LOGIC; 211 | int maxValue = DEFAULT_ROTARY_MAX; 212 | int minValue = DEFAULT_ROTARY_MIN; 213 | bool wrapMode = DEFAULT_WRAP_MODE; 214 | bool sensitive = DEFAULT_SENSITIVITY; // Two clicks per count 215 | int rotationalStep = 1; // Position changes by 1. Can be set with setRotationalStep 216 | // Switch 217 | unsigned long debounceDelay = DEFAULT_DEBOUNCE_DELAY; // Increase if the output bounces flickers 218 | unsigned long longPressTime = DEFAULT_LONG_PRESS_TIME; // Time for the switch to be pressed so as to be considered a long press (milliseconds) 219 | 220 | 221 | }; 222 | #endif 223 | -------------------------------------------------------------------------------- /src/FR_RotaryEncoder.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | ============================================================================= 3 | FR_RotaryEncoder.cpp 4 | ============================================================================= 5 | 6 | "FR_RotaryEncoder" is a library for using mechanical rotary encoders 7 | with a built-in push switch. 8 | 9 | Copyright (c) 2019 by Ilias Iliopoulos info@fryktoria.com 10 | 11 | This file is part of "FR_RotaryEncoder". 12 | 13 | "FR_RotaryEncoder" is free software: you can redistribute it and/or modify 14 | it under the terms of the GNU General Public License as published by 15 | the Free Software Foundation, version 3 of the License, or (at your option) 16 | any later version. 17 | 18 | "FR_RotaryEncoder" is distributed in the hope that it will be useful, 19 | but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | GNU General Public License for more details. 22 | 23 | You should have received a copy of the GNU General Public License 24 | along with FR_RotaryEncoder. If not, see . 25 | 26 | 27 | The part related to the debouncing of the rotary encoder is based on 28 | an idea documented in http://www.technoblogy.com/list?28Y4 29 | The article and code is copyrighted as: 30 | 31 | David Johnson-Davies - www.technoblogy.com - 7th July 2018 32 | Arduino/Genuino Uno 33 | CC BY 4.0 34 | Licensed under a Creative Commons Attribution 4.0 International license: 35 | http://creativecommons.org/licenses/by/4.0/ 36 | 37 | ============================================================================= 38 | */ 39 | 40 | 41 | #include "FR_RotaryEncoder.h" 42 | 43 | RotaryEncoder::RotaryEncoder(int rotaryPinCLK, int rotaryPinDT, int switchPinSW) 44 | { 45 | //Definitions 46 | pinA = rotaryPinCLK; 47 | pinB= rotaryPinDT; 48 | pinSwitch = switchPinSW; 49 | 50 | pinMode(pinA, INPUT); 51 | pinMode(pinB, INPUT); 52 | pinMode(pinSwitch, INPUT); 53 | 54 | // Internal usage is based on XOR and is opposite of user input 55 | switchLogic = !(switchLogic); 56 | 57 | // Set the initial value to a0 and b0 as the current pin states 58 | a0 = digitalRead(pinA); 59 | b0 = digitalRead(pinB); 60 | 61 | } 62 | 63 | // ----- Rotary operations ----- 64 | 65 | void RotaryEncoder::setRotaryLimits(int rotaryMin, int rotaryMax, bool rotaryWrapMode) 66 | { 67 | minValue = rotaryMin; 68 | maxValue = rotaryMax; 69 | wrapMode = rotaryWrapMode; 70 | } 71 | 72 | void RotaryEncoder::setRotaryLogic(bool logic) 73 | { 74 | rotaryLogic = (logic); 75 | } 76 | 77 | void RotaryEncoder::enableInternalRotaryPullups() 78 | { 79 | pinMode(pinA, INPUT_PULLUP); 80 | pinMode(pinB, INPUT_PULLUP); 81 | } 82 | 83 | int RotaryEncoder::getDirection() 84 | { 85 | return direction; 86 | } 87 | 88 | int RotaryEncoder::getPosition() 89 | { 90 | return rotaryPosition; 91 | } 92 | 93 | void RotaryEncoder::setPosition(int newPosition) 94 | { 95 | rotaryPosition = newPosition; 96 | // After an arbitrary set, the direction is ambiguous 97 | direction = NOT_MOVED; 98 | } 99 | 100 | void RotaryEncoder::setMaxValue(int newMaxValue) 101 | { 102 | maxValue = newMaxValue; 103 | } 104 | 105 | void RotaryEncoder::setMinValue(int newMinValue) 106 | { 107 | minValue = newMinValue; 108 | } 109 | 110 | void RotaryEncoder::setWrapMode(bool newWrapMode) 111 | { 112 | wrapMode = newWrapMode; 113 | } 114 | 115 | void RotaryEncoder::setSensitive(bool fast) 116 | { 117 | sensitive = fast; 118 | } 119 | 120 | void RotaryEncoder::setRotationalStep(int step) 121 | { 122 | rotationalStep = step; 123 | } 124 | 125 | void RotaryEncoder::rotaryUpdate() 126 | //Can be called from interrupt or loop 127 | { 128 | int a = digitalRead(pinA); 129 | int b = digitalRead(pinB); 130 | if (a != a0) { 131 | a0 = a; 132 | if (b0 == ROTARY_POSITION_UNKNOWN) { 133 | b0 = b; 134 | return; 135 | } 136 | if (b != b0) { 137 | //Serial.print("a= ");Serial.print(a); Serial.print(" b="); Serial.println(b); 138 | 139 | // Both signals A and B change at a 90 degree phase. Therefore, bouncing 140 | // of one signal has (hopefully) ended when the other signal changes. 141 | // We now know that both a and b have changed, so we have a valid transition, 142 | // not suffering from bounce. 143 | 144 | // Now we check the current states of A and B to identify the rotation direction. 145 | changeRotaryValue(!(a == b)); 146 | /* 147 | This is the same as: 148 | if (a) { 149 | // Rising edge of A, new a=1 150 | if (b) 151 | changeRotaryValue(false); // a=1 and b=1, CCW 152 | else 153 | changeRotaryValue(true); // a=1 and b=0, CW 154 | } else { 155 | // Falling edge of A, new a is 0 156 | if (b) 157 | changeRotaryValue(true); // a=0 and b=1, CW 158 | else 159 | changeRotaryValue(false); // a=0 and b=0, CCW 160 | } 161 | */ 162 | 163 | if (sensitive) { 164 | //Serial.println("Fast"); 165 | b0 = b; 166 | } else { 167 | // This makes previous B unknown, so the encoder always requires two steps to make one change 168 | //Serial.println("Slow"); 169 | b0 = ROTARY_POSITION_UNKNOWN; 170 | } 171 | } 172 | } 173 | } 174 | 175 | void RotaryEncoder::changeRotaryValue(bool leftRight) 176 | { 177 | int nextRotaryPosition; 178 | 179 | leftRight ^= rotaryLogic; 180 | 181 | if (leftRight) { 182 | nextRotaryPosition = rotaryPosition + rotationalStep; 183 | direction = CW; 184 | } else { 185 | nextRotaryPosition = rotaryPosition - rotationalStep; 186 | direction = CCW; 187 | } 188 | 189 | if (wrapMode) { 190 | if (nextRotaryPosition > maxValue) 191 | rotaryPosition = minValue; 192 | else if (nextRotaryPosition < minValue) 193 | rotaryPosition = maxValue; 194 | else 195 | rotaryPosition = nextRotaryPosition; 196 | 197 | } else { 198 | // Make sure that transitions remain within the range 199 | if ((nextRotaryPosition > maxValue) || (nextRotaryPosition < minValue)){ 200 | // do not change position 201 | direction = NOT_MOVED; 202 | } else { 203 | rotaryPosition = nextRotaryPosition; 204 | } 205 | } 206 | 207 | // Serial.print("Direction "); Serial.println(direction); 208 | // Serial.print("Position "); Serial.println(rotaryPosition); 209 | 210 | } 211 | 212 | // ----- Switch operations ----- 213 | 214 | void RotaryEncoder::enableInternalSwitchPullup() 215 | { 216 | pinMode(pinSwitch, INPUT_PULLUP); 217 | // Defaults to inverted state 218 | setSwitchLogic(false); 219 | } 220 | 221 | void RotaryEncoder::setSwitchLogic(bool logic) 222 | { 223 | // A true input means that 1 is ON but in our implementation 224 | // we use the XOR function to the pin input, 225 | // so we invert to make it work as: input false -> invert, input true -> do not invert 226 | // which is the opposite of XOR 227 | switchLogic = !(logic); 228 | } 229 | 230 | void RotaryEncoder::setSwitchDebounceDelay(unsigned long dd) 231 | { 232 | debounceDelay = dd; 233 | } 234 | 235 | int RotaryEncoder::getSwitchState() 236 | { 237 | if (switchLongPress) 238 | return SW_LONG; 239 | else if (switchPressed) 240 | return SW_ON; 241 | else 242 | return SW_OFF; 243 | } 244 | 245 | void RotaryEncoder::setLongPressTime(unsigned long longPress) 246 | { 247 | longPressTime = longPress; 248 | } 249 | 250 | bool RotaryEncoder::keyPressed() 251 | { 252 | return switchPressed; 253 | } 254 | 255 | unsigned long RotaryEncoder::keyPressedTime() 256 | { 257 | // ****** How shall it behave at millis wrap around?? 258 | if (switchPressed) 259 | return (millis() - lastPressedTime); 260 | else 261 | return 0; 262 | } 263 | 264 | void RotaryEncoder::switchUpdate() 265 | // We may come here either by an ISR caused by a rising or falling edge 266 | // or during polling 267 | { 268 | bool pinState = digitalRead(pinSwitch); 269 | 270 | // Apply the ON/OFF logic so that logic in the code below 1 is always true 271 | pinState ^= switchLogic; 272 | 273 | if (switchPressed) { 274 | 275 | if ((millis() - lastPressedTime) > longPressTime) { 276 | switchLongPress = true; 277 | } 278 | 279 | if ((millis() - lastPressedTime) > debounceDelay) { 280 | // Debouncing period finished, so state is the current state of the switch 281 | // which we consider as stable. 282 | // We also consider that the debouncing period is smaller than the time between 283 | // consecutive switch presses 284 | if (!pinState) { 285 | switchPressed = false; 286 | switchLongPress = false; 287 | lastPressedTime = 0; 288 | } 289 | } 290 | } else { 291 | if (pinState) { 292 | // New period when switch is considered as pressed 293 | switchPressed = true; 294 | lastPressedTime = millis(); 295 | } else { 296 | switchPressed = false; 297 | switchLongPress = false; 298 | lastPressedTime = 0; 299 | } 300 | } 301 | } 302 | 303 | void RotaryEncoder::update() 304 | { 305 | rotaryUpdate(); 306 | switchUpdate(); 307 | } 308 | 309 | 310 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------