rotary_encoder.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>
#include <optional>
 
namespace idfxx {
 
class rotary_encoder {
public:
    struct config {
        idfxx::gpio pin_a = gpio::nc(); 
        idfxx::gpio pin_b = gpio::nc(); 
        std::optional<gpio::pull_mode> encoder_pins_pull_mode = gpio::pull_mode::pullup;
        std::chrono::milliseconds acceleration_threshold{200}; 
        std::chrono::milliseconds acceleration_cap{4};         
        std::chrono::microseconds polling_interval{std::chrono::milliseconds{1}}; 
        std::move_only_function<void(int32_t)> callback;                          
    };
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
    [[nodiscard]] explicit rotary_encoder(config cfg);
#endif
 
    [[nodiscard]] static result<rotary_encoder> make(config cfg);
 
    void enable_acceleration(uint16_t coeff);
 
    void disable_acceleration();
 
    ~rotary_encoder();
 
    rotary_encoder(const rotary_encoder&) = delete;
    rotary_encoder& operator=(const rotary_encoder&) = delete;
    rotary_encoder(rotary_encoder&& other) noexcept;
    rotary_encoder& operator=(rotary_encoder&& other) noexcept;
 
private:
    explicit rotary_encoder(void* ctx);
 
    void _delete() noexcept;
 
    void* _context = nullptr;
};
 
 
} // namespace idfxx