io.silverspoon.bulldog.core.gpio

Interface DigitalInput

All Superinterfaces:

PinFeature

All Known Subinterfaces:

DigitalIO

All Known Implementing Classes:

AbstractDigitalInput, DigitalIOFeature

public interface DigitalInput
extends PinFeature

This interface specified the operations that can be used on a Pin that is configured as a digital input. This includes reading the current state on the pin as well as handling interrupt events.

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.
void	enableInterrupts() This method enables interrupt events on this input.
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.
Signal	read() Reads the current signal on the pin.
Signal	readDebounced(int debounceMilliseconds) 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 interface io.silverspoon.bulldog.core.gpio.PinFeature

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

Method Detail

read

Signal read()

Reads the current signal on the pin.

Returns:

the signal - either low or high

readDebounced

Signal readDebounced(int debounceMilliseconds)

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.

Parameters:

debounceMilliseconds - 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

disableInterrupts

void disableInterrupts()

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.

enableInterrupts

void enableInterrupts()

This method enables interrupt events on this input.

areInterruptsEnabled

boolean areInterruptsEnabled()

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

Returns:

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

setInterruptDebounceMs

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. 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.

Parameters:

milliSeconds - The maximum time that is used for debouncing

getInterruptDebounceMs

int getInterruptDebounceMs()

Returns the maximum time that is used for debouncing interrupts.

Returns:

The maximum time that is used for debouncing.

setInterruptTrigger

void setInterruptTrigger(Edge edge)

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.

Parameters:

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

getInterruptTrigger

Edge getInterruptTrigger()

Gets the interrupt trigger that is currently set.

Returns:

the interrupt trigger.

fireInterruptEvent

void fireInterruptEvent(InterruptEventArgs args)

Fire interrupt event.

Parameters:

args - the args

addInterruptListener

void addInterruptListener(InterruptListener listener)

Adds an interrupt listener to the digital input.

Parameters:

listener - the listener that is to be added.

removeInterruptListener

void removeInterruptListener(InterruptListener listener)

Removes an interrupt listener from the digital input.

Parameters:

listener - the listener that is to be removed.

clearInterruptListeners

void clearInterruptListeners()

Removes all interrupt listeners that are currently registered.

getInterruptListeners

List<InterruptListener> getInterruptListeners()

Gets a list of all the registered interrupt listeners.

Returns:

a list of all interrupt listeners.