Package net.solarnetwork.node.control.numato.usbgpio

Enum Class UsbGpioCommand

java.lang.Object

java.lang.Enum<UsbGpioCommand>

net.solarnetwork.node.control.numato.usbgpio.UsbGpioCommand

All Implemented Interfaces:

Serializable, Comparable<UsbGpioCommand>, Constable

public enum UsbGpioCommand
extends Enum<UsbGpioCommand>

A USB GPIO serial command verb.

Version:

1.0

Author:

matt

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AdcRead	Read analog input value as value in the range 0 - 1023.
GpioClear	Clear a GPIO.
GpioIoDirection	Set all GPIO directions as input (1) or output (0) via hex-encoded bitmask.
GpioIoMask	Set the GPIO mask for future writeall or iodir commands.
GpioRead	Clear a GPIO.
GpioReadAll	Read all GPIO values as a hex-encoded bitmask (the iodir command must be sent prior).
GpioSet	Clear a GPIO.
GpioWriteAll	Write all GPIO values as a hex-encoded bitmask (the iodir command must be sent prior).
IdGet	Get the user-configurable 8-character ID.
IdSet	Set the user-configurable 8-character ID.
Version	Get the version firmware.

Method Summary

Modifier and Type	Method	Description
String	getCommand()	Get the command text value.
static UsbGpioCommand	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UsbGpioCommand[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Version

public static final UsbGpioCommand Version

Get the version firmware.

IdGet

public static final UsbGpioCommand IdGet

Get the user-configurable 8-character ID.

IdSet

public static final UsbGpioCommand IdSet

Set the user-configurable 8-character ID.

GpioClear

public static final UsbGpioCommand GpioClear

Clear a GPIO.

GpioRead

public static final UsbGpioCommand GpioRead

Clear a GPIO.

GpioSet

public static final UsbGpioCommand GpioSet

Clear a GPIO.

GpioIoMask

public static final UsbGpioCommand GpioIoMask

Set the GPIO mask for future writeall or iodir commands.

GpioIoDirection

public static final UsbGpioCommand GpioIoDirection

Set all GPIO directions as input (1) or output (0) via hex-encoded bitmask.

GpioReadAll

public static final UsbGpioCommand GpioReadAll

Read all GPIO values as a hex-encoded bitmask (the iodir command must be sent prior).

GpioWriteAll

public static final UsbGpioCommand GpioWriteAll

Write all GPIO values as a hex-encoded bitmask (the iodir command must be sent prior).

AdcRead

public static final UsbGpioCommand AdcRead

Read analog input value as value in the range 0 - 1023.

Method Details

values

public static UsbGpioCommand[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static UsbGpioCommand valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getCommand

public String getCommand()

Get the command text value.

Returns:

the command text value