GpioPinImpl (Pi4J :: Parent POM 1.2 API)

java.lang.Object
- com.pi4j.io.gpio.impl.GpioPinImpl

All Implemented Interfaces:: GpioPin, GpioPinAnalog, GpioPinAnalogInput, GpioPinAnalogOutput, GpioPinDigital, GpioPinDigitalInput, GpioPinDigitalMultipurpose, GpioPinDigitalOutput, GpioPinInput, GpioPinOutput, GpioPinPwm, GpioPinPwmOutput

public class GpioPinImpl
extends Object
implements GpioPin, GpioPinDigitalInput, GpioPinDigitalOutput, GpioPinDigitalMultipurpose, GpioPinAnalogInput, GpioPinAnalogOutput, GpioPinPwmOutput, GpioPinInput, GpioPinOutput

Field Summary

Fields
Modifier and Type Field and Description

protected int NO_DEBOUCE

Fields
Modifier and Type	Field and Description
`protected int`	`NO_DEBOUCE`

Constructor Summary

Constructors
Constructor and Description

GpioPinImpl(GpioController gpio, GpioProvider provider, Pin pin)

Constructors
Constructor and Description
`GpioPinImpl(GpioController gpio, GpioProvider provider, Pin pin)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(GpioPinListener... listener)`
`void`	`addListener(List<? extends GpioPinListener> listeners)`
`void`	`addTrigger(GpioTrigger... trigger)`
`void`	`addTrigger(List<? extends GpioTrigger> triggers)`
`Future<?>`	`blink(long delay)`
`Future<?>`	`blink(long delay, long duration)`
`Future<?>`	`blink(long delay, long duration, PinState blinkState)`
`Future<?>`	`blink(long delay, long duration, PinState blinkState, TimeUnit timeUnit)`
`Future<?>`	`blink(long delay, long duration, TimeUnit timeUnit)`
`Future<?>`	`blink(long delay, PinState blinkState)`
`Future<?>`	`blink(long delay, PinState blinkState, TimeUnit timeUnit)`
`Future<?>`	`blink(long delay, TimeUnit timeUnit)`
`void`	`clearProperties()`
`void`	`export(PinMode mode)`
`void`	`export(PinMode mode, PinState defaultState)`
`int`	`getDebounce(PinState state)` Gets the configured debounce delay interval (in milliseconds) for the given pin state.
`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()`
`int`	`getPwm()` If this is a hardware PWM pin, the value will be between a range of 0 to 1024.
`GpioPinShutdown`	`getShutdownOptions()`
`PinState`	`getState()`
`Object`	`getTag()`
`Collection<GpioTrigger>`	`getTriggers()`
`double`	`getValue()`
`boolean`	`hasDebounce(PinState state)` Determines if a debounce delay interval has been configured for the given pin state.
`boolean`	`hasListener(GpioPinListener... listener)`
`boolean`	`hasProperty(String key)`
`void`	`high()`
`boolean`	`isExported()`
`boolean`	`isHigh()`
`boolean`	`isLow()`
`boolean`	`isMode(PinMode mode)`
`boolean`	`isPullResistance(PinPullResistance resistance)`
`boolean`	`isState(PinState state)`
`void`	`low()`
`Future<?>`	`pulse(long duration)`
`Future<?>`	`pulse(long duration, boolean blocking)`
`Future<?>`	`pulse(long duration, boolean blocking, Callable<Void> callback)`
`Future<?>`	`pulse(long duration, boolean blocking, Callable<Void> callback, TimeUnit timeUnit)`
`Future<?>`	`pulse(long duration, boolean blocking, TimeUnit timeUnit)`
`Future<?>`	`pulse(long duration, Callable<Void> callback)`
`Future<?>`	`pulse(long duration, Callable<Void> callback, TimeUnit timeUnit)`
`Future<?>`	`pulse(long duration, PinState pulseState)`
`Future<?>`	`pulse(long duration, PinState pulseState, boolean blocking)`
`Future<?>`	`pulse(long duration, PinState pulseState, boolean blocking, Callable<Void> callback)`
`Future<?>`	`pulse(long duration, PinState pulseState, boolean blocking, Callable<Void> callback, TimeUnit timeUnit)`
`Future<?>`	`pulse(long duration, PinState pulseState, boolean blocking, TimeUnit timeUnit)`
`Future<?>`	`pulse(long duration, PinState pulseState, Callable<Void> callback)`
`Future<?>`	`pulse(long duration, PinState pulseState, Callable<Void> callback, TimeUnit timeUnit)`
`Future<?>`	`pulse(long duration, PinState pulseState, TimeUnit timeUnit)`
`Future<?>`	`pulse(long duration, TimeUnit timeUnit)`
`void`	`removeAllListeners()`
`void`	`removeAllTriggers()`
`void`	`removeListener(GpioPinListener... listener)`
`void`	`removeListener(List<? extends GpioPinListener> listeners)`
`void`	`removeProperty(String key)`
`void`	`removeTrigger(GpioTrigger... trigger)`
`void`	`removeTrigger(List<? extends GpioTrigger> triggers)`
`void`	`setDebounce(int debounce)` Sets the debounce delay interval (in milliseconds) for all pin states.
`void`	`setDebounce(int debounce, PinState... state)` Sets the debounce delay interval (in milliseconds) for the specified pin state.
`void`	`setMode(PinMode mode)`
`void`	`setName(String name)`
`void`	`setProperty(String key, String value)`
`void`	`setPullResistance(PinPullResistance resistance)`
`void`	`setPwm(int value)` Set the PWM value/rate to toggle the GPIO pin.
`void`	`setPwmRange(int range)` This sets the range register in the PWM generator.
`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`	`setShutdownOptions(GpioPinShutdown options)`
`void`	`setState(boolean state)`
`void`	`setState(PinState state)`
`void`	`setTag(Object tag)`
`void`	`setValue(double value)`
`void`	`setValue(Number value)`
`void`	`toggle()`
`String`	`toString()`
`void`	`unexport()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NO_DEBOUCE
```
protected final int NO_DEBOUCE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GpioPinImpl
```
public GpioPinImpl(GpioController gpio,
                   GpioProvider provider,
                   Pin pin)
```
- Method Detail
  - getPin
```
public Pin getPin()
```
    Specified by:
    
    getPin in interface GpioPin
  - getProvider
```
public GpioProvider getProvider()
```
    Specified by:
    
    getProvider in interface GpioPin
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface GpioPin
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface GpioPin
  - setTag
```
public void setTag(Object tag)
```
    Specified by:
    
    setTag in interface GpioPin
  - getTag
```
public Object getTag()
```
    Specified by:
    
    getTag in interface GpioPin
  - setProperty
```
public void setProperty(String key,
                        String value)
```
    Specified by:
    
    setProperty in interface GpioPin
  - hasProperty
```
public boolean hasProperty(String key)
```
    Specified by:
    
    hasProperty in interface GpioPin
  - getProperty
```
public String getProperty(String key,
                          String defaultValue)
```
    Specified by:
    
    getProperty in interface GpioPin
  - getProperty
```
public String getProperty(String key)
```
    Specified by:
    
    getProperty in interface GpioPin
  - getProperties
```
public Map<String,String> getProperties()
```
    Specified by:
    
    getProperties in interface GpioPin
  - removeProperty
```
public void removeProperty(String key)
```
    Specified by:
    
    removeProperty in interface GpioPin
  - clearProperties
```
public void clearProperties()
```
    Specified by:
    
    clearProperties in interface GpioPin
  - export
```
public void export(PinMode mode)
```
    Specified by:
    
    export in interface GpioPin
  - export
```
public void export(PinMode mode,
                   PinState defaultState)
```
    Specified by:
    
    export in interface GpioPin
  - unexport
```
public void unexport()
```
    Specified by:
    
    unexport in interface GpioPin
  - isExported
```
public boolean isExported()
```
    Specified by:
    
    isExported in interface GpioPin
  - setMode
```
public void setMode(PinMode mode)
```
    Specified by:
    
    setMode in interface GpioPin
  - getMode
```
public PinMode getMode()
```
    Specified by:
    
    getMode in interface GpioPin
  - isMode
```
public boolean isMode(PinMode mode)
```
    Specified by:
    
    isMode in interface GpioPin
  - setPullResistance
```
public void setPullResistance(PinPullResistance resistance)
```
    Specified by:
    
    setPullResistance in interface GpioPin
  - getPullResistance
```
public PinPullResistance getPullResistance()
```
    Specified by:
    
    getPullResistance in interface GpioPin
  - isPullResistance
```
public boolean isPullResistance(PinPullResistance resistance)
```
    Specified by:
    
    isPullResistance in interface GpioPin
  - high
```
public void high()
```
    Specified by:
    
    high in interface GpioPinDigitalOutput
  - low
```
public void low()
```
    Specified by:
    
    low in interface GpioPinDigitalOutput
  - toggle
```
public void toggle()
```
    Specified by:
    
    toggle in interface GpioPinDigitalOutput
  - blink
```
public Future<?> blink(long delay)
```
    Specified by:
    
    blink in interface GpioPinDigitalOutput
  - blink
```
public Future<?> blink(long delay,
                       TimeUnit timeUnit)
```
    Specified by:
    
    blink in interface GpioPinDigitalOutput
  - blink
```
public Future<?> blink(long delay,
                       PinState blinkState)
```
    Specified by:
    
    blink in interface GpioPinDigitalOutput
  - blink
```
public Future<?> blink(long delay,
                       PinState blinkState,
                       TimeUnit timeUnit)
```
    Specified by:
    
    blink in interface GpioPinDigitalOutput
  - blink
```
public Future<?> blink(long delay,
                       long duration)
```
    Specified by:
    
    blink in interface GpioPinDigitalOutput
  - blink
```
public Future<?> blink(long delay,
                       long duration,
                       TimeUnit timeUnit)
```
    Specified by:
    
    blink in interface GpioPinDigitalOutput
  - blink
```
public Future<?> blink(long delay,
                       long duration,
                       PinState blinkState)
```
    Specified by:
    
    blink in interface GpioPinDigitalOutput
  - blink
```
public Future<?> blink(long delay,
                       long duration,
                       PinState blinkState,
                       TimeUnit timeUnit)
```
    Specified by:
    
    blink in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       TimeUnit timeUnit)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       Callable<Void> callback)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       Callable<Void> callback,
                       TimeUnit timeUnit)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       PinState pulseState)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       PinState pulseState,
                       TimeUnit timeUnit)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       PinState pulseState,
                       Callable<Void> callback)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       PinState pulseState,
                       Callable<Void> callback,
                       TimeUnit timeUnit)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       boolean blocking)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       boolean blocking,
                       TimeUnit timeUnit)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       boolean blocking,
                       Callable<Void> callback)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       boolean blocking,
                       Callable<Void> callback,
                       TimeUnit timeUnit)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       PinState pulseState,
                       boolean blocking)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       PinState pulseState,
                       boolean blocking,
                       TimeUnit timeUnit)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       PinState pulseState,
                       boolean blocking,
                       Callable<Void> callback,
                       TimeUnit timeUnit)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - pulse
```
public Future<?> pulse(long duration,
                       PinState pulseState,
                       boolean blocking,
                       Callable<Void> callback)
```
    Specified by:
    
    pulse in interface GpioPinDigitalOutput
  - setState
```
public void setState(PinState state)
```
    Specified by:
    
    setState in interface GpioPinDigitalOutput
  - setState
```
public void setState(boolean state)
```
    Specified by:
    
    setState in interface GpioPinDigitalOutput
  - isHigh
```
public boolean isHigh()
```
    Specified by:
    
    isHigh in interface GpioPinDigital
  - isLow
```
public boolean isLow()
```
    Specified by:
    
    isLow in interface GpioPinDigital
  - getState
```
public PinState getState()
```
    Specified by:
    
    getState in interface GpioPinDigital
  - isState
```
public boolean isState(PinState state)
```
    Specified by:
    
    isState in interface GpioPinDigital
  - hasDebounce
```
public boolean hasDebounce(PinState state)
```
    Description copied from interface: GpioPinDigitalInput
    
    Determines if a debounce delay interval has been configured for the given pin state.
    
    Specified by:
    
    hasDebounce in interface GpioPinDigitalInput
    
    Parameters:
    
    state - the pin state to test for debounce delay.
    
    Returns:
    
    'true' if the specified ping state has been configured with a debounce delay; else return 'false'.
  - getDebounce
```
public int getDebounce(PinState state)
```
    Description copied from interface: GpioPinDigitalInput
    
    Gets the configured debounce delay interval (in milliseconds) for the given pin state.
    
    Specified by:
    
    getDebounce in interface GpioPinDigitalInput
    
    Parameters:
    
    state - the pin state to get the configured debounce delay interval.
    
    Returns:
    
    the debounce delay interval (in milliseconds) for the specified pin state.
  - setDebounce
```
public void setDebounce(int debounce,
                        PinState... state)
```
    Description copied from interface: GpioPinDigitalInput
    
    Sets the debounce delay interval (in milliseconds) for the specified pin state.
    
    Specified by:
    
    setDebounce in interface GpioPinDigitalInput
    
    Parameters:
    
    debounce - The debounce delay interval in milliseconds.
    
    state - The pin states to apply the debounce delay interval to.
  - setDebounce
```
public void setDebounce(int debounce)
```
    Description copied from interface: GpioPinDigitalInput
    
    Sets the debounce delay interval (in milliseconds) for all pin states.
    
    Specified by:
    
    setDebounce in interface GpioPinDigitalInput
    
    Parameters:
    
    debounce - The debounce delay interval in milliseconds.
  - setValue
```
public void setValue(double value)
```
    Specified by:
    
    setValue in interface GpioPinAnalogOutput
  - setValue
```
public void setValue(Number value)
```
    Specified by:
    
    setValue in interface GpioPinAnalogOutput
  - getValue
```
public double getValue()
```
    Specified by:
    
    getValue in interface GpioPinAnalog
  - setPwm
```
public void setPwm(int value)
```
    Description copied from interface: GpioPinPwmOutput
    
    Set the PWM value/rate to toggle the GPIO pin. If this is a hardware PWM pin, the value should be between a range of 0 to 1024. If this is a software emulated PWM pin, the value should be between a range of 0 to 100.
    
    Specified by:
    
    setPwm in interface GpioPinPwmOutput
  - setPwmRange
```
public void setPwmRange(int range)
```
    Description copied from interface: GpioPinPwmOutput
    
    This sets the range register in the PWM generator. The default is 1024 for hardware PWM. The default is 100 for software emulated PWM.
    
    Specified by:
    
    setPwmRange in interface GpioPinPwmOutput
  - getPwm
```
public int getPwm()
```
    Description copied from interface: GpioPinPwm
    
    If this is a hardware PWM pin, the value will be between a range of 0 to 1024. If this is a software emulated PWM pin, the value will be between a range of 0 to 100.
    
    Specified by:
    
    getPwm in interface GpioPinPwm
    
    Returns:
    
    the value currently set for the PWM output
  - addListener
```
public void addListener(GpioPinListener... listener)
```
    Specified by:
    
    addListener in interface GpioPin
    
    Specified by:
    
    addListener in interface GpioPinAnalogInput
    
    Parameters:
    
    listener - gpio pin listener interface
  - addListener
```
public void addListener(List<? extends GpioPinListener> listeners)
```
    Specified by:
    
    addListener in interface GpioPin
    
    Specified by:
    
    addListener in interface GpioPinAnalogInput
  - getListeners
```
public Collection<GpioPinListener> getListeners()
```
    Specified by:
    
    getListeners in interface GpioPin
    
    Specified by:
    
    getListeners in interface GpioPinAnalogInput
  - hasListener
```
public boolean hasListener(GpioPinListener... listener)
```
    Specified by:
    
    hasListener in interface GpioPin
    
    Specified by:
    
    hasListener in interface GpioPinAnalogInput
  - removeListener
```
public void removeListener(GpioPinListener... listener)
```
    Specified by:
    
    removeListener in interface GpioPin
    
    Specified by:
    
    removeListener in interface GpioPinAnalogInput
  - removeListener
```
public void removeListener(List<? extends GpioPinListener> listeners)
```
    Specified by:
    
    removeListener in interface GpioPin
    
    Specified by:
    
    removeListener in interface GpioPinAnalogInput
  - removeAllListeners
```
public void removeAllListeners()
```
    Specified by:
    
    removeAllListeners in interface GpioPin
    
    Specified by:
    
    removeAllListeners in interface GpioPinAnalogInput
  - getTriggers
```
public Collection<GpioTrigger> getTriggers()
```
    Specified by:
    
    getTriggers in interface GpioPinAnalogInput
    
    Specified by:
    
    getTriggers in interface GpioPinInput
  - addTrigger
```
public void addTrigger(GpioTrigger... trigger)
```
    Specified by:
    
    addTrigger in interface GpioPinAnalogInput
    
    Specified by:
    
    addTrigger in interface GpioPinInput
  - addTrigger
```
public void addTrigger(List<? extends GpioTrigger> triggers)
```
    Specified by:
    
    addTrigger in interface GpioPinAnalogInput
    
    Specified by:
    
    addTrigger in interface GpioPinInput
  - removeTrigger
```
public void removeTrigger(GpioTrigger... trigger)
```
    Specified by:
    
    removeTrigger in interface GpioPinAnalogInput
    
    Specified by:
    
    removeTrigger in interface GpioPinInput
    
    Parameters:
    
    trigger - GPIO trigger interface
  - removeTrigger
```
public void removeTrigger(List<? extends GpioTrigger> triggers)
```
    Specified by:
    
    removeTrigger in interface GpioPinAnalogInput
    
    Specified by:
    
    removeTrigger in interface GpioPinInput
  - removeAllTriggers
```
public void removeAllTriggers()
```
    Specified by:
    
    removeAllTriggers in interface GpioPinAnalogInput
    
    Specified by:
    
    removeAllTriggers in interface GpioPinInput
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getShutdownOptions
```
public GpioPinShutdown getShutdownOptions()
```
    Specified by:
    
    getShutdownOptions in interface GpioPin
  - setShutdownOptions
```
public void setShutdownOptions(GpioPinShutdown options)
```
    Specified by:
    
    setShutdownOptions in interface GpioPin
  - setShutdownOptions
```
public void setShutdownOptions(Boolean unexport)
```
    Specified by:
    
    setShutdownOptions in interface GpioPin
  - setShutdownOptions
```
public void setShutdownOptions(Boolean unexport,
                               PinState state)
```
    Specified by:
    
    setShutdownOptions in interface GpioPin
  - setShutdownOptions
```
public void setShutdownOptions(Boolean unexport,
                               PinState state,
                               PinPullResistance resistance)
```
    Specified by:
    
    setShutdownOptions in interface GpioPin
  - setShutdownOptions
```
public void setShutdownOptions(Boolean unexport,
                               PinState state,
                               PinPullResistance resistance,
                               PinMode mode)
```
    Specified by:
    
    setShutdownOptions in interface GpioPin

Class GpioPinImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_DEBOUCE

Constructor Detail

GpioPinImpl

Method Detail

getPin

getProvider

setName

getName

setTag

getTag

setProperty

hasProperty

getProperty

getProperty

getProperties

removeProperty

clearProperties

export

export

unexport

isExported

setMode

getMode

isMode

setPullResistance

getPullResistance

isPullResistance

high

low

toggle

blink

blink

blink

blink

blink

blink

blink

blink

pulse

pulse

pulse

pulse

pulse

pulse

pulse

pulse

pulse

pulse

pulse

pulse

pulse

pulse

pulse

pulse

setState

setState

isHigh

isLow

getState

isState

hasDebounce

getDebounce

setDebounce

setDebounce

setValue

setValue

getValue

setPwm

setPwmRange

getPwm

addListener

addListener

getListeners

hasListener