Class ReceivePacket

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

Inheritance
System.Object
XBeePacket
XBeeAPIPacket
ReceivePacket
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: XBeeLibrary.Core.Packet.Common
Assembly: XBeeLibrary.Core.dll
Syntax
public class ReceivePacket : XBeeAPIPacket
Remarks

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.

Constructors

ReceivePacket(XBee64BitAddress, XBee16BitAddress, Byte, Byte[])

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

Declaration
public ReceivePacket(XBee64BitAddress sourceAddress64, XBee16BitAddress sourceAddress16, byte receiveOptions, byte[] rfData)
Parameters
Type Name Description
XBee64BitAddress sourceAddress64

The 64-bit address of the sender device.
XBee16BitAddress sourceAddress16

The 16-bit address of the sender device.
System.Byte receiveOptions

The bitField of receive options.
System.Byte[] rfData

The received RF data.
Exceptions
Type Condition
System.ArgumentException

If receiveOptions < 0 or if receiveOptions > 255.
System.ArgumentNullException

If sourceAddress64 == null or if sourceAddress16 == null.
See Also

Properties

APIPacketParameters

Gets a map with the XBee packet parameters and their values.

Declaration
protected override LinkedDictionary<string, string> APIPacketParameters { get; }
Property Value
Type Description
LinkedDictionary<System.String, System.String>

A sorted map containing the XBee packet parameters with their values.
Overrides

APIPacketSpecificData

Gets the XBee API packet specific data.

Declaration
protected override byte[] APIPacketSpecificData { get; }
Property Value
Type Description
System.Byte[]
Overrides
Remarks

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

IsBroadcast

Indicates whether the packet is a broadcast packet.

Declaration
public override bool IsBroadcast { get; }
Property Value
Type Description
System.Boolean
Overrides

NeedsAPIFrameID

Indicates whether the API packet needs API Frame ID or not.

Declaration
public override bool NeedsAPIFrameID { get; }
Property Value
Type Description
System.Boolean
Overrides

ReceiveOptions

The receive options bitfield.

Declaration
public byte ReceiveOptions { get; }
Property Value
Type Description
System.Byte

RFData

The received RF data.

Declaration
public byte[] RFData { get; set; }
Property Value
Type Description
System.Byte[]

SourceAddress16

The 16 bit sender/source address.

Declaration
public XBee16BitAddress SourceAddress16 { get; }
Property Value
Type Description
XBee16BitAddress
See Also

SourceAddress64

The 64 bit sender/source address.

Declaration
public XBee64BitAddress SourceAddress64 { get; }
Property Value
Type Description
XBee64BitAddress
See Also

Methods

CreatePacket(Byte[])

Creates a new ReceivePacket object from the given payload.

Declaration
public static ReceivePacket CreatePacket(byte[] payload)
Parameters
Type Name Description
System.Byte[] payload

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

Parsed Receive packet.
Exceptions
Type Condition
System.ArgumentException

If payload[0] != APIFrameType.RECEIVE_PACKET.GetValue() or if payload.length < XBeeLibrary.Core.Packet.Common.ReceivePacket.MIN_API_PAYLOAD_LENGTH.
System.ArgumentNullException

If payload == null.

See Also