processing.io

Class GPIO

Object

GPIO

public class GPIO
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHANGE trigger when level changes
static int	FALLING trigger when level changes from high to low
static int	HIGH
static int	INPUT
static int	INPUT_PULLDOWN
static int	INPUT_PULLUP
static int	LOW
static int	NONE
static int	OUTPUT
static int	RISING trigger when level changes from low to high

Constructor Summary

Constructors

Constructor and Description
GPIO()

Method Summary

Modifier and Type	Method and Description
static void	analogWrite(int pin, int value)
static void	attachInterrupt(int pin, PApplet parent, String method, int mode) Calls a function when the value of an input pin changes
static int	digitalRead(int pin) Returns the value of an input pin
static void	digitalWrite(int pin, boolean value)
static void	digitalWrite(int pin, int value) Sets an output pin to be either high or low
static void	interrupts() Allows interrupts to happen
static void	noInterrupts() Prevents interrupts from happpening
static void	pinMode(int pin, int mode) Configures a pin to act either as input or output
static void	releaseInterrupt(int pin) Stops listening for interrupts on an input pin
static void	releasePin(int pin) Gives ownership of a pin back to the operating system
static void	waitFor(int pin, int mode) Waits for the value of an input pin to change
static void	waitFor(int pin, int mode, int timeout) Waits for the value of an input pin to change This function will throw a RuntimeException in case of a timeout.
static boolean	waitForInterrupt(int pin, int mode, int timeout)

Methods inherited from class Object

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

Field Detail

INPUT

public static final int INPUT

See Also:

Constant Field Values

OUTPUT

public static final int OUTPUT

See Also:

Constant Field Values

INPUT_PULLUP

public static final int INPUT_PULLUP

See Also:

Constant Field Values

INPUT_PULLDOWN

public static final int INPUT_PULLDOWN

See Also:

Constant Field Values

LOW

public static final int LOW

See Also:

Constant Field Values

HIGH

public static final int HIGH

See Also:

Constant Field Values

NONE

public static final int NONE

See Also:

Constant Field Values

CHANGE

public static final int CHANGE

trigger when level changes

See Also:

Constant Field Values

FALLING

public static final int FALLING

trigger when level changes from high to low

See Also:

Constant Field Values

RISING

public static final int RISING

trigger when level changes from low to high

See Also:

Constant Field Values

Constructor Detail

GPIO

public GPIO()

Method Detail

analogWrite

public static void analogWrite(int pin,
                               int value)

attachInterrupt

public static void attachInterrupt(int pin,
                                   PApplet parent,
                                   String method,
                                   int mode)

Calls a function when the value of an input pin changes

Parameters:

pin - GPIO pin

parent - typically use "this"

method - name of sketch method to call

mode - when to call: GPIO.CHANGE, GPIO.FALLING or GPIO.RISING

See Also:

noInterrupts, interrupts, releaseInterrupt

digitalRead

public static int digitalRead(int pin)

Returns the value of an input pin

Parameters:

pin - GPIO pin

Returns:

GPIO.HIGH (1) or GPIO.LOW (0)

See Also:

pinMode, digitalWrite

digitalWrite

public static void digitalWrite(int pin,
                                int value)

Sets an output pin to be either high or low

Parameters:

pin - GPIO pin

value - GPIO.HIGH (1) or GPIO.LOW (0)

See Also:

pinMode, digitalRead

digitalWrite

public static void digitalWrite(int pin,
                                boolean value)

Parameters:

value - true or false

interrupts

public static void interrupts()

Allows interrupts to happen

See Also:

attachInterrupt, noInterrupts, releaseInterrupt

noInterrupts

public static void noInterrupts()

Prevents interrupts from happpening

See Also:

attachInterrupt, interrupts, releaseInterrupt

pinMode

public static void pinMode(int pin,
                           int mode)

Configures a pin to act either as input or output

Parameters:

pin - GPIO pin

mode - GPIO.INPUT, GPIO.INPUT_PULLUP, GPIO.INPUT_PULLDOWN, or GPIO.OUTPUT

See Also:

digitalRead, digitalWrite, releasePin

releaseInterrupt

public static void releaseInterrupt(int pin)

Stops listening for interrupts on an input pin

Parameters:

pin - GPIO pin

See Also:

attachInterrupt, noInterrupts, interrupts

releasePin

public static void releasePin(int pin)

Gives ownership of a pin back to the operating system

Parameters:

pin - GPIO pin

See Also:

pinMode

waitFor

public static void waitFor(int pin,
                           int mode)

Waits for the value of an input pin to change

Parameters:

pin - GPIO pin

mode - what to wait for: GPIO.CHANGE, GPIO.FALLING or GPIO.RISING

waitFor

public static void waitFor(int pin,
                           int mode,
                           int timeout)

Waits for the value of an input pin to change This function will throw a RuntimeException in case of a timeout.

Parameters:

timeout - don't wait more than timeout milliseconds

waitForInterrupt

public static boolean waitForInterrupt(int pin,
                                       int mode,
                                       int timeout)