Struct kiibohd_keyscanning::state::KeyState

pub struct KeyState<const CSIZE: usize, const SCAN_PERIOD_US: u32, const DEBOUNCE_US: u32, const IDLE_MS: u32> { /* private fields */ }

The KeyState handles all of the decision making and state changes based on a high or low signal from a GPIO pin

Implementations

impl<const CSIZE: usize, const SCAN_PERIOD_US: u32, const DEBOUNCE_US: u32, const IDLE_MS: u32> KeyState<CSIZE, SCAN_PERIOD_US, DEBOUNCE_US, IDLE_MS>

pub fn new() -> Self

pub fn record(&mut self, on: bool) -> (State, bool, u32)

Record the GPIO read event and adjust debounce state machine accordingly

Returns: (State, idle, cycles_since_state_change)

pub fn state(&self) -> (State, bool, u32)

Returns thet current state and cycles since the state changed

(State, idle, cycles_since_state_change)

pub fn cycles_since_state_change(&self) -> u32

Number of cycles since the last state change 0 when the state first changes

pub fn idle(&self) -> bool

True if the switch is idle idle indicates the switch is off and there have been no events

Trait Implementations

impl<const CSIZE: usize, const SCAN_PERIOD_US: u32, const DEBOUNCE_US: u32, const IDLE_MS: u32> Clone for KeyState<CSIZE, SCAN_PERIOD_US, DEBOUNCE_US, IDLE_MS>

fn clone(&self) -> KeyState<CSIZE, SCAN_PERIOD_US, DEBOUNCE_US, IDLE_MS>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const CSIZE: usize, const SCAN_PERIOD_US: u32, const DEBOUNCE_US: u32, const IDLE_MS: u32> Default for KeyState<CSIZE, SCAN_PERIOD_US, DEBOUNCE_US, IDLE_MS>

fn default() -> Self

Returns the “default value” for a type.

impl<const CSIZE: usize, const SCAN_PERIOD_US: u32, const DEBOUNCE_US: u32, const IDLE_MS: u32> Copy for KeyState<CSIZE, SCAN_PERIOD_US, DEBOUNCE_US, IDLE_MS>