com.digi.xbee.api.packet.thread

Class IPv6RemoteATCommandResponsePacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

public class IPv6RemoteATCommandResponsePacket
extends XBeeAPIPacket

This class represents an IPv6 Remote AT Command Response packet. Packet is built using the parameters of the constructor.

If a module receives a remote command response RF data frame in response to an IPv6 Remote AT Command Request, the module will send an IPv6 Remote AT Command Response message out the UART.

Remote Command options are set as a bitfield.

This packet is received in response of the IPv6 Remote AT Command Request packet. See IPv6RemoteATCommandRequestPacket.

Response also returns a field with its status. See ATCommandStatus.

Since:

1.2.1

See Also:

IPv6RemoteATCommandRequestPacket, XBeeAPIPacket

Field Summary

Fields inherited from class com.digi.xbee.api.packet.XBeeAPIPacket

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
IPv6RemoteATCommandResponsePacket(int frameID, Inet6Address sourceAddress, String command, ATCommandStatus status, byte[] commandValue) Class constructor.
IPv6RemoteATCommandResponsePacket(int frameID, Inet6Address sourceAddress, String command, ATCommandStatus status, String commandValue) Class constructor.

Method Summary

Modifier and Type	Method and Description
static IPv6RemoteATCommandResponsePacket	createPacket(byte[] payload) Creates a new IPv6RemoteATCommandResponsePacket object from the given payload.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
String	getCommand() Returns the AT Command.
byte[]	getCommandValue() Retrieves the AT command response value as byte array.
String	getCommandValueAsString() Returns the AT command response value as String.
Inet6Address	getSourceAddress() Retrieves the source IPv6 address.
ATCommandStatus	getStatus() Returns the AT command response status.
boolean	needsAPIFrameID() Returns whether the API packet needs API Frame ID or not.
void	setCommandValue(byte[] commandValue) Sets the AT command response response value as byte array.
void	setCommandValue(String commandValue) Sets the AT command response value as String.

Methods inherited from class com.digi.xbee.api.packet.XBeeAPIPacket

checkFrameID, getAPIData, getFrameID, getFrameType, getFrameTypeValue, getPacketData, isBroadcast, setFrameID

Methods inherited from class com.digi.xbee.api.packet.XBeePacket

equals, generateByteArray, generateByteArrayEscaped, getChecksum, getPacketLength, getParameters, hashCode, parsePacket, parsePacket, toPrettyString, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IPv6RemoteATCommandResponsePacket

public IPv6RemoteATCommandResponsePacket(int frameID,
                                         Inet6Address sourceAddress,
                                         String command,
                                         ATCommandStatus status,
                                         byte[] commandValue)

Class constructor. Instantiates a new IPv6RemoteATCommandResponsePacket object with the given parameters.

Parameters:

frameID - The Frame ID.

sourceAddress - IPv6 address of the source device.

command - AT command.

status - The command status.

commandValue - The AT command response value.

Throws:

IllegalArgumentException - if frameID < 0 or if frameID > 255.

NullPointerException - if sourceAddress == null or if command == null or if status == null.

See Also:

Inet6Address, ATCommandStatus

IPv6RemoteATCommandResponsePacket

public IPv6RemoteATCommandResponsePacket(int frameID,
                                         Inet6Address sourceAddress,
                                         String command,
                                         ATCommandStatus status,
                                         String commandValue)

Class constructor. Instantiates a new IPv6RemoteATCommandResponsePacket object with the given parameters.

Parameters:

frameID - The Frame ID.

sourceAddress - IPv6 address of the source device.

command - AT command.

status - The command status.

commandValue - The AT command response value as String.

Throws:

IllegalArgumentException - if frameID < 0 or if frameID > 255.

NullPointerException - if sourceAddress == null or if command == null or if status == null.

See Also:

Inet6Address, ATCommandStatus

Method Detail

createPacket

public static IPv6RemoteATCommandResponsePacket createPacket(byte[] payload)

Creates a new IPv6RemoteATCommandResponsePacket object from the given payload.

Parameters:

payload - The API frame payload. It must start with the frame type corresponding to an IPv6 Remote AT Command response packet (0x9B). The byte array must be in OperatingMode.API mode.

Returns:

Parsed IPv6 Remote AT Command Response packet.

Throws:

IllegalArgumentException - if payload[0] != APIFrameType.IPV6_REMOTE_AT_COMMAND_RESPONSE.getValue() or if payload.length < or

NullPointerException - if payload == null.

getAPIPacketParameters

public LinkedHashMap<String,String> getAPIPacketParameters()

Description copied from class: XBeeAPIPacket

Returns a map with the XBee packet parameters and their values.

Returns:

A sorted map containing the XBee packet parameters with their values.

getCommand

public String getCommand()

Returns the AT Command.

Returns:

The AT Command.

getCommandValue

public byte[] getCommandValue()

Retrieves the AT command response value as byte array.

Returns:

The AT command response value as byte array.

See Also:

getCommandValueAsString(), setCommandValue(String commandValue), setCommandValue(byte[] commandValue)

getCommandValueAsString

public String getCommandValueAsString()

Returns the AT command response value as String.

Returns:

The AT command response value as String, null if no value is set.

See Also:

getCommandValue(), setCommandValue(String commandValue), setCommandValue(byte[] commandValue)

getSourceAddress

public Inet6Address getSourceAddress()

Retrieves the source IPv6 address.

Returns:

The source IPv6 address.

See Also:

Inet6Address

getStatus

public ATCommandStatus getStatus()

Returns the AT command response status.

Returns:

The AT command response status.

See Also:

ATCommandStatus

needsAPIFrameID

public boolean needsAPIFrameID()

Description copied from class: XBeeAPIPacket

Returns whether the API packet needs API Frame ID or not.

Specified by:

needsAPIFrameID in class XBeeAPIPacket

Returns:

true if the packet needs API Frame ID, false otherwise.

setCommandValue

public void setCommandValue(byte[] commandValue)

Sets the AT command response response value as byte array.

Parameters:

commandValue - The AT command response value as byte array.

See Also:

getCommandValue(), getCommandValueAsString()

setCommandValue

public void setCommandValue(String commandValue)

Sets the AT command response value as String.

Parameters:

commandValue - The AT command response value as String.

See Also:

getCommandValue(), getCommandValueAsString()