net.solarnetwork.node.control.numato.usbgpio

Interface GpioService

All Known Implementing Classes:

UsbGpioService

public interface GpioService

Service API for manipulating GPIO.

Version:

1.0

Author:

matt

Method Summary

Modifier and Type	Method and Description
void	configureIoDirection(java.util.BitSet set) Configure the GPIO direction of all GPIO addresses.
void	configureWriteMask(java.util.BitSet set) Configure a bitmask to use on future configureIoDirection(BitSet) or writeAll(BitSet) calls.
java.lang.String	getDeviceVersion() Get the device version information.
java.lang.String	getId() Get the ID of the device.
boolean	read(int address) Get the value of the GPIO address as a binary value.
java.util.BitSet	readAll() Read the value of all GPIO addresses.
int	readAnalog(int address) Get the analog value of the GPIO address.
void	set(int address, boolean value) Set the value of the GPIO address as a binary value.
void	setId(java.lang.String id) Set the ID of the device.
void	writeAll(java.util.BitSet values) Set the value of all GPIO addresses on enabled/disabled based on a BitSet.

Method Detail

getDeviceVersion

java.lang.String getDeviceVersion()
                           throws java.io.IOException

Get the device version information.

Returns:

the device version

Throws:

java.io.IOException - if a communication error occurs

getId

java.lang.String getId()
                throws java.io.IOException

Get the ID of the device.

Returns:

the ID, an 8-character string

Throws:

java.io.IOException - if a communication error occurs

setId

void setId(java.lang.String id)
    throws java.io.IOException

Set the ID of the device.

Parameters:

id - the ID to set: an 8-character string

Throws:

java.io.IOException - if a communication error occurs

read

boolean read(int address)
      throws java.io.IOException

Get the value of the GPIO address as a binary value.

Parameters:

address - the address, starting from 0, of the GPIO to get

Returns:

true if the GPIO is on, otherwise false

Throws:

java.io.IOException - if a communication error occurs

readAnalog

int readAnalog(int address)
        throws java.io.IOException

Get the analog value of the GPIO address.

Parameters:

address - the address

Returns:

the analog value

Throws:

java.io.IOException - if a communication error occurs

readAll

java.util.BitSet readAll()
                  throws java.io.IOException

Read the value of all GPIO addresses.

Returns:

the set of enabled GPIO addresses

Throws:

java.io.IOException - if a communication error occurs

set

void set(int address,
         boolean value)
  throws java.io.IOException

Set the value of the GPIO address as a binary value.

Parameters:

address - the address, starting from 0, of the GPIO to get

value - true if the GPIO is on, otherwise false

Throws:

java.io.IOException - if a communication error occurs

writeAll

void writeAll(java.util.BitSet values)
       throws java.io.IOException

Set the value of all GPIO addresses on enabled/disabled based on a BitSet.

Parameters:

values - the value to set, with bit positions representing GPIO addresses

Throws:

java.io.IOException - if a communication error occurs

configureWriteMask

void configureWriteMask(java.util.BitSet set)
                 throws java.io.IOException

Configure a bitmask to use on future configureIoDirection(BitSet) or writeAll(BitSet) calls.

Parameters:

set - the GPIO addresses to enable for future operations, using bit positions

Throws:

java.io.IOException - if a communication error occurs

configureIoDirection

void configureIoDirection(java.util.BitSet set)
                   throws java.io.IOException

Configure the GPIO direction of all GPIO addresses.

If a bit is enabled that means the coreponsing GPIO address should be configured as the input direction, otherwise as output.

Parameters:

set - the GPIO addresses to configure as input, using bit positions

Throws:

java.io.IOException - if a communication error occurs