espp/button

0.21.0

uploaded 1 day ago
Button component for ESP-IDF

readme

# Button Component

The `Button` class provides a simple way to read the state of a button. There
are two ways to configure the functionality of the button.

The first uses `Button::Config` to configure the button to call a function when
the button is pressed or released and uses the `Interrupt` class' task and ISR
for signaling. At any time, a user may also call the `is_pressed` method to read
the current state of the button's input pin.

The second uses `Button::SimpleConfig` to simply configure the button as an
input with configurable pull-up or pull-down resistors and a configurable active
state (high or low). In this configuration, the input is read manually any time
the user calls the `is_pressed` method.

# Example

The [example](./example) shows how to use the `espp::Button` class to handle
input events from a physical button connected to an ESP32 GPIO pin.

Links

Supports all targets

Maintainer

  • William Emfinger <waemfinger@gmail.com>

License: MIT

To add this component to your project, run:

idf.py add-dependency "espp/button^0.21.0"

or download archive

Stats

  • Archive size
    Archive size ~ 8.09 KB
  • Downloaded in total
    Downloaded in total 0 times
  • Downloaded this version
    This version: 0 times

Badge

espp/button version: 0.21.0
|