-
Notifications
You must be signed in to change notification settings - Fork 233
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
458 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| /** | ||
| * @file OneButton.cpp | ||
| * | ||
| * @brief Library for detecting button clicks, doubleclicks and long press | ||
| * pattern on a single button. | ||
| * | ||
| * @author Matthias Hertel, https://www.mathertel.de | ||
| * @Copyright Copyright (c) by Matthias Hertel, https://www.mathertel.de. | ||
| * Ihor Nehrutsa, [email protected] | ||
| * | ||
| * This work is licensed under a BSD style license. See | ||
| * http://www.mathertel.de/License.aspx | ||
| * | ||
| * More information on: https://www.mathertel.de/Arduino/OneButtonLibrary.aspx | ||
| * | ||
| * Changelog: see OneButtonTiny.h | ||
| */ | ||
|
|
||
| #include "OneButtonTiny.h" | ||
|
|
||
| // ----- Initialization and Default Values ----- | ||
|
|
||
| /** | ||
| * Initialize the OneButton library. | ||
| * @param pin The pin to be used for input from a momentary button. | ||
| * @param activeLow Set to true when the input level is LOW when the button is pressed, Default is true. | ||
| * @param pullupActive Activate the internal pullup when available. Default is true. | ||
| */ | ||
| OneButtonTiny::OneButtonTiny(const int pin, const boolean activeLow, const bool pullupActive) { | ||
| _pin = pin; | ||
|
|
||
| if (activeLow) { | ||
| // the button connects the input pin to GND when pressed. | ||
| _buttonPressed = LOW; | ||
|
|
||
| } else { | ||
| // the button connects the input pin to VCC when pressed. | ||
| _buttonPressed = HIGH; | ||
| } | ||
|
|
||
| if (pullupActive) { | ||
| // use the given pin as input and activate internal PULLUP resistor. | ||
| pinMode(pin, INPUT_PULLUP); | ||
| } else { | ||
| // use the given pin as input | ||
| pinMode(pin, INPUT); | ||
| } | ||
| } // OneButton | ||
|
|
||
|
|
||
| // explicitly set the number of millisec that have to pass by before a click is assumed stable. | ||
| void OneButtonTiny::setDebounceMs(const unsigned int ms) { | ||
| _debounce_ms = ms; | ||
| } // setDebounceMs | ||
|
|
||
|
|
||
| // explicitly set the number of millisec that have to pass by before a click is detected. | ||
| void OneButtonTiny::setClickMs(const unsigned int ms) { | ||
| _click_ms = ms; | ||
| } // setClickMs | ||
|
|
||
|
|
||
| // explicitly set the number of millisec that have to pass by before a long button press is detected. | ||
| void OneButtonTiny::setPressMs(const unsigned int ms) { | ||
| _press_ms = ms; | ||
| } // setPressMs | ||
|
|
||
|
|
||
| // save function for click event | ||
| void OneButtonTiny::attachClick(callbackFunction newFunction) { | ||
| _clickFunc = newFunction; | ||
| } // attachClick | ||
|
|
||
|
|
||
| // save function for doubleClick event | ||
| void OneButtonTiny::attachDoubleClick(callbackFunction newFunction) { | ||
| _doubleClickFunc = newFunction; | ||
| } // attachDoubleClick | ||
|
|
||
|
|
||
| // save function for longPressStart event | ||
| void OneButtonTiny::attachLongPressStart(callbackFunction newFunction) { | ||
| _longPressStartFunc = newFunction; | ||
| } // attachLongPressStart | ||
|
|
||
|
|
||
| void OneButtonTiny::reset(void) { | ||
| _state = OneButtonTiny::OCS_INIT; | ||
| _nClicks = 0; | ||
| _startTime = 0; | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * @brief Debounce input pin level for use in SpecialInput. | ||
| */ | ||
| int OneButtonTiny::debounce(const int value) { | ||
| now = millis(); // current (relative) time in msecs. | ||
| if (_lastDebouncePinLevel == value) { | ||
| if (now - _lastDebounceTime >= _debounce_ms) | ||
| debouncedPinLevel = value; | ||
| } else { | ||
| _lastDebounceTime = now; | ||
| _lastDebouncePinLevel = value; | ||
| } | ||
| return debouncedPinLevel; | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * @brief Check input of the configured pin, | ||
| * debounce input pin level and then | ||
| * advance the finite state machine (FSM). | ||
| */ | ||
| void OneButtonTiny::tick(void) { | ||
| if (_pin >= 0) { | ||
| _fsm(debounce(digitalRead(_pin)) == _buttonPressed); | ||
| } | ||
| } // tick() | ||
|
|
||
|
|
||
| void OneButtonTiny::tick(bool activeLevel) { | ||
| _fsm(debounce(activeLevel)); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * @brief Advance to a new state and save the last one to come back in cas of bouncing detection. | ||
| */ | ||
| void OneButtonTiny::_newState(stateMachine_t nextState) { | ||
| _state = nextState; | ||
| } // _newState() | ||
|
|
||
|
|
||
| /** | ||
| * @brief Run the finite state machine (FSM) using the given level. | ||
| */ | ||
| void OneButtonTiny::_fsm(bool activeLevel) { | ||
| unsigned long waitTime = (now - _startTime); | ||
|
|
||
| // Implementation of the state machine | ||
| switch (_state) { | ||
| case OneButtonTiny::OCS_INIT: | ||
| // waiting for level to become active. | ||
| if (activeLevel) { | ||
| _newState(OneButtonTiny::OCS_DOWN); | ||
| _startTime = now; // remember starting time | ||
| _nClicks = 0; | ||
| } // if | ||
| break; | ||
|
|
||
| case OneButtonTiny::OCS_DOWN: | ||
| // waiting for level to become inactive. | ||
|
|
||
| if (!activeLevel) { | ||
| _newState(OneButtonTiny::OCS_UP); | ||
| _startTime = now; // remember starting time | ||
|
|
||
| } else if ((activeLevel) && (waitTime > _press_ms)) { | ||
| if (_longPressStartFunc) _longPressStartFunc(); | ||
| _newState(OneButtonTiny::OCS_PRESS); | ||
| } // if | ||
| break; | ||
|
|
||
| case OneButtonTiny::OCS_UP: | ||
| // level is inactive | ||
|
|
||
| // count as a short button down | ||
| _nClicks++; | ||
| _newState(OneButtonTiny::OCS_COUNT); | ||
| break; | ||
|
|
||
| case OneButtonTiny::OCS_COUNT: | ||
| // dobounce time is over, count clicks | ||
|
|
||
| if (activeLevel) { | ||
| // button is down again | ||
| _newState(OneButtonTiny::OCS_DOWN); | ||
| _startTime = now; // remember starting time | ||
|
|
||
| } else if ((waitTime >= _click_ms) || (_nClicks == 2)) { | ||
| // now we know how many clicks have been made. | ||
|
|
||
| if (_nClicks == 1) { | ||
| // this was 1 click only. | ||
| if (_clickFunc) _clickFunc(); | ||
|
|
||
| } else if (_nClicks == 2) { | ||
| // this was a 2 click sequence. | ||
| if (_doubleClickFunc) _doubleClickFunc(); | ||
|
|
||
| } // if | ||
|
|
||
| reset(); | ||
| } // if | ||
| break; | ||
|
|
||
| case OneButtonTiny::OCS_PRESS: | ||
| // waiting for pin being release after long press. | ||
|
|
||
| if (!activeLevel) { | ||
| _newState(OneButtonTiny::OCS_PRESSEND); | ||
| _startTime = now; | ||
| } // if | ||
| break; | ||
|
|
||
| case OneButtonTiny::OCS_PRESSEND: | ||
| // button was released. | ||
| reset(); | ||
| break; | ||
|
|
||
| default: | ||
| // unknown state detected -> reset state machine | ||
| _newState(OneButtonTiny::OCS_INIT); | ||
| break; | ||
| } // if | ||
|
|
||
| } // OneButton.tick() | ||
|
|
||
|
|
||
| // end. |
Oops, something went wrong.