Skip to content

marcinbor85/SmartButton

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SmartButton Library

SmartButton Library is used for handling various button events. It supports button press, release, multiple click and button hold events. Library is implemented in C++ with build-in Arduino port, but it is easy to port to different architecture.

Features

  • asynchronous non-blocking API based on events callbacks
  • hardware independent high-level architecture
  • works well with digital, analogs and other signal input backends
  • easy to use with Arduino boards
  • unlimited number of buttons
  • support multi-click events
  • support press and release events
  • support hold and long-hold events
  • support auto-repeat events during hold and long-hold
  • build-in debounce algorithm
  • configurable timeouts

Changelog

2020.08.12 - 0.3.0

  • hold auto-repeat periodic events added

2020.08.10 - 0.2.0

  • optional initialization by object-interface added
  • optional initialization by bool-pointer added
  • optional context passing added

Example

Single and double click example:

#include <Arduino.h>
#include <SmartButton.h>

constexpr int BUTTON_PIN = 2;
constexpr int LED_PIN = 13;

using namespace smartbutton;

SmartButton button(BUTTON_PIN, SmartButton::InputType::NORMAL_HIGH);

void setup()
{
    pinMode(LED_PIN, OUTPUT);           // Digital output for led
    pinMode(BUTTON_PIN, INPUT_PULLUP);  // Digital input with pull-up resistors (normal high)

    // Initialize and register smart button
    button.begin([] (SmartButton *button, SmartButton::Event event, int clickCounter)
    {
        if (event == SmartButton::Event::CLICK) {   // Click event handler
            if (clickCounter == 1) {
                digitalWrite(LED_PIN, LOW);         // Single click will turn led off
            } else if (clickCounter == 2) {
                digitalWrite(LED_PIN, HIGH);        // Double click will turn led on
            }
        }
    });
}

void loop()
{
    SmartButton::service();   // Asynchronous service routine, should be called periodically
}

About

Asynchronous SmartButton library for handling various button events

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages