io.silverspoon.bulldog.core.gpio.base

Class DigitalIOFeature

java.lang.Object

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

io.silverspoon.bulldog.core.gpio.base.DigitalIOFeature

All Implemented Interfaces:

DigitalInput, DigitalIO, DigitalOutput, PinFeature

public class DigitalIOFeature
extends AbstractPinFeature
implements DigitalIO

Constructor Summary

Constructors

Constructor and Description
DigitalIOFeature(Pin pin, DigitalInput input, DigitalOutput output)

Method Summary

Methods

Modifier and Type	Method and Description
void	addInterruptListener(InterruptListener listener) Adds an interrupt listener to the digital input.
void	applySignal(Signal signal) Writes a state to the pin.
boolean	areInterruptsEnabled() This method checks whether interrupts are currently enabled.
void	awaitBlinkingStopped() Halts the current thread until the blinking on the output has stopped.
void	blinkTimes(int periodLengthMilliseconds, int times) This method is used to let the input blink a number of times.
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.
Signal	getAppliedSignal() Gets the signal that is currently applied to the pin.
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()
void	high() Applies a high level signal to the pin.
boolean	isBlinking() Checks if this output is currently blinking.
boolean	isBlocking()
boolean	isHigh() Queries if the signal on the pin is currently high.
boolean	isInputActive() Checks if the pin is currently used as an input.
boolean	isLow() Queries if the signal on the pin is currently low.
boolean	isOutputActive() Checks if the pin is currently used as an output.
void	low() Applies a low level signal to the pin.
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.
protected void	setupImpl()
void	startBlinking(int periodLengthMilliseconds) This method is used to let the pin blink indefinitely.
void	startBlinking(int periodLengthMilliseconds, int durationMilliseconds) This method is used to let the pin blink for a specified duration.
void	stopBlinking() Stops any blinking process that is currently in progress on this output.
protected void	teardownImpl()
void	toggle() Toggles the current signal on the pin.
void	write(Signal signal) Writes a state to the pin.

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

activate, blockPin, getPin, isActivatedFeature, isSetup, isTorndownOnShutdown, setTeardownOnShutdown, setup, teardown, 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.PinFeature

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

Constructor Detail

DigitalIOFeature

public DigitalIOFeature(Pin pin,
                DigitalInput input,
                DigitalOutput output)

Method Detail

read

public Signal read()

Description copied from interface: DigitalInput

Reads the current signal on the pin.

Specified by:

read in interface DigitalInput

Returns:

the signal - either low or high

readDebounced

public Signal readDebounced(int debounceMilliseconds)

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:

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

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

enableInterrupts

public void enableInterrupts()

Description copied from interface: DigitalInput

This method enables interrupt events on this input.

Specified by:

enableInterrupts in interface DigitalInput

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.

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.

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.

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.

fireInterruptEvent

public void fireInterruptEvent(InterruptEventArgs args)

Description copied from interface: DigitalInput

Fire interrupt event.

Specified by:

fireInterruptEvent in interface DigitalInput

Parameters:

args - the args

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.

clearInterruptListeners

public void clearInterruptListeners()

Description copied from interface: DigitalInput

Removes all interrupt listeners that are currently registered.

Specified by:

clearInterruptListeners in interface DigitalInput

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.

getName

public String getName()

Specified by:

getName in interface PinFeature

write

public void write(Signal signal)

Description copied from interface: DigitalOutput

Writes a state to the pin.

Specified by:

write in interface DigitalOutput

Parameters:

signal - the signal

applySignal

public void applySignal(Signal signal)

Description copied from interface: DigitalOutput

Writes a state to the pin.

Specified by:

applySignal in interface DigitalOutput

Parameters:

signal - the signal

getAppliedSignal

public Signal getAppliedSignal()

Description copied from interface: DigitalOutput

Gets the signal that is currently applied to the pin.

Specified by:

getAppliedSignal in interface DigitalOutput

Returns:

the applied signal

high

public void high()

Description copied from interface: DigitalOutput

Applies a high level signal to the pin.

Specified by:

high in interface DigitalOutput

low

public void low()

Description copied from interface: DigitalOutput

Applies a low level signal to the pin.

Specified by:

low in interface DigitalOutput

toggle

public void toggle()

Description copied from interface: DigitalOutput

Toggles the current signal on the pin.

Specified by:

toggle in interface DigitalOutput

isHigh

public boolean isHigh()

Description copied from interface: DigitalOutput

Queries if the signal on the pin is currently high.

Specified by:

isHigh in interface DigitalOutput

Returns:

true, if the signal is high

isLow

public boolean isLow()

Description copied from interface: DigitalOutput

Queries if the signal on the pin is currently low.

Specified by:

isLow in interface DigitalOutput

Returns:

true, if the signal is low

startBlinking

public void startBlinking(int periodLengthMilliseconds)

Description copied from interface: DigitalOutput

This method is used to let the pin blink indefinitely. It is a non blocking method that will be executed asynchronously. To stop the blinking, see the stopBlinking() method. You can specify the duration of a blinking period. A blinking period is the full cycle of a state transition and includes the the high phase as well as the low phase. Both phases have the same duration.

Specified by:

startBlinking in interface DigitalOutput

Parameters:

periodLengthMilliseconds - the duration of one full blinking period in milliseconds

startBlinking

public void startBlinking(int periodLengthMilliseconds,
                 int durationMilliseconds)

Description copied from interface: DigitalOutput

This method is used to let the pin blink for a specified duration. It is a non blocking method that will be executed asynchronously.To stop the blinking prematurely, see the stopBlinking() method. You can specify the duration of a blinking period. A blinking period is the full cycle of a state transition and includes the the high phase as well as the low phase. Both phases have the same duration. Also, you can specify the duration of the whole blinking process, e.g. specify to let the output blink for 3000 milliseconds.

Specified by:

startBlinking in interface DigitalOutput

Parameters:

periodLengthMilliseconds - the duration of one full blinking period in milliseconds

durationMilliseconds - the duration of the whole blinking process in milliseconds. A value of 0 let's it blink indefinitely.

blinkTimes

public void blinkTimes(int periodLengthMilliseconds,
              int times)

Description copied from interface: DigitalOutput

This method is used to let the input blink a number of times.

Specified by:

blinkTimes in interface DigitalOutput

Parameters:

periodLengthMilliseconds - the duration of one full blinking period in milliseconds

times - the amount of times the output should blink

stopBlinking

public void stopBlinking()

Description copied from interface: DigitalOutput

Stops any blinking process that is currently in progress on this output.

Specified by:

stopBlinking in interface DigitalOutput

isBlinking

public boolean isBlinking()

Description copied from interface: DigitalOutput

Checks if this output is currently blinking.

Specified by:

isBlinking in interface DigitalOutput

Returns:

true, if the output is currently blinking

awaitBlinkingStopped

public void awaitBlinkingStopped()

Description copied from interface: DigitalOutput

Halts the current thread until the blinking on the output has stopped.

Specified by:

awaitBlinkingStopped in interface DigitalOutput

setupImpl

protected void setupImpl()

Specified by:

setupImpl in class AbstractPinFeature

teardownImpl

protected void teardownImpl()

Specified by:

teardownImpl in class AbstractPinFeature

isBlocking

public boolean isBlocking()

Specified by:

isBlocking in interface PinFeature

Overrides:

isBlocking in class AbstractPinFeature

isInputActive

public boolean isInputActive()

Description copied from interface: DigitalIO

Checks if the pin is currently used as an input.

Specified by:

isInputActive in interface DigitalIO

Returns:

true, if the pin is currently used as an input.

isOutputActive

public boolean isOutputActive()

Description copied from interface: DigitalIO

Checks if the pin is currently used as an output.

Specified by:

isOutputActive in interface DigitalIO

Returns:

true, if the pin is currently used as an output.