Module com.pi4j

Package com.pi4j.io.gpio.digital

Interface DigitalOutput

All Superinterfaces:

Bindable<DigitalOutput,DigitalBinding>, Describable, Digital<DigitalOutput,DigitalOutputConfig,DigitalOutputProvider>, com.pi4j.io.gpio.Gpio<DigitalOutput,DigitalOutputConfig,DigitalOutputProvider>, Identity, IO<DigitalOutput,DigitalOutputConfig,DigitalOutputProvider>, Lifecycle, OnOff<DigitalOutput>, OnOffRead<DigitalOutput>, OnOffWrite<DigitalOutput>, Output

All Known Implementing Classes:

DigitalOutputBase

public interface DigitalOutput
extends Digital<DigitalOutput,DigitalOutputConfig,DigitalOutputProvider>, Output, OnOff<DigitalOutput>

DigitalOutput interface.

Version:

$Id: $Id

Author:

Robert Savage (http://www.savagehomeautomation.com)

Method Summary

Modifier and Type	Method	Description
default DigitalOutput	blink(int delay, int duration, TimeUnit unit)	blink.
default DigitalOutput	blink(int delay, int duration, TimeUnit unit, DigitalState state)	blink.
DigitalOutput	blink(int delay, int duration, TimeUnit unit, DigitalState state, Callable<Void> callback)	blink.
default DigitalOutput	blink(int interval, TimeUnit unit)	blink.
default Future<?>	blinkAsync(int delay, int duration, TimeUnit unit)	blinkAsync.
default Future<?>	blinkAsync(int delay, int duration, TimeUnit unit, DigitalState state)	blinkAsync.
Future<?>	blinkAsync(int delay, int duration, TimeUnit unit, DigitalState state, Callable<Void> callback)	blinkAsync.
default Future<?>	blinkAsync(int interval, TimeUnit unit)	blinkAsync.
default DigitalOutput	high()	high.
default DigitalOutput	low()	low.
static DigitalOutputBuilder	newBuilder(Context context)	newBuilder.
static DigitalOutputConfigBuilder	newConfigBuilder(Context context)	newConfigBuilder.
default DigitalOutput	pulse(int interval, TimeUnit unit)	pulse.
default DigitalOutput	pulse(int interval, TimeUnit unit, DigitalState state)	pulse.
DigitalOutput	pulse(int interval, TimeUnit unit, DigitalState state, Callable<Void> callback)	pulse.
default Future<?>	pulseAsync(int interval, TimeUnit unit)	pulseAsync.
default Future<?>	pulseAsync(int interval, TimeUnit unit, DigitalState state)	pulseAsync.
Future<?>	pulseAsync(int interval, TimeUnit unit, DigitalState state, Callable<Void> callback)	pulseAsync.
default DigitalOutput	pulseHigh(int interval, TimeUnit unit)	pulseHigh.
default Future<?>	pulseHighAsync(int interval, TimeUnit unit, Callable<Void> callback)	pulseHighAsync.
default DigitalOutput	pulseLow(int interval, TimeUnit unit)	pulseLow.
default Future<?>	pulseLowAsync(int interval, TimeUnit unit, Callable<Void> callback)	pulseLowAsync.
default DigitalOutput	setState(boolean state)	setState.
default DigitalOutput	setState(byte state)	setState.
default DigitalOutput	setState(double state)	setState.
default DigitalOutput	setState(float state)	setState.
default DigitalOutput	setState(int state)	setState.
default DigitalOutput	setState(long state)	setState.
default DigitalOutput	setState(short state)	setState.
DigitalOutput	state(DigitalState state)	state.
default DigitalOutput	toggle()	toggle.

Methods inherited from interface com.pi4j.io.binding.Bindable

bind, unbind

Methods inherited from interface com.pi4j.io.gpio.digital.Digital

addListener, equals, equals, equals, equals, equals, equals, equals, equals, equals, isHigh, isLow, removeListener, state

Methods inherited from interface com.pi4j.io.gpio.Gpio

address, getAddress

Methods inherited from interface com.pi4j.common.Identity

describe, description, getDescription, getId, getMetadata, getName, id, metadata, name

Methods inherited from interface com.pi4j.io.IO

config, description, name, provider, type

Methods inherited from interface com.pi4j.common.Lifecycle

initialize, shutdown

Methods inherited from interface com.pi4j.io.OnOffRead

isOff, isOn

Methods inherited from interface com.pi4j.io.OnOffWrite

off, on

Method Details

newConfigBuilder

static DigitalOutputConfigBuilder newConfigBuilder(Context context)

newConfigBuilder.

Parameters:

context - Context

Returns:

a DigitalOutputConfigBuilder object.

newBuilder

static DigitalOutputBuilder newBuilder(Context context)

newBuilder.

Parameters:

context - a Context object.

Returns:

a DigitalOutputBuilder object.

state

DigitalOutput state(DigitalState state)
             throws IOException

state.

Parameters:

state - a DigitalState object.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

pulse

DigitalOutput pulse(int interval,
 TimeUnit unit,
 DigitalState state,
 Callable<Void> callback)
             throws IOException

pulse.

Parameters:

interval - a int.

unit - a TimeUnit object.

state - a DigitalState object.

callback - a Callable object.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

pulseAsync

Future<?> pulseAsync(int interval,
 TimeUnit unit,
 DigitalState state,
 Callable<Void> callback)

pulseAsync.

Parameters:

interval - a int.

unit - a TimeUnit object.

state - a DigitalState object.

callback - a Callable object.

Returns:

a Future object.

blink

DigitalOutput blink(int delay,
 int duration,
 TimeUnit unit,
 DigitalState state,
 Callable<Void> callback)

blink.

Parameters:

delay - a int.

duration - a int.

unit - a TimeUnit object.

state - a DigitalState object.

callback - a Callable object.

Returns:

a DigitalOutput object.

blinkAsync

Future<?> blinkAsync(int delay,
 int duration,
 TimeUnit unit,
 DigitalState state,
 Callable<Void> callback)

blinkAsync.

Parameters:

delay - a int.

duration - a int.

unit - a TimeUnit object.

state - a DigitalState object.

callback - a Callable object.

Returns:

a Future object.

setState

default DigitalOutput setState(boolean state)
                        throws IOException

setState.

Parameters:

state - a boolean.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

setState

default DigitalOutput setState(byte state)
                        throws IOException

setState.

Parameters:

state - a byte.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

setState

default DigitalOutput setState(short state)
                        throws IOException

setState.

Parameters:

state - a short.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

setState

default DigitalOutput setState(int state)
                        throws IOException

setState.

Parameters:

state - a int.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

setState

default DigitalOutput setState(long state)
                        throws IOException

setState.

Parameters:

state - a long.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

setState

default DigitalOutput setState(float state)
                        throws IOException

setState.

Parameters:

state - a float.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

setState

default DigitalOutput setState(double state)
                        throws IOException

setState.

Parameters:

state - a double.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

high

default DigitalOutput high()
                    throws IOException

high.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

low

default DigitalOutput low()
                   throws IOException

low.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

toggle

default DigitalOutput toggle()
                      throws IOException

toggle.

Specified by:

toggle in interface OnOff<DigitalOutput>

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

pulseHigh

default DigitalOutput pulseHigh(int interval,
 TimeUnit unit)
                         throws IOException

pulseHigh.

Parameters:

interval - a int.

unit - a TimeUnit object.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

pulseLow

default DigitalOutput pulseLow(int interval,
 TimeUnit unit)
                        throws IOException

pulseLow.

Parameters:

interval - a int.

unit - a TimeUnit object.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

pulseHighAsync

default Future<?> pulseHighAsync(int interval,
 TimeUnit unit,
 Callable<Void> callback)

pulseHighAsync.

Parameters:

interval - a int.

unit - a TimeUnit object.

callback - a Callable object.

Returns:

a Future object.

pulseLowAsync

default Future<?> pulseLowAsync(int interval,
 TimeUnit unit,
 Callable<Void> callback)

pulseLowAsync.

Parameters:

interval - a int.

unit - a TimeUnit object.

callback - a Callable object.

Returns:

a Future object.

pulse

default DigitalOutput pulse(int interval,
 TimeUnit unit)
                     throws IOException

pulse.

Parameters:

interval - a int.

unit - a TimeUnit object.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

pulse

default DigitalOutput pulse(int interval,
 TimeUnit unit,
 DigitalState state)
                     throws IOException

pulse.

Parameters:

interval - a int.

unit - a TimeUnit object.

state - a DigitalState object.

Returns:

a DigitalOutput object.

Throws:

IOException - if any.

pulseAsync

default Future<?> pulseAsync(int interval,
 TimeUnit unit)

pulseAsync.

Parameters:

interval - a int.

unit - a TimeUnit object.

Returns:

a Future object.

pulseAsync

default Future<?> pulseAsync(int interval,
 TimeUnit unit,
 DigitalState state)

pulseAsync.

Parameters:

interval - a int.

unit - a TimeUnit object.

state - a DigitalState object.

Returns:

a Future object.

blink

default DigitalOutput blink(int interval,
 TimeUnit unit)

blink.

Parameters:

interval - a int.

unit - a TimeUnit object.

Returns:

a DigitalOutput object.

blink

default DigitalOutput blink(int delay,
 int duration,
 TimeUnit unit)

blink.

Parameters:

delay - a int.

duration - a int.

unit - a TimeUnit object.

Returns:

a DigitalOutput object.

blink

default DigitalOutput blink(int delay,
 int duration,
 TimeUnit unit,
 DigitalState state)

blink.

Parameters:

delay - a int.

duration - a int.

unit - a TimeUnit object.

state - a DigitalState object.

Returns:

a DigitalOutput object.

blinkAsync

default Future<?> blinkAsync(int interval,
 TimeUnit unit)

blinkAsync.

Parameters:

interval - a int.

unit - a TimeUnit object.

Returns:

a Future object.

blinkAsync

default Future<?> blinkAsync(int delay,
 int duration,
 TimeUnit unit)

blinkAsync.

Parameters:

delay - a int.

duration - a int.

unit - a TimeUnit object.

Returns:

a Future object.

blinkAsync

default Future<?> blinkAsync(int delay,
 int duration,
 TimeUnit unit,
 DigitalState state)

blinkAsync.

Parameters:

delay - a int.

duration - a int.

unit - a TimeUnit object.

state - a DigitalState object.

Returns:

a Future object.