switch_button.h

Go to the documentation of this file.

#pragma once
 
#include "pico/stdio.h"
#include "pico/stdlib.h"
#include <stdio.h>
#include "sw/ui_core/ui_control_event.h"

#define GPIO_HI true

#define GPIO_LO false

enum class ButtonState
{
    IDLE,
    ACTIVE,
    RELEASE_PENDING,
    TIME_OUT_PENDING
};

#define DEBOUNCE_us 10000 // default to 10ms
#define LONG_RELEASE_DELAY_us 1000000 // default to 1s
#define LONG_PUSH_DELAY_us 1000000 // default to 1s
#define TIME_OUT_DELAY_us 5000000 // default top 5s

struct struct_ConfigSwitchButton
{
    uint debounce_delay_us = DEBOUNCE_us;
    uint long_release_delay_us = LONG_RELEASE_DELAY_us;
    uint long_push_delay_us = LONG_PUSH_DELAY_us;

    uint time_out_delay_us = TIME_OUT_DELAY_us;
    bool active_lo = true;
};

class SwitchButton
{
private:
protected:
    /*time related members*/
    uint debounce_delay_us;

    uint long_push_delay_us;

    uint long_release_delay_us;

    uint time_out_delay_us;
 
    /*mechanical switch related members*/
    uint gpio;

    bool active_lo;

    uint previous_change_time_us;

    bool is_switch_pushed();

    bool previous_switch_pushed_state;
 
    /*logical button related members*/
    ButtonState button_status{ButtonState::IDLE};
 
public:
    SwitchButton(uint gpio, struct_ConfigSwitchButton conf = {});
 
    SwitchButton();
    ~SwitchButton();

    UIControlEvent process_sample_event();

    ButtonState get_button_status();
};

class SwitchButtonWithIRQ : public SwitchButton
{
private:
    uint32_t irq_event_mask_config;
    bool is_switch_pushed(uint32_t current_event_mask);
 
protected:
public:
    void irq_enabled(bool enabled);
    SwitchButtonWithIRQ(uint gpio, gpio_irq_callback_t call_back, struct_ConfigSwitchButton conf = {},
                        uint32_t event_mask_config = GPIO_IRQ_EDGE_FALL | GPIO_IRQ_EDGE_RISE);
    SwitchButtonWithIRQ();
    ~SwitchButtonWithIRQ();
    UIControlEvent process_IRQ_event(uint32_t current_event_mask);
};