com.rapplogic.xbee.api
Enum ApiId

java.lang.Object
  extended by java.lang.Enum<ApiId>
      extended by com.rapplogic.xbee.api.ApiId
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ApiId>

public enum ApiId
extends java.lang.Enum<ApiId>


Enum Constant Summary
AT_COMMAND
          API ID: 0x08
AT_COMMAND_QUEUE
          API ID: 0x09
AT_RESPONSE
          API ID: 0x88
ERROR_RESPONSE
          This is returned if an error occurs during packet parsing and does not correspond to a XBee API ID.
MODEM_STATUS_RESPONSE
          API ID: 0x8a
REMOTE_AT_REQUEST
          API ID: 0x17
REMOTE_AT_RESPONSE
          API ID: 0x97
RX_16_IO_RESPONSE
          API ID: 0x83
RX_16_RESPONSE
          API ID: 0x81
RX_64_IO_RESPONSE
          API ID: 0x82
RX_64_RESPONSE
          API ID: 0x80
TX_REQUEST_16
          API ID: 0x1
TX_REQUEST_64
          API ID: 0x0
TX_STATUS_RESPONSE
          API ID: 0x89
UNKNOWN
          Indicates that we've parsed a packet for which we didn't know how to handle the API type.
ZNET_EXPLICIT_RX_RESPONSE
          API ID: 0x91
ZNET_EXPLICIT_TX_REQUEST
          API ID: 0x11
ZNET_IO_NODE_IDENTIFIER_RESPONSE
          API ID: 0x95
ZNET_IO_SAMPLE_RESPONSE
          API ID: 0x92
ZNET_RX_RESPONSE
          API ID: 0x90
ZNET_TX_REQUEST
          API ID: 0x10
ZNET_TX_STATUS_RESPONSE
          API ID: 0x8b
 
Method Summary
static ApiId get(int value)
           
 int getValue()
           
 java.lang.String toString()
           
static ApiId valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ApiId[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

TX_REQUEST_64

public static final ApiId TX_REQUEST_64
API ID: 0x0


TX_REQUEST_16

public static final ApiId TX_REQUEST_16
API ID: 0x1


AT_COMMAND

public static final ApiId AT_COMMAND
API ID: 0x08


AT_COMMAND_QUEUE

public static final ApiId AT_COMMAND_QUEUE
API ID: 0x09


REMOTE_AT_REQUEST

public static final ApiId REMOTE_AT_REQUEST
API ID: 0x17


ZNET_TX_REQUEST

public static final ApiId ZNET_TX_REQUEST
API ID: 0x10


ZNET_EXPLICIT_TX_REQUEST

public static final ApiId ZNET_EXPLICIT_TX_REQUEST
API ID: 0x11


RX_64_RESPONSE

public static final ApiId RX_64_RESPONSE
API ID: 0x80


RX_16_RESPONSE

public static final ApiId RX_16_RESPONSE
API ID: 0x81


RX_64_IO_RESPONSE

public static final ApiId RX_64_IO_RESPONSE
API ID: 0x82


RX_16_IO_RESPONSE

public static final ApiId RX_16_IO_RESPONSE
API ID: 0x83


AT_RESPONSE

public static final ApiId AT_RESPONSE
API ID: 0x88


TX_STATUS_RESPONSE

public static final ApiId TX_STATUS_RESPONSE
API ID: 0x89


MODEM_STATUS_RESPONSE

public static final ApiId MODEM_STATUS_RESPONSE
API ID: 0x8a


ZNET_RX_RESPONSE

public static final ApiId ZNET_RX_RESPONSE
API ID: 0x90


ZNET_EXPLICIT_RX_RESPONSE

public static final ApiId ZNET_EXPLICIT_RX_RESPONSE
API ID: 0x91


ZNET_TX_STATUS_RESPONSE

public static final ApiId ZNET_TX_STATUS_RESPONSE
API ID: 0x8b


REMOTE_AT_RESPONSE

public static final ApiId REMOTE_AT_RESPONSE
API ID: 0x97


ZNET_IO_SAMPLE_RESPONSE

public static final ApiId ZNET_IO_SAMPLE_RESPONSE
API ID: 0x92


ZNET_IO_NODE_IDENTIFIER_RESPONSE

public static final ApiId ZNET_IO_NODE_IDENTIFIER_RESPONSE
API ID: 0x95


UNKNOWN

public static final ApiId UNKNOWN
Indicates that we've parsed a packet for which we didn't know how to handle the API type. This will be parsed into a GenericResponse


ERROR_RESPONSE

public static final ApiId ERROR_RESPONSE
This is returned if an error occurs during packet parsing and does not correspond to a XBee API ID.

Method Detail

values

public static ApiId[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ApiId c : ApiId.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ApiId valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

get

public static ApiId get(int value)

getValue

public int getValue()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Enum<ApiId>