com.pi4j.io.gpio

Class OdroidGpioProvider

java.lang.Object

com.pi4j.io.gpio.GpioProviderBase

com.pi4j.io.gpio.WiringPiGpioProviderBase

com.pi4j.io.gpio.OdroidGpioProvider

All Implemented Interfaces:

GpioProvider, AnalogInputListener, GpioInterruptListener, EventListener

public class OdroidGpioProvider
extends WiringPiGpioProviderBase
implements GpioProvider, GpioInterruptListener, AnalogInputListener

Odroid-C1/C1+/XU4 GpioProvider implementation.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	AIN_ADDRESS_OFFSET
protected static double	analogInputListenerChangeThreshold
protected static int	analogInputPollingRate
static double	DEFAULT_ANALOG_INPUT_LISTENER_CHANGE_THRESHOLD
static int	DEFAULT_ANALOG_INPUT_POLLING_RATE
static String	NAME

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

MAX_PIN_CACHE, pinModeCache, pinSupportedCache

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

cache, DEFAULT_CACHE_SIZE, isshutdown, listeners

Constructor Summary

Constructors

Constructor and Description
OdroidGpioProvider() Default Constructor

Method Summary

Modifier and Type	Method and Description
void	export(Pin pin, PinMode mode, PinState defaultState)
static double	getAnalogInputListenerChangeThreshold() Get the analog input listener change value threshold.
static int	getAnalogInputPollingRate() Get the analog input monitor polling rate in milliseconds.
String	getName()
double	getValue(Pin pin)
boolean	isExported(Pin pin)
void	pinValueChange(AnalogInputEvent event)
static void	setAnalogInputListenerChangeThreshold(double threshold) Set the analog input listener change value threshold.
static void	setAnalogInputPollingRate(int milliseconds) Set the analog input monitor polling rate in milliseconds.
void	setMode(Pin pin, PinMode mode)
void	unexport(Pin pin)
protected void	updateInterruptListener(Pin pin)

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

addListener, export, getMode, getPwm, getState, hasPin, pinStateChange, removeListener, setPullResistance, setPwm, setPwmRange, setState, setValue

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

dispatchPinAnalogValueChangeEvent, dispatchPinDigitalStateChangeEvent, getPinCache, getPullResistance, isShutdown, removeAllListeners, shutdown

Methods inherited from class java.lang.Object

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

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

addListener, export, getMode, getPullResistance, getPwm, getState, hasPin, isShutdown, removeAllListeners, removeListener, setPullResistance, setPwm, setPwmRange, setState, setValue, shutdown

Methods inherited from interface com.pi4j.wiringpi.GpioInterruptListener

pinStateChange

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

AIN_ADDRESS_OFFSET

public static final int AIN_ADDRESS_OFFSET

See Also:

Constant Field Values

DEFAULT_ANALOG_INPUT_POLLING_RATE

public static final int DEFAULT_ANALOG_INPUT_POLLING_RATE

See Also:

Constant Field Values

DEFAULT_ANALOG_INPUT_LISTENER_CHANGE_THRESHOLD

public static final double DEFAULT_ANALOG_INPUT_LISTENER_CHANGE_THRESHOLD

See Also:

Constant Field Values

analogInputPollingRate

protected static int analogInputPollingRate

analogInputListenerChangeThreshold

protected static double analogInputListenerChangeThreshold

Constructor Detail

OdroidGpioProvider

public OdroidGpioProvider()

Default Constructor

Method Detail

getAnalogInputPollingRate

public static int getAnalogInputPollingRate()

Get the analog input monitor polling rate in milliseconds. This is the rate at which the internal analog input monitoring thread will poll for analog input value changes and dispatch analog input value change event for subscribed analog input listeners. (The DEFAULT polling rate is 50 milliseconds)

Returns:

polling rate in milliseconds

getAnalogInputListenerChangeThreshold

public static double getAnalogInputListenerChangeThreshold()

Get the analog input listener change value threshold. This is the threshold delta value that the internal analog input monitoring thread must cross before dispatching a new analog input value change event. The analog input value must change in excess of this defined value from the last event dispatched before dispatching a new analog input value change event. NOTE: This threshold value is a valuable tool to filter/limit the analog input value change events that your program may receive. (The DEFAULT change threshold value is 0)

Returns:

change threshold value (delta)

setAnalogInputPollingRate

public static void setAnalogInputPollingRate(int milliseconds)

Set the analog input monitor polling rate in milliseconds. This is the rate at which the internal analog input monitoring thread will poll for analog input value changes and dispatch analog input value change event for subscribed analog input listeners. NOTE: Be aware that lower polling rates can impact/increase the CPU usage for your application. (The DEFAULT polling rate is 50 milliseconds)

Parameters:

milliseconds - polling rate in milliseconds; this value must be a positive number else a default polling rate is used

setAnalogInputListenerChangeThreshold

public static void setAnalogInputListenerChangeThreshold(double threshold)

Set the analog input listener change value threshold. This is the threshold delta value that the internal analog input monitoring thread must cross before dispatching a new analog input value change event. The analog input value must change in excess of this defined value from the last event dispatched before dispatching a new analog input value change event. NOTE: This threshold value is a valuable tool to filter/limit the analog input value change events that your program may receive. (The DEFAULT change threshold value is 0)

Parameters:

threshold - change threshold value; this value must be zero or greater. If the threshold value is set to zero, then any change in value will dispatch a new analog input value event.

getName

public String getName()

Specified by:

getName in interface GpioProvider

Specified by:

getName in class WiringPiGpioProviderBase

export

public void export(Pin pin,
                   PinMode mode,
                   PinState defaultState)

Specified by:

export in interface GpioProvider

Overrides:

export in class WiringPiGpioProviderBase

isExported

public boolean isExported(Pin pin)

Specified by:

isExported in interface GpioProvider

Overrides:

isExported in class WiringPiGpioProviderBase

unexport

public void unexport(Pin pin)

Specified by:

unexport in interface GpioProvider

Overrides:

unexport in class WiringPiGpioProviderBase

setMode

public void setMode(Pin pin,
                    PinMode mode)

Specified by:

setMode in interface GpioProvider

Overrides:

setMode in class WiringPiGpioProviderBase

getValue

public double getValue(Pin pin)

Specified by:

getValue in interface GpioProvider

Overrides:

getValue in class WiringPiGpioProviderBase

pinValueChange

public void pinValueChange(AnalogInputEvent event)

Specified by:

pinValueChange in interface AnalogInputListener

updateInterruptListener

protected void updateInterruptListener(Pin pin)

Overrides:

updateInterruptListener in class WiringPiGpioProviderBase