io.silverspoon.bulldog.core.gpio.base

Class AbstractDigitalOutput

java.lang.Object

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

io.silverspoon.bulldog.core.gpio.base.AbstractDigitalOutput

All Implemented Interfaces:

DigitalOutput, PinFeature

public abstract class AbstractDigitalOutput
extends AbstractPinFeature
implements DigitalOutput

Constructor Summary

Constructors

Constructor and Description
AbstractDigitalOutput(Pin pin)

Method Summary

Methods

Modifier and Type	Method and Description
void	applySignal(Signal signal) Writes a state to the pin.
protected abstract void	applySignalImpl(Signal signal)
void	awaitBlinkingStopped() Halts the current thread until the blinking on the output has stopped.
void	blinkTimes(int periodMilliseconds, 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.
String	getName()
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 periodMilliseconds) This method is used to let the pin blink indefinitely.
void	startBlinking(int periodMilliseconds, 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 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.PinFeature

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

Constructor Detail

AbstractDigitalOutput

public AbstractDigitalOutput(Pin pin)

Method Detail

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

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

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

toggle

public void toggle()

Description copied from interface: DigitalOutput

Toggles the current signal on the pin.

Specified by:

toggle in interface DigitalOutput

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

startBlinking

public void startBlinking(int periodMilliseconds)

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:

periodMilliseconds - the duration of one full blinking period in milliseconds

startBlinking

public void startBlinking(int periodMilliseconds,
                 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:

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

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

blinkTimes

public void blinkTimes(int periodMilliseconds,
              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:

periodMilliseconds - the duration of one full blinking period in milliseconds

times - the amount of times the output should blink

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

applySignalImpl

protected abstract void applySignalImpl(Signal signal)