Package edu.wpi.first.math.filter

Class Debouncer

java.lang.Object

edu.wpi.first.math.filter.Debouncer

public class Debouncer
extends Object

A simple debounce filter for boolean streams. Requires that the boolean change value from baseline for a specified period of time before the filtered value changes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Debouncer.DebounceType

Constructor Summary

Constructors

Constructor	Description
Debouncer(double debounceTime)	Creates a new Debouncer.
Debouncer(double debounceTime, Debouncer.DebounceType type)	Creates a new Debouncer.

Method Summary

Modifier and Type	Method	Description
boolean	calculate(boolean input)	Applies the debouncer to the input stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Debouncer

public Debouncer(double debounceTime, Debouncer.DebounceType type)

Creates a new Debouncer.

Parameters:

debounceTime - The number of seconds the value must change from baseline for the filtered value to change.

type - Which type of state change the debouncing will be performed on.

Debouncer

public Debouncer(double debounceTime)

Creates a new Debouncer. Baseline value defaulted to "false."

Parameters:

debounceTime - The number of seconds the value must change from baseline for the filtered value to change.

Method Details

calculate

public boolean calculate(boolean input)

Applies the debouncer to the input stream.

Parameters:

input - The current value of the input stream.

Returns:

The debounced value of the input stream.