com.cinterion.io

Class OutPort

java.lang.Object

com.cinterion.io.OutPort

public class OutPort
extends Object

The OutPort class supports the access and configuration of a port of output pins of the general purpose IO driver (GPIO). The usage of all GPIO ports is restricted to the same interface where the GPIO driver was opened. The parallel access of the GPIO driver by Java and another interface (i.e. AT commnad interface) is not supported. When the module starts up, all GPIO pins are set to high-impedance state after initializing. Therefore, it is recommended to connect pull-up or pull-down resistors to all GPIO pins you want to use as output. This is necessary to keep these pins from floating or driving any external devices before all settings are done by the output port constructor and after release the output port again.

Constructor Summary

Constructors

Constructor and Description
OutPort(Vector<String> pins, Vector<Integer> values) Creates a new instance of a GPIO port of output pins.

Method Summary

Modifier and Type	Method and Description
Vector<String>	getPins() Gets the given pin configuration of an instance of a GPIO port of output pins.
int	getValue() Gets the current value of an instance of a GPIO port of output pins.
void	release() Releases an instance of a GPIO port of output pins.
void	setValue(int portValue) Sets the current value of an instance of a GPIO port of output pins.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutPort

public OutPort(Vector<String> pins,
               Vector<Integer> values)
        throws IOException

Creates a new instance of a GPIO port of output pins.

Parameters:

pins - pin configuration of port. First pin in vector is the LSB.

values - values of pins. First value is value of the LSB.

Throws:

IOException - on failure.

Method Detail

getPins

public Vector<String> getPins()

Gets the given pin configuration of an instance of a GPIO port of output pins.

Returns:

the pin configuration

getValue

public int getValue()
             throws IOException

Gets the current value of an instance of a GPIO port of output pins. Getting the state of a port whose width is less than 10 bits, the bits of the returned value that are more significant than the MSB of the port are set to zero.

Returns:

the current port value.

Throws:

IOException - on failure.

release

public void release()
             throws IOException

Releases an instance of a GPIO port of output pins. The pins of the port are closed as well and can be added to a new port.

Throws:

IOException - on failure.

setValue

public void setValue(int portValue)
              throws IOException

Sets the current value of an instance of a GPIO port of output pins.

Parameters:

portValue - The new value of the input port.

Throws:

IOException - on failure.