PinButton.h

/**
 * Simple, reliable button with multiple types of click detection.
 *
 * Supports debounced click, singleClick, doubleClick, longPress and
 * release events.
 *
 * This class provides a simple wrapper around the more generic MultiButton,
 * to simply use an Arduino digital pin as a button.
 *
 * Copyright (C) Martin Poelstra
 * MIT License
 */

#pragma once

#include <Arduino.h>
#include <MultiButton.h>

/**
 * Simple wrapper for MultiButton class using an Arduino pin.
 * Assumes a switch is connected between the pin and ground.
 * Make sure to regularly call update() (e.g. from loop()).
 *
 * See MultiButton for all `isXXXClick()` methods etc.
 *
 * Usage example:
 * ```cpp
 * #include <PinButton.h>
 *
 * PinButton myButton(5); // connect a switch between pin 5 and ground
 *
 * void setup() {
 *   Serial.begin(9600);
 * }
 *
 * void loop() {
 *   myButton.update();
 *   if (myButton.isClick()) {
 *     Serial.println("click");
 *   }
 * }
 * ```
 */
class PinButton : public MultiButton {
  public:
    /**
     * Construct a new PinButton using a switch connected between
     * an Arduino pin and ground.
     * The internal pull-up is automatically enabled.
     *
     * @param pin {int} Arduino pin to use
     */
    PinButton(int pin)
        : PinButton(pin, INPUT_PULLUP) {
    };

    /**
     * Construct a new PinButton using a switch.
     * Initialize the pinType according to how the button is connected:
     *  - INPUT: a switch is connected between Arduino pin and VDD with
     *      external resistor.
     *  - INPUT_PULLUP: a switch is connected between Arduino pin and ground.
     *
     * @param pin {int} Arduino pin to use
     * @param pinType {int} Set pin type (INPUT or INPUT_PULLUP)
     */
    PinButton(int pin, int pinType)
        : PinButton(pin, pinType, &DEFAULT_MULTIBUTTON_CONFIG) {
    };

    /**
     * Construct a new PinButton using a switch connected between
     * an Arduino pin and ground, and customized debounce/delays.
     * The internal pull-up is automatically enabled.
     *
     * @param pin {int} Arduino pin to use
     * @param configuration {const MultiButtonConfig*} Custom debounce/delay
     *      configuration.
     */
    PinButton(int pin, const MultiButtonConfig* configuration)
        : PinButton(pin, INPUT_PULLUP, configuration) {
    };

    /**
     * Construct a new PinButton using a switch and custom configuration.
     * Initialize the pinType according to how the button is connected:
     *  - INPUT: a switch is connected between Arduino pin and VDD with
     *      external resistor.
     *  - INPUT_PULLUP: a switch is connected between Arduino pin and ground.
     *
     * @param pin {int} Arduino pin to use
     * @param pinType {int} Set pin type (INPUT or INPUT_PULLUP)
     * @param configuration {const MultiButtonConfig*} Custom debounce/delay
     *      configuration.
     */
    PinButton(int pin, int pinType, const MultiButtonConfig* configuration)
        : MultiButton(configuration), _pin(pin) {
#ifdef ARDUINO_ARCH_STM32
      pinMode(pin, (WiringPinMode)pinType);
#else
      pinMode(pin, pinType);
#endif
      if (INPUT == pinType) {
        _pinActiveLevel = HIGH;
      }
    };

    /**
     * Read current hardware button state and decode into
     * stable state using isClick() etc.
     *
     * It's recommended to call this method in e.g. loop().
     */
    void update() {
      MultiButton::update(digitalRead(_pin) == _pinActiveLevel);
    }

  private:
    int _pin;
    int _pinActiveLevel = LOW;
};