com.digi.xbee.api.packet.devicecloud

Class DeviceRequestPacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.devicecloud.DeviceRequestPacket

public class DeviceRequestPacket
extends XBeeAPIPacket

This class represents a Device Request 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 when the XBee module receives a valid device request from Device Cloud.

Since:

1.2.0

See Also:

DeviceResponsePacket, XBeeAPIPacket

Field Summary

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

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
DeviceRequestPacket(int requestID, String target, byte[] requestData) Class constructor.

Method Summary

Modifier and Type	Method and Description
static DeviceRequestPacket	createPacket(byte[] payload) Creates a new DeviceRequestPacket object from the given payload.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
int	getFlags() Retrieves the flags.
byte[]	getRequestData() Retrieves the data of the device request.
int	getRequestID() Retrieves the ID of the device request.
String	getRequestTarget() Retrieves the device request target.
int	getTransport() Retrieves the transport.
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	setRequestData(byte[] requestData) Sets the data of the device request.
void	setRequestID(int requestID) Sets ID of the device request.
void	setRequestTarget(String target) Sets the device request target.

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

DeviceRequestPacket

public DeviceRequestPacket(int requestID,
                           String target,
                           byte[] requestData)

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

Parameters:

requestID - Identifies the device request. (0 has no special meaning.)

target - Device request target.

requestData - Data of the request.

Throws:

IllegalArgumentException - if requestID < 0 or if requestID > 255 or if target.length() > 255.

Method Detail

createPacket

public static DeviceRequestPacket createPacket(byte[] payload)

Creates a new DeviceRequestPacket object from the given payload.

Parameters:

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

Returns:

Parsed Device Request packet.

Throws:

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

getFlags

public int getFlags()

Retrieves the flags.

Returns:

The flags.

getRequestData

public byte[] getRequestData()

Retrieves the data of the device request.

Returns:

The data of the device request.

See Also:

setRequestData(byte[])

getRequestID

public int getRequestID()

Retrieves the ID of the device request.

Returns:

The ID of the device request.

See Also:

setRequestID(int)

getRequestTarget

public String getRequestTarget()

Retrieves the device request target.

Returns:

The device request target.

See Also:

setRequestTarget(String)

getTransport

public int getTransport()

Retrieves the transport.

Returns:

The transport.

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.

setRequestData

public void setRequestData(byte[] requestData)

Sets the data of the device request.

Parameters:

requestData - Data of the device request.

See Also:

getRequestData()

setRequestID

public void setRequestID(int requestID)

Sets ID of the device request.

Parameters:

requestID - ID of the device request.

Throws:

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

See Also:

getRequestID()

setRequestTarget

public void setRequestTarget(String target)

Sets the device request target.

Parameters:

target - The device request target.

Throws:

IllegalArgumentException - if target.length() > 255.

See Also:

getRequestTarget()