ButtonHandler.h

Go to the documentation of this file.

/* Copyright (c) 2015-2022 Skyward Experimental Rocketry
 * Authors: Luca Erbetta, Alberto Nidasio
 *
 * 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.
 */
 
#pragma once
 
#include <Singleton.h>
#include <scheduler/TaskScheduler.h>
#include <utils/GpioPinCompare.h>
 
#include <map>
 
namespace Boardcore
{
 
enum class ButtonEvent
{
    PRESSED,         
    SHORT_PRESS,     
    LONG_PRESS,      
    VERY_LONG_PRESS  
};
 
class ButtonHandler : public Singleton<ButtonHandler>
{
    friend Singleton<ButtonHandler>;
 
    static constexpr uint32_t SAMPLE_PERIOD    = 100;  // 10Hz
    static constexpr int LONG_PRESS_TICKS      = 10;   // 1s
    static constexpr int VERY_LONG_PRESS_TICKS = 50;   // 5s
 
public:
    using ButtonCallback = std::function<void(ButtonEvent)>;
 
    bool registerButtonCallback(miosix::GpioPin pin, ButtonCallback callback);
 
    bool unregisterButtonCallback(miosix::GpioPin pin);
 
    bool start();
 
    void stop();
 
private:
    ButtonHandler();
 
    void periodicButtonValueCheck(miosix::GpioPin pin);
 
    TaskScheduler scheduler;
 
    std::map<miosix::GpioPin, std::tuple<ButtonCallback, bool, unsigned int>,
             GpioPinCompare>
        callbacks;
};
 
}  // namespace Boardcore