Package com.digi.android.gpio

Class GPIOManager

java.lang.Object

com.digi.android.gpio.GPIOManager

public class GPIOManager
extends java.lang.Object

This class provides access to GPIOs.

This manager allows applications to create GPIO objects.

Unless noted, all GPIO API methods require the com.digi.android.permission.GPIO permission. If your application does not have this permission it will not have access to any GPIO service feature.

See Also:

GPIO

Constructor Summary

Constructors

Constructor	Description
GPIOManager(android.content.Context context)	Class constructor.

Method Summary

Modifier and Type	Method	Description
GPIO	createGPIO(int portIndex, int pinIndex, GPIOMode mode)	Creates and returns a new object of type GPIO with the given GPIO port number, pin offset, and desired working mode.
GPIO	createGPIO(int kernelNumber, GPIOMode mode)	Creates and returns a GPIO object with the given kernel GPIO number and desired working mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

GPIOManager

public GPIOManager(android.content.Context context)

Class constructor.

Instantiates a new GPIOManager for the given application.

Parameters:

context - Context of the application.

Method Detail

createGPIO

public GPIO createGPIO(int kernelNumber,
                       GPIOMode mode)
                throws GPIOException

Creates and returns a GPIO object with the given kernel GPIO number and desired working mode.

Parameters:

kernelNumber - Kernel number of the GPIO to be created.

mode - The desired GPIO working mode.

Returns:

The GPIO created with the desired mode.

Throws:

GPIOException - If there is an error creating the GPIO.

java.lang.IllegalArgumentException - If kernelNumber < 0.

java.lang.NullPointerException - If mode == null.

See Also:

GPIO, GPIOMode.INPUT, GPIOMode.INTERRUPT_EDGE_BOTH, GPIOMode.INTERRUPT_EDGE_FALLING, GPIOMode.INTERRUPT_EDGE_RISING, GPIOMode.OUTPUT_HIGH, GPIOMode.OUTPUT_LOW

createGPIO

public GPIO createGPIO(int portIndex,
                       int pinIndex,
                       GPIOMode mode)
                throws GPIOException

Creates and returns a new object of type GPIO with the given GPIO port number, pin offset, and desired working mode.

Parameters:

portIndex - GPIO base port index.

pinIndex - GPIO pin index.

mode - The desired GPIO working mode.

Returns:

The GPIO created with the desired mode.

Throws:

GPIOException - If there is an error creating the GPIO.

java.lang.IllegalArgumentException - If portIndex < 0 or if pinIndex < 0.

java.lang.NullPointerException - If mode == null.

See Also:

GPIO, GPIOMode.INPUT, GPIOMode.INTERRUPT_EDGE_BOTH, GPIOMode.INTERRUPT_EDGE_FALLING, GPIOMode.INTERRUPT_EDGE_RISING, GPIOMode.OUTPUT_HIGH, GPIOMode.OUTPUT_LOW