com.pi4j.io.gpio

Interface GpioController

All Known Implementing Classes:

GpioControllerImpl

public interface GpioController

Gpio controller interface. This interface describes all operations over GPIO.

Author:

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

Method Summary

Modifier and Type	Method and Description
void	addListener(GpioPinListener[] listeners, GpioPinInput... pin)
void	addListener(GpioPinListener listener, GpioPinInput... pin)
void	addTrigger(GpioTrigger[] triggers, GpioPinInput... pin)
void	addTrigger(GpioTrigger trigger, GpioPinInput... pin)
void	export(PinMode mode, GpioPin... pin)
void	export(PinMode mode, PinState defaultState, GpioPin... pin)
PinMode	getMode(GpioPin pin)
GpioPin	getProvisionedPin(Pin pin)
GpioPin	getProvisionedPin(String name)
Collection<GpioPin>	getProvisionedPins()
PinPullResistance	getPullResistance(GpioPin pin)
PinState	getState(GpioPinDigital pin)
double	getValue(GpioPinAnalog pin)
void	high(GpioPinDigitalOutput... pin)
boolean	isExported(GpioPin... pin)
boolean	isHigh(GpioPinDigital... pin)
boolean	isLow(GpioPinDigital... pin)
boolean	isMode(PinMode mode, GpioPin... pin)
boolean	isPullResistance(PinPullResistance resistance, GpioPin... pin)
boolean	isShutdown()
boolean	isState(PinState state, GpioPinDigital... pin)
void	low(GpioPinDigitalOutput... pin)
GpioPinAnalogInput	provisionAnalogInputPin(GpioProvider provider, Pin pin)
GpioPinAnalogInput	provisionAnalogInputPin(GpioProvider provider, Pin pin, String name)
GpioPinAnalogInput	provisionAnalogInputPin(Pin pin)
GpioPinAnalogInput	provisionAnalogInputPin(Pin pin, String name)
GpioPinAnalogOutput	provisionAnalogOutputPin(GpioProvider provider, Pin pin)
GpioPinAnalogOutput	provisionAnalogOutputPin(GpioProvider provider, Pin pin, double defaultValue)
GpioPinAnalogOutput	provisionAnalogOutputPin(GpioProvider provider, Pin pin, String name)
GpioPinAnalogOutput	provisionAnalogOutputPin(GpioProvider provider, Pin pin, String name, double defaultValue)
GpioPinAnalogOutput	provisionAnalogOutputPin(Pin pin)
GpioPinAnalogOutput	provisionAnalogOutputPin(Pin pin, double defaultValue)
GpioPinAnalogOutput	provisionAnalogOutputPin(Pin pin, String name)
GpioPinAnalogOutput	provisionAnalogOutputPin(Pin pin, String name, double defaultValue)
GpioPinDigitalInput	provisionDigitalInputPin(GpioProvider provider, Pin pin)
GpioPinDigitalInput	provisionDigitalInputPin(GpioProvider provider, Pin pin, PinPullResistance resistance)
GpioPinDigitalInput	provisionDigitalInputPin(GpioProvider provider, Pin pin, String name)
GpioPinDigitalInput	provisionDigitalInputPin(GpioProvider provider, Pin pin, String name, PinPullResistance resistance)
GpioPinDigitalInput	provisionDigitalInputPin(Pin pin)
GpioPinDigitalInput	provisionDigitalInputPin(Pin pin, PinPullResistance resistance)
GpioPinDigitalInput	provisionDigitalInputPin(Pin pin, String name)
GpioPinDigitalInput	provisionDigitalInputPin(Pin pin, String name, PinPullResistance resistance)
GpioPinDigitalMultipurpose	provisionDigitalMultipurposePin(GpioProvider provider, Pin pin, PinMode mode)
GpioPinDigitalMultipurpose	provisionDigitalMultipurposePin(GpioProvider provider, Pin pin, PinMode mode, PinPullResistance resistance)
GpioPinDigitalMultipurpose	provisionDigitalMultipurposePin(GpioProvider provider, Pin pin, String name, PinMode mode)
GpioPinDigitalMultipurpose	provisionDigitalMultipurposePin(GpioProvider provider, Pin pin, String name, PinMode mode, PinPullResistance resistance)
GpioPinDigitalMultipurpose	provisionDigitalMultipurposePin(Pin pin, PinMode mode)
GpioPinDigitalMultipurpose	provisionDigitalMultipurposePin(Pin pin, PinMode mode, PinPullResistance resistance)
GpioPinDigitalMultipurpose	provisionDigitalMultipurposePin(Pin pin, String name, PinMode mode)
GpioPinDigitalMultipurpose	provisionDigitalMultipurposePin(Pin pin, String name, PinMode mode, PinPullResistance resistance)
GpioPinDigitalOutput	provisionDigitalOutputPin(GpioProvider provider, Pin pin)
GpioPinDigitalOutput	provisionDigitalOutputPin(GpioProvider provider, Pin pin, PinState defaultState)
GpioPinDigitalOutput	provisionDigitalOutputPin(GpioProvider provider, Pin pin, String name)
GpioPinDigitalOutput	provisionDigitalOutputPin(GpioProvider provider, Pin pin, String name, PinState defaultState)
GpioPinDigitalOutput	provisionDigitalOutputPin(Pin pin)
GpioPinDigitalOutput	provisionDigitalOutputPin(Pin pin, PinState defaultState)
GpioPinDigitalOutput	provisionDigitalOutputPin(Pin pin, String name)
GpioPinDigitalOutput	provisionDigitalOutputPin(Pin pin, String name, PinState defaultState)
GpioPin	provisionPin(GpioProvider provider, Pin pin, PinMode mode)
GpioPin	provisionPin(GpioProvider provider, Pin pin, String name, PinMode mode)
GpioPin	provisionPin(GpioProvider provider, Pin pin, String name, PinMode mode, PinState defaultState)
GpioPin	provisionPin(Pin pin, PinMode mode)
GpioPin	provisionPin(Pin pin, String name, PinMode mode)
GpioPinPwmOutput	provisionPwmOutputPin(GpioProvider provider, Pin pin)
GpioPinPwmOutput	provisionPwmOutputPin(GpioProvider provider, Pin pin, int defaultValue)
GpioPinPwmOutput	provisionPwmOutputPin(GpioProvider provider, Pin pin, String name)
GpioPinPwmOutput	provisionPwmOutputPin(GpioProvider provider, Pin pin, String name, int defaultValue)
GpioPinPwmOutput	provisionPwmOutputPin(Pin pin)
GpioPinPwmOutput	provisionPwmOutputPin(Pin pin, int defaultValue)
GpioPinPwmOutput	provisionPwmOutputPin(Pin pin, String name)
GpioPinPwmOutput	provisionPwmOutputPin(Pin pin, String name, int defaultValue)
GpioPinPwmOutput	provisionSoftPwmOutputPin(GpioProvider provider, Pin pin)
GpioPinPwmOutput	provisionSoftPwmOutputPin(GpioProvider provider, Pin pin, int defaultValue)
GpioPinPwmOutput	provisionSoftPwmOutputPin(GpioProvider provider, Pin pin, String name)
GpioPinPwmOutput	provisionSoftPwmOutputPin(GpioProvider provider, Pin pin, String name, int defaultValue)
GpioPinPwmOutput	provisionSoftPwmOutputPin(Pin pin)
GpioPinPwmOutput	provisionSoftPwmOutputPin(Pin pin, int defaultValue)
GpioPinPwmOutput	provisionSoftPwmOutputPin(Pin pin, String name)
GpioPinPwmOutput	provisionSoftPwmOutputPin(Pin pin, String name, int defaultValue)
void	pulse(long milliseconds, GpioPinDigitalOutput... pin)
void	removeAllListeners()
void	removeAllTriggers()
void	removeListener(GpioPinListener[] listeners, GpioPinInput... pin)
void	removeListener(GpioPinListener listener, GpioPinInput... pin)
void	removeTrigger(GpioTrigger[] triggers, GpioPinInput... pin)
void	removeTrigger(GpioTrigger trigger, GpioPinInput... pin)
void	setMode(PinMode mode, GpioPin... pin)
void	setPullResistance(PinPullResistance resistance, GpioPin... pin)
void	setShutdownOptions(Boolean unexport, GpioPin... pin)
void	setShutdownOptions(Boolean unexport, PinState state, GpioPin... pin)
void	setShutdownOptions(Boolean unexport, PinState state, PinPullResistance resistance, GpioPin... pin)
void	setShutdownOptions(Boolean unexport, PinState state, PinPullResistance resistance, PinMode mode, GpioPin... pin)
void	setShutdownOptions(GpioPinShutdown options, GpioPin... pin)
void	setState(boolean state, GpioPinDigitalOutput... pin)
void	setState(PinState state, GpioPinDigitalOutput... pin)
void	setValue(double value, GpioPinAnalogOutput... pin)
void	shutdown()
void	toggle(GpioPinDigitalOutput... pin)
void	unexport(GpioPin... pin) Unexport a GPIO pin by GpioPin instance.
void	unexport(Pin... pin) Unexport a GPIO pin by Pin instance.
void	unexportAll() Unexport all GPIO pins that have been provisioned by Pi4J in the context of this program.
void	unprovisionPin(GpioPin... pin)

Method Detail

export

void export(PinMode mode,
            PinState defaultState,
            GpioPin... pin)

export

void export(PinMode mode,
            GpioPin... pin)

isExported

boolean isExported(GpioPin... pin)

unexport

void unexport(Pin... pin)

Unexport a GPIO pin by Pin instance. This method will explicitly unexport any Pin whether it has been provisioned in Pi4J or not.

Parameters:

pin - GPIO pin instance (i.e. RaspiPin.GPIO_00)

unexport

void unexport(GpioPin... pin)

Unexport a GPIO pin by GpioPin instance. This method will unexport an existing provisoned pin

Parameters:

pin - provisioned GPIO pin instance

unexportAll

void unexportAll()

Unexport all GPIO pins that have been provisioned by Pi4J in the context of this program.

setMode

void setMode(PinMode mode,
             GpioPin... pin)

getMode

PinMode getMode(GpioPin pin)

isMode

boolean isMode(PinMode mode,
               GpioPin... pin)

setPullResistance

void setPullResistance(PinPullResistance resistance,
                       GpioPin... pin)

getPullResistance

PinPullResistance getPullResistance(GpioPin pin)

isPullResistance

boolean isPullResistance(PinPullResistance resistance,
                         GpioPin... pin)

high

void high(GpioPinDigitalOutput... pin)

isHigh

boolean isHigh(GpioPinDigital... pin)

low

void low(GpioPinDigitalOutput... pin)

isLow

boolean isLow(GpioPinDigital... pin)

setState

void setState(PinState state,
              GpioPinDigitalOutput... pin)

setState

void setState(boolean state,
              GpioPinDigitalOutput... pin)

isState

boolean isState(PinState state,
                GpioPinDigital... pin)

getState

PinState getState(GpioPinDigital pin)

toggle

void toggle(GpioPinDigitalOutput... pin)

pulse

void pulse(long milliseconds,
           GpioPinDigitalOutput... pin)

setValue

void setValue(double value,
              GpioPinAnalogOutput... pin)

getValue

double getValue(GpioPinAnalog pin)

addListener

void addListener(GpioPinListener listener,
                 GpioPinInput... pin)

addListener

void addListener(GpioPinListener[] listeners,
                 GpioPinInput... pin)

removeListener

void removeListener(GpioPinListener listener,
                    GpioPinInput... pin)

removeListener

void removeListener(GpioPinListener[] listeners,
                    GpioPinInput... pin)

removeAllListeners

void removeAllListeners()

addTrigger

void addTrigger(GpioTrigger trigger,
                GpioPinInput... pin)

addTrigger

void addTrigger(GpioTrigger[] triggers,
                GpioPinInput... pin)

removeTrigger

void removeTrigger(GpioTrigger trigger,
                   GpioPinInput... pin)

removeTrigger

void removeTrigger(GpioTrigger[] triggers,
                   GpioPinInput... pin)

removeAllTriggers

void removeAllTriggers()

provisionDigitalMultipurposePin

GpioPinDigitalMultipurpose provisionDigitalMultipurposePin(GpioProvider provider,
                                                           Pin pin,
                                                           String name,
                                                           PinMode mode,
                                                           PinPullResistance resistance)

provisionDigitalMultipurposePin

GpioPinDigitalMultipurpose provisionDigitalMultipurposePin(GpioProvider provider,
                                                           Pin pin,
                                                           PinMode mode,
                                                           PinPullResistance resistance)

provisionDigitalMultipurposePin

GpioPinDigitalMultipurpose provisionDigitalMultipurposePin(GpioProvider provider,
                                                           Pin pin,
                                                           String name,
                                                           PinMode mode)

provisionDigitalMultipurposePin

GpioPinDigitalMultipurpose provisionDigitalMultipurposePin(GpioProvider provider,
                                                           Pin pin,
                                                           PinMode mode)

provisionDigitalMultipurposePin

GpioPinDigitalMultipurpose provisionDigitalMultipurposePin(Pin pin,
                                                           String name,
                                                           PinMode mode,
                                                           PinPullResistance resistance)

provisionDigitalMultipurposePin

GpioPinDigitalMultipurpose provisionDigitalMultipurposePin(Pin pin,
                                                           PinMode mode,
                                                           PinPullResistance resistance)

provisionDigitalMultipurposePin

GpioPinDigitalMultipurpose provisionDigitalMultipurposePin(Pin pin,
                                                           String name,
                                                           PinMode mode)

provisionDigitalMultipurposePin

GpioPinDigitalMultipurpose provisionDigitalMultipurposePin(Pin pin,
                                                           PinMode mode)

provisionDigitalInputPin

GpioPinDigitalInput provisionDigitalInputPin(GpioProvider provider,
                                             Pin pin,
                                             String name,
                                             PinPullResistance resistance)

provisionDigitalInputPin

GpioPinDigitalInput provisionDigitalInputPin(GpioProvider provider,
                                             Pin pin,
                                             PinPullResistance resistance)

provisionDigitalInputPin

GpioPinDigitalInput provisionDigitalInputPin(GpioProvider provider,
                                             Pin pin,
                                             String name)

provisionDigitalInputPin

GpioPinDigitalInput provisionDigitalInputPin(GpioProvider provider,
                                             Pin pin)

provisionDigitalInputPin

GpioPinDigitalInput provisionDigitalInputPin(Pin pin,
                                             String name,
                                             PinPullResistance resistance)

provisionDigitalInputPin

GpioPinDigitalInput provisionDigitalInputPin(Pin pin,
                                             PinPullResistance resistance)

provisionDigitalInputPin

GpioPinDigitalInput provisionDigitalInputPin(Pin pin,
                                             String name)

provisionDigitalInputPin

GpioPinDigitalInput provisionDigitalInputPin(Pin pin)

provisionDigitalOutputPin

GpioPinDigitalOutput provisionDigitalOutputPin(GpioProvider provider,
                                               Pin pin,
                                               String name,
                                               PinState defaultState)

provisionDigitalOutputPin

GpioPinDigitalOutput provisionDigitalOutputPin(GpioProvider provider,
                                               Pin pin,
                                               PinState defaultState)

provisionDigitalOutputPin

GpioPinDigitalOutput provisionDigitalOutputPin(GpioProvider provider,
                                               Pin pin,
                                               String name)

provisionDigitalOutputPin

GpioPinDigitalOutput provisionDigitalOutputPin(GpioProvider provider,
                                               Pin pin)

provisionDigitalOutputPin

GpioPinDigitalOutput provisionDigitalOutputPin(Pin pin,
                                               String name,
                                               PinState defaultState)

provisionDigitalOutputPin

GpioPinDigitalOutput provisionDigitalOutputPin(Pin pin,
                                               PinState defaultState)

provisionDigitalOutputPin

GpioPinDigitalOutput provisionDigitalOutputPin(Pin pin,
                                               String name)

provisionDigitalOutputPin

GpioPinDigitalOutput provisionDigitalOutputPin(Pin pin)

provisionAnalogInputPin

GpioPinAnalogInput provisionAnalogInputPin(GpioProvider provider,
                                           Pin pin,
                                           String name)

provisionAnalogInputPin

GpioPinAnalogInput provisionAnalogInputPin(GpioProvider provider,
                                           Pin pin)

provisionAnalogInputPin

GpioPinAnalogInput provisionAnalogInputPin(Pin pin,
                                           String name)

provisionAnalogInputPin

GpioPinAnalogInput provisionAnalogInputPin(Pin pin)

provisionAnalogOutputPin

GpioPinAnalogOutput provisionAnalogOutputPin(GpioProvider provider,
                                             Pin pin,
                                             String name,
                                             double defaultValue)

provisionAnalogOutputPin

GpioPinAnalogOutput provisionAnalogOutputPin(GpioProvider provider,
                                             Pin pin,
                                             double defaultValue)

provisionAnalogOutputPin

GpioPinAnalogOutput provisionAnalogOutputPin(GpioProvider provider,
                                             Pin pin,
                                             String name)

provisionAnalogOutputPin

GpioPinAnalogOutput provisionAnalogOutputPin(GpioProvider provider,
                                             Pin pin)

provisionAnalogOutputPin

GpioPinAnalogOutput provisionAnalogOutputPin(Pin pin,
                                             String name,
                                             double defaultValue)

provisionAnalogOutputPin

GpioPinAnalogOutput provisionAnalogOutputPin(Pin pin,
                                             double defaultValue)

provisionAnalogOutputPin

GpioPinAnalogOutput provisionAnalogOutputPin(Pin pin,
                                             String name)

provisionAnalogOutputPin

GpioPinAnalogOutput provisionAnalogOutputPin(Pin pin)

provisionPwmOutputPin

GpioPinPwmOutput provisionPwmOutputPin(GpioProvider provider,
                                       Pin pin,
                                       String name,
                                       int defaultValue)

provisionPwmOutputPin

GpioPinPwmOutput provisionPwmOutputPin(GpioProvider provider,
                                       Pin pin,
                                       int defaultValue)

provisionPwmOutputPin

GpioPinPwmOutput provisionPwmOutputPin(GpioProvider provider,
                                       Pin pin,
                                       String name)

provisionPwmOutputPin

GpioPinPwmOutput provisionPwmOutputPin(GpioProvider provider,
                                       Pin pin)

provisionPwmOutputPin

GpioPinPwmOutput provisionPwmOutputPin(Pin pin,
                                       String name,
                                       int defaultValue)

provisionPwmOutputPin

GpioPinPwmOutput provisionPwmOutputPin(Pin pin,
                                       int defaultValue)

provisionPwmOutputPin

GpioPinPwmOutput provisionPwmOutputPin(Pin pin,
                                       String name)

provisionPwmOutputPin

GpioPinPwmOutput provisionPwmOutputPin(Pin pin)

provisionSoftPwmOutputPin

GpioPinPwmOutput provisionSoftPwmOutputPin(GpioProvider provider,
                                           Pin pin,
                                           String name,
                                           int defaultValue)

provisionSoftPwmOutputPin

GpioPinPwmOutput provisionSoftPwmOutputPin(GpioProvider provider,
                                           Pin pin,
                                           int defaultValue)

provisionSoftPwmOutputPin

GpioPinPwmOutput provisionSoftPwmOutputPin(GpioProvider provider,
                                           Pin pin,
                                           String name)

provisionSoftPwmOutputPin

GpioPinPwmOutput provisionSoftPwmOutputPin(GpioProvider provider,
                                           Pin pin)

provisionSoftPwmOutputPin

GpioPinPwmOutput provisionSoftPwmOutputPin(Pin pin,
                                           String name,
                                           int defaultValue)

provisionSoftPwmOutputPin

GpioPinPwmOutput provisionSoftPwmOutputPin(Pin pin,
                                           int defaultValue)

provisionSoftPwmOutputPin

GpioPinPwmOutput provisionSoftPwmOutputPin(Pin pin,
                                           String name)

provisionSoftPwmOutputPin

GpioPinPwmOutput provisionSoftPwmOutputPin(Pin pin)

provisionPin

GpioPin provisionPin(GpioProvider provider,
                     Pin pin,
                     String name,
                     PinMode mode,
                     PinState defaultState)

provisionPin

GpioPin provisionPin(GpioProvider provider,
                     Pin pin,
                     String name,
                     PinMode mode)

provisionPin

GpioPin provisionPin(GpioProvider provider,
                     Pin pin,
                     PinMode mode)

provisionPin

GpioPin provisionPin(Pin pin,
                     String name,
                     PinMode mode)

provisionPin

GpioPin provisionPin(Pin pin,
                     PinMode mode)

setShutdownOptions

void setShutdownOptions(GpioPinShutdown options,
                        GpioPin... pin)

setShutdownOptions

void setShutdownOptions(Boolean unexport,
                        GpioPin... pin)

setShutdownOptions

void setShutdownOptions(Boolean unexport,
                        PinState state,
                        GpioPin... pin)

setShutdownOptions

void setShutdownOptions(Boolean unexport,
                        PinState state,
                        PinPullResistance resistance,
                        GpioPin... pin)

setShutdownOptions

void setShutdownOptions(Boolean unexport,
                        PinState state,
                        PinPullResistance resistance,
                        PinMode mode,
                        GpioPin... pin)

getProvisionedPins

Collection<GpioPin> getProvisionedPins()

getProvisionedPin

GpioPin getProvisionedPin(Pin pin)

getProvisionedPin

GpioPin getProvisionedPin(String name)

unprovisionPin

void unprovisionPin(GpioPin... pin)

isShutdown

boolean isShutdown()

shutdown

void shutdown()