Package com.diozero.api

Class DebouncedDigitalInputDevice

java.lang.Object

com.diozero.api.GpioDevice

com.diozero.api.GpioInputDevice<DigitalInputEvent>

com.diozero.api.AbstractDigitalInputDevice

com.diozero.api.DigitalInputDevice

com.diozero.api.DebouncedDigitalInputDevice

All Implemented Interfaces:

DeviceInterface, DigitalInputDeviceInterface, DeviceEventConsumer<DigitalInputEvent>, AutoCloseable, Consumer<DigitalInputEvent>

public class DebouncedDigitalInputDevice
extends DigitalInputDevice

Digital input device with debounce logic. The goal of this debounce implementation is to only detect level changes that are held for the specified debounce time. All other level changes that are shorter than that duration will be ignored.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DebouncedDigitalInputDevice.Builder

Field Summary

Fields inherited from class com.diozero.api.AbstractDigitalInputDevice

activeHigh

Fields inherited from class com.diozero.api.GpioDevice

pinInfo

Constructor Summary

Constructors

Constructor	Description
DebouncedDigitalInputDevice(int gpio, int debounceTimeMs)
DebouncedDigitalInputDevice(int gpio, GpioPullUpDown pud, int debounceTimeMs)
DebouncedDigitalInputDevice(GpioDeviceFactoryInterface deviceFactory, int gpio, GpioPullUpDown pud, int debounceTimeMs)
DebouncedDigitalInputDevice(GpioDeviceFactoryInterface deviceFactory, PinInfo pinInfo, GpioPullUpDown pud, int debounceTimeMs)

Method Summary

Modifier and Type	Method	Description
void	accept(DigitalInputEvent event)
void	changeDetection()
void	close()	Close this device

Methods inherited from class com.diozero.api.DigitalInputDevice

getPullUpDown, getTrigger, getValue, isActive, removeListener, setListener

Methods inherited from class com.diozero.api.AbstractDigitalInputDevice

disableDeviceListener, enableDeviceListener, isActiveHigh, waitForActive, waitForActive, waitForInactive, waitForInactive, waitForValue, whenActivated, whenDeactivated

Methods inherited from class com.diozero.api.GpioInputDevice

addListener, hasListeners, removeAllListeners, removeListener

Methods inherited from class com.diozero.api.GpioDevice

getGpio

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Detail

DebouncedDigitalInputDevice

public DebouncedDigitalInputDevice(int gpio,
                                   int debounceTimeMs)
                            throws RuntimeIOException,
                                   IllegalArgumentException

Parameters:

gpio - GPIO

debounceTimeMs - Specifies the length of time (in seconds) that the component will ignore changes in state after an initial change.

Throws:

RuntimeIOException - if an I/O error occurs

IllegalArgumentException - if the debounce time is less than 0

DebouncedDigitalInputDevice

public DebouncedDigitalInputDevice(int gpio,
                                   GpioPullUpDown pud,
                                   int debounceTimeMs)
                            throws RuntimeIOException,
                                   IllegalArgumentException

Parameters:

gpio - GPIO

pud - Pull-up/down configuration

debounceTimeMs - Specifies the length of time (in seconds) that the component will ignore changes in state after an initial change.

Throws:

RuntimeIOException - if an I/O error occurs

IllegalArgumentException - if the debounce time is less than 0

DebouncedDigitalInputDevice

public DebouncedDigitalInputDevice(GpioDeviceFactoryInterface deviceFactory,
                                   int gpio,
                                   GpioPullUpDown pud,
                                   int debounceTimeMs)
                            throws RuntimeIOException,
                                   IllegalArgumentException

Parameters:

deviceFactory - Device factory to use to provision this debounced digital input device

gpio - GPIO

pud - Pull-up/down configuration

debounceTimeMs - Specifies the length of time (in seconds) that the component will ignore changes in state after an initial change.

Throws:

RuntimeIOException - if an I/O error occurs

IllegalArgumentException - if the debounce time is less than 0

DebouncedDigitalInputDevice

public DebouncedDigitalInputDevice(GpioDeviceFactoryInterface deviceFactory,
                                   PinInfo pinInfo,
                                   GpioPullUpDown pud,
                                   int debounceTimeMs)
                            throws RuntimeIOException,
                                   IllegalArgumentException

Parameters:

deviceFactory - Device factory to use to provision this debounced digital input device

pinInfo - Information about the GPIO pin to which the device is connected

pud - Pull-up/down configuration

debounceTimeMs - Specifies the length of time (in seconds) that the component will ignore changes in state after an initial change.

Throws:

RuntimeIOException - if an I/O error occurs

IllegalArgumentException - if the debounce time is less than 0

Method Detail

accept

public void accept(DigitalInputEvent event)

Specified by:

accept in interface Consumer<DigitalInputEvent>

Overrides:

accept in class AbstractDigitalInputDevice

close

public void close()

Description copied from interface: DeviceInterface

Close this device

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DeviceInterface

Overrides:

close in class DigitalInputDevice

changeDetection

public void changeDetection()