com.pi4j.gpio.extension.base

Class DacGpioProviderBase

java.lang.Object

com.pi4j.io.gpio.GpioProviderBase

com.pi4j.gpio.extension.base.DacGpioProviderBase

All Implemented Interfaces:

DacGpioProvider, GpioProvider

Direct Known Subclasses:

MCP4725GpioProvider

public abstract class DacGpioProviderBase
extends GpioProviderBase
implements DacGpioProvider

This base GPIO provider defined the required interfaces and implements the base functionality for DAC (digital to analog) expansion chips as native Pi4J GPIO pins.

Author:

Robert Savage

Field Summary

Fields

Modifier and Type	Field and Description
protected Pin[]	allPins
protected Double[]	shutdownValues

Fields inherited from class com.pi4j.io.gpio.GpioProviderBase

cache, DEFAULT_CACHE_SIZE, isshutdown, listeners

Constructor Summary

Constructors

Constructor and Description
DacGpioProviderBase(Pin[] pins) Default Constructor

Method Summary

Modifier and Type	Method and Description
Number	getShutdownValue(GpioPinAnalogOutput pin) Get the shutdown/terminate value that the DAC should apply to the given GPIO pin when the class is destroyed/terminated.
Number	getShutdownValue(Pin pin) Get the shutdown/terminate value that the DAC should apply to the given GPIO pin when the class is destroyed/terminated.
void	setPercentValue(GpioPinAnalogOutput pin, Number percent) Set the current analog value as a percentage of the available range instead of a raw value.
void	setPercentValue(Pin pin, Number percent) Set the current value in a percentage of the available range instead of a raw value.
void	setShutdownValue(Number value, GpioPinAnalogOutput... pin) Set the shutdown/terminate value that the DAC should apply to the given GPIO pin when the class is destroyed/terminated.
void	setShutdownValue(Number value, Pin... pin) Set the shutdown/terminate value that the DAC should apply to the given GPIO pin when the class is destroyed/terminated.
void	setValue(Pin pin, Number value) Set the requested analog output pin's conversion value.
void	shutdown() This method is used by the framework to shutdown the DAC instance and apply any configured shutdown values to the DAC pins.

Methods inherited from class com.pi4j.io.gpio.GpioProviderBase

addListener, dispatchPinAnalogValueChangeEvent, dispatchPinDigitalStateChangeEvent, export, export, getMode, getName, getPinCache, getPullResistance, getPwm, getState, getValue, hasPin, isExported, isShutdown, removeAllListeners, removeListener, setMode, setPullResistance, setPwm, setPwmRange, setState, setValue, unexport

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pi4j.gpio.extension.base.DacGpioProvider

getMaxSupportedValue, getMinSupportedValue

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

addListener, export, export, getMode, getName, getPullResistance, getPwm, getState, getValue, hasPin, isExported, isShutdown, removeAllListeners, removeListener, setMode, setPullResistance, setPwm, setPwmRange, setState, setValue, unexport

Field Detail

allPins

protected Pin[] allPins

shutdownValues

protected Double[] shutdownValues

Constructor Detail

DacGpioProviderBase

public DacGpioProviderBase(Pin[] pins)

Default Constructor

Parameters:

pins - the collection of all GPIO pins used with this ADC provider implementation

Method Detail

setPercentValue

public void setPercentValue(Pin pin,
                            Number percent)

Set the current value in a percentage of the available range instead of a raw value.

Specified by:

setPercentValue in interface DacGpioProvider

Parameters:

pin -

percent - percentage value between 0 and 100.

setPercentValue

public void setPercentValue(GpioPinAnalogOutput pin,
                            Number percent)

Set the current analog value as a percentage of the available range instead of a raw value. Thr framework will automatically convert the percentage to a scaled number in the ADC's value range.

Specified by:

setPercentValue in interface DacGpioProvider

setValue

public void setValue(Pin pin,
                     Number value)

Set the requested analog output pin's conversion value.

Specified by:

setValue in interface DacGpioProvider

Parameters:

pin - to get conversion values for

value - analog output pin conversion value

shutdown

public void shutdown()

This method is used by the framework to shutdown the DAC instance and apply any configured shutdown values to the DAC pins.

Specified by:

shutdown in interface GpioProvider

Overrides:

shutdown in class GpioProviderBase

setShutdownValue

public void setShutdownValue(Number value,
                             Pin... pin)

Set the shutdown/terminate value that the DAC should apply to the given GPIO pin when the class is destroyed/terminated.

Specified by:

setShutdownValue in interface DacGpioProvider

Parameters:

value - the shutdown value to apply to the given pin(s)

pin - analog output pin (vararg: one or more pins)

getShutdownValue

public Number getShutdownValue(Pin pin)

Get the shutdown/terminate value that the DAC should apply to the given GPIO pin when the class is destroyed/terminated.

Specified by:

getShutdownValue in interface DacGpioProvider

Parameters:

pin - analog output pin

Returns:

return the shutdown value if one has been defined, else NULL.

setShutdownValue

public void setShutdownValue(Number value,
                             GpioPinAnalogOutput... pin)

Set the shutdown/terminate value that the DAC should apply to the given GPIO pin when the class is destroyed/terminated.

Specified by:

setShutdownValue in interface DacGpioProvider

Parameters:

value - the shutdown value to apply to the given pin(s)

pin - analog output pin (vararg: one or more pins)

getShutdownValue

public Number getShutdownValue(GpioPinAnalogOutput pin)

Get the shutdown/terminate value that the DAC should apply to the given GPIO pin when the class is destroyed/terminated.

Specified by:

getShutdownValue in interface DacGpioProvider

Parameters:

pin - analog output pin

Returns:

return the shutdown value if one has been defined, else NULL.