espressif/button

uploaded 2 months ago
GPIO and ADC button driver

readme

Component Registry

Component: Button

Online documentation

After creating a new button object by calling function button_create(), the button object can create press events, every press event can have its own callback.

List of supported events:

  • Button pressed
  • Button released
  • Button pressed - repeated
  • Button press repeat done
  • Button single click
  • Button double click
  • Button long press start
  • Button long press hold

There are three ways this driver can handle buttons:

  1. Buttons connected to standard digital GPIO
  2. Multiple buttons connected to single ADC channel
  3. Custom button connect to any driver

Add component to your project

Please use the component manager command add-dependency to add the button to your project's dependency, during the CMake step the component will be downloaded automatically

idf.py add-dependency "espressif/buttom=*"

changelog

ChangeLog

v2.5.1 - 2023-3-14

Enhancements:

  • Update doc and code specification
  • Avoid overwriting callback by @franz-ms-muc in #252

v2.5.0 - 2023-2-1

Enhancements:

  • Support custom button
  • Add BUTTON_PRESS_REPEAT_DONE event

Links

Supports all targets

License: Apache-2.0

To add this component to your project, run:

idf.py add-dependency "espressif/button^2.5.1"

or download archive

Dependencies

  • espressif/cmake_utilities 0.*
  • ESP-IDF >=4.0

    • Stats

    • Downloaded in total
      Downloaded in total 24.0k times
    • Downloaded this version
      This version: 1.9k times

    Badge

    espressif/button version: 2.5.1 |
    report abuse