├── extras ├── RotaryEncoder.png ├── FritzingRotary.fzz └── FritzingRotary.png ├── ErriezRotaryEncoderFullStep.pdf ├── library.properties ├── keywords.txt ├── LICENSE ├── src ├── ErriezRotaryFullStep.h └── ErriezRotaryFullStep.cpp ├── examples ├── Polled │ ├── PolledFullStepBasic │ │ └── PolledFullStepBasic.ino │ ├── PolledFullStepCounter │ │ └── PolledFullStepCounter.ino │ ├── PolledFullStepButton │ │ └── PolledFullStepButton.ino │ └── PolledFullStepMultiple │ │ └── PolledFullStepMultiple.ino └── Interrupt │ ├── InterruptFullStepBasic │ └── InterruptFullStepBasic.ino │ ├── InterruptFullStepCounter │ └── InterruptFullStepCounter.ino │ └── InterruptFullStepButton │ └── InterruptFullStepButton.ino ├── README.md └── Doxyfile /extras/RotaryEncoder.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Erriez/ErriezRotaryEncoderFullStep/HEAD/extras/RotaryEncoder.png -------------------------------------------------------------------------------- /extras/FritzingRotary.fzz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Erriez/ErriezRotaryEncoderFullStep/HEAD/extras/FritzingRotary.fzz -------------------------------------------------------------------------------- /extras/FritzingRotary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Erriez/ErriezRotaryEncoderFullStep/HEAD/extras/FritzingRotary.png -------------------------------------------------------------------------------- /ErriezRotaryEncoderFullStep.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Erriez/ErriezRotaryEncoderFullStep/HEAD/ErriezRotaryEncoderFullStep.pdf -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=Erriez Rotary Encoder Full Step 2 | version=1.1.1 3 | author=Erriez 4 | maintainer=Erriez 5 | sentence=Rotary Encoder Full Step library for Arduino 6 | paragraph=This is a three speed Full Step Rotary Encoder library for Arduino with configurable sensitivity. Polled and interrupts are supported. 7 | category=Device Control 8 | url=https://github.com/Erriez/ErriezRotaryEncoderFullStep 9 | architectures=* 10 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | ####################################### 2 | # Rotary library for Arduino 3 | ####################################### 4 | 5 | ####################################### 6 | # Datatypes (KEYWORD1) 7 | ####################################### 8 | Rotary KEYWORD1 9 | rotary KEYWORD1 10 | 11 | ####################################### 12 | # Methods and Functions (KEYWORD2) 13 | ####################################### 14 | 15 | begin KEYWORD2 16 | read KEYWORD2 17 | setSensitivity KEYWORD2 18 | getSensitivity KEYWORD2 19 | 20 | ####################################### 21 | # Instances (KEYWORD2) 22 | ####################################### 23 | 24 | ####################################### 25 | # Constants (LITERAL1) 26 | ####################################### 27 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018-2020 Erriez 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /src/ErriezRotaryFullStep.h: -------------------------------------------------------------------------------- 1 | /* 2 | * MIT License 3 | * 4 | * Copyright (c) 2018-2021 Erriez 5 | * 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy 7 | * of this software and associated documentation files (the "Software"), to deal 8 | * in the Software without restriction, including without limitation the rights 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | * copies of the Software, and to permit persons to whom the Software is 11 | * furnished to do so, subject to the following conditions: 12 | * 13 | * The above copyright notice and this permission notice shall be included in all 14 | * copies or substantial portions of the Software. 15 | * 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 | * SOFTWARE. 23 | */ 24 | 25 | /*! 26 | * \file ErriezRotaryFullStep.h 27 | * \brief Three speed full step Rotary Encoder library for Arduino 28 | * \details 29 | * Source: https://github.com/Erriez/ErriezRotaryEncoderFullStep 30 | * Documentation: https://erriez.github.io/ErriezRotaryEncoderFullStep 31 | */ 32 | 33 | #ifndef ERRIEZ_ROTARY_FULL_STEP_H_ 34 | #define ERRIEZ_ROTARY_FULL_STEP_H_ 35 | 36 | #include 37 | 38 | /*! 39 | * \brief Full step Rotary Encoder class 40 | */ 41 | class RotaryFullStep 42 | { 43 | public: 44 | RotaryFullStep(uint8_t pin1, uint8_t pin2, bool pullUp=true, uint8_t sensitivity=100); 45 | int read(); 46 | void setSensitivity(uint8_t sensitivity); 47 | uint8_t getSensitivity(); 48 | 49 | private: 50 | unsigned long _lastChange; 51 | uint8_t _pin1; 52 | uint8_t _pin2; 53 | uint8_t _state; 54 | uint8_t _sensitivity; 55 | }; 56 | 57 | #endif // ERRIEZ_ROTARY_FULL_STEP_H_ 58 | -------------------------------------------------------------------------------- /examples/Polled/PolledFullStepBasic/PolledFullStepBasic.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * MIT License 3 | * 4 | * Copyright (c) 2018-2021 Erriez 5 | * 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy 7 | * of this software and associated documentation files (the "Software"), to deal 8 | * in the Software without restriction, including without limitation the rights 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | * copies of the Software, and to permit persons to whom the Software is 11 | * furnished to do so, subject to the following conditions: 12 | * 13 | * The above copyright notice and this permission notice shall be included in all 14 | * copies or substantial portions of the Software. 15 | * 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 | * SOFTWARE. 23 | */ 24 | 25 | /* Polled Full Step Rotary Encoder basic example 26 | * Source: https://github.com/Erriez/ErriezRotaryEncoderFullStep 27 | * Documentation: https://erriez.github.io/ErriezRotaryEncoderFullStep 28 | */ 29 | 30 | #include 31 | 32 | // Connect rotary pins to the DIGITAL or ANALOG pins of the Arduino board 33 | // Use A0..A7 when using analog pins 34 | #define ROTARY_PIN1 2 35 | #define ROTARY_PIN2 3 36 | 37 | // Initialize full step rotary encoder with internal pull-up pins enabled 38 | // and default sensitivity=100 39 | RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2); 40 | 41 | void setup() 42 | { 43 | // Initialize Serial port 44 | Serial.begin(115200); 45 | while (!Serial) { 46 | ; 47 | } 48 | Serial.println(F("\nBasic example polled full step Rotary Encoder")); 49 | } 50 | 51 | void loop() 52 | { 53 | int rotaryState; 54 | 55 | // Read rotary state 56 | rotaryState = rotary.read(); 57 | 58 | // Print count value when rotary changed 59 | if ((rotaryState > 0) || (rotaryState < 0)) { 60 | Serial.println(rotaryState); 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /examples/Interrupt/InterruptFullStepBasic/InterruptFullStepBasic.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * MIT License 3 | * 4 | * Copyright (c) 2018-2021 Erriez 5 | * 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy 7 | * of this software and associated documentation files (the "Software"), to deal 8 | * in the Software without restriction, including without limitation the rights 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | * copies of the Software, and to permit persons to whom the Software is 11 | * furnished to do so, subject to the following conditions: 12 | * 13 | * The above copyright notice and this permission notice shall be included in all 14 | * copies or substantial portions of the Software. 15 | * 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 | * SOFTWARE. 23 | */ 24 | 25 | /* Basic example full step Rotary Encoder with interrupts 26 | * Source: https://github.com/Erriez/ErriezRotaryEncoderFullStep 27 | * Documentation: https://erriez.github.io/ErriezRotaryEncoderFullStep 28 | */ 29 | 30 | #include 31 | 32 | // Connect rotary pins to the DIGITAL pins of the Arduino board with interrupt 33 | // support: 34 | // 35 | // +-----------------------------------+----------------------------+ 36 | // | Board | DIGITAL interrupt pins | 37 | // +-----------------------------------+----------------------------+ 38 | // | Uno, Nano, Mini, other 328-based | 2, 3 | 39 | // | Mega, Mega2560, MegaADK | 2, 3, 18, 19, 20, 21 | 40 | // | Micro, Leonardo, other 32u4-based | 0, 1, 2, 3, 7 | 41 | // | WeMos D1 R2 & mini (ESP8266) | 12 = D6; 13 = D7; 14 = D5 | 42 | // +-----------------------------------+----------------------------+ 43 | // 44 | #define ROTARY_PIN1 2 45 | #define ROTARY_PIN2 3 46 | 47 | // Initialize full step rotary encoder with internal pull-up pins enabled 48 | // and default sensitivity=100 49 | RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2); 50 | 51 | // Forward declaration 52 | void rotaryInterrupt(); 53 | 54 | void setup() 55 | { 56 | // Initialize Serial port 57 | Serial.begin(115200); 58 | while (!Serial) { 59 | ; 60 | } 61 | Serial.println(F("\nBasic example full step Rotary Encoder with interrupts")); 62 | 63 | // Initialize pin change interrupt on both rotary encoder pins 64 | attachInterrupt(digitalPinToInterrupt(ROTARY_PIN1), rotaryInterrupt, CHANGE); 65 | attachInterrupt(digitalPinToInterrupt(ROTARY_PIN2), rotaryInterrupt, CHANGE); 66 | } 67 | 68 | void loop() 69 | { 70 | // Wait for interrupt 71 | } 72 | 73 | #if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32) 74 | ICACHE_RAM_ATTR 75 | #endif 76 | void rotaryInterrupt() 77 | { 78 | int rotaryState; 79 | 80 | // Read rotary state 81 | rotaryState = rotary.read(); 82 | 83 | // Print count value when count value changed 84 | if ((rotaryState > 0) || (rotaryState < 0)) { 85 | Serial.println(rotaryState); 86 | } 87 | } 88 | -------------------------------------------------------------------------------- /examples/Polled/PolledFullStepCounter/PolledFullStepCounter.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * MIT License 3 | * 4 | * Copyright (c) 2018-2021 Erriez 5 | * 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy 7 | * of this software and associated documentation files (the "Software"), to deal 8 | * in the Software without restriction, including without limitation the rights 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | * copies of the Software, and to permit persons to whom the Software is 11 | * furnished to do so, subject to the following conditions: 12 | * 13 | * The above copyright notice and this permission notice shall be included in all 14 | * copies or substantial portions of the Software. 15 | * 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 | * SOFTWARE. 23 | */ 24 | 25 | /* Counter example polled full step Rotary Encoder 26 | * Source: https://github.com/Erriez/ErriezRotaryEncoderFullStep 27 | * Documentation: https://erriez.github.io/ErriezRotaryEncoderFullStep 28 | */ 29 | 30 | #include 31 | 32 | // Connect rotary pins to the DIGITAL or ANALOG pins of the Arduino board 33 | // Use A0..A7 when using analog pins 34 | #define ROTARY_PIN1 2 35 | #define ROTARY_PIN2 3 36 | 37 | // Initialize full step rotary encoder with internal pull-up pins enabled 38 | // and default sensitivity=100 39 | RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2); 40 | 41 | // Or initialize full step rotary encoder with internal pull-up pins disabled 42 | // and default sensitivity=100 43 | // RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2, false); 44 | 45 | // Or initialize full step rotary encoder with internal pull-up pins enabled and 46 | // sensitivity value 1..255 47 | // A higher value is more sensitive 48 | // RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2, true, 200); 49 | 50 | // Global variables 51 | int count = 0; 52 | int countLast = 0; 53 | 54 | 55 | void setup() 56 | { 57 | // Initialize Serial port 58 | Serial.begin(115200); 59 | while (!Serial) { 60 | ; 61 | } 62 | Serial.println(F("\nCounter example polled full step Rotary Encoder")); 63 | 64 | // Change sensitivity 65 | rotary.setSensitivity(125); 66 | } 67 | 68 | void loop() 69 | { 70 | int rotaryState; 71 | 72 | // Read rotary state (Counter clockwise) -2, -1, 0, 1, 2 (Clockwise) 73 | rotaryState = rotary.read(); 74 | 75 | // Count up or down by using rotary speed 76 | if (rotaryState == 0) { 77 | // No change 78 | return; 79 | } else if (abs(rotaryState) >= 2) { 80 | count += rotaryState * 2; 81 | } else { 82 | count += rotaryState; 83 | } 84 | 85 | // Limit count to a minimum and maximum value 86 | if (count > 100) { 87 | count = 100; 88 | } 89 | if (count < 0) { 90 | count = 0; 91 | } 92 | 93 | // Print count value when count value changed 94 | if (countLast != count) { 95 | countLast = count; 96 | Serial.print(F("Count: ")); 97 | Serial.println(count); 98 | } 99 | } 100 | -------------------------------------------------------------------------------- /examples/Polled/PolledFullStepButton/PolledFullStepButton.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * MIT License 3 | * 4 | * Copyright (c) 2018-2021 Erriez 5 | * 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy 7 | * of this software and associated documentation files (the "Software"), to deal 8 | * in the Software without restriction, including without limitation the rights 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | * copies of the Software, and to permit persons to whom the Software is 11 | * furnished to do so, subject to the following conditions: 12 | * 13 | * The above copyright notice and this permission notice shall be included in all 14 | * copies or substantial portions of the Software. 15 | * 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 | * SOFTWARE. 23 | */ 24 | 25 | /* Button example polled full step Rotary Encoder 26 | * Source: https://github.com/Erriez/ErriezRotaryEncoderFullStep 27 | * Documentation: https://erriez.github.io/ErriezRotaryEncoderFullStep 28 | */ 29 | 30 | #include 31 | 32 | // Connect rotary pins to the DIGITAL or ANALOG pins of the Arduino board 33 | // Use A0..A7 when using analog pins 34 | #define ROTARY_PIN1 2 35 | #define ROTARY_PIN2 3 36 | #define ROTARY_BUTTON_PIN 4 37 | 38 | // Initialize full step rotary encoder with internal pull-up pins enabled 39 | // and default sensitivity=100 40 | RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2); 41 | 42 | // Or initialize full step rotary encoder with internal pull-up pins disabled 43 | // and default sensitivity=100 44 | // RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2, false); 45 | 46 | // Or initialize full step rotary encoder with internal pull-up pins enabled and 47 | // sensitivity value 1..255 48 | // A higher value is more sensitive 49 | // RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2, true, 200); 50 | 51 | // Global variables 52 | int count = 0; 53 | int countLast = 0; 54 | 55 | 56 | void setup() 57 | { 58 | // Initialize Serial port 59 | Serial.begin(115200); 60 | while (!Serial) { 61 | ; 62 | } 63 | Serial.println(F("\nButton example polled full step Rotary Encoder")); 64 | 65 | // Enable internal pull-up for the rotary button pin 66 | pinMode(ROTARY_BUTTON_PIN, INPUT_PULLUP); 67 | } 68 | 69 | void loop() 70 | { 71 | int rotaryState; 72 | 73 | if (digitalRead(ROTARY_BUTTON_PIN) == 0) { 74 | // Reset count when rotary button is down 75 | count = 0; 76 | } else { 77 | // Read rotary state (Counter clockwise) -2, -1, 0, 1, 2 (Clockwise) 78 | rotaryState = rotary.read(); 79 | 80 | // Count up or down by using rotary speed 81 | if (rotaryState == 0) { 82 | // No change 83 | return; 84 | } else if (abs(rotaryState) >= 2) { 85 | count += rotaryState * 2; 86 | } else { 87 | count += rotaryState; 88 | } 89 | 90 | // Limit count to a minimum and maximum value 91 | if (count > 100) { 92 | count = 100; 93 | } 94 | if (count < 0) { 95 | count = 0; 96 | } 97 | } 98 | 99 | // Print count value when count value changed 100 | if (countLast != count) { 101 | countLast = count; 102 | Serial.print(F("Count: ")); 103 | Serial.println(count); 104 | } 105 | } 106 | -------------------------------------------------------------------------------- /examples/Interrupt/InterruptFullStepCounter/InterruptFullStepCounter.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * MIT License 3 | * 4 | * Copyright (c) 2018-2021 Erriez 5 | * 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy 7 | * of this software and associated documentation files (the "Software"), to deal 8 | * in the Software without restriction, including without limitation the rights 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | * copies of the Software, and to permit persons to whom the Software is 11 | * furnished to do so, subject to the following conditions: 12 | * 13 | * The above copyright notice and this permission notice shall be included in all 14 | * copies or substantial portions of the Software. 15 | * 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 | * SOFTWARE. 23 | */ 24 | 25 | /* Counter example full step Rotary Encoder with interrupts 26 | * Source: https://github.com/Erriez/ErriezRotaryEncoderFullStep 27 | * Documentation: https://erriez.github.io/ErriezRotaryEncoderFullStep 28 | */ 29 | 30 | #include 31 | 32 | // Connect rotary pins to the DIGITAL pins of the Arduino board with interrupt 33 | // support: 34 | // 35 | // +-----------------------------------+----------------------------+ 36 | // | Board | DIGITAL interrupt pins | 37 | // +-----------------------------------+----------------------------+ 38 | // | Uno, Nano, Mini, other 328-based | 2, 3 | 39 | // | Mega, Mega2560, MegaADK | 2, 3, 18, 19, 20, 21 | 40 | // | Micro, Leonardo, other 32u4-based | 0, 1, 2, 3, 7 | 41 | // | WeMos D1 R2 & mini (ESP8266) | 12 = D6; 13 = D7; 14 = D5 | 42 | // +-----------------------------------+----------------------------+ 43 | // 44 | #define ROTARY_PIN1 2 45 | #define ROTARY_PIN2 3 46 | 47 | // Initialize full step rotary encoder with internal pull-up pins enabled 48 | // and default sensitivity=100 49 | RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2); 50 | 51 | // Or initialize full step rotary encoder with internal pull-up pins disabled 52 | // and default sensitivity=100 53 | // RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2, false); 54 | 55 | // Or initialize full step rotary encoder with internal pull-up pins enabled and 56 | // sensitivity value 1..255 57 | // A higher value is more sensitive 58 | // RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2, true, 200); 59 | 60 | // Global variables 61 | int count = 0; 62 | int countLast = 0; 63 | 64 | // Forward declaration 65 | void rotaryInterrupt(); 66 | 67 | 68 | void setup() 69 | { 70 | // Initialize Serial port 71 | Serial.begin(115200); 72 | while (!Serial) { 73 | ; 74 | } 75 | Serial.println(F("\nCounter example full step Rotary Encoder with interrupts")); 76 | 77 | // Initialize pin change interrupt on both rotary encoder pins 78 | attachInterrupt(digitalPinToInterrupt(ROTARY_PIN1), rotaryInterrupt, CHANGE); 79 | attachInterrupt(digitalPinToInterrupt(ROTARY_PIN2), rotaryInterrupt, CHANGE); 80 | 81 | // Change sensitivity 82 | rotary.setSensitivity(125); 83 | } 84 | 85 | void loop() 86 | { 87 | // Wait for interrupt 88 | } 89 | 90 | #if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32) 91 | ICACHE_RAM_ATTR 92 | #endif 93 | void rotaryInterrupt() 94 | { 95 | int rotaryState; 96 | 97 | // Read rotary state (Counter clockwise) -2, -1, 0, 1, 2 (Clockwise) 98 | rotaryState = rotary.read(); 99 | 100 | // Count up or down by using rotary speed 101 | if (rotaryState == 0) { 102 | // No change 103 | return; 104 | } else if (abs(rotaryState) >= 2) { 105 | count += rotaryState * 2; 106 | } else { 107 | count += rotaryState; 108 | } 109 | 110 | // Limit count to a minimum and maximum value 111 | if (count > 100) { 112 | count = 100; 113 | } 114 | if (count < 0) { 115 | count = 0; 116 | } 117 | 118 | // Print count value when count value changed 119 | if (countLast != count) { 120 | countLast = count; 121 | Serial.print(F("Count: ")); 122 | Serial.println(count); 123 | } 124 | } 125 | -------------------------------------------------------------------------------- /examples/Polled/PolledFullStepMultiple/PolledFullStepMultiple.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * MIT License 3 | * 4 | * Copyright (c) 2018-2021 Erriez 5 | * 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy 7 | * of this software and associated documentation files (the "Software"), to deal 8 | * in the Software without restriction, including without limitation the rights 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | * copies of the Software, and to permit persons to whom the Software is 11 | * furnished to do so, subject to the following conditions: 12 | * 13 | * The above copyright notice and this permission notice shall be included in all 14 | * copies or substantial portions of the Software. 15 | * 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 | * SOFTWARE. 23 | */ 24 | 25 | /* Example multiple polled full step Rotary Encoders 26 | * Source: https://github.com/Erriez/ErriezRotaryEncoderFullStep 27 | * Documentation: https://erriez.github.io/ErriezRotaryEncoderFullStep 28 | */ 29 | 30 | #include 31 | 32 | // Connect rotary pins to the DIGITAL or ANALOG pins of the Arduino board 33 | // Use A0..A7 when using analog pins 34 | #define ROTARY1_PIN1 2 35 | #define ROTARY1_PIN2 3 36 | #define ROTARY1_BUTTON_PIN 4 37 | #define ROTARY2_PIN1 5 38 | #define ROTARY2_PIN2 6 39 | #define ROTARY2_BUTTON_PIN 7 40 | 41 | // Configure a number of rotaries 42 | #define NUM_ROTARIES 2 43 | 44 | // Initialize full step rotary encoder with internal pull-up pins enabled 45 | // and default sensitivity=100 46 | RotaryFullStep rotaries[NUM_ROTARIES] = { 47 | RotaryFullStep(ROTARY1_PIN1, ROTARY1_PIN2), 48 | RotaryFullStep(ROTARY2_PIN1, ROTARY2_PIN2) 49 | }; 50 | 51 | // Global variables 52 | int pinStateLast[NUM_ROTARIES]; 53 | 54 | // Forward declarations 55 | void handleRotaryButton(uint8_t rotaryId); 56 | 57 | 58 | void setup() 59 | { 60 | // Initialize Serial port 61 | Serial.begin(115200); 62 | while (!Serial) { 63 | ; 64 | } 65 | Serial.println(F("\nExample multiple polled full step Rotary Encoders")); 66 | Serial.println(F("Press the rotary button to change sensitivity")); 67 | 68 | // Enable internal pull-up for the rotary button pins 69 | pinMode(ROTARY1_BUTTON_PIN, INPUT_PULLUP); 70 | pinMode(ROTARY2_BUTTON_PIN, INPUT_PULLUP); 71 | } 72 | 73 | void loop() 74 | { 75 | // Handle multiple Rotary Encoders 76 | for (uint8_t i = 0; i < NUM_ROTARIES; i++) { 77 | // Handle rotary button 78 | handleRotaryButton(i); 79 | 80 | // Read rotary state 81 | int rotaryState = rotaries[i].read(); 82 | 83 | // Print count value when rotary changed 84 | if ((rotaryState > 0) || (rotaryState < 0)) { 85 | Serial.print(F("Rotary ")); 86 | Serial.print(i + 1); 87 | Serial.print(F(": ")); 88 | Serial.println(rotaryState); 89 | } 90 | } 91 | } 92 | 93 | void handleRotaryButton(uint8_t rotaryId) 94 | { 95 | int pinState; 96 | 97 | // Read Rotary button state 98 | switch (rotaryId) { 99 | case 0: 100 | pinState = digitalRead(ROTARY1_BUTTON_PIN); 101 | break; 102 | case 1: 103 | pinState = digitalRead(ROTARY2_BUTTON_PIN); 104 | break; 105 | default: 106 | return; 107 | } 108 | 109 | // Check if Rotary button state changed 110 | if (pinStateLast[rotaryId] != pinState) { 111 | pinStateLast[rotaryId] = pinState; 112 | 113 | // Check if button is down 114 | if (pinState == 0) { 115 | uint8_t sensitivity; 116 | 117 | // Get current Rotary sensitivity 118 | sensitivity = rotaries[rotaryId].getSensitivity(); 119 | 120 | // Increment sensitivity value in steps of 50 121 | if (sensitivity >= 250) { 122 | sensitivity = 0; 123 | } else { 124 | sensitivity += 50; 125 | } 126 | 127 | // Print new sensitivity value on Serial 128 | Serial.print(F("Rotary ")); 129 | Serial.print(rotaryId + 1); 130 | Serial.print(F(" sensitivity: ")); 131 | Serial.println(sensitivity); 132 | 133 | // Set new Rotary sensitivity value 134 | rotaries[rotaryId].setSensitivity(sensitivity); 135 | } 136 | } 137 | } 138 | -------------------------------------------------------------------------------- /examples/Interrupt/InterruptFullStepButton/InterruptFullStepButton.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * MIT License 3 | * 4 | * Copyright (c) 2018-2021 Erriez 5 | * 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy 7 | * of this software and associated documentation files (the "Software"), to deal 8 | * in the Software without restriction, including without limitation the rights 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | * copies of the Software, and to permit persons to whom the Software is 11 | * furnished to do so, subject to the following conditions: 12 | * 13 | * The above copyright notice and this permission notice shall be included in all 14 | * copies or substantial portions of the Software. 15 | * 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 | * SOFTWARE. 23 | */ 24 | 25 | /* Button example full step Rotary Encoder with interrupts 26 | * Source: https://github.com/Erriez/ErriezRotaryEncoderFullStep 27 | * Documentation: https://erriez.github.io/ErriezRotaryEncoderFullStep 28 | */ 29 | 30 | #include 31 | 32 | // Connect rotary pins to the DIGITAL pins of the Arduino board with interrupt 33 | // support: 34 | // 35 | // +-----------------------------------+----------------------------+ 36 | // | Board | DIGITAL interrupt pins | 37 | // +-----------------------------------+----------------------------+ 38 | // | Uno, Nano, Mini, other 328-based | 2, 3 | 39 | // | Mega, Mega2560, MegaADK | 2, 3, 18, 19, 20, 21 | 40 | // | Micro, Leonardo, other 32u4-based | 0, 1, 2, 3, 7 | 41 | // | WeMos D1 R2 & mini (ESP8266) | 12 = D6; 13 = D7; 14 = D5 | 42 | // +-----------------------------------+----------------------------+ 43 | // 44 | #define ROTARY_PIN1 2 45 | #define ROTARY_PIN2 3 46 | #define ROTARY_BUTTON_PIN 4 47 | 48 | // Initialize full step rotary encoder with internal pull-up pins enabled 49 | // and default sensitivity=100 50 | RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2); 51 | 52 | // Or initialize full step rotary encoder with internal pull-up pins disabled 53 | // and default sensitivity=100 54 | // RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2, false); 55 | 56 | // Or initialize full step rotary encoder with internal pull-up pins enabled and 57 | // sensitivity value 1..255 58 | // A higher value is more sensitive 59 | // RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2, true, 200); 60 | 61 | // Global variables 62 | // Make count variable volatile, because it is accessed from the main loop as 63 | // well as the interrupt handler 64 | volatile int count = 0; 65 | int countLast = 0; 66 | 67 | // Forward declaration 68 | void rotaryInterrupt(); 69 | void printCount(); 70 | 71 | 72 | void setup() 73 | { 74 | // Initialize Serial port 75 | Serial.begin(115200); 76 | while (!Serial) { 77 | ; 78 | } 79 | Serial.println(F("\nButton example full step Rotary Encoder with interrupts")); 80 | 81 | // Enable internal pull-up for the rotary button pin 82 | pinMode(ROTARY_BUTTON_PIN, INPUT_PULLUP); 83 | 84 | // Initialize pin change interrupt on both rotary encoder pins 85 | attachInterrupt(digitalPinToInterrupt(ROTARY_PIN1), rotaryInterrupt, CHANGE); 86 | attachInterrupt(digitalPinToInterrupt(ROTARY_PIN2), rotaryInterrupt, CHANGE); 87 | } 88 | 89 | void loop() 90 | { 91 | // Poll Rotary button pin 92 | if (digitalRead(ROTARY_BUTTON_PIN) == 0) { 93 | // Reset and print count value when rotary button is down and count > 0 94 | if (count != 0) { 95 | count = 0; 96 | printCount(); 97 | } 98 | } 99 | } 100 | 101 | #if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32) 102 | ICACHE_RAM_ATTR 103 | #endif 104 | void rotaryInterrupt() 105 | { 106 | int rotaryState; 107 | 108 | // Read rotary state (Counter clockwise) -2, -1, 0, 1, 2 (Clockwise) 109 | rotaryState = rotary.read(); 110 | 111 | // Count up or down by using rotary speed 112 | if (rotaryState == 0) { 113 | // No change 114 | return; 115 | } else if (abs(rotaryState) >= 2) { 116 | count += rotaryState * 2; 117 | } else { 118 | count += rotaryState; 119 | } 120 | 121 | // Limit count to a minimum and maximum value 122 | if (count > 100) { 123 | count = 100; 124 | } 125 | if (count < 0) { 126 | count = 0; 127 | } 128 | 129 | // Print count value when count value changed 130 | if (countLast != count) { 131 | countLast = count; 132 | printCount(); 133 | } 134 | } 135 | 136 | void printCount() 137 | { 138 | // Print count value on Serial 139 | Serial.print(F("Count: ")); 140 | Serial.println(count); 141 | } 142 | -------------------------------------------------------------------------------- /src/ErriezRotaryFullStep.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * MIT License 3 | * 4 | * Copyright (c) 2018-2021 Erriez 5 | * 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy 7 | * of this software and associated documentation files (the "Software"), to deal 8 | * in the Software without restriction, including without limitation the rights 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | * copies of the Software, and to permit persons to whom the Software is 11 | * furnished to do so, subject to the following conditions: 12 | * 13 | * The above copyright notice and this permission notice shall be included in all 14 | * copies or substantial portions of the Software. 15 | * 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 | * SOFTWARE. 23 | */ 24 | 25 | /*! 26 | * \file ErriezRotaryFullStep.cpp 27 | * \brief Three speed full step Rotary Encoder library for Arduino. 28 | * \details 29 | * Source: https://github.com/Erriez/ErriezRotaryEncoderFullStep 30 | * Documentation: https://erriez.github.io/ErriezRotaryEncoderFullStep 31 | */ 32 | 33 | #if (defined(__AVR__) || defined(ARDUINO_ARCH_SAM) || defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_STM32F1)) 34 | #include 35 | #else 36 | #include 37 | #endif 38 | 39 | #include "ErriezRotaryFullStep.h" 40 | 41 | #define DIR_NONE 0x00 //!< No complete step yet 42 | #define DIR_CW 0x10 //!< Clockwise step 43 | #define DIR_CCW 0x20 //!< Counter-clockwise step 44 | 45 | // Use the full-step state table, clockwise and counter clockwise 46 | // Emits a code at '00' only 47 | #define RFS_START 0x00 //!< Rotary full step start 48 | #define RFS_CW_FINAL 0x01 //!< Rotary full step clock wise final 49 | #define RFS_CW_BEGIN 0x02 //!< Rotary full step clock begin 50 | #define RFS_CW_NEXT 0x03 //!< Rotary full step clock next 51 | #define RFS_CCW_BEGIN 0x04 //!< Rotary full step counter clockwise begin 52 | #define RFS_CCW_FINAL 0x05 //!< Rotary full step counter clockwise final 53 | #define RFS_CCW_NEXT 0x06 //!< Rotary full step counter clockwise next 54 | 55 | static const PROGMEM uint8_t fullStepTable[7][4] = { 56 | // RFS_START 57 | {RFS_START, RFS_CW_BEGIN, RFS_CCW_BEGIN, RFS_START}, 58 | // RFS_CW_FINAL 59 | {RFS_CW_NEXT, RFS_START, RFS_CW_FINAL, RFS_START | DIR_CW}, 60 | // RFS_CW_BEGIN 61 | {RFS_CW_NEXT, RFS_CW_BEGIN, RFS_START, RFS_START}, 62 | // RFS_CW_NEXT 63 | {RFS_CW_NEXT, RFS_CW_BEGIN, RFS_CW_FINAL, RFS_START}, 64 | // RFS_CCW_BEGIN 65 | {RFS_CCW_NEXT, RFS_START, RFS_CCW_BEGIN, RFS_START}, 66 | // RFS_CCW_FINAL 67 | {RFS_CCW_NEXT, RFS_CCW_FINAL, RFS_START, RFS_START | DIR_CCW}, 68 | // RFS_CCW_NEXT 69 | {RFS_CCW_NEXT, RFS_CCW_FINAL, RFS_CCW_BEGIN, RFS_START}, 70 | }; 71 | 72 | /*! 73 | * \brief 74 | * Constructor full step Rotary Encoder 75 | * \param pin1 76 | * Rotary Encoder pin 1 77 | * \param pin2 78 | * Rotary Encoder pin 2 79 | * \param pullUp 80 | * true: Enable internal pull-up on Rotary Encoder pins [default argument]. 81 | * false: Disable internal pull-up on Rotary Encoder pins. 82 | * \param sensitivity 83 | * Set sensitivity rotation speed value 0..255. 84 | * A higher is more sensitive for rotation speed, a smaller value is less 85 | * sensitive or will disable speed detection. 86 | * Default is 100. 87 | */ 88 | RotaryFullStep::RotaryFullStep(uint8_t pin1, uint8_t pin2, bool pullUp, uint8_t sensitivity) : 89 | _pin1(pin1), _pin2(pin2), _state(0), _sensitivity(sensitivity) 90 | { 91 | if (pullUp) { 92 | // Enable internal pull-up 93 | pinMode(_pin1, INPUT_PULLUP); 94 | pinMode(_pin2, INPUT_PULLUP); 95 | } 96 | } 97 | 98 | /*! 99 | * \brief 100 | * Read Rotary Encoder state 101 | * \details 102 | * Call this function as fast as possible to prevent missing pin changes. 103 | * This seems to work for most rotary encoders when calling this function 104 | * within 10ms in an endless loop. 105 | * 106 | * The sensitivity value is used to calculate three rotation speeds by 107 | * measuring the speed of the Rotary Encoder pin changes. The rotation speed 108 | * depends on the number of Rotary notches and knob size. The value should 109 | * experimentally determined. 110 | * \return Rotary speed and direction 111 | * -3: Counter clockwise turn, multiple notches fast 112 | * -2: Counter clockwise turn, multiple notches 113 | * -1: Counter clockwise turn, single notch 114 | * 0: No change 115 | * 1: Clockwise turn, single notch 116 | * 2: Clockwise turn, multiple notches 117 | * 3: Clockwise turn, multiple notches fast 118 | */ 119 | int RotaryFullStep::read() 120 | { 121 | int pinState; 122 | int rotaryState; 123 | unsigned long timeStamp; 124 | unsigned long changeTime; 125 | 126 | // Sample rotary digital pins 127 | pinState = (digitalRead(_pin1) << 1) | digitalRead(_pin2); 128 | 129 | // Determine new state from the pins and state table. 130 | _state = pgm_read_byte(&fullStepTable[_state & 0x0f][pinState]); 131 | 132 | // Check rotary state 133 | switch (_state & 0x30) { 134 | case DIR_CW: 135 | rotaryState = 1; 136 | break; 137 | case DIR_CCW: 138 | rotaryState = -1; 139 | break; 140 | case DIR_NONE: 141 | default: 142 | rotaryState = 0; 143 | } 144 | 145 | // Check if rotary changed 146 | if (rotaryState != 0) { 147 | timeStamp = millis(); 148 | changeTime = timeStamp - _lastChange; 149 | _lastChange = timeStamp; 150 | 151 | // Check speed change 152 | if (changeTime < (_sensitivity / 2)) { 153 | rotaryState *= 3; 154 | } else if (changeTime < _sensitivity) { 155 | rotaryState *= 2; 156 | } 157 | } 158 | 159 | return rotaryState; 160 | } 161 | 162 | /*! 163 | * \brief 164 | * Set sensitivity value. 165 | * \param sensitivity 166 | * Sensitivity value 0..255 167 | */ 168 | void RotaryFullStep::setSensitivity(uint8_t sensitivity) 169 | { 170 | _sensitivity = sensitivity; 171 | } 172 | 173 | /*! 174 | * \brief 175 | * Get sensitivity value. 176 | * \return 177 | * Sensitivity value 0..255. 178 | */ 179 | uint8_t RotaryFullStep::getSensitivity() 180 | { 181 | return _sensitivity; 182 | } 183 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 3 speed Rotary Encoder Full Step library for Arduino 2 | [![Build Status](https://travis-ci.org/Erriez/ErriezRotaryEncoderFullStep.svg?branch=master)](https://travis-ci.org/Erriez/ErriezRotaryEncoderFullStep) 3 | 4 | This is an optimized three speed Rotary Encoder library for Arduino which supports: 5 | 6 | * Full step Rotary Encoder types. 7 | * Detect three rotation speeds. 8 | * Configurable rotation speed sensitivity. 9 | * Polling and interrupt based. 10 | * Single or multiple Rotary Encoders. 11 | * Optional Rotary button. 12 | * Pin state table in flash. 13 | 14 | ![Rotary encoder](https://raw.githubusercontent.com/Erriez/ErriezRotaryEncoderFullStep/master/extras/RotaryEncoder.png) 15 | 16 | 17 | ## Full step / half step Rotary Encoders 18 | 19 | The difference between a full step or half step Rotary Encoder type is how the data signals of the two pins are generated. It depends on the mechanical construction of the notches and contacts inside the Rotary Encoder. 20 | 21 | Please refer to the [ErriezRotaryEncoderHalfStep](https://github.com/Erriez/ErriezRotaryEncoderHalfStep) library for half step Rotary Encoders. 22 | Experiment with the half step and full step libraries which works optimal for your Rotary Encoder. 23 | 24 | 25 | ## Hardware 26 | 27 | Connect the two rotary pins to the DIGITAL pins of an Arduino board. 28 | 29 | A third rotary button pin is not used in the Rotary library, but can be used in the sketch. 30 | 31 | Tested with Arduino IDE v1.8.13 on hardware: 32 | 33 | * Arduino UNO 34 | * Arduino Nano 35 | * Arduino Micro 36 | * Arduino Pro or Pro Mini 37 | * Arduino Mega or Mega2560 38 | * Arduino Leonardo 39 | * WeMos D1 R2 & mini (ESP8266) 40 | 41 | Other supported targets: 42 | * ESP8266 43 | * ESP32 44 | * SAMD21 45 | * STM32F1 46 | 47 | 48 | ### Interrupts 49 | 50 | Both rotary pins must be connected to a DIGITAL pin with interrupt support, such as `INT0` or `INT1`. This is chip specific. Please refer to the documentation of your board or [attachInterrupt()](https://www.arduino.cc/reference/en/language/functions/external-interrupts/attachinterrupt/). 51 | 52 | 53 | ### Arduino UNO hardware 54 | 55 | The connection below can be used for polled and interrupts. An optional button pin can be connected to DIGITAL pin 4. 56 | 57 | ![3-pin Rotary Encoder Arduino connection](https://raw.githubusercontent.com/Erriez/ErriezRotaryEncoderFullStep/master/extras/FritzingRotary.png) 58 | 59 | | Rotary pin | Arduino UNO/NANO/Mega2560/Leonardo board | 60 | | :---------------: | :--------------------------------------: | 61 | | 1 | DIGITAL pin 2 (INT0) | 62 | | 2 | DIGITAL pin 3 (INT1) | 63 | | Button (optional) | DIGITAL pin 4 | 64 | | GND | GND | 65 | 66 | 67 | 68 | ### Arduino WeMos D1 R2 & mini (ESP8266) hardware 69 | 70 | Note that some ESP8266 pins mixes ESP8622 GPIO pins with Arduino digital pins. Connect a Rotary Encoder to the following pins which can be used with polled and interrupt examples: 71 | 72 | | Rotary pin | ESP8622 pin | Text on board / WeMos D1 & R2 | 73 | | :---------------: | :---------: | :---------------------------: | 74 | | 1 | GPIO13 | D7 (MOSI) | 75 | | 2 | GPIO12 | D6 (MISO) | 76 | | Button (optional) | GPIO14 | D5 (SCK) | 77 | | LED (Not used) | GPIO2 | D4 | 78 | | GND | GND | GND | 79 | 80 | **Note:** An external pull-up resistor is required when a pin does not have an internal pull-up. 81 | 82 | ```c++ 83 | // Connect the rotary pins to the WeMos D1 R2 board: 84 | #define ROTARY_PIN1 12 85 | #define ROTARY_PIN2 13 86 | #define ROTARY_BUTTON_PIN 14 87 | ``` 88 | 89 | 90 | 91 | ## Examples 92 | 93 | The following examples are available: 94 | * Rotary | Interrupt | [InterruptFullStepBasic](https://github.com/Erriez/ErriezRotaryEncoderFullStep/blob/master/examples/Interrupt/InterruptFullStepBasic/InterruptFullStepBasic.ino) 95 | * Rotary | Interrupt | [InterruptFullStepButton](https://github.com/Erriez/ErriezRotaryEncoderFullStep/blob/master/examples/Interrupt/InterruptFullStepButton/InterruptFullStepButton.ino) 96 | * Rotary | Interrupt | [InterruptFullStepCounter](https://github.com/Erriez/ErriezRotaryEncoderFullStep/blob/master/examples/Interrupt/InterruptFullStepCounter/InterruptFullStepCounter.ino) 97 | * Rotary | Polled | [PolledFullStepBasic](https://github.com/Erriez/ErriezRotaryEncoderFullStep/blob/master/examples/Polled/PolledFullStepBasic/PolledFullStepBasic.ino) 98 | * Rotary | Polled | [PolledFullStepButton](https://github.com/Erriez/ErriezRotaryEncoderFullStep/blob/master/examples/Polled/PolledFullStepButton/PolledFullStepButton.ino) 99 | * Rotary | Polled | [PolledFullStepCounter](https://github.com/Erriez/ErriezRotaryEncoderFullStep/blob/master/examples/Polled/PolledFullStepCounter/PolledFullStepCounter.ino) 100 | * Rotary | Polled | [PolledFullStepMultiple](https://github.com/Erriez/ErriezRotaryEncoderFullStep/blob/master/examples/Polled/PolledFullStepMultiple/PolledFullStepMultiple.ino) 101 | 102 | 103 | ## Documentation 104 | 105 | - [Doxygen online HTML](https://Erriez.github.io/ErriezRotaryEncoderFullStep) 106 | - [Doxygen PDF](https://github.com/Erriez/ErriezRotaryEncoderFullStep/raw/master/ErriezRotaryEncoderFullStep.pdf) 107 | 108 | 109 | ## Usage 110 | 111 | **Read rotary with polling** 112 | ```c++ 113 | #include 114 | 115 | // Connect rotary pins to the DIGITAL pins of the Arduino board 116 | #define ROTARY_PIN1 2 117 | #define ROTARY_PIN2 3 118 | 119 | // Enable ONE of the three constructors below with different number of arguments: 120 | 121 | // Initialize full step rotary encoder, default pull-up enabled, default 122 | // sensitive=100 123 | RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2); 124 | 125 | // Or initialize full step rotary encoder, pull-up disabled, default sensitive=100 126 | // RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2, false); 127 | 128 | // Or initialize full step rotary encoder, pull-up enabled, sensitive 1..255 129 | // A higher value is more sensitive 130 | // RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2, true, 150); 131 | 132 | void loop() 133 | { 134 | int rotaryState = rotary.read(); 135 | 136 | // rotaryState = -3: Counter clockwise turn, multiple notches fast 137 | // rotaryState = -2: Counter clockwise turn, multiple notches 138 | // rotaryState = -1: Counter clockwise turn, single notch 139 | // rotaryState = 0: No change 140 | // rotaryState = 1: Clockwise turn, single notch 141 | // rotaryState = 2: Clockwise turn, multiple notches 142 | // rotaryState = 3: Clockwise turn, multiple notches fast 143 | } 144 | ``` 145 | 146 | **Read rotary with interrupts** 147 | 148 | ```c++ 149 | #include 150 | 151 | // Connect rotary pins to Arduino DIGITAL pins with interrupt support: 152 | // 153 | // +-----------------------------------+--------------------------+ 154 | // | Board | DIGITAL interrupt pins | 155 | // +-----------------------------------+--------------------------+ 156 | // | Uno, Nano, Mini, other 328-based | 2, 3 | 157 | // | Mega, Mega2560, MegaADK | 2, 3, 18, 19, 20, 21 | 158 | // | Micro, Leonardo, other 32u4-based | 0, 1, 2, 3, 7 | 159 | // +-----------------------------------+--------------------------+ 160 | // 161 | #define ROTARY_PIN1 2 162 | #define ROTARY_PIN2 3 163 | 164 | // Enable ONE of the three constructors below with different number of arguments: 165 | 166 | // Initialize full step rotary encoder, default pull-up enabled, default 167 | // sensitive=100 168 | RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2); 169 | 170 | // Or initialize full step rotary encoder, pull-up disabled, default sensitive=100 171 | // RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2, false); 172 | 173 | // Or initialize full step rotary encoder, pull-up enabled, sensitive 1..255 174 | // A higher value is more sensitive 175 | // RotaryFullStep rotary(ROTARY_PIN1, ROTARY_PIN2, true, 150); 176 | 177 | void setup() 178 | { 179 | // Initialize pin change interrupt on both rotary encoder pins 180 | attachInterrupt(digitalPinToInterrupt(ROTARY_PIN1), rotaryInterrupt, CHANGE); 181 | attachInterrupt(digitalPinToInterrupt(ROTARY_PIN2), rotaryInterrupt, CHANGE); 182 | } 183 | 184 | void rotaryInterrupt() 185 | { 186 | int rotaryState = rotary.read(); 187 | 188 | // rotaryState = -3: Counter clockwise turn, multiple notches fast 189 | // rotaryState = -2: Counter clockwise turn, multiple notches 190 | // rotaryState = -1: Counter clockwise turn, single notch 191 | // rotaryState = 0: No change 192 | // rotaryState = 1: Clockwise turn, single notch 193 | // rotaryState = 2: Clockwise turn, multiple notches 194 | // rotaryState = 3: Clockwise turn, multiple notches fast 195 | } 196 | ``` 197 | 198 | 199 | ## Library dependencies 200 | 201 | - None. 202 | 203 | 204 | ## Library installation 205 | 206 | Please refer to the [Wiki](https://github.com/Erriez/ErriezArduinoLibrariesAndSketches/wiki) page. 207 | 208 | 209 | ## Other Arduino Libraries and Sketches from Erriez 210 | 211 | * [Erriez Libraries and Sketches](https://github.com/Erriez/ErriezArduinoLibrariesAndSketches) 212 | -------------------------------------------------------------------------------- /Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.13 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "Erriez Full step Rotary Encoder" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 1.1.1 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = "Three speed Full Step Rotary Encoder Library for Arduino" 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = extras/RotaryEncoder.png 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = "The $name class" \ 122 | "The $name widget" \ 123 | "The $name file" \ 124 | is \ 125 | provides \ 126 | specifies \ 127 | contains \ 128 | represents \ 129 | a \ 130 | an \ 131 | the 132 | 133 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134 | # doxygen will generate a detailed section even if there is only a brief 135 | # description. 136 | # The default value is: NO. 137 | 138 | ALWAYS_DETAILED_SEC = NO 139 | 140 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141 | # inherited members of a class in the documentation of that class as if those 142 | # members were ordinary class members. Constructors, destructors and assignment 143 | # operators of the base classes will not be shown. 144 | # The default value is: NO. 145 | 146 | INLINE_INHERITED_MEMB = NO 147 | 148 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 149 | # before files name in the file list and in the header files. If set to NO the 150 | # shortest path that makes the file name unique will be used 151 | # The default value is: YES. 152 | 153 | FULL_PATH_NAMES = YES 154 | 155 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156 | # Stripping is only done if one of the specified strings matches the left-hand 157 | # part of the path. The tag can be used to show relative paths in the file list. 158 | # If left blank the directory from which doxygen is run is used as the path to 159 | # strip. 160 | # 161 | # Note that you can specify absolute paths here, but also relative paths, which 162 | # will be relative from the directory where doxygen is started. 163 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 164 | 165 | STRIP_FROM_PATH = 166 | 167 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168 | # path mentioned in the documentation of a class, which tells the reader which 169 | # header file to include in order to use a class. If left blank only the name of 170 | # the header file containing the class definition is used. Otherwise one should 171 | # specify the list of include paths that are normally passed to the compiler 172 | # using the -I flag. 173 | 174 | STRIP_FROM_INC_PATH = 175 | 176 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177 | # less readable) file names. This can be useful is your file systems doesn't 178 | # support long names like on DOS, Mac, or CD-ROM. 179 | # The default value is: NO. 180 | 181 | SHORT_NAMES = NO 182 | 183 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184 | # first line (until the first dot) of a Javadoc-style comment as the brief 185 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 186 | # style comments (thus requiring an explicit @brief command for a brief 187 | # description.) 188 | # The default value is: NO. 189 | 190 | JAVADOC_AUTOBRIEF = NO 191 | 192 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193 | # line (until the first dot) of a Qt-style comment as the brief description. If 194 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195 | # requiring an explicit \brief command for a brief description.) 196 | # The default value is: NO. 197 | 198 | QT_AUTOBRIEF = NO 199 | 200 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202 | # a brief description. This used to be the default behavior. The new default is 203 | # to treat a multi-line C++ comment block as a detailed description. Set this 204 | # tag to YES if you prefer the old behavior instead. 205 | # 206 | # Note that setting this tag to YES also means that rational rose comments are 207 | # not recognized any more. 208 | # The default value is: NO. 209 | 210 | MULTILINE_CPP_IS_BRIEF = NO 211 | 212 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213 | # documentation from any documented member that it re-implements. 214 | # The default value is: YES. 215 | 216 | INHERIT_DOCS = YES 217 | 218 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 219 | # page for each member. If set to NO, the documentation of a member will be part 220 | # of the file/class/namespace that contains it. 221 | # The default value is: NO. 222 | 223 | SEPARATE_MEMBER_PAGES = NO 224 | 225 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226 | # uses this value to replace tabs by spaces in code fragments. 227 | # Minimum value: 1, maximum value: 16, default value: 4. 228 | 229 | TAB_SIZE = 4 230 | 231 | # This tag can be used to specify a number of aliases that act as commands in 232 | # the documentation. An alias has the form: 233 | # name=value 234 | # For example adding 235 | # "sideeffect=@par Side Effects:\n" 236 | # will allow you to put the command \sideeffect (or @sideeffect) in the 237 | # documentation, which will result in a user-defined paragraph with heading 238 | # "Side Effects:". You can put \n's in the value part of an alias to insert 239 | # newlines. 240 | 241 | ALIASES = 242 | 243 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 244 | # A mapping has the form "name=value". For example adding "class=itcl::class" 245 | # will allow you to use the command class in the itcl::class meaning. 246 | 247 | TCL_SUBST = 248 | 249 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250 | # only. Doxygen will then generate output that is more tailored for C. For 251 | # instance, some of the names that are used will be different. The list of all 252 | # members will be omitted, etc. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_FOR_C = NO 256 | 257 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258 | # Python sources only. Doxygen will then generate output that is more tailored 259 | # for that language. For instance, namespaces will be presented as packages, 260 | # qualified scopes will look different, etc. 261 | # The default value is: NO. 262 | 263 | OPTIMIZE_OUTPUT_JAVA = NO 264 | 265 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266 | # sources. Doxygen will then generate output that is tailored for Fortran. 267 | # The default value is: NO. 268 | 269 | OPTIMIZE_FOR_FORTRAN = NO 270 | 271 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272 | # sources. Doxygen will then generate output that is tailored for VHDL. 273 | # The default value is: NO. 274 | 275 | OPTIMIZE_OUTPUT_VHDL = NO 276 | 277 | # Doxygen selects the parser to use depending on the extension of the files it 278 | # parses. With this tag you can assign which parser to use for a given 279 | # extension. Doxygen has a built-in mapping, but you can override or extend it 280 | # using this tag. The format is ext=language, where ext is a file extension, and 281 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284 | # Fortran. In the later case the parser tries to guess whether the code is fixed 285 | # or free formatted code, this is the default for Fortran type files), VHDL. For 286 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 287 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 288 | # 289 | # Note: For files without extension you can use no_extension as a placeholder. 290 | # 291 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292 | # the files are not read by doxygen. 293 | 294 | EXTENSION_MAPPING = 295 | 296 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297 | # according to the Markdown format, which allows for more readable 298 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 299 | # The output of markdown processing is further processed by doxygen, so you can 300 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301 | # case of backward compatibilities issues. 302 | # The default value is: YES. 303 | 304 | MARKDOWN_SUPPORT = YES 305 | 306 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 307 | # to that level are automatically included in the table of contents, even if 308 | # they do not have an id attribute. 309 | # Note: This feature currently applies only to Markdown headings. 310 | # Minimum value: 0, maximum value: 99, default value: 0. 311 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 312 | 313 | TOC_INCLUDE_HEADINGS = 0 314 | 315 | # When enabled doxygen tries to link words that correspond to documented 316 | # classes, or namespaces to their corresponding documentation. Such a link can 317 | # be prevented in individual cases by putting a % sign in front of the word or 318 | # globally by setting AUTOLINK_SUPPORT to NO. 319 | # The default value is: YES. 320 | 321 | AUTOLINK_SUPPORT = YES 322 | 323 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 324 | # to include (a tag file for) the STL sources as input, then you should set this 325 | # tag to YES in order to let doxygen match functions declarations and 326 | # definitions whose arguments contain STL classes (e.g. func(std::string); 327 | # versus func(std::string) {}). This also make the inheritance and collaboration 328 | # diagrams that involve STL classes more complete and accurate. 329 | # The default value is: NO. 330 | 331 | BUILTIN_STL_SUPPORT = NO 332 | 333 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 334 | # enable parsing support. 335 | # The default value is: NO. 336 | 337 | CPP_CLI_SUPPORT = NO 338 | 339 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 340 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 341 | # will parse them like normal C++ but will assume all classes use public instead 342 | # of private inheritance when no explicit protection keyword is present. 343 | # The default value is: NO. 344 | 345 | SIP_SUPPORT = NO 346 | 347 | # For Microsoft's IDL there are propget and propput attributes to indicate 348 | # getter and setter methods for a property. Setting this option to YES will make 349 | # doxygen to replace the get and set methods by a property in the documentation. 350 | # This will only work if the methods are indeed getting or setting a simple 351 | # type. If this is not the case, or you want to show the methods anyway, you 352 | # should set this option to NO. 353 | # The default value is: YES. 354 | 355 | IDL_PROPERTY_SUPPORT = YES 356 | 357 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 358 | # tag is set to YES then doxygen will reuse the documentation of the first 359 | # member in the group (if any) for the other members of the group. By default 360 | # all members of a group must be documented explicitly. 361 | # The default value is: NO. 362 | 363 | DISTRIBUTE_GROUP_DOC = NO 364 | 365 | # If one adds a struct or class to a group and this option is enabled, then also 366 | # any nested class or struct is added to the same group. By default this option 367 | # is disabled and one has to add nested compounds explicitly via \ingroup. 368 | # The default value is: NO. 369 | 370 | GROUP_NESTED_COMPOUNDS = NO 371 | 372 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 373 | # (for instance a group of public functions) to be put as a subgroup of that 374 | # type (e.g. under the Public Functions section). Set it to NO to prevent 375 | # subgrouping. Alternatively, this can be done per class using the 376 | # \nosubgrouping command. 377 | # The default value is: YES. 378 | 379 | SUBGROUPING = YES 380 | 381 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 382 | # are shown inside the group in which they are included (e.g. using \ingroup) 383 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 384 | # and RTF). 385 | # 386 | # Note that this feature does not work in combination with 387 | # SEPARATE_MEMBER_PAGES. 388 | # The default value is: NO. 389 | 390 | INLINE_GROUPED_CLASSES = NO 391 | 392 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 393 | # with only public data fields or simple typedef fields will be shown inline in 394 | # the documentation of the scope in which they are defined (i.e. file, 395 | # namespace, or group documentation), provided this scope is documented. If set 396 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 397 | # Man pages) or section (for LaTeX and RTF). 398 | # The default value is: NO. 399 | 400 | INLINE_SIMPLE_STRUCTS = NO 401 | 402 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 403 | # enum is documented as struct, union, or enum with the name of the typedef. So 404 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 405 | # with name TypeT. When disabled the typedef will appear as a member of a file, 406 | # namespace, or class. And the struct will be named TypeS. This can typically be 407 | # useful for C code in case the coding convention dictates that all compound 408 | # types are typedef'ed and only the typedef is referenced, never the tag name. 409 | # The default value is: NO. 410 | 411 | TYPEDEF_HIDES_STRUCT = NO 412 | 413 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 414 | # cache is used to resolve symbols given their name and scope. Since this can be 415 | # an expensive process and often the same symbol appears multiple times in the 416 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 417 | # doxygen will become slower. If the cache is too large, memory is wasted. The 418 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 419 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 420 | # symbols. At the end of a run doxygen will report the cache usage and suggest 421 | # the optimal cache size from a speed point of view. 422 | # Minimum value: 0, maximum value: 9, default value: 0. 423 | 424 | LOOKUP_CACHE_SIZE = 0 425 | 426 | #--------------------------------------------------------------------------- 427 | # Build related configuration options 428 | #--------------------------------------------------------------------------- 429 | 430 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 431 | # documentation are documented, even if no documentation was available. Private 432 | # class members and static file members will be hidden unless the 433 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 434 | # Note: This will also disable the warnings about undocumented members that are 435 | # normally produced when WARNINGS is set to YES. 436 | # The default value is: NO. 437 | 438 | EXTRACT_ALL = NO 439 | 440 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 441 | # be included in the documentation. 442 | # The default value is: NO. 443 | 444 | EXTRACT_PRIVATE = NO 445 | 446 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 447 | # scope will be included in the documentation. 448 | # The default value is: NO. 449 | 450 | EXTRACT_PACKAGE = NO 451 | 452 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 453 | # included in the documentation. 454 | # The default value is: NO. 455 | 456 | EXTRACT_STATIC = NO 457 | 458 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 459 | # locally in source files will be included in the documentation. If set to NO, 460 | # only classes defined in header files are included. Does not have any effect 461 | # for Java sources. 462 | # The default value is: YES. 463 | 464 | EXTRACT_LOCAL_CLASSES = YES 465 | 466 | # This flag is only useful for Objective-C code. If set to YES, local methods, 467 | # which are defined in the implementation section but not in the interface are 468 | # included in the documentation. If set to NO, only methods in the interface are 469 | # included. 470 | # The default value is: NO. 471 | 472 | EXTRACT_LOCAL_METHODS = NO 473 | 474 | # If this flag is set to YES, the members of anonymous namespaces will be 475 | # extracted and appear in the documentation as a namespace called 476 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 477 | # the file that contains the anonymous namespace. By default anonymous namespace 478 | # are hidden. 479 | # The default value is: NO. 480 | 481 | EXTRACT_ANON_NSPACES = NO 482 | 483 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 484 | # undocumented members inside documented classes or files. If set to NO these 485 | # members will be included in the various overviews, but no documentation 486 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 487 | # The default value is: NO. 488 | 489 | HIDE_UNDOC_MEMBERS = NO 490 | 491 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 492 | # undocumented classes that are normally visible in the class hierarchy. If set 493 | # to NO, these classes will be included in the various overviews. This option 494 | # has no effect if EXTRACT_ALL is enabled. 495 | # The default value is: NO. 496 | 497 | HIDE_UNDOC_CLASSES = NO 498 | 499 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 500 | # (class|struct|union) declarations. If set to NO, these declarations will be 501 | # included in the documentation. 502 | # The default value is: NO. 503 | 504 | HIDE_FRIEND_COMPOUNDS = NO 505 | 506 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 507 | # documentation blocks found inside the body of a function. If set to NO, these 508 | # blocks will be appended to the function's detailed documentation block. 509 | # The default value is: NO. 510 | 511 | HIDE_IN_BODY_DOCS = NO 512 | 513 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 514 | # \internal command is included. If the tag is set to NO then the documentation 515 | # will be excluded. Set it to YES to include the internal documentation. 516 | # The default value is: NO. 517 | 518 | INTERNAL_DOCS = NO 519 | 520 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 521 | # names in lower-case letters. If set to YES, upper-case letters are also 522 | # allowed. This is useful if you have classes or files whose names only differ 523 | # in case and if your file system supports case sensitive file names. Windows 524 | # and Mac users are advised to set this option to NO. 525 | # The default value is: system dependent. 526 | 527 | CASE_SENSE_NAMES = NO 528 | 529 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 530 | # their full class and namespace scopes in the documentation. If set to YES, the 531 | # scope will be hidden. 532 | # The default value is: NO. 533 | 534 | HIDE_SCOPE_NAMES = NO 535 | 536 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 537 | # append additional text to a page's title, such as Class Reference. If set to 538 | # YES the compound reference will be hidden. 539 | # The default value is: NO. 540 | 541 | HIDE_COMPOUND_REFERENCE= NO 542 | 543 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 544 | # the files that are included by a file in the documentation of that file. 545 | # The default value is: YES. 546 | 547 | SHOW_INCLUDE_FILES = YES 548 | 549 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 550 | # grouped member an include statement to the documentation, telling the reader 551 | # which file to include in order to use the member. 552 | # The default value is: NO. 553 | 554 | SHOW_GROUPED_MEMB_INC = NO 555 | 556 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 557 | # files with double quotes in the documentation rather than with sharp brackets. 558 | # The default value is: NO. 559 | 560 | FORCE_LOCAL_INCLUDES = NO 561 | 562 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 563 | # documentation for inline members. 564 | # The default value is: YES. 565 | 566 | INLINE_INFO = YES 567 | 568 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 569 | # (detailed) documentation of file and class members alphabetically by member 570 | # name. If set to NO, the members will appear in declaration order. 571 | # The default value is: YES. 572 | 573 | SORT_MEMBER_DOCS = YES 574 | 575 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 576 | # descriptions of file, namespace and class members alphabetically by member 577 | # name. If set to NO, the members will appear in declaration order. Note that 578 | # this will also influence the order of the classes in the class list. 579 | # The default value is: NO. 580 | 581 | SORT_BRIEF_DOCS = NO 582 | 583 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 584 | # (brief and detailed) documentation of class members so that constructors and 585 | # destructors are listed first. If set to NO the constructors will appear in the 586 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 587 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 588 | # member documentation. 589 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 590 | # detailed member documentation. 591 | # The default value is: NO. 592 | 593 | SORT_MEMBERS_CTORS_1ST = NO 594 | 595 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 596 | # of group names into alphabetical order. If set to NO the group names will 597 | # appear in their defined order. 598 | # The default value is: NO. 599 | 600 | SORT_GROUP_NAMES = NO 601 | 602 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 603 | # fully-qualified names, including namespaces. If set to NO, the class list will 604 | # be sorted only by class name, not including the namespace part. 605 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 606 | # Note: This option applies only to the class list, not to the alphabetical 607 | # list. 608 | # The default value is: NO. 609 | 610 | SORT_BY_SCOPE_NAME = NO 611 | 612 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 613 | # type resolution of all parameters of a function it will reject a match between 614 | # the prototype and the implementation of a member function even if there is 615 | # only one candidate or it is obvious which candidate to choose by doing a 616 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 617 | # accept a match between prototype and implementation in such cases. 618 | # The default value is: NO. 619 | 620 | STRICT_PROTO_MATCHING = NO 621 | 622 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 623 | # list. This list is created by putting \todo commands in the documentation. 624 | # The default value is: YES. 625 | 626 | GENERATE_TODOLIST = YES 627 | 628 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 629 | # list. This list is created by putting \test commands in the documentation. 630 | # The default value is: YES. 631 | 632 | GENERATE_TESTLIST = YES 633 | 634 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 635 | # list. This list is created by putting \bug commands in the documentation. 636 | # The default value is: YES. 637 | 638 | GENERATE_BUGLIST = YES 639 | 640 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 641 | # the deprecated list. This list is created by putting \deprecated commands in 642 | # the documentation. 643 | # The default value is: YES. 644 | 645 | GENERATE_DEPRECATEDLIST= YES 646 | 647 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 648 | # sections, marked by \if ... \endif and \cond 649 | # ... \endcond blocks. 650 | 651 | ENABLED_SECTIONS = 652 | 653 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 654 | # initial value of a variable or macro / define can have for it to appear in the 655 | # documentation. If the initializer consists of more lines than specified here 656 | # it will be hidden. Use a value of 0 to hide initializers completely. The 657 | # appearance of the value of individual variables and macros / defines can be 658 | # controlled using \showinitializer or \hideinitializer command in the 659 | # documentation regardless of this setting. 660 | # Minimum value: 0, maximum value: 10000, default value: 30. 661 | 662 | MAX_INITIALIZER_LINES = 30 663 | 664 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 665 | # the bottom of the documentation of classes and structs. If set to YES, the 666 | # list will mention the files that were used to generate the documentation. 667 | # The default value is: YES. 668 | 669 | SHOW_USED_FILES = YES 670 | 671 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 672 | # will remove the Files entry from the Quick Index and from the Folder Tree View 673 | # (if specified). 674 | # The default value is: YES. 675 | 676 | SHOW_FILES = YES 677 | 678 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 679 | # page. This will remove the Namespaces entry from the Quick Index and from the 680 | # Folder Tree View (if specified). 681 | # The default value is: YES. 682 | 683 | SHOW_NAMESPACES = YES 684 | 685 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 686 | # doxygen should invoke to get the current version for each file (typically from 687 | # the version control system). Doxygen will invoke the program by executing (via 688 | # popen()) the command command input-file, where command is the value of the 689 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 690 | # by doxygen. Whatever the program writes to standard output is used as the file 691 | # version. For an example see the documentation. 692 | 693 | FILE_VERSION_FILTER = 694 | 695 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 696 | # by doxygen. The layout file controls the global structure of the generated 697 | # output files in an output format independent way. To create the layout file 698 | # that represents doxygen's defaults, run doxygen with the -l option. You can 699 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 700 | # will be used as the name of the layout file. 701 | # 702 | # Note that if you run doxygen from a directory containing a file called 703 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 704 | # tag is left empty. 705 | 706 | LAYOUT_FILE = 707 | 708 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 709 | # the reference definitions. This must be a list of .bib files. The .bib 710 | # extension is automatically appended if omitted. This requires the bibtex tool 711 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 712 | # For LaTeX the style of the bibliography can be controlled using 713 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 714 | # search path. See also \cite for info how to create references. 715 | 716 | CITE_BIB_FILES = 717 | 718 | #--------------------------------------------------------------------------- 719 | # Configuration options related to warning and progress messages 720 | #--------------------------------------------------------------------------- 721 | 722 | # The QUIET tag can be used to turn on/off the messages that are generated to 723 | # standard output by doxygen. If QUIET is set to YES this implies that the 724 | # messages are off. 725 | # The default value is: NO. 726 | 727 | QUIET = NO 728 | 729 | # The WARNINGS tag can be used to turn on/off the warning messages that are 730 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 731 | # this implies that the warnings are on. 732 | # 733 | # Tip: Turn warnings on while writing the documentation. 734 | # The default value is: YES. 735 | 736 | WARNINGS = YES 737 | 738 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 739 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 740 | # will automatically be disabled. 741 | # The default value is: YES. 742 | 743 | WARN_IF_UNDOCUMENTED = YES 744 | 745 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 746 | # potential errors in the documentation, such as not documenting some parameters 747 | # in a documented function, or documenting parameters that don't exist or using 748 | # markup commands wrongly. 749 | # The default value is: YES. 750 | 751 | WARN_IF_DOC_ERROR = YES 752 | 753 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 754 | # are documented, but have no documentation for their parameters or return 755 | # value. If set to NO, doxygen will only warn about wrong or incomplete 756 | # parameter documentation, but not about the absence of documentation. 757 | # The default value is: NO. 758 | 759 | WARN_NO_PARAMDOC = NO 760 | 761 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 762 | # a warning is encountered. 763 | # The default value is: NO. 764 | 765 | WARN_AS_ERROR = NO 766 | 767 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 768 | # can produce. The string should contain the $file, $line, and $text tags, which 769 | # will be replaced by the file and line number from which the warning originated 770 | # and the warning text. Optionally the format may contain $version, which will 771 | # be replaced by the version of the file (if it could be obtained via 772 | # FILE_VERSION_FILTER) 773 | # The default value is: $file:$line: $text. 774 | 775 | WARN_FORMAT = "$file:$line: $text" 776 | 777 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 778 | # messages should be written. If left blank the output is written to standard 779 | # error (stderr). 780 | 781 | WARN_LOGFILE = 782 | 783 | #--------------------------------------------------------------------------- 784 | # Configuration options related to the input files 785 | #--------------------------------------------------------------------------- 786 | 787 | # The INPUT tag is used to specify the files and/or directories that contain 788 | # documented source files. You may enter file names like myfile.cpp or 789 | # directories like /usr/src/myproject. Separate the files or directories with 790 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 791 | # Note: If this tag is empty the current directory is searched. 792 | 793 | INPUT = src \ 794 | README.md 795 | 796 | # This tag can be used to specify the character encoding of the source files 797 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 798 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 799 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 800 | # possible encodings. 801 | # The default value is: UTF-8. 802 | 803 | INPUT_ENCODING = UTF-8 804 | 805 | # If the value of the INPUT tag contains directories, you can use the 806 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 807 | # *.h) to filter out the source-files in the directories. 808 | # 809 | # Note that for custom extensions or not directly supported extensions you also 810 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 811 | # read by doxygen. 812 | # 813 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 814 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 815 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 816 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 817 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 818 | 819 | FILE_PATTERNS = *.c \ 820 | *.cc \ 821 | *.cxx \ 822 | *.cpp \ 823 | *.c++ \ 824 | *.java \ 825 | *.ii \ 826 | *.ixx \ 827 | *.ipp \ 828 | *.i++ \ 829 | *.inl \ 830 | *.idl \ 831 | *.ddl \ 832 | *.odl \ 833 | *.h \ 834 | *.hh \ 835 | *.hxx \ 836 | *.hpp \ 837 | *.h++ \ 838 | *.cs \ 839 | *.d \ 840 | *.php \ 841 | *.php4 \ 842 | *.php5 \ 843 | *.phtml \ 844 | *.inc \ 845 | *.m \ 846 | *.markdown \ 847 | *.md \ 848 | *.mm \ 849 | *.dox \ 850 | *.py \ 851 | *.pyw \ 852 | *.f90 \ 853 | *.f95 \ 854 | *.f03 \ 855 | *.f08 \ 856 | *.f \ 857 | *.for \ 858 | *.tcl \ 859 | *.vhd \ 860 | *.vhdl \ 861 | *.ucf \ 862 | *.qsf 863 | 864 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 865 | # be searched for input files as well. 866 | # The default value is: NO. 867 | 868 | RECURSIVE = YES 869 | 870 | # The EXCLUDE tag can be used to specify files and/or directories that should be 871 | # excluded from the INPUT source files. This way you can easily exclude a 872 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 873 | # 874 | # Note that relative paths are relative to the directory from which doxygen is 875 | # run. 876 | 877 | EXCLUDE = 878 | 879 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 880 | # directories that are symbolic links (a Unix file system feature) are excluded 881 | # from the input. 882 | # The default value is: NO. 883 | 884 | EXCLUDE_SYMLINKS = NO 885 | 886 | # If the value of the INPUT tag contains directories, you can use the 887 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 888 | # certain files from those directories. 889 | # 890 | # Note that the wildcards are matched against the file with absolute path, so to 891 | # exclude all test directories for example use the pattern */test/* 892 | 893 | EXCLUDE_PATTERNS = 894 | 895 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 896 | # (namespaces, classes, functions, etc.) that should be excluded from the 897 | # output. The symbol name can be a fully qualified name, a word, or if the 898 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 899 | # AClass::ANamespace, ANamespace::*Test 900 | # 901 | # Note that the wildcards are matched against the file with absolute path, so to 902 | # exclude all test directories use the pattern */test/* 903 | 904 | EXCLUDE_SYMBOLS = 905 | 906 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 907 | # that contain example code fragments that are included (see the \include 908 | # command). 909 | 910 | EXAMPLE_PATH = 911 | 912 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 913 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 914 | # *.h) to filter out the source-files in the directories. If left blank all 915 | # files are included. 916 | 917 | EXAMPLE_PATTERNS = * 918 | 919 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 920 | # searched for input files to be used with the \include or \dontinclude commands 921 | # irrespective of the value of the RECURSIVE tag. 922 | # The default value is: NO. 923 | 924 | EXAMPLE_RECURSIVE = NO 925 | 926 | # The IMAGE_PATH tag can be used to specify one or more files or directories 927 | # that contain images that are to be included in the documentation (see the 928 | # \image command). 929 | 930 | IMAGE_PATH = 931 | 932 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 933 | # invoke to filter for each input file. Doxygen will invoke the filter program 934 | # by executing (via popen()) the command: 935 | # 936 | # 937 | # 938 | # where is the value of the INPUT_FILTER tag, and is the 939 | # name of an input file. Doxygen will then use the output that the filter 940 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 941 | # will be ignored. 942 | # 943 | # Note that the filter must not add or remove lines; it is applied before the 944 | # code is scanned, but not when the output code is generated. If lines are added 945 | # or removed, the anchors will not be placed correctly. 946 | # 947 | # Note that for custom extensions or not directly supported extensions you also 948 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 949 | # properly processed by doxygen. 950 | 951 | INPUT_FILTER = 952 | 953 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 954 | # basis. Doxygen will compare the file name with each pattern and apply the 955 | # filter if there is a match. The filters are a list of the form: pattern=filter 956 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 957 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 958 | # patterns match the file name, INPUT_FILTER is applied. 959 | # 960 | # Note that for custom extensions or not directly supported extensions you also 961 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 962 | # properly processed by doxygen. 963 | 964 | FILTER_PATTERNS = 965 | 966 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 967 | # INPUT_FILTER) will also be used to filter the input files that are used for 968 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 969 | # The default value is: NO. 970 | 971 | FILTER_SOURCE_FILES = NO 972 | 973 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 974 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 975 | # it is also possible to disable source filtering for a specific pattern using 976 | # *.ext= (so without naming a filter). 977 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 978 | 979 | FILTER_SOURCE_PATTERNS = 980 | 981 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 982 | # is part of the input, its contents will be placed on the main page 983 | # (index.html). This can be useful if you have a project on for instance GitHub 984 | # and want to reuse the introduction page also for the doxygen output. 985 | 986 | USE_MDFILE_AS_MAINPAGE = README.md 987 | 988 | #--------------------------------------------------------------------------- 989 | # Configuration options related to source browsing 990 | #--------------------------------------------------------------------------- 991 | 992 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 993 | # generated. Documented entities will be cross-referenced with these sources. 994 | # 995 | # Note: To get rid of all source code in the generated output, make sure that 996 | # also VERBATIM_HEADERS is set to NO. 997 | # The default value is: NO. 998 | 999 | SOURCE_BROWSER = YES 1000 | 1001 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1002 | # classes and enums directly into the documentation. 1003 | # The default value is: NO. 1004 | 1005 | INLINE_SOURCES = NO 1006 | 1007 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1008 | # special comment blocks from generated source code fragments. Normal C, C++ and 1009 | # Fortran comments will always remain visible. 1010 | # The default value is: YES. 1011 | 1012 | STRIP_CODE_COMMENTS = YES 1013 | 1014 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1015 | # function all documented functions referencing it will be listed. 1016 | # The default value is: NO. 1017 | 1018 | REFERENCED_BY_RELATION = NO 1019 | 1020 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1021 | # all documented entities called/used by that function will be listed. 1022 | # The default value is: NO. 1023 | 1024 | REFERENCES_RELATION = NO 1025 | 1026 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1027 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1028 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1029 | # link to the documentation. 1030 | # The default value is: YES. 1031 | 1032 | REFERENCES_LINK_SOURCE = YES 1033 | 1034 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1035 | # source code will show a tooltip with additional information such as prototype, 1036 | # brief description and links to the definition and documentation. Since this 1037 | # will make the HTML file larger and loading of large files a bit slower, you 1038 | # can opt to disable this feature. 1039 | # The default value is: YES. 1040 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1041 | 1042 | SOURCE_TOOLTIPS = YES 1043 | 1044 | # If the USE_HTAGS tag is set to YES then the references to source code will 1045 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1046 | # source browser. The htags tool is part of GNU's global source tagging system 1047 | # (see http://www.gnu.org/software/global/global.html). You will need version 1048 | # 4.8.6 or higher. 1049 | # 1050 | # To use it do the following: 1051 | # - Install the latest version of global 1052 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1053 | # - Make sure the INPUT points to the root of the source tree 1054 | # - Run doxygen as normal 1055 | # 1056 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1057 | # tools must be available from the command line (i.e. in the search path). 1058 | # 1059 | # The result: instead of the source browser generated by doxygen, the links to 1060 | # source code will now point to the output of htags. 1061 | # The default value is: NO. 1062 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1063 | 1064 | USE_HTAGS = NO 1065 | 1066 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1067 | # verbatim copy of the header file for each class for which an include is 1068 | # specified. Set to NO to disable this. 1069 | # See also: Section \class. 1070 | # The default value is: YES. 1071 | 1072 | VERBATIM_HEADERS = YES 1073 | 1074 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1075 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1076 | # cost of reduced performance. This can be particularly helpful with template 1077 | # rich C++ code for which doxygen's built-in parser lacks the necessary type 1078 | # information. 1079 | # Note: The availability of this option depends on whether or not doxygen was 1080 | # generated with the -Duse-libclang=ON option for CMake. 1081 | # The default value is: NO. 1082 | 1083 | CLANG_ASSISTED_PARSING = NO 1084 | 1085 | # If clang assisted parsing is enabled you can provide the compiler with command 1086 | # line options that you would normally use when invoking the compiler. Note that 1087 | # the include paths will already be set by doxygen for the files and directories 1088 | # specified with INPUT and INCLUDE_PATH. 1089 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1090 | 1091 | CLANG_OPTIONS = 1092 | 1093 | #--------------------------------------------------------------------------- 1094 | # Configuration options related to the alphabetical class index 1095 | #--------------------------------------------------------------------------- 1096 | 1097 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1098 | # compounds will be generated. Enable this if the project contains a lot of 1099 | # classes, structs, unions or interfaces. 1100 | # The default value is: YES. 1101 | 1102 | ALPHABETICAL_INDEX = YES 1103 | 1104 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1105 | # which the alphabetical index list will be split. 1106 | # Minimum value: 1, maximum value: 20, default value: 5. 1107 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1108 | 1109 | COLS_IN_ALPHA_INDEX = 5 1110 | 1111 | # In case all classes in a project start with a common prefix, all classes will 1112 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1113 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1114 | # while generating the index headers. 1115 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1116 | 1117 | IGNORE_PREFIX = 1118 | 1119 | #--------------------------------------------------------------------------- 1120 | # Configuration options related to the HTML output 1121 | #--------------------------------------------------------------------------- 1122 | 1123 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1124 | # The default value is: YES. 1125 | 1126 | GENERATE_HTML = YES 1127 | 1128 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1129 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1130 | # it. 1131 | # The default directory is: html. 1132 | # This tag requires that the tag GENERATE_HTML is set to YES. 1133 | 1134 | HTML_OUTPUT = html 1135 | 1136 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1137 | # generated HTML page (for example: .htm, .php, .asp). 1138 | # The default value is: .html. 1139 | # This tag requires that the tag GENERATE_HTML is set to YES. 1140 | 1141 | HTML_FILE_EXTENSION = .html 1142 | 1143 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1144 | # each generated HTML page. If the tag is left blank doxygen will generate a 1145 | # standard header. 1146 | # 1147 | # To get valid HTML the header file that includes any scripts and style sheets 1148 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1149 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1150 | # default header using 1151 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1152 | # YourConfigFile 1153 | # and then modify the file new_header.html. See also section "Doxygen usage" 1154 | # for information on how to generate the default header that doxygen normally 1155 | # uses. 1156 | # Note: The header is subject to change so you typically have to regenerate the 1157 | # default header when upgrading to a newer version of doxygen. For a description 1158 | # of the possible markers and block names see the documentation. 1159 | # This tag requires that the tag GENERATE_HTML is set to YES. 1160 | 1161 | HTML_HEADER = 1162 | 1163 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1164 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1165 | # footer. See HTML_HEADER for more information on how to generate a default 1166 | # footer and what special commands can be used inside the footer. See also 1167 | # section "Doxygen usage" for information on how to generate the default footer 1168 | # that doxygen normally uses. 1169 | # This tag requires that the tag GENERATE_HTML is set to YES. 1170 | 1171 | HTML_FOOTER = 1172 | 1173 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1174 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1175 | # the HTML output. If left blank doxygen will generate a default style sheet. 1176 | # See also section "Doxygen usage" for information on how to generate the style 1177 | # sheet that doxygen normally uses. 1178 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1179 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1180 | # obsolete. 1181 | # This tag requires that the tag GENERATE_HTML is set to YES. 1182 | 1183 | HTML_STYLESHEET = 1184 | 1185 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1186 | # cascading style sheets that are included after the standard style sheets 1187 | # created by doxygen. Using this option one can overrule certain style aspects. 1188 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1189 | # standard style sheet and is therefore more robust against future updates. 1190 | # Doxygen will copy the style sheet files to the output directory. 1191 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1192 | # style sheet in the list overrules the setting of the previous ones in the 1193 | # list). For an example see the documentation. 1194 | # This tag requires that the tag GENERATE_HTML is set to YES. 1195 | 1196 | HTML_EXTRA_STYLESHEET = 1197 | 1198 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1199 | # other source files which should be copied to the HTML output directory. Note 1200 | # that these files will be copied to the base HTML output directory. Use the 1201 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1202 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1203 | # files will be copied as-is; there are no commands or markers available. 1204 | # This tag requires that the tag GENERATE_HTML is set to YES. 1205 | 1206 | HTML_EXTRA_FILES = 1207 | 1208 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1209 | # will adjust the colors in the style sheet and background images according to 1210 | # this color. Hue is specified as an angle on a colorwheel, see 1211 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1212 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1213 | # purple, and 360 is red again. 1214 | # Minimum value: 0, maximum value: 359, default value: 220. 1215 | # This tag requires that the tag GENERATE_HTML is set to YES. 1216 | 1217 | HTML_COLORSTYLE_HUE = 220 1218 | 1219 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1220 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1221 | # value of 255 will produce the most vivid colors. 1222 | # Minimum value: 0, maximum value: 255, default value: 100. 1223 | # This tag requires that the tag GENERATE_HTML is set to YES. 1224 | 1225 | HTML_COLORSTYLE_SAT = 100 1226 | 1227 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1228 | # luminance component of the colors in the HTML output. Values below 100 1229 | # gradually make the output lighter, whereas values above 100 make the output 1230 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1231 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1232 | # change the gamma. 1233 | # Minimum value: 40, maximum value: 240, default value: 80. 1234 | # This tag requires that the tag GENERATE_HTML is set to YES. 1235 | 1236 | HTML_COLORSTYLE_GAMMA = 80 1237 | 1238 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1239 | # page will contain the date and time when the page was generated. Setting this 1240 | # to YES can help to show when doxygen was last run and thus if the 1241 | # documentation is up to date. 1242 | # The default value is: NO. 1243 | # This tag requires that the tag GENERATE_HTML is set to YES. 1244 | 1245 | HTML_TIMESTAMP = NO 1246 | 1247 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1248 | # documentation will contain sections that can be hidden and shown after the 1249 | # page has loaded. 1250 | # The default value is: NO. 1251 | # This tag requires that the tag GENERATE_HTML is set to YES. 1252 | 1253 | HTML_DYNAMIC_SECTIONS = NO 1254 | 1255 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1256 | # shown in the various tree structured indices initially; the user can expand 1257 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1258 | # such a level that at most the specified number of entries are visible (unless 1259 | # a fully collapsed tree already exceeds this amount). So setting the number of 1260 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1261 | # representing an infinite number of entries and will result in a full expanded 1262 | # tree by default. 1263 | # Minimum value: 0, maximum value: 9999, default value: 100. 1264 | # This tag requires that the tag GENERATE_HTML is set to YES. 1265 | 1266 | HTML_INDEX_NUM_ENTRIES = 100 1267 | 1268 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1269 | # generated that can be used as input for Apple's Xcode 3 integrated development 1270 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1271 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1272 | # Makefile in the HTML output directory. Running make will produce the docset in 1273 | # that directory and running make install will install the docset in 1274 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1275 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1276 | # for more information. 1277 | # The default value is: NO. 1278 | # This tag requires that the tag GENERATE_HTML is set to YES. 1279 | 1280 | GENERATE_DOCSET = NO 1281 | 1282 | # This tag determines the name of the docset feed. A documentation feed provides 1283 | # an umbrella under which multiple documentation sets from a single provider 1284 | # (such as a company or product suite) can be grouped. 1285 | # The default value is: Doxygen generated docs. 1286 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1287 | 1288 | DOCSET_FEEDNAME = "Doxygen generated docs" 1289 | 1290 | # This tag specifies a string that should uniquely identify the documentation 1291 | # set bundle. This should be a reverse domain-name style string, e.g. 1292 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1293 | # The default value is: org.doxygen.Project. 1294 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1295 | 1296 | DOCSET_BUNDLE_ID = org.doxygen.Project 1297 | 1298 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1299 | # the documentation publisher. This should be a reverse domain-name style 1300 | # string, e.g. com.mycompany.MyDocSet.documentation. 1301 | # The default value is: org.doxygen.Publisher. 1302 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1303 | 1304 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1305 | 1306 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1307 | # The default value is: Publisher. 1308 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1309 | 1310 | DOCSET_PUBLISHER_NAME = Publisher 1311 | 1312 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1313 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1314 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1315 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1316 | # Windows. 1317 | # 1318 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1319 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1320 | # files are now used as the Windows 98 help format, and will replace the old 1321 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1322 | # HTML files also contain an index, a table of contents, and you can search for 1323 | # words in the documentation. The HTML workshop also contains a viewer for 1324 | # compressed HTML files. 1325 | # The default value is: NO. 1326 | # This tag requires that the tag GENERATE_HTML is set to YES. 1327 | 1328 | GENERATE_HTMLHELP = NO 1329 | 1330 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1331 | # file. You can add a path in front of the file if the result should not be 1332 | # written to the html output directory. 1333 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1334 | 1335 | CHM_FILE = 1336 | 1337 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1338 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1339 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1340 | # The file has to be specified with full path. 1341 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1342 | 1343 | HHC_LOCATION = 1344 | 1345 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1346 | # (YES) or that it should be included in the master .chm file (NO). 1347 | # The default value is: NO. 1348 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1349 | 1350 | GENERATE_CHI = NO 1351 | 1352 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1353 | # and project file content. 1354 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1355 | 1356 | CHM_INDEX_ENCODING = 1357 | 1358 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1359 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1360 | # enables the Previous and Next buttons. 1361 | # The default value is: NO. 1362 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1363 | 1364 | BINARY_TOC = NO 1365 | 1366 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1367 | # the table of contents of the HTML help documentation and to the tree view. 1368 | # The default value is: NO. 1369 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1370 | 1371 | TOC_EXPAND = NO 1372 | 1373 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1374 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1375 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1376 | # (.qch) of the generated HTML documentation. 1377 | # The default value is: NO. 1378 | # This tag requires that the tag GENERATE_HTML is set to YES. 1379 | 1380 | GENERATE_QHP = NO 1381 | 1382 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1383 | # the file name of the resulting .qch file. The path specified is relative to 1384 | # the HTML output folder. 1385 | # This tag requires that the tag GENERATE_QHP is set to YES. 1386 | 1387 | QCH_FILE = 1388 | 1389 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1390 | # Project output. For more information please see Qt Help Project / Namespace 1391 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1392 | # The default value is: org.doxygen.Project. 1393 | # This tag requires that the tag GENERATE_QHP is set to YES. 1394 | 1395 | QHP_NAMESPACE = org.doxygen.Project 1396 | 1397 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1398 | # Help Project output. For more information please see Qt Help Project / Virtual 1399 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1400 | # folders). 1401 | # The default value is: doc. 1402 | # This tag requires that the tag GENERATE_QHP is set to YES. 1403 | 1404 | QHP_VIRTUAL_FOLDER = doc 1405 | 1406 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1407 | # filter to add. For more information please see Qt Help Project / Custom 1408 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1409 | # filters). 1410 | # This tag requires that the tag GENERATE_QHP is set to YES. 1411 | 1412 | QHP_CUST_FILTER_NAME = 1413 | 1414 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1415 | # custom filter to add. For more information please see Qt Help Project / Custom 1416 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1417 | # filters). 1418 | # This tag requires that the tag GENERATE_QHP is set to YES. 1419 | 1420 | QHP_CUST_FILTER_ATTRS = 1421 | 1422 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1423 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1424 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1425 | # This tag requires that the tag GENERATE_QHP is set to YES. 1426 | 1427 | QHP_SECT_FILTER_ATTRS = 1428 | 1429 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1430 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1431 | # generated .qhp file. 1432 | # This tag requires that the tag GENERATE_QHP is set to YES. 1433 | 1434 | QHG_LOCATION = 1435 | 1436 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1437 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1438 | # install this plugin and make it available under the help contents menu in 1439 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1440 | # to be copied into the plugins directory of eclipse. The name of the directory 1441 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1442 | # After copying Eclipse needs to be restarted before the help appears. 1443 | # The default value is: NO. 1444 | # This tag requires that the tag GENERATE_HTML is set to YES. 1445 | 1446 | GENERATE_ECLIPSEHELP = NO 1447 | 1448 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1449 | # the directory name containing the HTML and XML files should also have this 1450 | # name. Each documentation set should have its own identifier. 1451 | # The default value is: org.doxygen.Project. 1452 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1453 | 1454 | ECLIPSE_DOC_ID = org.doxygen.Project 1455 | 1456 | # If you want full control over the layout of the generated HTML pages it might 1457 | # be necessary to disable the index and replace it with your own. The 1458 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1459 | # of each HTML page. A value of NO enables the index and the value YES disables 1460 | # it. Since the tabs in the index contain the same information as the navigation 1461 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1462 | # The default value is: NO. 1463 | # This tag requires that the tag GENERATE_HTML is set to YES. 1464 | 1465 | DISABLE_INDEX = NO 1466 | 1467 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1468 | # structure should be generated to display hierarchical information. If the tag 1469 | # value is set to YES, a side panel will be generated containing a tree-like 1470 | # index structure (just like the one that is generated for HTML Help). For this 1471 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1472 | # (i.e. any modern browser). Windows users are probably better off using the 1473 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1474 | # further fine-tune the look of the index. As an example, the default style 1475 | # sheet generated by doxygen has an example that shows how to put an image at 1476 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1477 | # the same information as the tab index, you could consider setting 1478 | # DISABLE_INDEX to YES when enabling this option. 1479 | # The default value is: NO. 1480 | # This tag requires that the tag GENERATE_HTML is set to YES. 1481 | 1482 | GENERATE_TREEVIEW = NO 1483 | 1484 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1485 | # doxygen will group on one line in the generated HTML documentation. 1486 | # 1487 | # Note that a value of 0 will completely suppress the enum values from appearing 1488 | # in the overview section. 1489 | # Minimum value: 0, maximum value: 20, default value: 4. 1490 | # This tag requires that the tag GENERATE_HTML is set to YES. 1491 | 1492 | ENUM_VALUES_PER_LINE = 4 1493 | 1494 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1495 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1496 | # Minimum value: 0, maximum value: 1500, default value: 250. 1497 | # This tag requires that the tag GENERATE_HTML is set to YES. 1498 | 1499 | TREEVIEW_WIDTH = 250 1500 | 1501 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1502 | # external symbols imported via tag files in a separate window. 1503 | # The default value is: NO. 1504 | # This tag requires that the tag GENERATE_HTML is set to YES. 1505 | 1506 | EXT_LINKS_IN_WINDOW = NO 1507 | 1508 | # Use this tag to change the font size of LaTeX formulas included as images in 1509 | # the HTML documentation. When you change the font size after a successful 1510 | # doxygen run you need to manually remove any form_*.png images from the HTML 1511 | # output directory to force them to be regenerated. 1512 | # Minimum value: 8, maximum value: 50, default value: 10. 1513 | # This tag requires that the tag GENERATE_HTML is set to YES. 1514 | 1515 | FORMULA_FONTSIZE = 10 1516 | 1517 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1518 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1519 | # supported properly for IE 6.0, but are supported on all modern browsers. 1520 | # 1521 | # Note that when changing this option you need to delete any form_*.png files in 1522 | # the HTML output directory before the changes have effect. 1523 | # The default value is: YES. 1524 | # This tag requires that the tag GENERATE_HTML is set to YES. 1525 | 1526 | FORMULA_TRANSPARENT = YES 1527 | 1528 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1529 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1530 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1531 | # installed or if you want to formulas look prettier in the HTML output. When 1532 | # enabled you may also need to install MathJax separately and configure the path 1533 | # to it using the MATHJAX_RELPATH option. 1534 | # The default value is: NO. 1535 | # This tag requires that the tag GENERATE_HTML is set to YES. 1536 | 1537 | USE_MATHJAX = NO 1538 | 1539 | # When MathJax is enabled you can set the default output format to be used for 1540 | # the MathJax output. See the MathJax site (see: 1541 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1542 | # Possible values are: HTML-CSS (which is slower, but has the best 1543 | # compatibility), NativeMML (i.e. MathML) and SVG. 1544 | # The default value is: HTML-CSS. 1545 | # This tag requires that the tag USE_MATHJAX is set to YES. 1546 | 1547 | MATHJAX_FORMAT = HTML-CSS 1548 | 1549 | # When MathJax is enabled you need to specify the location relative to the HTML 1550 | # output directory using the MATHJAX_RELPATH option. The destination directory 1551 | # should contain the MathJax.js script. For instance, if the mathjax directory 1552 | # is located at the same level as the HTML output directory, then 1553 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1554 | # Content Delivery Network so you can quickly see the result without installing 1555 | # MathJax. However, it is strongly recommended to install a local copy of 1556 | # MathJax from http://www.mathjax.org before deployment. 1557 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1558 | # This tag requires that the tag USE_MATHJAX is set to YES. 1559 | 1560 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1561 | 1562 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1563 | # extension names that should be enabled during MathJax rendering. For example 1564 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1565 | # This tag requires that the tag USE_MATHJAX is set to YES. 1566 | 1567 | MATHJAX_EXTENSIONS = 1568 | 1569 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1570 | # of code that will be used on startup of the MathJax code. See the MathJax site 1571 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1572 | # example see the documentation. 1573 | # This tag requires that the tag USE_MATHJAX is set to YES. 1574 | 1575 | MATHJAX_CODEFILE = 1576 | 1577 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1578 | # the HTML output. The underlying search engine uses javascript and DHTML and 1579 | # should work on any modern browser. Note that when using HTML help 1580 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1581 | # there is already a search function so this one should typically be disabled. 1582 | # For large projects the javascript based search engine can be slow, then 1583 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1584 | # search using the keyboard; to jump to the search box use + S 1585 | # (what the is depends on the OS and browser, but it is typically 1586 | # , /