Crate button_driver

Button driver

This crate is a button driver for embedded Rust projects. It offers various usage scenarios, supports ESP, embedded_hal, embassy and no_std targets.

This crate aims to be as flexible as possible to support various HALs and use-cases.

Examples

For more examples consider looking into the examples folder. You can easily flash them using cargo run command!

For ESP32C3 with std:

Required features: std, esp

use button_driver::{Button, ButtonConfig};
use esp_idf_hal::{gpio::PinDriver, prelude::Peripherals};
use esp_idf_sys::EspError;
use log::info;

fn main() -> Result<(), EspError> {
    esp_idf_sys::link_patches();
    esp_idf_svc::log::EspLogger::initialize_default();

    let peripherals = Peripherals::take().unwrap();
    let pin = PinDriver::input(peripherals.pins.gpio9)?;

    let mut button = Button::new(pin, ButtonConfig::default());

    loop {
        button.tick();

        if let Some(dur) = button.held_time() {
            info!("Total holding time {:?}", dur);

            if button.is_clicked() {
                info!("Clicked + held");
            } else if button.is_double_clicked() {
                info!("Double clicked + held");
            } else if button.holds() == 2 && button.clicks() > 0 {
                info!("Held twice with {} clicks", button.clicks());
            } else if button.holds() == 2 {
                info!("Held twice");
            }
        } else {
            if button.is_clicked() {
                led_pin.set_low();
                info!("Click");
            } else if button.is_double_clicked() {
                led_pin.set_high();
                info!("Double click");
            } else if button.is_triple_clicked() {
                info!("Triple click");
            } else if let Some(dur) = button.current_holding_time() {
                info!("Held for {:?}", dur);
            }
        }

        button.reset();
    }
}

TODO

1. async support
2. Debounce strategies support

Algorithm

High-level state machine diagram

Re-exports

• pub use config::ButtonConfig;
• pub use config::Mode;
• pub use instant::InstantProvider;

Modules

• config
  Button configuration.
• instant
  Different current global time sources.

Structs

• Button
  Generic button abstraction.

Enums

• State
  Represents current button state.

Traits

• PinWrapper
  An abstraction over different switching APIs.