Buttons.h

Go to the documentation of this file.

 
#ifndef BUTTONS_H
#define BUTTONS_H
 
#include <Arduino.h>

class Button {
    private:
        const uint32_t pin;

        bool activated;
 
    public:
        enum TransitionEdge {
            PRESSING,
            RELEASING
        };
 
    private:
        volatile TransitionEdge singleClickTransitionEdge;

        volatile bool pulseClickEnabled;

        volatile bool secureModeEnabled;

        volatile bool isPressed;

        volatile bool singleClicked;

        volatile bool pulseClicked;

        volatile unsigned long buttonFallTimeMillis;

        unsigned long pulseDelayStartMillis;

        unsigned long pulseClicksMinimumIntervalMillis;

        unsigned long prevPulseClickResponseTimeMillis;

        volatile bool antiMisclickActivated;

        void (*volatile callback)(void);

        void resetFields();

        bool isButtonPressed();

        void scheduledCallback();

        bool anyOtherButtonsPressed();

        void setAntiMisclickActive(const bool active);

        void stateChangedCallback();

        struct Node {
            Button *const button;

            Node *volatile next;

            Node(Button *const button, Node *const next);
        };

        static Node *volatile activeButtonsListHead;

        void registerButtonToActiveList();

        void unregisterButtonFromActiveList();

        static const TransitionEdge DEFAULT_SINGLE_CLICK_TRANSITION_EDGE;

        static const unsigned long DEFAULT_PULSE_DELAY_START_MILLIS;

        static const unsigned long DEFAULT_PULSE_CLICKS_MINIMUM_INTERVAL_MILLIS;
 
    public:
        Button(const uint32_t pin);

        ~Button();

        void begin();

        void end();

        bool isClicked();

        void setSingleClickTransitionEdge(TransitionEdge edge);

        void setPulseClickEnabled(const bool enabled);

        void setPulseDelayStartPeriod(const unsigned long period);

        void setPulseClicksMinimumInterval(const unsigned long minInterval);

        void setSecureModeEnabled(const bool enabled);

        void attachInterrupt(void (*callback)(void));

        void detachInterrupt();

        static void scheduledAllButtonsCallback();
};

extern Button buttons [4];

extern Button &button1;

extern Button &button2;

extern Button &button3;

extern Button &button4;

bool is_button_clicked(const uint32_t button_no);

void set_buttons_mode(const uint8_t mode);

enum {

    button_raw_mode,

    button_fall_mode,

    button_fall_pulse_mode,
    
    button_fall_pulse_secured_mode,

    button_rise_mode,

    button_rise_pulse_mode,

    button_rise_pulse_secured_mode
};

void button_attach_interrupt(const uint32_t button_no, void (*user_func)(void));

void button_detach_interrupt(const uint32_t button_no);
 
 
#endif