AceButton.h

/*
MIT License
 
Copyright (c) 2018 Brian T. Park
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
#ifndef ACE_BUTTON_ACE_BUTTON_H
#define ACE_BUTTON_ACE_BUTTON_H
 
#include <Arduino.h>
#include "ButtonConfig.h"
 
class __FlashStringHelper;
 
namespace ace_button {
 
class AceButton {
  public:
    // The supported event types.
 
    static const uint8_t kEventPressed = 0;
 
    static const uint8_t kEventReleased = 1;
 
    static const uint8_t kEventClicked = 2;
 
    static const uint8_t kEventDoubleClicked = 3;
 
    static const uint8_t kEventLongPressed = 4;
 
    static const uint8_t kEventRepeatPressed = 5;
 
    static const uint8_t kEventLongReleased = 6;
 
    static const uint8_t kEventHeartBeat = 7;
 
    static const uint8_t kButtonStateUnknown = 127;
 
    static __FlashStringHelper* eventName(uint8_t event);
 
    explicit AceButton(
        uint8_t pin = 0,
        uint8_t defaultReleasedState = HIGH,
        uint8_t id = 0
    ) :
        mButtonConfig(ButtonConfig::getSystemButtonConfig()) {
      init(pin, defaultReleasedState, id);
    }
 
    explicit AceButton(
        ButtonConfig* buttonConfig,
        uint8_t pin = 0,
        uint8_t defaultReleasedState = HIGH,
        uint8_t id = 0) {
      init(buttonConfig, pin, defaultReleasedState, id);
    }
 
    void init(
        uint8_t pin = 0,
        uint8_t defaultReleasedState = HIGH,
        uint8_t id = 0);
 
    void init(
        ButtonConfig* buttonConfig,
        uint8_t pin = 0,
        uint8_t defaultReleasedState = HIGH,
        uint8_t id = 0);
 
    ButtonConfig* getButtonConfig() const {
      return mButtonConfig;
    }
 
    void setButtonConfig(ButtonConfig* buttonConfig) {
      mButtonConfig = buttonConfig;
    }
 
    void setEventHandler(ButtonConfig::EventHandler eventHandler) {
      mButtonConfig->setEventHandler(eventHandler);
    }
 
    uint8_t getPin() const { return mPin; }
 
    uint8_t getId() const { return mId; }
 
    uint8_t getDefaultReleasedState() const;
 
    uint8_t getLastButtonState() const {
      return mLastButtonState;
    }
 
    void check();
 
    void checkState(uint8_t buttonState);
 
    bool isReleased(uint8_t buttonState) const {
      return buttonState == getDefaultReleasedState();
    }
 
    bool isPressedRaw() const {
      return !isReleased(mButtonConfig->readButton(mPin));
    }
 
  // Some of these private methods may be useful to the calling client but I
  // don't want to release them to the public because I want to keep the API as
  // small as possible for easier long term maintenance. (Once a method is
  // released to the public, it must be supported forever to ensure backwards
  // compatibility with older client code.)
 
  private:
    // Disable copy-constructor and assignment operator
    AceButton(const AceButton&) = delete;
    AceButton& operator=(const AceButton&) = delete;
 
    void setPin(uint8_t pin) { mPin = pin; }
 
    void setDefaultReleasedState(uint8_t state);
 
    void setId(uint8_t id) { mId = id; }
 
    // Various bit masks to store a boolean flag in the 'mFlags' field.
    // We use bit masks to save static RAM. If we had used a 'bool' type, each
    // of these would consume one byte.
    typedef uint16_t FlagType;
    static const FlagType kFlagDefaultReleasedState = 0x01;
    static const FlagType kFlagDebouncing = 0x02;
    static const FlagType kFlagPressed = 0x04; // mLastPressTime is valid
    static const FlagType kFlagClicked = 0x08; // mLastClickTime valid
    static const FlagType kFlagDoubleClicked = 0x10;
    static const FlagType kFlagLongPressed = 0x20;
    static const FlagType kFlagRepeatPressed = 0x40; // mLastRepeatPressTime
    static const FlagType kFlagClickPostponed = 0x80;
    static const FlagType kFlagHeartRunning = 0x100; // mLastHeartBeatTime valid
 
    bool isFlag(FlagType flag) const {
      return mFlags & flag;
    }
 
    void setFlag(FlagType flag) {
      mFlags |= flag;
    }
 
    void clearFlag(FlagType flag) {
      mFlags &= ~flag;
    }
 
    bool checkDebounced(uint16_t now, uint8_t buttonState);
 
    bool checkInitialized(uint16_t buttonState);
 
    void checkEvent(uint16_t now, uint8_t buttonState);
 
    void checkLongPress(uint16_t now, uint8_t buttonState);
 
    void checkRepeatPress(uint16_t now, uint8_t buttonState);
 
    void checkChanged(uint16_t now, uint8_t buttonState);
 
    void checkReleased(uint16_t now, uint8_t buttonState);
 
    void checkPressed(uint16_t now, uint8_t buttonState);
 
    void checkClicked(uint16_t now);
 
    void checkDoubleClicked(uint16_t now);
 
    void checkOrphanedClick(uint16_t now);
 
    void checkPostponedClick(uint16_t now);
 
    void checkHeartBeat(uint16_t now);
 
    void handleEvent(uint8_t eventType);
 
  private:
    ButtonConfig* mButtonConfig;
 
    uint8_t mPin;
 
    uint8_t mId;
 
    FlagType mFlags;
 
    uint8_t mLastButtonState;
 
    // Internal states of the button debouncing and event handling.
    // NOTE: We don't keep track of the lastDoubleClickTime, because we
    // don't support a TripleClicked event. That may change in the future.
    uint16_t mLastDebounceTime; // ms
    uint16_t mLastClickTime; // ms
    uint16_t mLastPressTime; // ms
    uint16_t mLastRepeatPressTime; // ms
    uint16_t mLastHeartBeatTime; // ms
};
 
}
#endif