com.digi.xbee.api.packet.devicecloud

Class DeviceResponsePacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.devicecloud.DeviceResponsePacket

public class DeviceResponsePacket
extends XBeeAPIPacket

This class represents a Device Response packet. Packet is built using the parameters of the constructor or providing a valid API payload.

This frame type is sent to the serial port by the host in response to the DeviceRequestPacket. It should be sent within five seconds to avoid a timeout error.

Since:

1.2.0

See Also:

DeviceRequestPacket, XBeeAPIPacket

Field Summary

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

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
DeviceResponsePacket(int frameID, int requestID, byte[] responseData) Class constructor.

Method Summary

Modifier and Type	Method and Description
static DeviceResponsePacket	createPacket(byte[] payload) Creates a new DeviceResponsePacket object from the given payload.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
int	getRequestID() Retrieves the ID of the device response.
byte[]	getResponseData() Retrieves the data of the device response.
boolean	isBroadcast() Returns whether or not the packet is a broadcast packet.
boolean	needsAPIFrameID() Returns whether the API packet needs API Frame ID or not.
void	setRequestID(int requestID) Sets ID of the device response.
void	setResponseData(byte[] responseData) Sets the data of the device response.

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

checkFrameID, getAPIData, getFrameID, getFrameType, getFrameTypeValue, getPacketData, 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

DeviceResponsePacket

public DeviceResponsePacket(int frameID,
                            int requestID,
                            byte[] responseData)

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

Parameters:

frameID - Frame ID.

requestID - Device Request ID. This number should match the device request ID in the device request. Otherwise, an error will occur. (0 has no special meaning in this case.)

responseData - Data of the response.

Throws:

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

Method Detail

createPacket

public static DeviceResponsePacket createPacket(byte[] payload)

Creates a new DeviceResponsePacket object from the given payload.

Parameters:

payload - The API frame payload. It must start with the frame type corresponding to a Device Response packet (0x2A). The byte array must be in OperatingMode.API mode.

Returns:

Parsed Device Response packet.

Throws:

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

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.

getRequestID

public int getRequestID()

Retrieves the ID of the device response.

Returns:

The ID of the device response.

See Also:

setRequestID(int)

getResponseData

public byte[] getResponseData()

Retrieves the data of the device response.

Returns:

The data of the device response.

See Also:

setResponseData(byte[])

isBroadcast

public boolean isBroadcast()

Description copied from class: XBeeAPIPacket

Returns whether or not the packet is a broadcast packet.

Specified by:

isBroadcast in class XBeeAPIPacket

Returns:

true if the packet is a broadcast packet, false otherwise.

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.

setRequestID

public void setRequestID(int requestID)

Sets ID of the device response.

Parameters:

requestID - ID of the device response.

Throws:

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

See Also:

getRequestID()

setResponseData

public void setResponseData(byte[] responseData)

Sets the data of the device response.

Parameters:

responseData - Data of the device response.

See Also:

getResponseData()