io.silverspoon.bulldog.core.gpio

Interface DigitalOutput

All Superinterfaces:

PinFeature

All Known Subinterfaces:

DigitalIO

All Known Implementing Classes:

AbstractDigitalOutput, DigitalIOFeature

public interface DigitalOutput
extends PinFeature

This interface specified the operations that can be used on a Pin that is configured as a digital output. This includes setting the state on the pin and also some convenience features.

Method Summary

Methods

Modifier and Type	Method and Description
void	applySignal(Signal signal) Writes a state to the pin.
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.
Signal	getAppliedSignal() Gets the signal that is currently applied to the pin.
void	high() Applies a high level signal to the pin.
boolean	isBlinking() Checks if this output is currently blinking.
boolean	isHigh() Queries if the signal on the pin is currently high.
boolean	isLow() Queries if the signal on the pin is currently low.
void	low() Applies a low level signal to the pin.
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.
void	toggle() Toggles the current signal on the pin.
void	write(Signal signal) Writes a state to the pin.

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

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

Method Detail

write

void write(Signal signal)

Writes a state to the pin.

Parameters:

signal - the signal

applySignal

void applySignal(Signal signal)

Writes a state to the pin.

Parameters:

signal - the signal

getAppliedSignal

Signal getAppliedSignal()

Gets the signal that is currently applied to the pin.

Returns:

the applied signal

high

void high()

Applies a high level signal to the pin.

low

void low()

Applies a low level signal to the pin.

toggle

void toggle()

Toggles the current signal on the pin.

isHigh

boolean isHigh()

Queries if the signal on the pin is currently high.

Returns:

true, if the signal is high

isLow

boolean isLow()

Queries if the signal on the pin is currently low.

Returns:

true, if the signal is low

startBlinking

void startBlinking(int periodLengthMilliseconds)

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.

Parameters:

periodLengthMilliseconds - the duration of one full blinking period in milliseconds

startBlinking

void startBlinking(int periodLengthMilliseconds,
                 int durationMilliseconds)

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.

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

void blinkTimes(int periodLengthMilliseconds,
              int times)

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

Parameters:

periodLengthMilliseconds - the duration of one full blinking period in milliseconds

times - the amount of times the output should blink

stopBlinking

void stopBlinking()

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

isBlinking

boolean isBlinking()

Checks if this output is currently blinking.

Returns:

true, if the output is currently blinking

awaitBlinkingStopped

void awaitBlinkingStopped()

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