com.digi.xbee.api.packet.devicecloud

Class SendDataResponsePacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.devicecloud.SendDataResponsePacket

public class SendDataResponsePacket
extends XBeeAPIPacket

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

This frame type is sent out the serial port in response to the SendDataRequestPacket, providing its frame ID is non-zero.

Since:

1.2.0

See Also:

SendDataRequestPacket, XBeeAPIPacket

Field Summary

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

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
SendDataResponsePacket(int frameID, DeviceCloudStatus status) Class constructor.

Method Summary

Modifier and Type	Method and Description
static SendDataResponsePacket	createPacket(byte[] payload) Creates a new SendDataResponsePacket object from the given payload.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
DeviceCloudStatus	getStatus() Retrieves the file upload status.
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	setStatus(DeviceCloudStatus status) Sets the file upload status.

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

SendDataResponsePacket

public SendDataResponsePacket(int frameID,
                              DeviceCloudStatus status)

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

Parameters:

frameID - Frame ID.

status - Status.

Throws:

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

NullPointerException - if status == null.

See Also:

DeviceCloudStatus

Method Detail

createPacket

public static SendDataResponsePacket createPacket(byte[] payload)

Creates a new SendDataResponsePacket object from the given payload.

Parameters:

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

Returns:

Parsed Send Data Response packet.

Throws:

IllegalArgumentException - if payload[0] != APIFrameType.SEND_DATA_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.

getStatus

public DeviceCloudStatus getStatus()

Retrieves the file upload status.

Returns:

The file upload status.

See Also:

setStatus(DeviceCloudStatus), DeviceCloudStatus

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.

setStatus

public void setStatus(DeviceCloudStatus status)

Sets the file upload status.

Parameters:

status - File upload status.

Throws:

NullPointerException - if status == null.

See Also:

getStatus(), DeviceCloudStatus