rtos_switch_button.h

Go to the documentation of this file.

#pragma once
 
#include "pico/stdio.h"
#include "pico/stdlib.h"
#include "hardware/timer.h"
#include <stdio.h>
#include "sw/ui_core/ui_control_event.h"
#include "FreeRTOS.h"
#include "queue.h"
#include "task.h"

#define GPIO_HI true

#define GPIO_LO false

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

struct struct_IRQData
{
    uint32_t current_time_us;
    uint32_t event_mask;
};

struct struct_ControlEventData
{
    int gpio_number;
    UIControlEvent event;
};

#define DEBOUNCE_us 10000 // default to 10ms
#define LONG_RELEASE_DELAY_us 1000000 // default to 1s
#define LONG_PUSH_DELAY_ms 1000 // default to 1s
#define TIME_OUT_DELAY_ms 5000 // default 5s/

struct struct_rtosConfigSwitchButton
{
    uint debounce_delay_us = DEBOUNCE_us;
    uint long_release_delay_us = LONG_RELEASE_DELAY_us;
    uint long_push_delay_ms = LONG_PUSH_DELAY_ms;

    uint time_out_delay_ms = TIME_OUT_DELAY_ms;
    bool active_lo = true;
};

 
class rtosSwitchButton
{
private:
    uint32_t irq_event_mask_config;
 
protected:
    bool is_switch_pushed(uint32_t current_event_mask);
 
    /*time related members*/
    uint debounce_delay_us;

    uint long_push_delay_ms;

    uint long_release_delay_us;

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

    bool active_lo;

    uint previous_change_time_us;

    bool previous_switch_pushed_state;
 
    /*logical button related members*/
    ButtonState button_status{ButtonState::IDLE};

    QueueHandle_t switch_button_queue;
    QueueHandle_t control_event_queue;
 
public:
    rtosSwitchButton(uint gpio, gpio_irq_callback_t call_back, QueueHandle_t in_switch_button_queue, QueueHandle_t out_control_event_queue,
                     struct_rtosConfigSwitchButton conf = {}, uint32_t event_mask_config = GPIO_IRQ_EDGE_FALL | GPIO_IRQ_EDGE_RISE);

    ~rtosSwitchButton();

    virtual void rtos_process_IRQ_event() ;
};