com.digi.xbee.api.packet.relay

Class UserDataRelayPacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.relay.UserDataRelayPacket

public class UserDataRelayPacket
extends XBeeAPIPacket

This class represents a User Data Relay packet. Packet is built using the parameters of the constructor. The User Data Relay packet allows for data to come in on an interface with a designation of the target interface for the data to be output on. The destination interface must be one of the interfaces found in the corresponding enumerator. See XBeeLocalInterface.

Since:

1.3.0

See Also:

UserDataRelayOutputPacket, XBeeAPIPacket

Field Summary

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

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
UserDataRelayPacket(int frameID, XBeeLocalInterface localInterface, byte[] data) Class constructor.

Method Summary

Modifier and Type	Method and Description
static UserDataRelayPacket	createPacket(byte[] payload) Creates a new UserDataRelayPacket object from the given payload.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
byte[]	getAPIPacketSpecificData() Returns the XBee API packet specific data.
byte[]	getData() Retrieves the data to send.
XBeeLocalInterface	getDestinationInterface() Retrieves the the destination XBee local interface.
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	setData(byte[] data) Sets the data to send.
void	setDestinationInterface(XBeeLocalInterface localInterface) Sets the destination XBee local interface.

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

UserDataRelayPacket

public UserDataRelayPacket(int frameID,
                           XBeeLocalInterface localInterface,
                           byte[] data)

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

Parameters:

frameID - Frame ID.

localInterface - The destination XBeeLocalInterface.

data - RF Data that is sent to the destination interface.

Throws:

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

NullPointerException - if localInterface == null.

Method Detail

createPacket

public static UserDataRelayPacket createPacket(byte[] payload)

Creates a new UserDataRelayPacket object from the given payload.

Parameters:

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

Returns:

Parsed User Data Relay packet.

Throws:

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

getAPIPacketSpecificData

public byte[] getAPIPacketSpecificData()

Description copied from class: XBeeAPIPacket

Returns the XBee API packet specific data.

This does not include the frame ID if it is needed.

Returns:

The XBee API packet data.

getData

public byte[] getData()

Retrieves the data to send.

Returns:

Data to send.

See Also:

setData(byte[])

getDestinationInterface

public XBeeLocalInterface getDestinationInterface()

Retrieves the the destination XBee local interface.

Returns:

The the destination interface.

See Also:

setDestinationInterface(XBeeLocalInterface), XBeeLocalInterface

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.

setData

public void setData(byte[] data)

Sets the data to send.

Parameters:

data - Data to send.

See Also:

getData()

setDestinationInterface

public void setDestinationInterface(XBeeLocalInterface localInterface)

Sets the destination XBee local interface.

Parameters:

localInterface - The new destination interface.

Throws:

NullPointerException - if localInterface == null.

See Also:

getDestinationInterface(), XBeeLocalInterface