Module com.pi4j

Package com.pi4j.io.gpio.analog

Interface AnalogOutputConfig

All Superinterfaces:

AddressConfig<AnalogOutputConfig>, AnalogConfig<AnalogOutputConfig>, Config<AnalogOutputConfig>, com.pi4j.io.gpio.GpioConfig<AnalogOutputConfig>, IOConfig<AnalogOutputConfig>

public interface AnalogOutputConfig
extends AnalogConfig<AnalogOutputConfig>

AnalogOutputConfig interface.

Version:

$Id: $Id

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	INITIAL_VALUE_KEY	Constant INITIAL_VALUE_KEY="initial"
static String	SHUTDOWN_VALUE_KEY	Constant SHUTDOWN_VALUE_KEY="shutdown"
static String	STEP_VALUE_KEY	Constant STEP_VALUE_KEY="step"

Fields inherited from interface com.pi4j.config.AddressConfig

ADDRESS_KEY

Fields inherited from interface com.pi4j.io.gpio.analog.AnalogConfig

RANGE_MAX_KEY, RANGE_MIN_KEY

Fields inherited from interface com.pi4j.config.Config

DESCRIPTION_KEY, ID_KEY, NAME_KEY

Fields inherited from interface com.pi4j.io.IOConfig

PLATFORM_KEY, PROVIDER_KEY

Method Summary

Modifier and Type	Method	Description
default Number	getInitialValue()	getInitialValue.
default Number	getShutdownValue()	getShutdownValue.
default Number	getStepValue()	getStepValue.
Integer	initialValue()	initialValue.
static AnalogOutputConfigBuilder	newBuilder(Context context)	newBuilder.
default void	setShutdownValue(Integer value)	setShutdownValue.
default void	setStepValue(Integer value)	setStepValue.
Integer	shutdownValue()	shutdownValue.
AnalogOutputConfig	shutdownValue(Integer value)	shutdownValue.
Integer	stepValue()	stepValue.
AnalogOutputConfig	stepValue(Integer value)	stepValue.

Methods inherited from interface com.pi4j.config.AddressConfig

address, getAddress

Methods inherited from interface com.pi4j.io.gpio.analog.AnalogConfig

getRange, range

Methods inherited from interface com.pi4j.config.Config

description, getDescription, getId, getName, id, name, properties, validate

Methods inherited from interface com.pi4j.io.IOConfig

getPlatform, getProvider, platform, provider

Field Detail

SHUTDOWN_VALUE_KEY

static final String SHUTDOWN_VALUE_KEY

Constant SHUTDOWN_VALUE_KEY="shutdown"

See Also:

Constant Field Values

INITIAL_VALUE_KEY

static final String INITIAL_VALUE_KEY

Constant INITIAL_VALUE_KEY="initial"

See Also:

Constant Field Values

STEP_VALUE_KEY

static final String STEP_VALUE_KEY

Constant STEP_VALUE_KEY="step"

See Also:

Constant Field Values

Method Detail

shutdownValue

Integer shutdownValue()

shutdownValue.

Returns:

a Integer object.

shutdownValue

AnalogOutputConfig shutdownValue(Integer value)

shutdownValue.

Parameters:

value - a Integer object.

Returns:

a AnalogOutputConfig object.

getShutdownValue

default Number getShutdownValue()

getShutdownValue.

Returns:

a Number object.

setShutdownValue

default void setShutdownValue(Integer value)

setShutdownValue.

Parameters:

value - a Integer object.

stepValue

Integer stepValue()

stepValue.

Returns:

a Integer object.

stepValue

AnalogOutputConfig stepValue(Integer value)

stepValue.

Parameters:

value - a Integer object.

Returns:

a AnalogOutputConfig object.

getStepValue

default Number getStepValue()

getStepValue.

Returns:

a Number object.

setStepValue

default void setStepValue(Integer value)

setStepValue.

Parameters:

value - a Integer object.

initialValue

Integer initialValue()

initialValue.

Returns:

a Integer object.

getInitialValue

default Number getInitialValue()

getInitialValue.

Returns:

a Number object.

newBuilder

static AnalogOutputConfigBuilder newBuilder(Context context)

newBuilder.

Parameters:

context - Context

Returns:

a AnalogOutputConfigBuilder object.