com.digi.xbee.api.packet.common

Class ReceivePacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.common.ReceivePacket

public class ReceivePacket
extends XBeeAPIPacket

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

When the module receives an RF packet, it is sent out the UART using this message type.

This packet is received when external devices send transmit request packets to this module.

Among received data, some options can also be received indicating transmission parameters.

See Also:

TransmitPacket, XBeeReceiveOptions, XBeeAPIPacket

Field Summary

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

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
ReceivePacket(XBee64BitAddress sourceAddress64, XBee16BitAddress sourceAddress16, int receiveOptions, byte[] rfData) Class constructor.

Method Summary

Modifier and Type	Method and Description
static ReceivePacket	createPacket(byte[] payload) Creates a new ReceivePacket object from the given payload.
XBee16BitAddress	get16bitSourceAddress() Returns the 16-bit sender/source address.
XBee64BitAddress	get64bitSourceAddress() Returns the 64-bit sender/source address.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
int	getReceiveOptions() Returns the receive options bitfield.
byte[]	getRFData() Returns the received RF data.
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	setRFData(byte[] rfData) Sets the received RF data.

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

generateByteArray, generateByteArrayEscaped, getChecksum, getPacketLength, getParameters, parsePacket, parsePacket, toPrettyString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReceivePacket

public ReceivePacket(XBee64BitAddress sourceAddress64,
                     XBee16BitAddress sourceAddress16,
                     int receiveOptions,
                     byte[] rfData)

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

Parameters:

sourceAddress64 - 64-bit address of the sender.

sourceAddress16 - 16-bit address of the sender.

receiveOptions - Bitfield indicating the receive options.

rfData - Received RF data.

Throws:

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

NullPointerException - if sourceAddress64 == null or if sourceAddress16 == null.

See Also:

XBeeReceiveOptions, XBee16BitAddress, XBee64BitAddress

Method Detail

createPacket

public static ReceivePacket createPacket(byte[] payload)

Creates a new ReceivePacket object from the given payload.

Parameters:

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

Returns:

Parsed ZigBee Receive packet.

Throws:

IllegalArgumentException - if payload[0] != APIFrameType.RECEIVE_PACKET.getValue() or if payload.length < {@value #MIN_API_PAYLOAD_LENGTH} or if receiveOptions < 0 or if receiveOptions > 255.

NullPointerException - if payload == null.

get16bitSourceAddress

public XBee16BitAddress get16bitSourceAddress()

Returns the 16-bit sender/source address.

Returns:

The 16-bit sender/source address.

See Also:

XBee16BitAddress

get64bitSourceAddress

public XBee64BitAddress get64bitSourceAddress()

Returns the 64-bit sender/source address.

Returns:

The 64-bit sender/source address.

See Also:

XBee64BitAddress

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.

getReceiveOptions

public int getReceiveOptions()

Returns the receive options bitfield.

Returns:

Receive options bitfield.

See Also:

XBeeReceiveOptions

getRFData

public byte[] getRFData()

Returns the received RF data.

Returns:

Received RF data.

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.

setRFData

public void setRFData(byte[] rfData)

Sets the received RF data.

Parameters:

rfData - Received RF data.