Class TXStatusPacket

This class represents a TX (Transmit) Status packet. Packet is built using the parameters of the constructor or providing a valid API payload.

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

When a TX Request is completed, the module sends a TX Status message. This message will indicate if the packet was transmitted successfully or if there was a failure.

Constructors

TXStatusPacket(Byte, XBeeTransmitStatus)

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

Declaration
public TXStatusPacket(byte frameID, XBeeTransmitStatus transmitStatus)
Parameters
Type Name Description
System.Byte frameID

The Frame ID.
XBeeTransmitStatus transmitStatus

The transmit status.
Exceptions
Type Condition
System.ArgumentException

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

TransmitStatus

Gets the transmit status.

Declaration
public XBeeTransmitStatus TransmitStatus { get; }
Property Value
Type Description
XBeeTransmitStatus
See Also

Methods

CreatePacket(Byte[])

Creates a new TXStatusPacket object from the given payload.

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

The API frame payload. It must start with the frame type corresponding to a TX Status packet (0x89). The byte array must be in API mode.
Returns
Type Description
TXStatusPacket

Parsed TX Status packet.
Exceptions
Type Condition
System.ArgumentException

If payload[0] != APIFrameType.TX_STATUS.GetValue() or if payload.length < XBeeLibrary.Core.Packet.Raw.TXStatusPacket.MIN_API_PAYLOAD_LENGTH.
System.ArgumentNullException

If payload == null.

See Also