Class UserDataRelayPacket

This class represents a User Data Relay packet.

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

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.

Constructors

UserDataRelayPacket(Byte, XBeeLocalInterface, Byte[])

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

Declaration
public UserDataRelayPacket(byte frameID, XBeeLocalInterface destinationInterface, byte[] data)
Parameters
Type Name Description
System.Byte frameID

The Frame ID.
XBeeLocalInterface destinationInterface

The destination interface.
System.Byte[] data

The data that is sent to the destination interface.
Exceptions
Type Condition
System.ArgumentException

If frameID < 0 or if frameID > 255 or if destinationInterface == UNKNOWN.
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.

Data

The data that is sent to the destination interface.

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

DestinationInterface

The destination XBee local interface.

Declaration
public XBeeLocalInterface DestinationInterface { get; }
Property Value
Type Description
XBeeLocalInterface
See Also

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

Methods

CreatePacket(Byte[])

Creates a new UserDataRelayPacket object from the given payload.

Declaration
public static UserDataRelayPacket CreatePacket(byte[] payload)
Parameters
Type Name Description
System.Byte[] 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 API mode.
Returns
Type Description
UserDataRelayPacket

Parsed User Data Relay packet.
Exceptions
Type Condition
System.ArgumentException

If payload[0] != APIFrameType.USER_DATA_RELAY.GetValue() or if payload.length < XBeeLibrary.Core.Packet.Relay.UserDataRelayPacket.MIN_API_PAYLOAD_LENGTH.
System.ArgumentNullException

If payload == null.

See Also