/**
 * \file button.h
 *
 * Simple debouncing routine from
 * <https://hackaday.com/2015/12/10/embed-with-elliot-debounce-your-noisy-buttons-part-ii/>
 *
 */
#ifndef _button_h
#define _button_h

#include <stdint.h>
#include "bool.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct Button {
    uint8_t pin,        /**< Pin to which button is attached */
            history,    /**< Button state history */
            poll_freq,  /**< How often (in ms) to check button state */
            last_poll;  /**< Time at which we last checked button state */
} Button;

void button_new(Button *button, uint8_t pin, uint8_t poll_freq);
extern void button_destroy(Button *);
extern void button_update(Button *);
extern bool button_is_pressed(Button *);
extern bool button_is_released(Button *);
extern bool button_is_up(Button *);
extern bool button_is_down(Button *);

#ifdef __cplusplus
}
#endif

#endif // _button_h