button.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 Chris Leishman
 
#pragma once
 
#include <idfxx/error>
#include <idfxx/gpio>
 
#include <chrono>
#include <functional>
 
namespace idfxx {
 
class button {
public:
    enum class mode : int {
        poll = 0,      
        interrupt = 1, 
    };
 
    enum class event_type : int {
        pressed = 0,    
        released = 1,   
        clicked = 2,    
        long_press = 3, 
    };
 
    struct config {
        idfxx::gpio pin = gpio::nc();                                       
        enum mode mode = mode::poll;                                        
        gpio::level pressed_level = gpio::level::low;                       
        bool enable_pull = true;                                            
        bool autorepeat = false;                                            
        std::chrono::microseconds dead_time{std::chrono::milliseconds{50}}; 
        std::chrono::microseconds long_press_time{std::chrono::milliseconds{1000}};    
        std::chrono::microseconds autorepeat_timeout{std::chrono::milliseconds{500}};  
        std::chrono::microseconds autorepeat_interval{std::chrono::milliseconds{250}}; 
        std::chrono::microseconds poll_interval{std::chrono::milliseconds{10}};        
        std::move_only_function<void(event_type)> callback;                            
    };
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    [[nodiscard]] explicit button(config cfg);
#endif
 
    [[nodiscard]] static result<button> make(config cfg);
 
    ~button();
 
    button(const button&) = delete;
    button& operator=(const button&) = delete;
    button(button&& other) noexcept;
    button& operator=(button&& other) noexcept;
 
private:
    explicit button(void* ctx);
 
    void _delete() noexcept;
 
    void* _context = nullptr;
};
 
 
} // namespace idfxx