avdweb_Switch.cpp

/**
 * avdweb_Switch.cpp
 *
 * Switch - Arduino switch and button library with Short/Long Press,
 * Double Click and Beep.
 * ===========================================================
 *
 * Sources
 * -------
 * https://github.com/avandalen/avdweb_Switch
 *
 * Website
 * -------
 * http://www.avdweb.nl/arduino/hardware-interfacing/simple-switch-debouncer.html
 *
 * License
 * --------
 * SPDX: GPL-3.0-or-later
 *
 *  Switch - Arduino switch and button library with Short/Long Press,
 *    Double Click and Beep.
 *  Copyright (C) 2012-2024 Albert van Dalen <http://www.avdweb.nl>
 *  Copyright (C) 2024 Abhijit Bose (aka. Boseji) :contributor:
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * Notes
 * ------
 *
 * HISTORY:
 * 1.0.0    20-04-2013 _debouncePeriod=50
 * 1.0.1    22-05-2013 Added longPress, doubleClick
 * 1.0.2    01-12-2015 added process(input)
 * 1.0.3    15-01-2016 added deglitching
 * 1.0.5    25-01-2017 file renamed to avdweb_Switch
 * 1.1.0    28-07-2018 added callbacks (code by Sean Lanigan, added by
 *           Martin Laclaustra)
 * 1.2.0-rc 28-07-2018 added singleclick. Reorganize, keeping
 *           variables for each event in one function
 * 1.2.0    29-09-2018 released
 * 1.2.1    30-11-2018 bugfix. Initialize time variables in the constructor.
 *           Fixes false event if first call to poll was delayed
 * 1.2.2    18-10-2019 beep when a switch is pressed with using a
 *           setBeepAllCallback function
 * 1.2.3    03-04-2020 made public: deglitchPeriod, debouncePeriod,
 *           longPressPeriod, doubleClickPeriod
 * 1.2.4    14-07-2021 "static switchCallback_t _beepAllCallback = nullptr;"
 *           gives error with SAMD21, removed "= nullptr;"
 *
 *******************************************************************************
.......................................DEGLITCHING..............................

                      ________________   _
             on      |                | | |    _
                     |                | | |   | |
                     |                |_| |___| |__
 analog      off_____|_____________________________|____________________________

                      ________________   _     _
 input          _____|                |_| |___| |_______________________________

 poll          ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^

 equal         0 1 1 0 1 1 1 1 1 1 1 1 0 0 0 1 0 0 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1

 deglitchPeriod        <--------><--   <--     <-  <--------><--------><--------
                                  ___________________________
 deglitched     _________________|                           |__________________

 deglitchTime          ^         ^     ^       ^   ^         ^        ^

 ........................................DEBOUNCING.............................

 debouncePeriod                  <-------------------------------->
                                  _________________________________
 debounced      _________________|                                 |____________
                                  _                                 _
 _switched      _________________| |_______________________________| |__________

 switchedTime                    ^                                 ^


********************************************************************************
......................................DOUBLE CLICK..............................

                         __________         ______
 debounced      ________|          |_______|      |_____________________________

 poll          ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
                         _                  _
 pushed        _________| |________________| |__________________________________

 pushedTime             ^                  ^
                                    _              _
 released      ____________________| |____________| |___________________________

 releasedTime                      ^              ^

 doubleClickPeriod       <------------------------------------->
                                            _
 _doubleClick   ___________________________| |__________________________________


......................................LONG PRESS................................

                         ___________________________
 debounced      ________|                           |___________________________

 poll          ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^

 longPressPeriod          <--------------->
                          _                           _
 _switched      _________| |_________________________| |________________________
                                            __________
 longPressDisable__________________________|          |_________________________
                                            _
 _longPress     ___________________________| |__________________________________


......................................SINGLE CLICK..............................

                         __________                                 ______
 debounced      ________|          |_______________________________|      |_____

 poll          ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^

 longPressPeriod         <--------------->
 doubleClickPeriod       <------------------------------------->
                          _         _                               _      _
 _switched      _________| |_______| |_____________________________| |____| |___
                                                                _____
 singleClickDisable____________________________________________|     |__________
                                                                _
 _singleClick   _______________________________________________| |______________

 *******************************************************************************
 */

#include "avdweb_Switch.h"

switchCallback_t Switch::_beepAllCallback = nullptr; // definition static function pointer with typedef
void* Switch::_beepAllCallbackParam = nullptr;

Switch::Switch(byte _pin, byte PinMode, bool polarity,
    unsigned long debouncePeriod, unsigned long longPressPeriod,
    unsigned long doubleClickPeriod, unsigned long deglitchPeriod)
    : deglitchPeriod(deglitchPeriod)
    , debouncePeriod(debouncePeriod)
    , longPressPeriod(longPressPeriod)
    , doubleClickPeriod(doubleClickPeriod)
    , pin(_pin)
    , polarity(polarity)
{
    pinMode(pin, PinMode);
    switchedTime = millis();
    debounced = digitalRead(pin);
    singleClickDisable = true;
    poll();
}

bool Switch::poll()
{
    input = digitalRead(pin);
    ms = millis();
    return process();
}

bool Switch::process()
{
    deglitch();
    debounce();
    calcSingleClick();
    calcDoubleClick();
    calcLongPress();
    if (switched()) {
        switchedTime = ms; // stores last times for future rounds
        if (pushed()) {
            if (_beepAllCallback)
                _beepAllCallback(_beepAllCallbackParam);
            pushedTime = ms;
        } else {
            releasedTime = ms;
        }
    }
    triggerCallbacks();
    return _switched;
}

void inline Switch::deglitch()
{
    if (input == lastInput)
        equal = 1;
    else {
        equal = 0;
        deglitchTime = ms;
    }
    if (equal && ((ms - deglitchTime) > deglitchPeriod)) // max 50ms, disable deglitch: 0ms
    {
        deglitched = input;
        deglitchTime = ms;
    }
    lastInput = input;
}

void inline Switch::debounce()
{
    _switched = 0;
    if ((deglitched != debounced) && ((ms - switchedTime) > debouncePeriod)) {
        debounced = deglitched;
        _switched = 1;
    }
}

void inline Switch::calcSingleClick()
{
    _singleClick = false;
    if (pushed()) {
        if ((ms - pushedTime) >= doubleClickPeriod) {
            singleClickDisable = false; // resets when pushed not in second click of doubleclick
        } else {
            singleClickDisable = true; // silence single click in second cl. doublecl.
        }
    }
    if (!singleClickDisable) {
        _singleClick = !switched() && !on() && ((releasedTime - pushedTime) <= longPressPeriod) && ((ms - pushedTime) >= doubleClickPeriod); // true just one time between polls
        singleClickDisable = _singleClick; // will be reset at next push
    }
}

void inline Switch::calcDoubleClick()
{
    _doubleClick = pushed() && ((ms - pushedTime) < doubleClickPeriod);
}

void inline Switch::calcLongPress()
{
    _longPress = false;
    if (released())
        longPressDisable = false; // resets when released
    if (!longPressDisable) {
        _longPress = !switched() && on() && ((ms - pushedTime) > longPressPeriod); // true just one time between polls
        longPressDisable = _longPress; // will be reset at next release
    }
}

bool Switch::switched() { return _switched; }

bool Switch::on() { return !(debounced ^ polarity); }

bool Switch::pushed() { return _switched && !(debounced ^ polarity); }

bool Switch::released() { return _switched && (debounced ^ polarity); }

bool Switch::longPress() { return _longPress; }

bool Switch::isLongPressed() { return longPressDisable; }

bool Switch::doubleClick() { return _doubleClick; }

bool Switch::singleClick() { return _singleClick; }

void Switch::triggerCallbacks()
{
    if (_pushedCallback && pushed()) {
        _pushedCallback(_pushedCallbackParam);
    } else if (_releasedCallback && released()) {
        _releasedCallback(_releasedCallbackParam);
    }

    if (_longPressCallback && longPress()) {
        _longPressCallback(_longPressCallbackParam);
    }

    if (_doubleClickCallback && doubleClick()) {
        _doubleClickCallback(_doubleClickCallbackParam);
    }

    if (_singleClickCallback && singleClick()) {
        _singleClickCallback(_singleClickCallbackParam);
    }
}

void Switch::setPushedCallback(switchCallback_t cb, void* param)
{
    _pushedCallback = cb; // Store the "pushed" callback function
    _pushedCallbackParam = param;
}

void Switch::setReleasedCallback(switchCallback_t cb, void* param)
{
    _releasedCallback = cb; // Store the "released" callback function
    _releasedCallbackParam = param;
}

void Switch::setLongPressCallback(switchCallback_t cb, void* param)
{
    _longPressCallback = cb; // Store the "long press" callback function
    _longPressCallbackParam = param;
}

void Switch::setDoubleClickCallback(switchCallback_t cb, void* param)
{
    _doubleClickCallback = cb; // Store the "double click" callback function
    _doubleClickCallbackParam = param;
}

void Switch::setSingleClickCallback(switchCallback_t cb, void* param)
{
    _singleClickCallback = cb; // Store the "double click" callback function
    _singleClickCallbackParam = param;
}

// void Switch::setBeepAllCallback(void(*cb)(void*), void* param) static
// function pointer without typedef
void Switch::setBeepAllCallback(
    switchCallback_t cb,
    void* param) // with static function pointer without typedef
{
    _beepAllCallback = cb; // Store the "beep" callback function
    _beepAllCallbackParam = param;
}