com.digi.xbee.api.packet.relay

Class UserDataRelayOutputPacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.relay.UserDataRelayOutputPacket

public class UserDataRelayOutputPacket
extends XBeeAPIPacket

This class represents a User Data Relay Output packet. Packet is built using the parameters of the constructor. The User Data Relay Output packet can be received from any XBee local interface. The source interface must be one of the interfaces found in the corresponding enumerator. See XBeeLocalInterface.

Since:

1.3.0

See Also:

UserDataRelayPacket, XBeeAPIPacket

Field Summary

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

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
UserDataRelayOutputPacket(XBeeLocalInterface localInterface, byte[] data) Class constructor.

Method Summary

Modifier and Type	Method and Description
static UserDataRelayOutputPacket	createPacket(byte[] payload) Creates a new UserDataRelayOutputPacket 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 received data.
XBeeLocalInterface	getSourceInterface() Retrieves the the source 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 received data.
void	setSourceInterface(XBeeLocalInterface localInterface) Sets the source 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

UserDataRelayOutputPacket

public UserDataRelayOutputPacket(XBeeLocalInterface localInterface,
                                 byte[] data)

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

Parameters:

localInterface - The source XBeeLocalInterface.

data - RF Data that is received from the source interface.

Throws:

NullPointerException - if localInterface == null.

Method Detail

createPacket

public static UserDataRelayOutputPacket createPacket(byte[] payload)

Creates a new UserDataRelayOutputPacket 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 (0xAD). The byte array must be in OperatingMode.API mode.

Returns:

Parsed User Data Relay Output packet.

Throws:

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

Returns:

Received data.

See Also:

setData(byte[])

getSourceInterface

public XBeeLocalInterface getSourceInterface()

Retrieves the the source XBee local interface.

Returns:

The the source interface.

See Also:

setSourceInterface(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 received data.

Parameters:

data - Received data.

See Also:

getData()

setSourceInterface

public void setSourceInterface(XBeeLocalInterface localInterface)

Sets the source XBee local interface.

Parameters:

localInterface - The new source interface.

Throws:

NullPointerException - if localInterface == null.

See Also:

getSourceInterface(), XBeeLocalInterface