io.silverspoon.bulldog.core.gpio.base

Class AbstractDigitalInput

java.lang.Object

io.silverspoon.bulldog.core.gpio.base.AbstractPinFeature

io.silverspoon.bulldog.core.gpio.base.AbstractDigitalInput

All Implemented Interfaces:

DigitalInput, PinFeature

public abstract class AbstractDigitalInput
extends AbstractPinFeature
implements DigitalInput

Constructor Summary

Constructors

Constructor and Description
AbstractDigitalInput(Pin pin)

Method Summary

Methods

Modifier and Type	Method and Description
void	addInterruptListener(InterruptListener listener) Adds an interrupt listener to the digital input.
boolean	areInterruptsEnabled() This method checks whether interrupts are currently enabled.
void	clearInterruptListeners() Removes all interrupt listeners that are currently registered.
void	disableInterrupts() This method disables interrupt events on this input.
protected abstract void	disableInterruptsImpl()
void	enableInterrupts() This method enables interrupt events on this input.
protected abstract void	enableInterruptsImpl()
void	fireInterruptEvent(InterruptEventArgs args) Fire interrupt event.
int	getInterruptDebounceMs() Returns the maximum time that is used for debouncing interrupts.
List<InterruptListener>	getInterruptListeners() Gets a list of all the registered interrupt listeners.
Edge	getInterruptTrigger() Gets the interrupt trigger that is currently set.
String	getName()
Signal	readDebounced(int debounceTime) Reads the signal on the pin debounced.
void	removeInterruptListener(InterruptListener listener) Removes an interrupt listener from the digital input.
void	setInterruptDebounceMs(int milliSeconds) If the edges of interrupts should be debounced before calling the interrupt event handlers, then the maximum time that should be used for debouncing can be specified here.
void	setInterruptTrigger(Edge edge) Sets the interrupt trigger.

Methods inherited from class io.silverspoon.bulldog.core.gpio.base.AbstractPinFeature

activate, blockPin, getPin, isActivatedFeature, isBlocking, isSetup, isTorndownOnShutdown, setTeardownOnShutdown, setup, setupImpl, teardown, teardownImpl, toString, unblockPin

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.silverspoon.bulldog.core.gpio.DigitalInput

read

Methods inherited from interface io.silverspoon.bulldog.core.gpio.PinFeature

activate, blockPin, getPin, isActivatedFeature, isBlocking, isSetup, isTorndownOnShutdown, setTeardownOnShutdown, setup, teardown, unblockPin

Constructor Detail

AbstractDigitalInput

public AbstractDigitalInput(Pin pin)

Method Detail

getName

public String getName()

Specified by:

getName in interface PinFeature

setInterruptTrigger

public void setInterruptTrigger(Edge edge)

Description copied from interface: DigitalInput

Sets the interrupt trigger. This is the Edge that is used for interrupt detection. Interrupts can either trigger on a rising edge, a falling edge, or on both edges. The default value is both edges.

Specified by:

setInterruptTrigger in interface DigitalInput

Parameters:

edge - the edge that is used for triggering interrupts on this input.

setInterruptDebounceMs

public void setInterruptDebounceMs(int milliSeconds)

Description copied from interface: DigitalInput

If the edges of interrupts should be debounced before calling the interrupt event handlers, then the maximum time that should be used for debouncing can be specified here. When the input is still bouncing after the specified period, then the return value will not be reliable. However, please note that this is the maximum time taken. If the input can stably be read earlier, then it won't take as long. The interrupt will then trigger only once instead of multiple times on a bouncing input.

Specified by:

setInterruptDebounceMs in interface DigitalInput

Parameters:

milliSeconds - The maximum time that is used for debouncing

getInterruptDebounceMs

public int getInterruptDebounceMs()

Description copied from interface: DigitalInput

Returns the maximum time that is used for debouncing interrupts.

Specified by:

getInterruptDebounceMs in interface DigitalInput

Returns:

The maximum time that is used for debouncing.

getInterruptTrigger

public Edge getInterruptTrigger()

Description copied from interface: DigitalInput

Gets the interrupt trigger that is currently set.

Specified by:

getInterruptTrigger in interface DigitalInput

Returns:

the interrupt trigger.

addInterruptListener

public void addInterruptListener(InterruptListener listener)

Description copied from interface: DigitalInput

Adds an interrupt listener to the digital input.

Specified by:

addInterruptListener in interface DigitalInput

Parameters:

listener - the listener that is to be added.

removeInterruptListener

public void removeInterruptListener(InterruptListener listener)

Description copied from interface: DigitalInput

Removes an interrupt listener from the digital input.

Specified by:

removeInterruptListener in interface DigitalInput

Parameters:

listener - the listener that is to be removed.

getInterruptListeners

public List<InterruptListener> getInterruptListeners()

Description copied from interface: DigitalInput

Gets a list of all the registered interrupt listeners.

Specified by:

getInterruptListeners in interface DigitalInput

Returns:

a list of all interrupt listeners.

clearInterruptListeners

public void clearInterruptListeners()

Description copied from interface: DigitalInput

Removes all interrupt listeners that are currently registered.

Specified by:

clearInterruptListeners in interface DigitalInput

fireInterruptEvent

public void fireInterruptEvent(InterruptEventArgs args)

Description copied from interface: DigitalInput

Fire interrupt event.

Specified by:

fireInterruptEvent in interface DigitalInput

Parameters:

args - the args

readDebounced

public Signal readDebounced(int debounceTime)

Description copied from interface: DigitalInput

Reads the signal on the pin debounced. This is useful if one needs to read a bouncing state transition. It does so by continuously reading the input and after it had a number of stable reads it returns the read value.

Specified by:

readDebounced in interface DigitalInput

Parameters:

debounceTime - this is the time that is used for debouncing in the worst case. When the input is still bouncing after the specified period, then the return value will not be reliable.

Returns:

the signal that was read from the pin - either low or high

areInterruptsEnabled

public boolean areInterruptsEnabled()

Description copied from interface: DigitalInput

This method checks whether interrupts are currently enabled. If they are enabled, interrupt events will be handled. disableInterrupts() to disable interrupts and DigitalInput.enableInterrupts() to enable them.

Specified by:

areInterruptsEnabled in interface DigitalInput

Returns:

true, if interrupt requests are currently handled, false otherwise.

enableInterrupts

public void enableInterrupts()

Description copied from interface: DigitalInput

This method enables interrupt events on this input.

Specified by:

enableInterrupts in interface DigitalInput

disableInterrupts

public void disableInterrupts()

Description copied from interface: DigitalInput

This method disables interrupt events on this input. When interrupt events are disabled, then edges on the pins won't trigger the InterruptListener's interruptRequest method.

Specified by:

disableInterrupts in interface DigitalInput

enableInterruptsImpl

protected abstract void enableInterruptsImpl()

disableInterruptsImpl

protected abstract void disableInterruptsImpl()