input.hpp

Go to the documentation of this file.

/**
 * @file input.hpp
 * @brief Button input convenience functions
 * @ingroup hal
 *
 * Composes GPIO driver reads with Button update in a single call.
 *
 * Usage:
 *   #include <sbl/hal/button/input.hpp>
 *
 *   sbl::button::read<sbl::driver::Gpio>(btn, handle);
 */
 
#ifndef SBL_HAL_BUTTON_INPUT_HPP_
#define SBL_HAL_BUTTON_INPUT_HPP_
 
#include <sbl/types.hpp>
#include <sbl/components/control/button.hpp>
 
namespace sbl {
namespace button {
 
using Button = sbl::components::control::Button;
using ButtonConfig = sbl::components::control::ButtonConfig;
 
/**
 * @brief Read GPIO pin and feed into Button (debounce + edge detection)
 *
 * Gpio::read() returns logical value (active_low handled by driver),
 * so Button doesn't need inversion logic.
 *
 * @tparam Driver GPIO driver type (e.g., sbl::driver::Gpio)
 * @param btn    Button instance to update
 * @param handle GPIO handle for the button pin
 *
 * @note ISR-safe — single GPIO register read
 */
template<typename Driver>
inline void read(Button& btn, const GpioHandle& handle) {
    btn.update(Driver::read(handle));
}
 
} // namespace button
} // namespace sbl
 
#endif // SBL_HAL_BUTTON_INPUT_HPP_