ej.hal.gpio

Class GPIO

java.lang.Object

ej.hal.gpio.GPIO

public class GPIO
extends java.lang.Object

This class configures and drives digital or analog pins. A pin is identified with its port and the pin number of its port. Each port has a unique ID which is implementation specific. Pin numbers are a zero-based indexes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GPIO.Mode Specify the pin mode.

Constructor Summary

Constructors

Constructor and Description
GPIO()

Method Summary

Modifier and Type	Method and Description
static int	getAnalogValue(int port, int pin) Gets the value of the analog pin (a value between 0 and the targeted hardware ADC maximum value). The returned value is undefined when the pin is not configured or configured as digital pin.
static boolean	getDigitalValue(int port, int pin) Gets the value of the digital pin. The returned value is undefined when the pin is not configured or configured as analog pin.
static void	setAnalogValue(int port, int pin, int percentage) Sets a value on the analog pin.
static void	setDigitalValue(int port, int pin, boolean value) Sets a value on the digital pin.
static void	setMode(int port, int pin, GPIO.Mode mode) Configures the pin mode using the enumeration GPIO.Mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

GPIO

public GPIO()

Method Detail

setMode

public static void setMode(int port,
                           int pin,
                           GPIO.Mode mode)

Configures the pin mode using the enumeration GPIO.Mode.

Parameters:

port - port identifier

pin - pin number

mode - pin mode

Throws:

java.lang.IllegalArgumentException - when the combination port / pin is unreachable

java.lang.NullPointerException - when mode is null

getDigitalValue

public static boolean getDigitalValue(int port,
                                      int pin)

Gets the value of the digital pin.
The returned value is undefined when the pin is not configured or configured as analog pin.

Parameters:

port - port identifier

pin - pin number

Returns:

true when the GPIO digital value is currently high.

Throws:

java.lang.IllegalArgumentException - when the combination port / pin is unreachable

setDigitalValue

public static void setDigitalValue(int port,
                                   int pin,
                                   boolean value)

Sets a value on the digital pin.

Parameters:

port - port identifier

pin - pin number

value - digital pin value: true for high, false for low.

Throws:

java.lang.IllegalArgumentException - when the combination port / pin is unreachable

getAnalogValue

public static int getAnalogValue(int port,
                                 int pin)

Gets the value of the analog pin (a value between 0 and the targeted hardware ADC maximum value).
The returned value is undefined when the pin is not configured or configured as digital pin.

Parameters:

port - port identifier

pin - pin number

Returns:

analog pin value.

Throws:

java.lang.IllegalArgumentException - when the combination port / pin is unreachable

setAnalogValue

public static void setAnalogValue(int port,
                                  int pin,
                                  int percentage)

Sets a value on the analog pin. The value is a percentage which defines the duty cycle a DAC or a PWM has to produce.

Parameters:

port - port identifier

pin - pin number

percentage - percentage of analog pin value.

Throws:

java.lang.IllegalArgumentException - when the combination port / pin is unreachable or when the percentage is invalid