net.solarnetwork.node.control.numato.usbgpio

Class UsbGpioService

java.lang.Object

net.solarnetwork.node.control.numato.usbgpio.UsbGpioService

All Implemented Interfaces:

GpioService

public class UsbGpioService
extends java.lang.Object
implements GpioService

Implementation of the GpioService.

Version:

1.0

Author:

matt

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_GPIO_COUNT The gpioCount property default value.
static long	DEFAULT_LISTEN_WAIT_MS The listenWaitMs property default value.

Constructor Summary

Constructors

Constructor and Description
UsbGpioService(net.solarnetwork.node.io.serial.SerialConnection conn) Constructor.

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 GpioService.configureIoDirection(BitSet) or GpioService.writeAll(BitSet) calls.
java.lang.String	getDeviceVersion() Get the device version information.
int	getGpioCount() Get the GPIO count.
java.lang.String	getId() Get the ID of the device.
long	getListenWaitMs() Get the length of time to wait to read responses after writing a command, in milliseconds.
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	setGpioCount(int gpioCount) Set the GPIO count.
void	setId(java.lang.String id) Set the ID of the device.
void	setListenWaitMs(long listenWaitMs) Set the length of time to wait to read responses after writing a command, in milliseconds.
void	writeAll(java.util.BitSet values) Set the value of all GPIO addresses on enabled/disabled based on a BitSet.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LISTEN_WAIT_MS

public static final long DEFAULT_LISTEN_WAIT_MS

The listenWaitMs property default value.

See Also:

Constant Field Values

DEFAULT_GPIO_COUNT

public static final int DEFAULT_GPIO_COUNT

The gpioCount property default value.

See Also:

Constant Field Values

Constructor Detail

UsbGpioService

public UsbGpioService(net.solarnetwork.node.io.serial.SerialConnection conn)

Constructor.

Parameters:

conn - the serial connection to use

Throws:

java.lang.IllegalArgumentException - if any argument is null

Method Detail

getDeviceVersion

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

Description copied from interface: GpioService

Get the device version information.

Specified by:

getDeviceVersion in interface GpioService

Returns:

the device version

Throws:

java.io.IOException - if a communication error occurs

getId

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

Description copied from interface: GpioService

Get the ID of the device.

Specified by:

getId in interface GpioService

Returns:

the ID, an 8-character string

Throws:

java.io.IOException - if a communication error occurs

setId

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

Description copied from interface: GpioService

Set the ID of the device.

Specified by:

setId in interface GpioService

Parameters:

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

Throws:

java.io.IOException - if a communication error occurs

read

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

Description copied from interface: GpioService

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

Specified by:

read in interface GpioService

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

set

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

Description copied from interface: GpioService

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

Specified by:

set in interface GpioService

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

readAnalog

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

Description copied from interface: GpioService

Get the analog value of the GPIO address.

Specified by:

readAnalog in interface GpioService

Parameters:

address - the address

Returns:

the analog value

Throws:

java.io.IOException - if a communication error occurs

readAll

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

Description copied from interface: GpioService

Read the value of all GPIO addresses.

Specified by:

readAll in interface GpioService

Returns:

the set of enabled GPIO addresses

Throws:

java.io.IOException - if a communication error occurs

writeAll

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

Description copied from interface: GpioService

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

Specified by:

writeAll in interface GpioService

Parameters:

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

Throws:

java.io.IOException - if a communication error occurs

configureWriteMask

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

Description copied from interface: GpioService

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

Specified by:

configureWriteMask in interface GpioService

Parameters:

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

Throws:

java.io.IOException - if a communication error occurs

configureIoDirection

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

Description copied from interface: GpioService

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.

Specified by:

configureIoDirection in interface GpioService

Parameters:

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

Throws:

java.io.IOException - if a communication error occurs

getListenWaitMs

public long getListenWaitMs()

Get the length of time to wait to read responses after writing a command, in milliseconds.

Returns:

the milliseconds to wait, or 0 to not wait at all; defaults to DEFAULT_LISTEN_WAIT_MS

setListenWaitMs

public void setListenWaitMs(long listenWaitMs)

Set the length of time to wait to read responses after writing a command, in milliseconds.

Parameters:

listenWaitMs - the milliseconds to set, or 0 to not wait at all

getGpioCount

public int getGpioCount()

Get the GPIO count.

Returns:

the count; defaults to DEFAULT_GPIO_COUNT

setGpioCount

public void setGpioCount(int gpioCount)

Set the GPIO count.

Parameters:

gpioCount - the gpioCount to set

Throws:

java.lang.IllegalArgumentException - if gpioCount is less than 1