Package com.pi4j.io.gpio

Interface GpioPin

All Known Subinterfaces:

GpioPinAnalog, GpioPinAnalogInput, GpioPinAnalogOutput, GpioPinDigital, GpioPinDigitalInput, GpioPinDigitalMultipurpose, GpioPinDigitalOutput, GpioPinInput, GpioPinOutput, GpioPinPwm, GpioPinPwmOutput

All Known Implementing Classes:

GpioPinImpl

public interface GpioPin

Gpio pin interface. This interface describes all operations over single GPIO pin.

Author:

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

Method Summary

Modifier and Type	Method	Description
void	addListener(GpioPinListener... listener)
void	addListener(List<? extends GpioPinListener> listeners)
void	clearProperties()
void	export(PinMode mode)
void	export(PinMode mode, PinState defaultState)
Collection<GpioPinListener>	getListeners()
PinMode	getMode()
String	getName()
Pin	getPin()
Map<String,String>	getProperties()
String	getProperty(String key)
String	getProperty(String key, String defaultValue)
GpioProvider	getProvider()
PinPullResistance	getPullResistance()
GpioPinShutdown	getShutdownOptions()
Object	getTag()
boolean	hasListener(GpioPinListener... listener)
boolean	hasProperty(String key)
boolean	isExported()
boolean	isMode(PinMode mode)
boolean	isPullResistance(PinPullResistance resistance)
void	removeAllListeners()
void	removeListener(GpioPinListener... listener)
void	removeListener(List<? extends GpioPinListener> listeners)
void	removeProperty(String key)
void	setMode(PinMode mode)
void	setName(String name)
void	setProperty(String key, String value)
void	setPullResistance(PinPullResistance resistance)
void	setShutdownOptions(GpioPinShutdown options)
void	setShutdownOptions(Boolean unexport)
void	setShutdownOptions(Boolean unexport, PinState state)
void	setShutdownOptions(Boolean unexport, PinState state, PinPullResistance resistance)
void	setShutdownOptions(Boolean unexport, PinState state, PinPullResistance resistance, PinMode mode)
void	setTag(Object tag)
void	unexport()

Method Detail

getProvider

GpioProvider getProvider()

getPin

Pin getPin()

setName

void setName(String name)

getName

String getName()

setTag

void setTag(Object tag)

getTag

Object getTag()

setProperty

void setProperty(String key,
                 String value)

hasProperty

boolean hasProperty(String key)

getProperty

String getProperty(String key)

getProperty

String getProperty(String key,
                   String defaultValue)

getProperties

Map<String,String> getProperties()

removeProperty

void removeProperty(String key)

clearProperties

void clearProperties()

export

void export(PinMode mode)

export

void export(PinMode mode,
            PinState defaultState)

unexport

void unexport()

isExported

boolean isExported()

setMode

void setMode(PinMode mode)

getMode

PinMode getMode()

isMode

boolean isMode(PinMode mode)

setPullResistance

void setPullResistance(PinPullResistance resistance)

getPullResistance

PinPullResistance getPullResistance()

isPullResistance

boolean isPullResistance(PinPullResistance resistance)

getListeners

Collection<GpioPinListener> getListeners()

addListener

void addListener(GpioPinListener... listener)

addListener

void addListener(List<? extends GpioPinListener> listeners)

hasListener

boolean hasListener(GpioPinListener... listener)

removeListener

void removeListener(GpioPinListener... listener)

removeListener

void removeListener(List<? extends GpioPinListener> listeners)

removeAllListeners

void removeAllListeners()

getShutdownOptions

GpioPinShutdown getShutdownOptions()

setShutdownOptions

void setShutdownOptions(GpioPinShutdown options)

setShutdownOptions

void setShutdownOptions(Boolean unexport)

setShutdownOptions

void setShutdownOptions(Boolean unexport,
                        PinState state)

setShutdownOptions

void setShutdownOptions(Boolean unexport,
                        PinState state,
                        PinPullResistance resistance)

setShutdownOptions

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