├── keywords.txt ├── library.properties ├── examples ├── SimpleOnOff │ └── SimpleOnOff.ino ├── Toggle │ └── Toggle.ino ├── UpDown │ └── UpDown.ino └── LongPress │ └── LongPress.ino ├── src ├── JC_Button.cpp └── JC_Button.h ├── CONTRIBUTING.md ├── README.md └── LICENSE.md /keywords.txt: -------------------------------------------------------------------------------- 1 | JC_Button KEYWORD1 2 | Button KEYWORD1 3 | ToggleButton KEYWORD1 4 | begin KEYWORD2 5 | read KEYWORD2 6 | isPressed KEYWORD2 7 | isReleased KEYWORD2 8 | wasPressed KEYWORD2 9 | wasReleased KEYWORD2 10 | pressedFor KEYWORD2 11 | releasedFor KEYWORD2 12 | lastChange KEYWORD2 13 | changed KEYWORD2 14 | toggleState KEYWORD2 15 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=JC_Button 2 | version=2.1.6 3 | author=Jack Christensen 4 | maintainer=Jack Christensen 5 | sentence=Arduino library to debounce button switches, detect presses, releases, and long presses. 6 | paragraph=Copyright (C) 2018-2025 by Jack Christensen and licensed under GNU GPL v3.0. 7 | category=Signal Input/Output 8 | url=https://github.com/JChristensen/JC_Button 9 | architectures=* 10 | -------------------------------------------------------------------------------- /examples/SimpleOnOff/SimpleOnOff.ino: -------------------------------------------------------------------------------- 1 | // Arduino Button Library 2 | // https://github.com/JChristensen/JC_Button 3 | // Copyright (C) 2018 by Jack Christensen and licensed under 4 | // GNU GPL v3.0, https://www.gnu.org/licenses/gpl.html 5 | // 6 | // Example sketch to turn an LED on and off with a tactile button switch. 7 | // Wire the switch from the Arduino pin to ground. 8 | 9 | #include // https://github.com/JChristensen/JC_Button 10 | 11 | // pin assignments 12 | const byte 13 | BUTTON_PIN(7), // connect a button switch from this pin to ground 14 | LED_PIN(13); // the standard Arduino "pin 13" LED 15 | 16 | Button myBtn(BUTTON_PIN); // define the button 17 | 18 | void setup() 19 | { 20 | myBtn.begin(); // initialize the button object 21 | pinMode(LED_PIN, OUTPUT); // set the LED pin as an output 22 | } 23 | 24 | void loop() 25 | { 26 | static bool ledState; // a variable that keeps the current LED status 27 | myBtn.read(); // read the button 28 | 29 | if (myBtn.wasReleased()) // if the button was released, change the LED state 30 | { 31 | ledState = !ledState; 32 | digitalWrite(LED_PIN, ledState); 33 | } 34 | } 35 | 36 | -------------------------------------------------------------------------------- /src/JC_Button.cpp: -------------------------------------------------------------------------------- 1 | // Arduino Button Library 2 | // https://github.com/JChristensen/JC_Button 3 | // Copyright (C) 2018 by Jack Christensen and licensed under 4 | // GNU GPL v3.0, https://www.gnu.org/licenses/gpl.html 5 | 6 | #include "JC_Button.h" 7 | 8 | // initialize a Button object 9 | void Button::begin() 10 | { 11 | pinMode(m_pin, m_puEnable ? INPUT_PULLUP : INPUT); 12 | m_state = static_cast(digitalRead(m_pin)) ^ m_invert; 13 | m_time = millis(); 14 | m_lastState = m_state; 15 | m_changed = false; 16 | m_lastChange = m_time; 17 | } 18 | 19 | // returns the state of the button, true if pressed, false if released. 20 | // does debouncing, captures and maintains times, previous state, etc. 21 | bool Button::read() 22 | { 23 | m_time = millis(); 24 | bool pinVal = static_cast(digitalRead(m_pin)) ^ m_invert; 25 | 26 | switch (m_fsm) { 27 | case STABLE: 28 | if (pinVal != m_state) { // maybe a change, but debounce first 29 | m_dbStart = m_time; 30 | m_fsm = DEBOUNCE; 31 | } 32 | m_changed = false; 33 | break; 34 | 35 | case DEBOUNCE: 36 | if (m_time - m_dbStart >= m_dbTime) { 37 | m_fsm = STABLE; 38 | if (pinVal != m_state) { // a real change (else just noise) 39 | m_lastState = m_state; 40 | m_state = pinVal; 41 | m_lastChange = m_time; 42 | m_changed = true; 43 | } 44 | } 45 | break; 46 | } 47 | return m_state; 48 | } 49 | -------------------------------------------------------------------------------- /examples/Toggle/Toggle.ino: -------------------------------------------------------------------------------- 1 | // Arduino Button Library 2 | // https://github.com/JChristensen/JC_Button 3 | // Copyright (C) 2018 by Jack Christensen and licensed under 4 | // GNU GPL v3.0, https://www.gnu.org/licenses/gpl.html 5 | // 6 | // Example sketch to demonstrate toggle buttons. 7 | 8 | #include // https://github.com/JChristensen/JC_Button 9 | 10 | // pin assignments 11 | const byte 12 | LED1_PIN(5), // connect an LED to ground, through an appropriate current limiting resistor 13 | LED2_PIN(6), // connect an LED to ground, through an appropriate current limiting resistor 14 | BUTTON1_PIN(7), // connect a button switch from this pin to ground 15 | BUTTON2_PIN(8); // connect a button switch from this pin to ground 16 | 17 | ToggleButton // define the buttons 18 | btn1(BUTTON1_PIN), // this button's initial state is off 19 | btn2(BUTTON2_PIN, true); // this button's initial state is on 20 | 21 | void setup() 22 | { 23 | // initialize the button objects 24 | btn1.begin(); 25 | btn2.begin(); 26 | 27 | // set the LED pins as outputs 28 | pinMode(LED1_PIN, OUTPUT); 29 | pinMode(LED2_PIN, OUTPUT); 30 | 31 | // show the initial states 32 | digitalWrite(LED1_PIN, btn1.toggleState()); 33 | digitalWrite(LED2_PIN, btn2.toggleState()); 34 | } 35 | 36 | void loop() 37 | { 38 | // read the buttons 39 | btn1.read(); 40 | btn2.read(); 41 | 42 | // if button state changed, update the LEDs 43 | if (btn1.changed()) digitalWrite(LED1_PIN, btn1.toggleState()); 44 | if (btn2.changed()) digitalWrite(LED2_PIN, btn2.toggleState()); 45 | } 46 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # A GitHub Manifesto 2 | ### Notes on contributing to my repositories 3 | Jack Christensen 4 | Jan 2018 5 | 6 | Surely Git and GitHub are wonderful tools. They make coding and collaboration so much easier. I'm equally impressed with the open source movement, and with the Arduino ecosystem in particular. 7 | 8 | I'm just one guy, mostly a hobbyist. Posting my projects to GitHub is my way of giving back a little to the community. It's very gratifying that some of my code has received a modicum of popularity. 9 | 10 | Like many things, this has been somewhat of a double-edged sword. Especially since I tend to be a pretty busy guy with many varied interests. 11 | 12 | First, I am always interested in bug reports. Please raise an issue in the appropriate repository and please please please include a good, concise description of the issue and a Short, Self Contained, Correct (Compilable), Example (see [sscce.org](http://www.sscce.org/)). I will need to be able to reproduce the issue, with minimal hardware, and without installing a dozen other libraries. I work exclusively with the AVR architecture so most times I will not be able to reproduce issues on other platforms. (There have been one or two occasions where relatively simple changes have been made to accommodate another platform; I am not necessarily averse to these.) 13 | 14 | Second, bug reports should always be for problems with *my* code. I will not use GitHub to help you with *your* code, even if you happen to be using one of my libraries. Please use the [Arduino forum](https://forum.arduino.cc/) or other such venue instead. 15 | 16 | Finally, pull requests can be problematic, especially if they represent enhancements rather than fixes. I seldom intend my code to be all things to all people. This is mostly a hobby activity and I have very limited bandwidth. Reviewing and managing PRs requires time that I do not often have. Sometimes a PR will take a library in a direction that I'm not interested in. Sometimes a PR will be counter to my original design intent. No doubt the author of a PR thinks that their new feature is the best thing since canned beer, but if I don't happen to share that opinion, then I'll decline it. OTOH, I am certainly capable of making stupid mistakes and missing absolutely fundamental things, and I do appreciate it when these are pointed out. 17 | 18 | All this to say, that if I do decline a request, please do not take it personally. Feel free to consider it my problem, not yours. At the end of the day, it's my code, and I reserve the right to decline issues or PRs for any reason, or for no reason at all. But here is the beauty of open source. You can always fork the repository and have your way with it. 19 | -------------------------------------------------------------------------------- /examples/UpDown/UpDown.ino: -------------------------------------------------------------------------------- 1 | // Arduino Button Library 2 | // https://github.com/JChristensen/JC_Button 3 | // Copyright (C) 2018 by Jack Christensen and licensed under 4 | // GNU GPL v3.0, https://www.gnu.org/licenses/gpl.html 5 | // 6 | // Example sketch that uses both short and long button presses to adjust 7 | // a number up and down, between two limits. Short presses increment 8 | // or decrement by one, long presses repeat at a specified rate. 9 | // Every time the number changes, it is written to the serial monitor. 10 | 11 | #include // https://github.com/JChristensen/JC_Button 12 | 13 | // pin assignments 14 | const byte 15 | DN_PIN(7), // connect a button switch from this pin to ground 16 | UP_PIN(8); // ditto 17 | 18 | Button btnUP(UP_PIN), btnDN(DN_PIN); // define the buttons 19 | 20 | const unsigned long 21 | REPEAT_FIRST(500), // ms required before repeating on long press 22 | REPEAT_INCR(100); // repeat interval for long press 23 | const int 24 | MIN_COUNT(0), 25 | MAX_COUNT(59); 26 | 27 | void setup() 28 | { 29 | btnUP.begin(); 30 | btnDN.begin(); 31 | Serial.begin(115200); 32 | } 33 | 34 | void loop() 35 | { 36 | static int 37 | count, // the number that is adjusted 38 | lastCount(-1); // previous value of count (initialized to ensure it's different when the sketch starts) 39 | static unsigned long 40 | rpt(REPEAT_FIRST); // a variable time that is used to drive the repeats for long presses 41 | enum states_t {WAIT, INCR, DECR}; // states for the state machine 42 | static states_t STATE; // current state machine state 43 | 44 | btnUP.read(); // read the buttons 45 | btnDN.read(); 46 | 47 | if (count != lastCount) // print the count if it has changed 48 | { 49 | lastCount = count; 50 | Serial.println(count, DEC); 51 | } 52 | 53 | switch (STATE) 54 | { 55 | case WAIT: // wait for a button event 56 | if (btnUP.wasPressed()) 57 | STATE = INCR; 58 | else if (btnDN.wasPressed()) 59 | STATE = DECR; 60 | else if (btnUP.wasReleased()) // reset the long press interval 61 | rpt = REPEAT_FIRST; 62 | else if (btnDN.wasReleased()) 63 | rpt = REPEAT_FIRST; 64 | else if (btnUP.pressedFor(rpt)) // check for long press 65 | { 66 | rpt += REPEAT_INCR; // increment the long press interval 67 | STATE = INCR; 68 | } 69 | else if (btnDN.pressedFor(rpt)) 70 | { 71 | rpt += REPEAT_INCR; 72 | STATE = DECR; 73 | } 74 | break; 75 | 76 | case INCR: 77 | ++count; // increment the counter 78 | count = min(count, MAX_COUNT); // but not more than the specified maximum 79 | STATE = WAIT; 80 | break; 81 | 82 | case DECR: 83 | --count; // decrement the counter 84 | count = max(count, MIN_COUNT); // but not less than the specified minimum 85 | STATE = WAIT; 86 | break; 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /examples/LongPress/LongPress.ino: -------------------------------------------------------------------------------- 1 | // Arduino Button Library 2 | // https://github.com/JChristensen/JC_Button 3 | // Copyright (C) 2018 by Jack Christensen and licensed under 4 | // GNU GPL v3.0, https://www.gnu.org/licenses/gpl.html 5 | // 6 | // Example sketch demonstrating short and long button presses. 7 | // 8 | // A simple state machine where a short press of the button turns the 9 | // Arduino pin 13 LED on or off, and a long press causes the LED to 10 | // blink rapidly. Once in rapid blink mode, another long press goes 11 | // back to on/off mode. 12 | 13 | #include // https://github.com/JChristensen/JC_Button 14 | 15 | // pin assignments 16 | const byte 17 | BUTTON_PIN(7), // connect a button switch from this pin to ground 18 | LED_PIN(13); // the standard Arduino "pin 13" LED 19 | 20 | Button myBtn(BUTTON_PIN); // define the button 21 | const unsigned long 22 | LONG_PRESS(1000), // we define a "long press" to be 1000 milliseconds. 23 | BLINK_INTERVAL(100); // in the BLINK state, switch the LED every 100 milliseconds. 24 | 25 | void setup() 26 | { 27 | myBtn.begin(); // initialize the button object 28 | pinMode(LED_PIN, OUTPUT); // set the LED pin as an output 29 | } 30 | 31 | // the list of possible states for the state machine. This state machine has a fixed 32 | // sequence of states, i.e. ONOFF --> TO_BLINK --> BLINK --> TO_ONOFF --> ONOFF 33 | // note that while the user perceives two "modes", i.e. ON/OFF mode and rapid blink mode, 34 | // two extra states are needed in the state machine to transition between these modes. 35 | enum states_t {ONOFF, TO_BLINK, BLINK, TO_ONOFF}; 36 | 37 | bool ledState; // current LED status 38 | unsigned long ms; // current time from millis() 39 | unsigned long msLast; // last time the LED was switched 40 | 41 | void loop() 42 | { 43 | static states_t STATE; // current state machine state 44 | ms = millis(); // record the current time 45 | myBtn.read(); // read the button 46 | 47 | switch (STATE) 48 | { 49 | // this state watches for short and long presses, switches the LED for 50 | // short presses, and moves to the TO_BLINK state for long presses. 51 | case ONOFF: 52 | if (myBtn.wasReleased()) 53 | switchLED(); 54 | else if (myBtn.pressedFor(LONG_PRESS)) 55 | STATE = TO_BLINK; 56 | break; 57 | 58 | // this is a transition state where we start the fast blink as feedback to the user, 59 | // but we also need to wait for the user to release the button, i.e. end the 60 | // long press, before moving to the BLINK state. 61 | case TO_BLINK: 62 | if (myBtn.wasReleased()) 63 | STATE = BLINK; 64 | else 65 | fastBlink(); 66 | break; 67 | 68 | // the fast-blink state. Watch for another long press which will cause us to 69 | // turn the LED off (as feedback to the user) and move to the TO_ONOFF state. 70 | case BLINK: 71 | if (myBtn.pressedFor(LONG_PRESS)) 72 | { 73 | STATE = TO_ONOFF; 74 | digitalWrite(LED_PIN, LOW); 75 | ledState = false; 76 | } 77 | else 78 | fastBlink(); 79 | break; 80 | 81 | // this is a transition state where we just wait for the user to release the button 82 | // before moving back to the ONOFF state. 83 | case TO_ONOFF: 84 | if (myBtn.wasReleased()) 85 | STATE = ONOFF; 86 | break; 87 | } 88 | } 89 | 90 | // reverse the current LED state. if it's on, turn it off. if it's off, turn it on. 91 | void switchLED() 92 | { 93 | msLast = ms; // record the last switch time 94 | ledState = !ledState; 95 | digitalWrite(LED_PIN, ledState); 96 | } 97 | 98 | // switch the LED on and off every BLINK_INTERVAL milliseconds. 99 | void fastBlink() 100 | { 101 | if (ms - msLast >= BLINK_INTERVAL) 102 | switchLED(); 103 | } 104 | 105 | -------------------------------------------------------------------------------- /src/JC_Button.h: -------------------------------------------------------------------------------- 1 | // Arduino Button Library 2 | // https://github.com/JChristensen/JC_Button 3 | // Copyright (C) 2018 by Jack Christensen and licensed under 4 | // GNU GPL v3.0, https://www.gnu.org/licenses/gpl.html 5 | 6 | #ifndef JC_BUTTON_H_INCLUDED 7 | #define JC_BUTTON_H_INCLUDED 8 | 9 | #include 10 | 11 | class Button 12 | { 13 | public: 14 | // Button(pin, dbTime, puEnable, invert) instantiates a button object. 15 | // 16 | // Required parameter: 17 | // pin The Arduino pin the button is connected to 18 | // 19 | // Optional parameters: 20 | // dbTime Debounce time in milliseconds (default 25ms) 21 | // puEnable true to enable the AVR internal pullup resistor (default true) 22 | // invert true to interpret a low logic level as pressed (default true) 23 | Button(uint8_t pin, uint32_t dbTime=25, uint8_t puEnable=true, uint8_t invert=true) 24 | : m_pin(pin), m_dbTime(dbTime), m_puEnable(puEnable), m_invert(invert) {} 25 | 26 | // Initialize a Button object 27 | void begin(); 28 | 29 | // Returns the state of the button, true if pressed, false if released. 30 | // Does debouncing, captures and maintains times, previous state, etc. 31 | // Call this function frequently to ensure the sketch is responsive to user input. 32 | bool read(); 33 | 34 | // Returns true if the button state was pressed at the last call to read(). 35 | // Does not cause the button to be read. 36 | bool isPressed() const {return m_state;} 37 | 38 | // Returns true if the button state was released at the last call to read(). 39 | // Does not cause the button to be read. 40 | bool isReleased() const {return !m_state;} 41 | 42 | // These functions check the button state to see if it changed 43 | // between the last two reads and return true or false accordingly. 44 | // These functions do not cause the button to be read. 45 | bool wasPressed() const {return m_state && m_changed;} 46 | bool wasReleased() const {return !m_state && m_changed;} 47 | 48 | // Returns true if the button state at the last call to read() was pressed, 49 | // and has been in that state for at least the given number of milliseconds. 50 | // This function does not cause the button to be read. 51 | bool pressedFor(uint32_t ms) const {return m_state && m_time - m_lastChange >= ms;} 52 | 53 | // Returns true if the button state at the last call to read() was released, 54 | // and has been in that state for at least the given number of milliseconds. 55 | // This function does not cause the button to be read. 56 | bool releasedFor(uint32_t ms) const {return !m_state && m_time - m_lastChange >= ms;} 57 | 58 | // Returns the time in milliseconds (from millis) that the button last 59 | // changed state. 60 | uint32_t lastChange() const {return m_lastChange;} 61 | 62 | private: 63 | enum fsmStates_t {STABLE, DEBOUNCE}; // states for the state machine 64 | fsmStates_t m_fsm {STABLE}; // initial state machine state 65 | uint8_t m_pin; // arduino pin number connected to button 66 | uint32_t m_dbTime; // debounce time (ms) 67 | bool m_puEnable; // internal pullup resistor enabled 68 | bool m_invert; // if true, interpret logic low as pressed, else interpret logic high as pressed 69 | bool m_state {false}; // current button state, true=pressed 70 | bool m_lastState {false}; // previous button state 71 | bool m_changed {false}; // state changed since last read 72 | uint32_t m_time {0}; // time of current state (ms from millis) 73 | uint32_t m_lastChange {0}; // time of last state change (ms) 74 | uint32_t m_dbStart; // debounce interval start time 75 | }; 76 | 77 | // a derived class for a "push-on, push-off" (toggle) type button. 78 | // initial state can be given, default is off (false). 79 | class ToggleButton : public Button 80 | { 81 | public: 82 | 83 | // constructor is similar to Button, but includes the initial state for the toggle. 84 | ToggleButton(uint8_t pin, bool initialState=false, uint32_t dbTime=25, uint8_t puEnable=true, uint8_t invert=true) 85 | : Button(pin, dbTime, puEnable, invert), m_toggleState(initialState) {} 86 | 87 | // read the button and return its state. 88 | // should be called frequently. 89 | bool read() 90 | { 91 | Button::read(); 92 | if (wasPressed()) { 93 | m_toggleState = !m_toggleState; 94 | m_changed = true; 95 | } 96 | else { 97 | m_changed = false; 98 | } 99 | return m_toggleState; 100 | } 101 | 102 | // has the state changed? 103 | bool changed() const {return m_changed;} 104 | 105 | // return the current state 106 | bool toggleState() const {return m_toggleState;} 107 | 108 | private: 109 | bool m_toggleState; 110 | bool m_changed = false; 111 | }; 112 | #endif 113 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Arduino Button Library 2 | https://github.com/JChristensen/JC_Button 3 | README file 4 | 5 | ## License 6 | Arduino Button Library Copyright (C) 2018-2019 Jack Christensen GNU GPL v3.0 7 | 8 | This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License v3.0 as published by the Free Software Foundation. 9 | 10 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 11 | 12 | You should have received a copy of the GNU General Public License along with this program. If not, see 13 | 14 | ## Introduction 15 | The Button library is for debouncing and reading momentary contact switches like tactile button switches. "Long presses" of arbitrary length can be detected. Works well in state machine constructs. Use the read() function to read each button in the main loop, which should execute as fast as possible. 16 | 17 | The simplest way to use a button with an AVR microcontroller is to wire the button between a GPIO pin and ground, and turn on the AVR internal pullup resistor. The Button class constructor takes four arguments, but three have default values that work for a button wired in this manner. 18 | 19 | A derived class, ToggleButton, implements button objects that need only "push-on, push-off" functionality. 20 | 21 | ## Examples 22 | The following example sketches are included with the **Button** library: 23 | 24 | - **SimpleOnOff**: Just turns the Arduino's pin 13 LED on and off. 25 | - **LongPress**: Demonstrates detecting long and short button presses. 26 | - **UpDown**: Counts up or down, one number at a time or rapidly by holding the button down. 27 | - **Toggle**: Demonstrates ToggleButton functionality. 28 | 29 | 30 | ## Constructors 31 | 32 | ### Button(pin, dbTime, puEnable, invert) 33 | ##### Description 34 | The constructor defines a button object. 35 | ##### Syntax 36 | `Button(pin, dbTime, puEnable, invert);` 37 | ##### Required parameter 38 | **pin:** Arduino pin number that the button is connected to *(byte)* 39 | ##### Optional parameters 40 | **dbTime:** Debounce time in milliseconds. Defaults to 25ms if not given. *(unsigned long)* 41 | **puEnable:** *true* to enable the microcontroller's internal pull-up resistor, else *false*. Defaults to *true* if not given. *(bool)* 42 | **invert:** *false* interprets a high logic level to mean the button is pressed, *true* interprets a low level as pressed. *true* should be used when a pull-up resistor is employed, *false* for a pull-down resistor. Defaults to *true* if not given. *(bool)* 43 | ##### Returns 44 | None. 45 | ##### Example 46 | ```c++ 47 | // button connected from pin 2 to ground, 25ms debounce, pullup enabled, logic inverted 48 | Button myButton(2); 49 | 50 | // same as above but this button needs a longer debounce time (50ms) 51 | Button myButton(3, 50); 52 | 53 | // a button wired from the MCU pin to Vcc with an external pull-down resistor 54 | Button myButton(4, 25, false, false); 55 | 56 | ``` 57 | 58 | ### ToggleButton(pin, initialState, dbTime, puEnable, invert) 59 | ##### Description 60 | The constructor defines a toggle button object, which has "push-on, push-off" functionality. The initial state can be on or off. See the section, [ToggleButton Library Functions](https://github.com/JChristensen/JC_Button#togglebutton-library-functions) for functions that apply specifically to the ToggleButton object. The ToggleButton class is derived from the Button class, so all Button functions are available, but because it is inherently a more limited concept, the special ToggleButton functions will be most useful, along with `begin()` and `read()`. 61 | ##### Syntax 62 | `ToggleButton(pin, initialState, dbTime, puEnable, invert);` 63 | ##### Required parameter 64 | **pin:** Arduino pin number that the button is connected to *(byte)* 65 | ##### Optional parameters 66 | **initialState:** Initial state for the button. Defaults to off (false) if not given. *(bool)* 67 | **dbTime:** Debounce time in milliseconds. Defaults to 25ms if not given. *(unsigned long)* 68 | **puEnable:** *true* to enable the microcontroller's internal pull-up resistor, else *false*. Defaults to *true* if not given. *(bool)* 69 | **invert:** *false* interprets a high logic level to mean the button is pressed, *true* interprets a low level as pressed. *true* should be used when a pull-up resistor is employed, *false* for a pull-down resistor. Defaults to *true* if not given. *(bool)* 70 | ##### Returns 71 | None. 72 | ##### Example 73 | ```c++ 74 | // button connected from pin 2 to ground, initial state off, 75 | // 25ms debounce, pullup enabled, logic inverted 76 | ToggleButton myToggle(2); 77 | 78 | // same as above but this button is initially "on" and also 79 | // needs a longer debounce time (50ms). 80 | ToggleButton myToggle(3, true, 50); 81 | 82 | // a button wired from the MCU pin to Vcc with an external pull-down resistor, 83 | // initial state is off. 84 | Button myButton(4, false, 25, false, false); 85 | 86 | ``` 87 | 88 | ## Button Library Functions 89 | 90 | ### begin() 91 | ##### Description 92 | Initializes the Button object and the pin it is connected to. 93 | ##### Syntax 94 | `myButton.begin();` 95 | ##### Parameters 96 | None. 97 | ##### Returns 98 | None. 99 | ##### Example 100 | ```c++ 101 | myButton.begin(); 102 | ``` 103 | ### read() 104 | ##### Description 105 | Reads the button and returns a *boolean* value (*true* or *false*) to indicate whether the button is pressed. The read() function needs to execute very frequently in order for the sketch to be responsive. A good place for read() is at the top of loop(). Often, the return value from read() will not be needed if the other functions below are used. 106 | ##### Syntax 107 | `myButton.read();` 108 | ##### Parameters 109 | None. 110 | ##### Returns 111 | *true* if the button is pressed, else *false* *(bool)* 112 | ##### Example 113 | ```c++ 114 | myButton.read(); 115 | ``` 116 | 117 | ### isPressed() 118 | ### isReleased() 119 | ##### Description 120 | These functions check the button state from the last call to `read()` and return false or true accordingly. These functions **do not** cause the button to be read. 121 | ##### Syntax 122 | `myButton.isPressed();` 123 | `myButton.isReleased();` 124 | ##### Parameters 125 | None. 126 | ##### Returns 127 | *true* or *false*, depending on whether the button has been pressed (released) or not *(bool)* 128 | ##### Example 129 | ```c++ 130 | if ( myButton.isPressed() ) 131 | { 132 | //do something 133 | } 134 | else 135 | { 136 | //do something else 137 | } 138 | ``` 139 | 140 | ### wasPressed() 141 | ### wasReleased() 142 | ##### Description 143 | These functions check the button state to see if it changed between the last two calls to `read()` and return false or true accordingly. These functions **do not** cause the button to be read. Note that these functions may be more useful than `isPressed()` and `isReleased()` since they actually detect a **change** in the state of the button, which is usually what we want in order to cause some action. 144 | ##### Syntax 145 | `myButton.wasPressed();` 146 | `myButton.wasReleased();` 147 | ##### Parameters 148 | None. 149 | ##### Returns 150 | *true* or *false*, depending on whether the button was pressed (released) or not *(boolean)* 151 | ##### Example 152 | ```c++ 153 | if ( myButton.wasPressed() ) 154 | { 155 | //do something 156 | } 157 | ``` 158 | 159 | ### pressedFor(ms) 160 | ### releasedFor(ms) 161 | ##### Description 162 | These functions check to see if the button is pressed (or released), and has been in that state for the specified time in milliseconds. Returns false or true accordingly. These functions are useful to detect "long presses". Note that these functions **do not** cause the button to be read. 163 | ##### Syntax 164 | `myButton.pressedFor(ms);` 165 | `myButton.releasedFor(ms);` 166 | ##### Parameters 167 | **ms:** The number of milliseconds *(unsigned long)* 168 | ##### Returns 169 | *true* or *false*, depending on whether the button was pressed (released) for the specified time *(bool)* 170 | ##### Example 171 | ```c++ 172 | if ( myButton.pressedFor(1000) ) 173 | { 174 | // button has been pressed for one second 175 | } 176 | ``` 177 | 178 | ### lastChange() 179 | ##### Description 180 | Under certain circumstances, it may be useful to know when a button last changed state. `lastChange()` returns the time the button last changed state, in milliseconds (the value is derived from the Arduino millis() function). 181 | ##### Syntax 182 | `myButton.lastChange();` 183 | ##### Parameters 184 | None. 185 | ##### Returns 186 | The time in milliseconds when the button last changed state *(unsigned long)* 187 | ##### Example 188 | ```c++ 189 | unsigned long msLastChange = myButton.lastChange(); 190 | ``` 191 | 192 | ## ToggleButton Library Functions 193 | 194 | ### changed() 195 | ##### Description 196 | Returns a boolean value (true or false) to indicate whether the toggle button changed state the last time `read()` was called. 197 | ##### Syntax 198 | `myToggle.changed();` 199 | ##### Parameters 200 | None. 201 | ##### Returns 202 | *true* if the toggle state changed, else *false* *(bool)* 203 | ##### Example 204 | ```c++ 205 | if (myToggle.changed()) 206 | { 207 | // do something 208 | } 209 | else 210 | { 211 | // do something different 212 | } 213 | ``` 214 | 215 | ### toggleState() 216 | ##### Description 217 | Returns a boolean value (true or false) to indicate the toggle button state as of the last time `read()` was called. 218 | ##### Syntax 219 | `myToggle.toggleState();` 220 | ##### Parameters 221 | None. 222 | ##### Returns 223 | *true* if the toggle is "on", else *false* *(bool)* 224 | ##### Example 225 | ```c++ 226 | if (myToggle.toggleState()) 227 | { 228 | // do something 229 | } 230 | else 231 | { 232 | // do something different 233 | } 234 | ``` -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | ### GNU GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | ### Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for 14 | software and other kinds of works. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | the GNU General Public License is intended to guarantee your freedom 19 | to share and change all versions of a program--to make sure it remains 20 | free software for all its users. We, the Free Software Foundation, use 21 | the GNU General Public License for most of our software; it applies 22 | also to any other work released this way by its authors. You can apply 23 | it to your programs, too. 24 | 25 | When we speak of free software, we are referring to freedom, not 26 | price. Our General Public Licenses are designed to make sure that you 27 | have the freedom to distribute copies of free software (and charge for 28 | them if you wish), that you receive source code or can get it if you 29 | want it, that you can change the software or use pieces of it in new 30 | free programs, and that you know you can do these things. 31 | 32 | To protect your rights, we need to prevent others from denying you 33 | these rights or asking you to surrender the rights. Therefore, you 34 | have certain responsibilities if you distribute copies of the 35 | software, or if you modify it: responsibilities to respect the freedom 36 | of others. 37 | 38 | For example, if you distribute copies of such a program, whether 39 | gratis or for a fee, you must pass on to the recipients the same 40 | freedoms that you received. You must make sure that they, too, receive 41 | or can get the source code. And you must show them these terms so they 42 | know their rights. 43 | 44 | Developers that use the GNU GPL protect your rights with two steps: 45 | (1) assert copyright on the software, and (2) offer you this License 46 | giving you legal permission to copy, distribute and/or modify it. 47 | 48 | For the developers' and authors' protection, the GPL clearly explains 49 | that there is no warranty for this free software. For both users' and 50 | authors' sake, the GPL requires that modified versions be marked as 51 | changed, so that their problems will not be attributed erroneously to 52 | authors of previous versions. 53 | 54 | Some devices are designed to deny users access to install or run 55 | modified versions of the software inside them, although the 56 | manufacturer can do so. This is fundamentally incompatible with the 57 | aim of protecting users' freedom to change the software. The 58 | systematic pattern of such abuse occurs in the area of products for 59 | individuals to use, which is precisely where it is most unacceptable. 60 | Therefore, we have designed this version of the GPL to prohibit the 61 | practice for those products. If such problems arise substantially in 62 | other domains, we stand ready to extend this provision to those 63 | domains in future versions of the GPL, as needed to protect the 64 | freedom of users. 65 | 66 | Finally, every program is threatened constantly by software patents. 67 | States should not allow patents to restrict development and use of 68 | software on general-purpose computers, but in those that do, we wish 69 | to avoid the special danger that patents applied to a free program 70 | could make it effectively proprietary. To prevent this, the GPL 71 | assures that patents cannot be used to render the program non-free. 72 | 73 | The precise terms and conditions for copying, distribution and 74 | modification follow. 75 | 76 | ### TERMS AND CONDITIONS 77 | 78 | #### 0. Definitions. 79 | 80 | "This License" refers to version 3 of the GNU General Public License. 81 | 82 | "Copyright" also means copyright-like laws that apply to other kinds 83 | of works, such as semiconductor masks. 84 | 85 | "The Program" refers to any copyrightable work licensed under this 86 | License. Each licensee is addressed as "you". "Licensees" and 87 | "recipients" may be individuals or organizations. 88 | 89 | To "modify" a work means to copy from or adapt all or part of the work 90 | in a fashion requiring copyright permission, other than the making of 91 | an exact copy. The resulting work is called a "modified version" of 92 | the earlier work or a work "based on" the earlier work. 93 | 94 | A "covered work" means either the unmodified Program or a work based 95 | on the Program. 96 | 97 | To "propagate" a work means to do anything with it that, without 98 | permission, would make you directly or secondarily liable for 99 | infringement under applicable copyright law, except executing it on a 100 | computer or modifying a private copy. Propagation includes copying, 101 | distribution (with or without modification), making available to the 102 | public, and in some countries other activities as well. 103 | 104 | To "convey" a work means any kind of propagation that enables other 105 | parties to make or receive copies. Mere interaction with a user 106 | through a computer network, with no transfer of a copy, is not 107 | conveying. 108 | 109 | An interactive user interface displays "Appropriate Legal Notices" to 110 | the extent that it includes a convenient and prominently visible 111 | feature that (1) displays an appropriate copyright notice, and (2) 112 | tells the user that there is no warranty for the work (except to the 113 | extent that warranties are provided), that licensees may convey the 114 | work under this License, and how to view a copy of this License. If 115 | the interface presents a list of user commands or options, such as a 116 | menu, a prominent item in the list meets this criterion. 117 | 118 | #### 1. Source Code. 119 | 120 | The "source code" for a work means the preferred form of the work for 121 | making modifications to it. "Object code" means any non-source form of 122 | a work. 123 | 124 | A "Standard Interface" means an interface that either is an official 125 | standard defined by a recognized standards body, or, in the case of 126 | interfaces specified for a particular programming language, one that 127 | is widely used among developers working in that language. 128 | 129 | The "System Libraries" of an executable work include anything, other 130 | than the work as a whole, that (a) is included in the normal form of 131 | packaging a Major Component, but which is not part of that Major 132 | Component, and (b) serves only to enable use of the work with that 133 | Major Component, or to implement a Standard Interface for which an 134 | implementation is available to the public in source code form. A 135 | "Major Component", in this context, means a major essential component 136 | (kernel, window system, and so on) of the specific operating system 137 | (if any) on which the executable work runs, or a compiler used to 138 | produce the work, or an object code interpreter used to run it. 139 | 140 | The "Corresponding Source" for a work in object code form means all 141 | the source code needed to generate, install, and (for an executable 142 | work) run the object code and to modify the work, including scripts to 143 | control those activities. However, it does not include the work's 144 | System Libraries, or general-purpose tools or generally available free 145 | programs which are used unmodified in performing those activities but 146 | which are not part of the work. For example, Corresponding Source 147 | includes interface definition files associated with source files for 148 | the work, and the source code for shared libraries and dynamically 149 | linked subprograms that the work is specifically designed to require, 150 | such as by intimate data communication or control flow between those 151 | subprograms and other parts of the work. 152 | 153 | The Corresponding Source need not include anything that users can 154 | regenerate automatically from other parts of the Corresponding Source. 155 | 156 | The Corresponding Source for a work in source code form is that same 157 | work. 158 | 159 | #### 2. Basic Permissions. 160 | 161 | All rights granted under this License are granted for the term of 162 | copyright on the Program, and are irrevocable provided the stated 163 | conditions are met. This License explicitly affirms your unlimited 164 | permission to run the unmodified Program. The output from running a 165 | covered work is covered by this License only if the output, given its 166 | content, constitutes a covered work. This License acknowledges your 167 | rights of fair use or other equivalent, as provided by copyright law. 168 | 169 | You may make, run and propagate covered works that you do not convey, 170 | without conditions so long as your license otherwise remains in force. 171 | You may convey covered works to others for the sole purpose of having 172 | them make modifications exclusively for you, or provide you with 173 | facilities for running those works, provided that you comply with the 174 | terms of this License in conveying all material for which you do not 175 | control copyright. Those thus making or running the covered works for 176 | you must do so exclusively on your behalf, under your direction and 177 | control, on terms that prohibit them from making any copies of your 178 | copyrighted material outside their relationship with you. 179 | 180 | Conveying under any other circumstances is permitted solely under the 181 | conditions stated below. Sublicensing is not allowed; section 10 makes 182 | it unnecessary. 183 | 184 | #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 185 | 186 | No covered work shall be deemed part of an effective technological 187 | measure under any applicable law fulfilling obligations under article 188 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 189 | similar laws prohibiting or restricting circumvention of such 190 | measures. 191 | 192 | When you convey a covered work, you waive any legal power to forbid 193 | circumvention of technological measures to the extent such 194 | circumvention is effected by exercising rights under this License with 195 | respect to the covered work, and you disclaim any intention to limit 196 | operation or modification of the work as a means of enforcing, against 197 | the work's users, your or third parties' legal rights to forbid 198 | circumvention of technological measures. 199 | 200 | #### 4. Conveying Verbatim Copies. 201 | 202 | You may convey verbatim copies of the Program's source code as you 203 | receive it, in any medium, provided that you conspicuously and 204 | appropriately publish on each copy an appropriate copyright notice; 205 | keep intact all notices stating that this License and any 206 | non-permissive terms added in accord with section 7 apply to the code; 207 | keep intact all notices of the absence of any warranty; and give all 208 | recipients a copy of this License along with the Program. 209 | 210 | You may charge any price or no price for each copy that you convey, 211 | and you may offer support or warranty protection for a fee. 212 | 213 | #### 5. Conveying Modified Source Versions. 214 | 215 | You may convey a work based on the Program, or the modifications to 216 | produce it from the Program, in the form of source code under the 217 | terms of section 4, provided that you also meet all of these 218 | conditions: 219 | 220 | - a) The work must carry prominent notices stating that you modified 221 | it, and giving a relevant date. 222 | - b) The work must carry prominent notices stating that it is 223 | released under this License and any conditions added under 224 | section 7. This requirement modifies the requirement in section 4 225 | to "keep intact all notices". 226 | - c) You must license the entire work, as a whole, under this 227 | License to anyone who comes into possession of a copy. This 228 | License will therefore apply, along with any applicable section 7 229 | additional terms, to the whole of the work, and all its parts, 230 | regardless of how they are packaged. This License gives no 231 | permission to license the work in any other way, but it does not 232 | invalidate such permission if you have separately received it. 233 | - d) If the work has interactive user interfaces, each must display 234 | Appropriate Legal Notices; however, if the Program has interactive 235 | interfaces that do not display Appropriate Legal Notices, your 236 | work need not make them do so. 237 | 238 | A compilation of a covered work with other separate and independent 239 | works, which are not by their nature extensions of the covered work, 240 | and which are not combined with it such as to form a larger program, 241 | in or on a volume of a storage or distribution medium, is called an 242 | "aggregate" if the compilation and its resulting copyright are not 243 | used to limit the access or legal rights of the compilation's users 244 | beyond what the individual works permit. Inclusion of a covered work 245 | in an aggregate does not cause this License to apply to the other 246 | parts of the aggregate. 247 | 248 | #### 6. Conveying Non-Source Forms. 249 | 250 | You may convey a covered work in object code form under the terms of 251 | sections 4 and 5, provided that you also convey the machine-readable 252 | Corresponding Source under the terms of this License, in one of these 253 | ways: 254 | 255 | - a) Convey the object code in, or embodied in, a physical product 256 | (including a physical distribution medium), accompanied by the 257 | Corresponding Source fixed on a durable physical medium 258 | customarily used for software interchange. 259 | - b) Convey the object code in, or embodied in, a physical product 260 | (including a physical distribution medium), accompanied by a 261 | written offer, valid for at least three years and valid for as 262 | long as you offer spare parts or customer support for that product 263 | model, to give anyone who possesses the object code either (1) a 264 | copy of the Corresponding Source for all the software in the 265 | product that is covered by this License, on a durable physical 266 | medium customarily used for software interchange, for a price no 267 | more than your reasonable cost of physically performing this 268 | conveying of source, or (2) access to copy the Corresponding 269 | Source from a network server at no charge. 270 | - c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 275 | - d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | - e) Convey the object code using peer-to-peer transmission, 288 | provided you inform other peers where the object code and 289 | Corresponding Source of the work are being offered to the general 290 | public at no charge under subsection 6d. 291 | 292 | A separable portion of the object code, whose source code is excluded 293 | from the Corresponding Source as a System Library, need not be 294 | included in conveying the object code work. 295 | 296 | A "User Product" is either (1) a "consumer product", which means any 297 | tangible personal property which is normally used for personal, 298 | family, or household purposes, or (2) anything designed or sold for 299 | incorporation into a dwelling. In determining whether a product is a 300 | consumer product, doubtful cases shall be resolved in favor of 301 | coverage. For a particular product received by a particular user, 302 | "normally used" refers to a typical or common use of that class of 303 | product, regardless of the status of the particular user or of the way 304 | in which the particular user actually uses, or expects or is expected 305 | to use, the product. A product is a consumer product regardless of 306 | whether the product has substantial commercial, industrial or 307 | non-consumer uses, unless such uses represent the only significant 308 | mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to 312 | install and execute modified versions of a covered work in that User 313 | Product from a modified version of its Corresponding Source. The 314 | information must suffice to ensure that the continued functioning of 315 | the modified object code is in no case prevented or interfered with 316 | solely because modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or 331 | updates for a work that has been modified or installed by the 332 | recipient, or for the User Product in which it has been modified or 333 | installed. Access to a network may be denied when the modification 334 | itself materially and adversely affects the operation of the network 335 | or violates the rules and protocols for communication across the 336 | network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | #### 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders 364 | of that material) supplement the terms of this License with terms: 365 | 366 | - a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 368 | - b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | - c) Prohibiting misrepresentation of the origin of that material, 372 | or requiring that modified versions of such material be marked in 373 | reasonable ways as different from the original version; or 374 | - d) Limiting the use for publicity purposes of names of licensors 375 | or authors of the material; or 376 | - e) Declining to grant rights under trademark law for use of some 377 | trade names, trademarks, or service marks; or 378 | - f) Requiring indemnification of licensors and authors of that 379 | material by anyone who conveys the material (or modified versions 380 | of it) with contractual assumptions of liability to the recipient, 381 | for any liability that these contractual assumptions directly 382 | impose on those licensors and authors. 383 | 384 | All other non-permissive additional terms are considered "further 385 | restrictions" within the meaning of section 10. If the Program as you 386 | received it, or any part of it, contains a notice stating that it is 387 | governed by this License along with a term that is a further 388 | restriction, you may remove that term. If a license document contains 389 | a further restriction but permits relicensing or conveying under this 390 | License, you may add to a covered work material governed by the terms 391 | of that license document, provided that the further restriction does 392 | not survive such relicensing or conveying. 393 | 394 | If you add terms to a covered work in accord with this section, you 395 | must place, in the relevant source files, a statement of the 396 | additional terms that apply to those files, or a notice indicating 397 | where to find the applicable terms. 398 | 399 | Additional terms, permissive or non-permissive, may be stated in the 400 | form of a separately written license, or stated as exceptions; the 401 | above requirements apply either way. 402 | 403 | #### 8. Termination. 404 | 405 | You may not propagate or modify a covered work except as expressly 406 | provided under this License. Any attempt otherwise to propagate or 407 | modify it is void, and will automatically terminate your rights under 408 | this License (including any patent licenses granted under the third 409 | paragraph of section 11). 410 | 411 | However, if you cease all violation of this License, then your license 412 | from a particular copyright holder is reinstated (a) provisionally, 413 | unless and until the copyright holder explicitly and finally 414 | terminates your license, and (b) permanently, if the copyright holder 415 | fails to notify you of the violation by some reasonable means prior to 416 | 60 days after the cessation. 417 | 418 | Moreover, your license from a particular copyright holder is 419 | reinstated permanently if the copyright holder notifies you of the 420 | violation by some reasonable means, this is the first time you have 421 | received notice of violation of this License (for any work) from that 422 | copyright holder, and you cure the violation prior to 30 days after 423 | your receipt of the notice. 424 | 425 | Termination of your rights under this section does not terminate the 426 | licenses of parties who have received copies or rights from you under 427 | this License. If your rights have been terminated and not permanently 428 | reinstated, you do not qualify to receive new licenses for the same 429 | material under section 10. 430 | 431 | #### 9. Acceptance Not Required for Having Copies. 432 | 433 | You are not required to accept this License in order to receive or run 434 | a copy of the Program. Ancillary propagation of a covered work 435 | occurring solely as a consequence of using peer-to-peer transmission 436 | to receive a copy likewise does not require acceptance. However, 437 | nothing other than this License grants you permission to propagate or 438 | modify any covered work. These actions infringe copyright if you do 439 | not accept this License. Therefore, by modifying or propagating a 440 | covered work, you indicate your acceptance of this License to do so. 441 | 442 | #### 10. Automatic Licensing of Downstream Recipients. 443 | 444 | Each time you convey a covered work, the recipient automatically 445 | receives a license from the original licensors, to run, modify and 446 | propagate that work, subject to this License. You are not responsible 447 | for enforcing compliance by third parties with this License. 448 | 449 | An "entity transaction" is a transaction transferring control of an 450 | organization, or substantially all assets of one, or subdividing an 451 | organization, or merging organizations. If propagation of a covered 452 | work results from an entity transaction, each party to that 453 | transaction who receives a copy of the work also receives whatever 454 | licenses to the work the party's predecessor in interest had or could 455 | give under the previous paragraph, plus a right to possession of the 456 | Corresponding Source of the work from the predecessor in interest, if 457 | the predecessor has it or can get it with reasonable efforts. 458 | 459 | You may not impose any further restrictions on the exercise of the 460 | rights granted or affirmed under this License. For example, you may 461 | not impose a license fee, royalty, or other charge for exercise of 462 | rights granted under this License, and you may not initiate litigation 463 | (including a cross-claim or counterclaim in a lawsuit) alleging that 464 | any patent claim is infringed by making, using, selling, offering for 465 | sale, or importing the Program or any portion of it. 466 | 467 | #### 11. Patents. 468 | 469 | A "contributor" is a copyright holder who authorizes use under this 470 | License of the Program or a work on which the Program is based. The 471 | work thus licensed is called the contributor's "contributor version". 472 | 473 | A contributor's "essential patent claims" are all patent claims owned 474 | or controlled by the contributor, whether already acquired or 475 | hereafter acquired, that would be infringed by some manner, permitted 476 | by this License, of making, using, or selling its contributor version, 477 | but do not include claims that would be infringed only as a 478 | consequence of further modification of the contributor version. For 479 | purposes of this definition, "control" includes the right to grant 480 | patent sublicenses in a manner consistent with the requirements of 481 | this License. 482 | 483 | Each contributor grants you a non-exclusive, worldwide, royalty-free 484 | patent license under the contributor's essential patent claims, to 485 | make, use, sell, offer for sale, import and otherwise run, modify and 486 | propagate the contents of its contributor version. 487 | 488 | In the following three paragraphs, a "patent license" is any express 489 | agreement or commitment, however denominated, not to enforce a patent 490 | (such as an express permission to practice a patent or covenant not to 491 | sue for patent infringement). To "grant" such a patent license to a 492 | party means to make such an agreement or commitment not to enforce a 493 | patent against the party. 494 | 495 | If you convey a covered work, knowingly relying on a patent license, 496 | and the Corresponding Source of the work is not available for anyone 497 | to copy, free of charge and under the terms of this License, through a 498 | publicly available network server or other readily accessible means, 499 | then you must either (1) cause the Corresponding Source to be so 500 | available, or (2) arrange to deprive yourself of the benefit of the 501 | patent license for this particular work, or (3) arrange, in a manner 502 | consistent with the requirements of this License, to extend the patent 503 | license to downstream recipients. "Knowingly relying" means you have 504 | actual knowledge that, but for the patent license, your conveying the 505 | covered work in a country, or your recipient's use of the covered work 506 | in a country, would infringe one or more identifiable patents in that 507 | country that you have reason to believe are valid. 508 | 509 | If, pursuant to or in connection with a single transaction or 510 | arrangement, you convey, or propagate by procuring conveyance of, a 511 | covered work, and grant a patent license to some of the parties 512 | receiving the covered work authorizing them to use, propagate, modify 513 | or convey a specific copy of the covered work, then the patent license 514 | you grant is automatically extended to all recipients of the covered 515 | work and works based on it. 516 | 517 | A patent license is "discriminatory" if it does not include within the 518 | scope of its coverage, prohibits the exercise of, or is conditioned on 519 | the non-exercise of one or more of the rights that are specifically 520 | granted under this License. You may not convey a covered work if you 521 | are a party to an arrangement with a third party that is in the 522 | business of distributing software, under which you make payment to the 523 | third party based on the extent of your activity of conveying the 524 | work, and under which the third party grants, to any of the parties 525 | who would receive the covered work from you, a discriminatory patent 526 | license (a) in connection with copies of the covered work conveyed by 527 | you (or copies made from those copies), or (b) primarily for and in 528 | connection with specific products or compilations that contain the 529 | covered work, unless you entered into that arrangement, or that patent 530 | license was granted, prior to 28 March 2007. 531 | 532 | Nothing in this License shall be construed as excluding or limiting 533 | any implied license or other defenses to infringement that may 534 | otherwise be available to you under applicable patent law. 535 | 536 | #### 12. No Surrender of Others' Freedom. 537 | 538 | If conditions are imposed on you (whether by court order, agreement or 539 | otherwise) that contradict the conditions of this License, they do not 540 | excuse you from the conditions of this License. If you cannot convey a 541 | covered work so as to satisfy simultaneously your obligations under 542 | this License and any other pertinent obligations, then as a 543 | consequence you may not convey it at all. For example, if you agree to 544 | terms that obligate you to collect a royalty for further conveying 545 | from those to whom you convey the Program, the only way you could 546 | satisfy both those terms and this License would be to refrain entirely 547 | from conveying the Program. 548 | 549 | #### 13. Use with the GNU Affero General Public License. 550 | 551 | Notwithstanding any other provision of this License, you have 552 | permission to link or combine any covered work with a work licensed 553 | under version 3 of the GNU Affero General Public License into a single 554 | combined work, and to convey the resulting work. The terms of this 555 | License will continue to apply to the part which is the covered work, 556 | but the special requirements of the GNU Affero General Public License, 557 | section 13, concerning interaction through a network will apply to the 558 | combination as such. 559 | 560 | #### 14. Revised Versions of this License. 561 | 562 | The Free Software Foundation may publish revised and/or new versions 563 | of the GNU General Public License from time to time. Such new versions 564 | will be similar in spirit to the present version, but may differ in 565 | detail to address new problems or concerns. 566 | 567 | Each version is given a distinguishing version number. If the Program 568 | specifies that a certain numbered version of the GNU General Public 569 | License "or any later version" applies to it, you have the option of 570 | following the terms and conditions either of that numbered version or 571 | of any later version published by the Free Software Foundation. If the 572 | Program does not specify a version number of the GNU General Public 573 | License, you may choose any version ever published by the Free 574 | Software Foundation. 575 | 576 | If the Program specifies that a proxy can decide which future versions 577 | of the GNU General Public License can be used, that proxy's public 578 | statement of acceptance of a version permanently authorizes you to 579 | choose that version for the Program. 580 | 581 | Later license versions may give you additional or different 582 | permissions. However, no additional obligations are imposed on any 583 | author or copyright holder as a result of your choosing to follow a 584 | later version. 585 | 586 | #### 15. Disclaimer of Warranty. 587 | 588 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 589 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 590 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT 591 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT 592 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 593 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND 594 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 595 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR 596 | CORRECTION. 597 | 598 | #### 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR 602 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 603 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES 604 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT 605 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR 606 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM 607 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER 608 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 609 | 610 | #### 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | ### How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these 626 | terms. 627 | 628 | To do so, attach the following notices to the program. It is safest to 629 | attach them to the start of each source file to most effectively state 630 | the exclusion of warranty; and each file should have at least the 631 | "copyright" line and a pointer to where the full notice is found. 632 | 633 | 634 | Copyright (C) 635 | 636 | This program is free software: you can redistribute it and/or modify 637 | it under the terms of the GNU General Public License as published by 638 | the Free Software Foundation, either version 3 of the License, or 639 | (at your option) any later version. 640 | 641 | This program is distributed in the hope that it will be useful, 642 | but WITHOUT ANY WARRANTY; without even the implied warranty of 643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 644 | GNU General Public License for more details. 645 | 646 | You should have received a copy of the GNU General Public License 647 | along with this program. If not, see . 648 | 649 | Also add information on how to contact you by electronic and paper 650 | mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands \`show w' and \`show c' should show the 661 | appropriate parts of the General Public License. Of course, your 662 | program's commands might be different; for a GUI interface, you would 663 | use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or 666 | school, if any, to sign a "copyright disclaimer" for the program, if 667 | necessary. For more information on this, and how to apply and follow 668 | the GNU GPL, see . 669 | 670 | The GNU General Public License does not permit incorporating your 671 | program into proprietary programs. If your program is a subroutine 672 | library, you may consider it more useful to permit linking proprietary 673 | applications with the library. If this is what you want to do, use the 674 | GNU Lesser General Public License instead of this License. But first, 675 | please read . 676 | --------------------------------------------------------------------------------