SerialWombatDebouncedInput.h

Go to the documentation of this file.

#pragma once
/*
Copyright 2020-2026 Broadwell Consulting Inc.
 
"Serial Wombat" is a registered trademark of Broadwell Consulting Inc. in
the United States.  See SerialWombat.com for usage guidance.
 
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.
*/
 
#include "SerialWombat.h"
#include "limits.h"


class SerialWombatDebouncedInput:public SerialWombatAbstractButton , public SerialWombatPin
{
public:
    SerialWombatDebouncedInput(SerialWombatChip& serialWombatChip):SerialWombatAbstractButton(),SerialWombatPin(serialWombatChip){}
 

    int16_t begin(uint8_t pin, uint16_t debounce_mS = 30, bool invert = true, bool usePullUp = true)
    {
        _pin = pin;
        _pinMode = PIN_MODE_DEBOUNCE;
        return( initPacketNoResponse(0,debounce_mS,(uint8_t)invert,0,(uint8_t)usePullUp));
    }

    bool digitalRead()
    {
        return (_sw.readPublicData(_pin) > 0);
    }
 
    /*
    @brief return the number of mS that the debounced input has been in true state
    
    Note that this value starts incrementing after the debounce period, not after the physical pin transition.
    
    @return returns a value in mS which saturates at 65535.  Returns 0 if currently false.
    */
    uint16_t readDurationInTrueState_mS()
    {
        
        uint8_t tx[8] = { 201,_pin,_pinMode,1,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
        _sw.sendPacket(tx,rx);
 
        transitions +=  (256 * rx[5] + rx[4]);
        if (rx[3] == 0)
        {
            return (0);
        }
        else
        {
            return(256 * rx[7] + rx[6]);
        }
    }
 
    /*
    @brief return the number of mS that the debounced input has been in false state
    
    Note that this value starts incrementing after the debounce period, not after the physical pin transition.
    
    @return returns a value in mS which saturates at 65535.  Returns 0 if currently true.
    */
    uint16_t readDurationInFalseState_mS()
    {
 
        uint8_t tx[8] = { 201,_pin,_pinMode,1,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
        _sw.sendPacket(tx, rx);
 
        transitions += (256 * rx[5] + rx[4]);
 
        if (rx[3] == 1)
        {
            return (0);
        }
        else
        {
            return(256 * rx[7] + rx[6]);
        }
    }
 
    /*
    @brief Queries the number of transistions that have occured on the debounced input
    
    This function queries the debounced input for current state and transitions since last call.
    transition count is put in the global member transitions.  The debounced input in the Serial
    Wombat resets its count to zero after this call.
    
    @return TRUE or FALSE, current status of debounced input
    */
    bool readTransitionsState(bool resetTransitionCounts = true)
    {
        uint8_t tx[8] = { 201,_pin,_pinMode,(uint8_t)resetTransitionCounts,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
        _sw.sendPacket(tx, rx);
        transitions = (256 * rx[5] + rx[4]);
        return (rx[3] > 0);
    }

    int16_t setDoubleClickPeriod(uint16_t doubleClickPeriod_mS)
    {
        return(initPacketNoResponse(2, doubleClickPeriod_mS));
    }

    int16_t setOutputPin(uint8_t outputPin, uint16_t transitionOutputValue, uint16_t doubleClickOutputValue)
    {
        uint8_t tx[8] = { 203,_pin,_pinMode,outputPin,SW_LE16(transitionOutputValue),SW_LE16(doubleClickOutputValue) };
        return(_sw.sendPacket(tx));
    }

    uint16_t readDoubleClickCount(bool resetDoubleClickCount = true)
    {
        uint8_t tx[8] = { 204,_pin,_pinMode,(uint8_t)resetDoubleClickCount,0x55,0x55,0x55,0x55 };
        uint8_t rx[8];
        _sw.sendPacket(tx, rx);
        return(256 * rx[4] + rx[3]);
    }

    int16_t setToggleSimulation(bool enabled, uint16_t transitionCount = 0)
    {
        return(initPacketNoResponse(5, (uint8_t)enabled, (uint8_t)(transitionCount & 0xFF), (uint8_t)(transitionCount >> 8)));
    }
 
private:
};
 

class SerialWombatButtonCounter
{
public:

     SerialWombatButtonCounter( SerialWombatAbstractButton& serialWombatDebouncedInput):_debouncedInput(serialWombatDebouncedInput)
    {
        _debouncedInput = serialWombatDebouncedInput;
    }

     void begin(int32_t* variableToIncrement,
         int32_t slowIncrement = 1, uint32_t slow_mS_betweenIncrements = 250,
         uint16_t slowToMediumTransition_mS = 1000, 
         int32_t mediumIncrement = 1, uint32_t medium_mS_betweenIncrements = 100,
         uint16_t mediumToFastTransition_mS = 1000 , 
         int32_t fastIncrement = 1, uint32_t fast_mS_betweenIncrements = 50)
    {
        _variableToIncrement = variableToIncrement;
        
        _slowIncrement = slowIncrement;
        _slow_mS_betweenIncrements = slow_mS_betweenIncrements;
 
        _slowToMediumTransition_mS = slowToMediumTransition_mS;
        
        _mediumIncrement = mediumIncrement;
        _medium_mS_betweenIncrements = medium_mS_betweenIncrements;
 
        _mediumToFastTransistion_mS = mediumToFastTransition_mS;
 
        _fastIncrement = fastIncrement;
        _fast_mS_betweenIncrements = fast_mS_betweenIncrements;
 
        _lastPressDuration = 0;
 
    }

    bool update()
    {
        uint16_t pressDuration = _debouncedInput.readDurationInTrueState_mS();
        int increments = 0;
        bool incremented = false;
        bool pressed = false;
        if (pressDuration > 0)
        {
            if (_lastPressDuration >= pressDuration)
            {
                _lastPressDuration = 0;
            }
 
            if (pressDuration > _mediumToFastTransistion_mS)
            {
                // Increment fast
                increments = (pressDuration - _lastPressDuration) / _fast_mS_betweenIncrements;
                *_variableToIncrement += _fastIncrement * increments;
                _lastPressDuration += _fast_mS_betweenIncrements * increments;
            }
            else if (pressDuration > _slowToMediumTransition_mS)
            {
                // Increment medium
                increments = (pressDuration - _lastPressDuration) / _medium_mS_betweenIncrements;
                *_variableToIncrement += _mediumIncrement * increments;
                _lastPressDuration += _medium_mS_betweenIncrements * increments;
            }
            else
            {
                //Increment slow
                increments = (pressDuration - _lastPressDuration) / _slow_mS_betweenIncrements;
                *_variableToIncrement += _slowIncrement * increments;
                _lastPressDuration += _slow_mS_betweenIncrements * increments;
                incremented = increments > 0;  // An increment happened
            }
            if (incremented)
            {
                _debouncedInput.transitions = 0;  // Get rid of false->true transition so that final release doesn't cause and increment
            }
            pressed = true;
        }
        else 
        {
            // Button isn't currently pressed.  if there were other transitions, add them
            _lastPressDuration = 0;
            int presses = _debouncedInput.transitions / 2;
             *_variableToIncrement += _slowIncrement * presses;
             _debouncedInput.transitions -= presses * 2;
        }
 
        if (*_variableToIncrement > highLimit)
        {
            *_variableToIncrement = highLimit;
        }
        if (*_variableToIncrement < lowLimit)
        {
            *_variableToIncrement = lowLimit;
        }
 
        return (pressed);
    }

    long highLimit = LONG_MAX;
    long lowLimit = LONG_MIN;
 
private:
    SerialWombatAbstractButton& _debouncedInput;
    int32_t* _variableToIncrement;
 
    int32_t _slowIncrement;
    uint32_t _slow_mS_betweenIncrements;
    
    uint16_t _slowToMediumTransition_mS;
 
    int32_t _mediumIncrement; 
    uint32_t _medium_mS_betweenIncrements;
    
    uint16_t _mediumToFastTransistion_mS;
 
    int32_t _fastIncrement;
    uint32_t _fast_mS_betweenIncrements;
 
    uint32_t _lastPressDuration;
    
};