Class UnknownXBeePacket

This class represents an unknown XBee packet where the payload is set as a byte array without a defined structure.

Inheritance
System.Object
XBeePacket
XBeeAPIPacket
UnknownXBeePacket
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
Assembly: XBeeLibrary.Core.dll
Syntax
public class UnknownXBeePacket : XBeeAPIPacket

Constructors

UnknownXBeePacket(Byte[])

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

Declaration
public UnknownXBeePacket(byte[] rfData)
Parameters
Type Name Description
System.Byte[] rfData

The XBee RF Data.

UnknownXBeePacket(Byte[], Byte)

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

Declaration
public UnknownXBeePacket(byte[] rfData, byte origApiFrameType)
Parameters
Type Name Description
System.Byte[] rfData

The XBee RF Data.
System.Byte origApiFrameType

The original API frame type.

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

A sorted dictionary with the packet parameters and their values.

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

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

RFData

The received RF data.

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

Methods

CreatePacket(Byte[])

Creates a new UnknownXBeePacket object from the given payload.

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

The API frame payload. It must start with the frame type corresponding to an Unknown packet (0xFF). The byte array must be in API mode.
Returns
Type Description
UnknownXBeePacket

Parsed Unknown packet.
Exceptions
Type Condition
System.ArgumentException

If payload.length < XBeeLibrary.Core.Packet.UnknownXBeePacket.MIN_API_PAYLOAD_LENGTH.
System.ArgumentNullException

If payload == null.

See Also