com.pi4j.io.gpio.impl

Class GpioControllerImpl

java.lang.Object

com.pi4j.io.gpio.impl.GpioControllerImpl

All Implemented Interfaces:

GpioController

public class GpioControllerImpl
extends Object
implements GpioController

Constructor Summary

Constructors

Constructor and Description
GpioControllerImpl() Default Constructor
GpioControllerImpl(GpioProvider provider) Default Constructor

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)
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() This method returns TRUE if the GPIO controller has been shutdown.
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)
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() This method can be called to forcefully shutdown all GPIO controller monitoring, listening, and task threads/executors.
void	toggle(GpioPinDigitalOutput... pin)
void	unexport(GpioPin... pin)
void	unexportAll()
void	unprovisionPin(GpioPin... pin)

Methods inherited from class java.lang.Object

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

Constructor Detail

GpioControllerImpl

public GpioControllerImpl()

Default Constructor

GpioControllerImpl

public GpioControllerImpl(GpioProvider provider)

Default Constructor

Method Detail

getProvisionedPins

public Collection<GpioPin> getProvisionedPins()

Specified by:

getProvisionedPins in interface GpioController

unexportAll

public void unexportAll()

Specified by:

unexportAll in interface GpioController

export

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

Specified by:

export in interface GpioController

export

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

Specified by:

export in interface GpioController

isExported

public boolean isExported(GpioPin... pin)

Specified by:

isExported in interface GpioController

Parameters:

pin -

Returns:

A value of 'true' is returned if the requested pin is exported.

unexport

public void unexport(GpioPin... pin)

Specified by:

unexport in interface GpioController

getMode

public PinMode getMode(GpioPin pin)

Specified by:

getMode in interface GpioController

isMode

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

Specified by:

isMode in interface GpioController

setMode

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

Specified by:

setMode in interface GpioController

setPullResistance

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

Specified by:

setPullResistance in interface GpioController

getPullResistance

public PinPullResistance getPullResistance(GpioPin pin)

Specified by:

getPullResistance in interface GpioController

isPullResistance

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

Specified by:

isPullResistance in interface GpioController

high

public void high(GpioPinDigitalOutput... pin)

Specified by:

high in interface GpioController

low

public void low(GpioPinDigitalOutput... pin)

Specified by:

low in interface GpioController

isHigh

public boolean isHigh(GpioPinDigital... pin)

Specified by:

isHigh in interface GpioController

isLow

public boolean isLow(GpioPinDigital... pin)

Specified by:

isLow in interface GpioController

toggle

public void toggle(GpioPinDigitalOutput... pin)

Specified by:

toggle in interface GpioController

pulse

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

Specified by:

pulse in interface GpioController

setState

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

Specified by:

setState in interface GpioController

setState

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

Specified by:

setState in interface GpioController

getState

public PinState getState(GpioPinDigital pin)

Specified by:

getState in interface GpioController

isState

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

Specified by:

isState in interface GpioController

setValue

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

Specified by:

setValue in interface GpioController

getValue

public double getValue(GpioPinAnalog pin)

Specified by:

getValue in interface GpioController

addListener

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

Specified by:

addListener in interface GpioController

addListener

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

Specified by:

addListener in interface GpioController

removeListener

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

Specified by:

removeListener in interface GpioController

removeListener

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

Specified by:

removeListener in interface GpioController

removeAllListeners

public void removeAllListeners()

Specified by:

removeAllListeners in interface GpioController

addTrigger

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

Specified by:

addTrigger in interface GpioController

addTrigger

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

Specified by:

addTrigger in interface GpioController

removeTrigger

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

Specified by:

removeTrigger in interface GpioController

removeTrigger

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

Specified by:

removeTrigger in interface GpioController

removeAllTriggers

public void removeAllTriggers()

Specified by:

removeAllTriggers in interface GpioController

provisionPin

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

Specified by:

provisionPin in interface GpioController

provisionPin

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

Specified by:

provisionPin in interface GpioController

provisionPin

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

Specified by:

provisionPin in interface GpioController

provisionPin

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

Specified by:

provisionPin in interface GpioController

provisionPin

public GpioPin provisionPin(Pin pin,
                            PinMode mode)

Specified by:

provisionPin in interface GpioController

provisionDigitalMultipurposePin

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

Specified by:

provisionDigitalMultipurposePin in interface GpioController

provisionDigitalMultipurposePin

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

Specified by:

provisionDigitalMultipurposePin in interface GpioController

provisionDigitalMultipurposePin

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

Specified by:

provisionDigitalMultipurposePin in interface GpioController

provisionDigitalMultipurposePin

public GpioPinDigitalMultipurpose provisionDigitalMultipurposePin(Pin pin,
                                                                  PinMode mode)

Specified by:

provisionDigitalMultipurposePin in interface GpioController

provisionDigitalMultipurposePin

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

Specified by:

provisionDigitalMultipurposePin in interface GpioController

provisionDigitalMultipurposePin

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

Specified by:

provisionDigitalMultipurposePin in interface GpioController

provisionDigitalMultipurposePin

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

Specified by:

provisionDigitalMultipurposePin in interface GpioController

provisionDigitalMultipurposePin

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

Specified by:

provisionDigitalMultipurposePin in interface GpioController

provisionDigitalInputPin

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

Specified by:

provisionDigitalInputPin in interface GpioController

provisionDigitalInputPin

public GpioPinDigitalInput provisionDigitalInputPin(GpioProvider provider,
                                                    Pin pin)

Specified by:

provisionDigitalInputPin in interface GpioController

provisionDigitalInputPin

public GpioPinDigitalInput provisionDigitalInputPin(Pin pin,
                                                    String name)

Specified by:

provisionDigitalInputPin in interface GpioController

provisionDigitalInputPin

public GpioPinDigitalInput provisionDigitalInputPin(Pin pin)

Specified by:

provisionDigitalInputPin in interface GpioController

provisionDigitalInputPin

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

Specified by:

provisionDigitalInputPin in interface GpioController

provisionDigitalInputPin

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

Specified by:

provisionDigitalInputPin in interface GpioController

provisionDigitalInputPin

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

Specified by:

provisionDigitalInputPin in interface GpioController

provisionDigitalInputPin

public GpioPinDigitalInput provisionDigitalInputPin(Pin pin,
                                                    PinPullResistance resistance)

Specified by:

provisionDigitalInputPin in interface GpioController

provisionDigitalOutputPin

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

Specified by:

provisionDigitalOutputPin in interface GpioController

provisionDigitalOutputPin

public GpioPinDigitalOutput provisionDigitalOutputPin(GpioProvider provider,
                                                      Pin pin)

Specified by:

provisionDigitalOutputPin in interface GpioController

provisionDigitalOutputPin

public GpioPinDigitalOutput provisionDigitalOutputPin(Pin pin,
                                                      String name)

Specified by:

provisionDigitalOutputPin in interface GpioController

provisionDigitalOutputPin

public GpioPinDigitalOutput provisionDigitalOutputPin(Pin pin)

Specified by:

provisionDigitalOutputPin in interface GpioController

provisionDigitalOutputPin

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

Specified by:

provisionDigitalOutputPin in interface GpioController

provisionDigitalOutputPin

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

Specified by:

provisionDigitalOutputPin in interface GpioController

provisionDigitalOutputPin

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

Specified by:

provisionDigitalOutputPin in interface GpioController

provisionDigitalOutputPin

public GpioPinDigitalOutput provisionDigitalOutputPin(Pin pin,
                                                      PinState defaultState)

Specified by:

provisionDigitalOutputPin in interface GpioController

provisionAnalogInputPin

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

Specified by:

provisionAnalogInputPin in interface GpioController

provisionAnalogInputPin

public GpioPinAnalogInput provisionAnalogInputPin(GpioProvider provider,
                                                  Pin pin)

Specified by:

provisionAnalogInputPin in interface GpioController

provisionAnalogInputPin

public GpioPinAnalogInput provisionAnalogInputPin(Pin pin,
                                                  String name)

Specified by:

provisionAnalogInputPin in interface GpioController

provisionAnalogInputPin

public GpioPinAnalogInput provisionAnalogInputPin(Pin pin)

Specified by:

provisionAnalogInputPin in interface GpioController

provisionAnalogOutputPin

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

Specified by:

provisionAnalogOutputPin in interface GpioController

provisionAnalogOutputPin

public GpioPinAnalogOutput provisionAnalogOutputPin(GpioProvider provider,
                                                    Pin pin)

Specified by:

provisionAnalogOutputPin in interface GpioController

provisionAnalogOutputPin

public GpioPinAnalogOutput provisionAnalogOutputPin(Pin pin,
                                                    String name)

Specified by:

provisionAnalogOutputPin in interface GpioController

provisionAnalogOutputPin

public GpioPinAnalogOutput provisionAnalogOutputPin(Pin pin)

Specified by:

provisionAnalogOutputPin in interface GpioController

provisionAnalogOutputPin

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

Specified by:

provisionAnalogOutputPin in interface GpioController

provisionAnalogOutputPin

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

Specified by:

provisionAnalogOutputPin in interface GpioController

provisionAnalogOutputPin

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

Specified by:

provisionAnalogOutputPin in interface GpioController

provisionAnalogOutputPin

public GpioPinAnalogOutput provisionAnalogOutputPin(Pin pin,
                                                    double defaultValue)

Specified by:

provisionAnalogOutputPin in interface GpioController

provisionPwmOutputPin

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

Specified by:

provisionPwmOutputPin in interface GpioController

provisionPwmOutputPin

public GpioPinPwmOutput provisionPwmOutputPin(GpioProvider provider,
                                              Pin pin)

Specified by:

provisionPwmOutputPin in interface GpioController

provisionPwmOutputPin

public GpioPinPwmOutput provisionPwmOutputPin(Pin pin,
                                              String name)

Specified by:

provisionPwmOutputPin in interface GpioController

provisionPwmOutputPin

public GpioPinPwmOutput provisionPwmOutputPin(Pin pin)

Specified by:

provisionPwmOutputPin in interface GpioController

provisionPwmOutputPin

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

Specified by:

provisionPwmOutputPin in interface GpioController

provisionPwmOutputPin

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

Specified by:

provisionPwmOutputPin in interface GpioController

provisionPwmOutputPin

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

Specified by:

provisionPwmOutputPin in interface GpioController

provisionPwmOutputPin

public GpioPinPwmOutput provisionPwmOutputPin(Pin pin,
                                              int defaultValue)

Specified by:

provisionPwmOutputPin in interface GpioController

unprovisionPin

public void unprovisionPin(GpioPin... pin)

Specified by:

unprovisionPin in interface GpioController

setShutdownOptions

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

Specified by:

setShutdownOptions in interface GpioController

setShutdownOptions

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

Specified by:

setShutdownOptions in interface GpioController

setShutdownOptions

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

Specified by:

setShutdownOptions in interface GpioController

setShutdownOptions

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

Specified by:

setShutdownOptions in interface GpioController

setShutdownOptions

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

Specified by:

setShutdownOptions in interface GpioController

isShutdown

public boolean isShutdown()

This method returns TRUE if the GPIO controller has been shutdown.

Specified by:

isShutdown in interface GpioController

Returns:

shutdown state

shutdown

public void shutdown()

This method can be called to forcefully shutdown all GPIO controller monitoring, listening, and task threads/executors.

Specified by:

shutdown in interface GpioController