button_demo

Example of the component cleishm/idfxx_button v2.0.0
# Button Demo

Detects clicks and long presses on a push button with debouncing.

## What it demonstrates

- Creating an `idfxx::button` from a config with the pin, the pressed level, the internal pull-up and
  an event callback
- Handling each `idfxx::button::event_type` (pressed, released, clicked, long press and extended press)
  in the callback
- The default 50 ms debounce time and 1 second long-press threshold
- Counting events in the callback and logging them from the main task, using
  `idfxx::chrono::tick_clock` and `idfxx::delay()` to watch for 30 seconds

The example uses the exception-based API (`CONFIG_COMPILER_CXX_EXCEPTIONS=y` in `sdkconfig.defaults`).

## Hardware required

- Any ESP32-series development board

The example uses the board's BOOT button: GPIO 9 on the ESP32-C3, ESP32-C6 and ESP32-H2, and GPIO 0
on the others, so no extra parts are needed. To use a different button, connect it between a pin and
GND and change `button_pin` in `main/main.cpp`. The example enables the internal pull-up and treats a
low level as pressed, so no external resistor is needed.

## How to use

Create a project from this example:

```bash
idf.py create-project-from-example "cleishm/idfxx_button:button_demo"
cd button_demo
```

Then build and flash it, then watch the serial output:

```bash
idf.py set-target esp32
idf.py -p PORT flash monitor
```

Replace `esp32` with your target and `PORT` with your board's serial port. During the 30 seconds after
startup, press and release the button quickly for a click, or hold it for more than a second for a long
press. The example then logs a summary and stops. Press `Ctrl-]` to exit the monitor.

To create a project from this example, run:

idf.py create-project-from-example "cleishm/idfxx_button=2.0.0:button_demo"

or download archive (~2.74 KB)