Class TransmitStatusPacket

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

Inheritance
System.Object
XBeePacket
XBeeAPIPacket
TransmitStatusPacket
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 TransmitStatusPacket : XBeeAPIPacket
Remarks

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

This packet is the response to standard and explicit transmit requests.

Constructors

TransmitStatusPacket(Byte, XBee16BitAddress, Byte, XBeeTransmitStatus, XBeeDiscoveryStatus)

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

Declaration
public TransmitStatusPacket(byte frameID, XBee16BitAddress destAddress16, byte transmitRetryCount, XBeeTransmitStatus transmitStatus, XBeeDiscoveryStatus discoveryStatus)
Parameters
Type Name Description
System.Byte frameID

The frame ID.
XBee16BitAddress destAddress16

The 16-bit network address the packet was delivered to.
System.Byte transmitRetryCount

The number of application transmission retries that took place.
XBeeTransmitStatus transmitStatus

The transmit status.
XBeeDiscoveryStatus discoveryStatus

The discovery status.
Exceptions
Type Condition
System.ArgumentNullException

If destAddress16 == 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.

DestAddress16

The 16 bit destination address.

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

DiscoveryStatus

The discovery status.

Declaration
public XBeeDiscoveryStatus DiscoveryStatus { get; }
Property Value
Type Description
XBeeDiscoveryStatus
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

TransmitRetryCount

The transmit retry count.

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

TransmitStatus

The transmit status.

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

Methods

CreatePacket(Byte[])

Creates a new TransmitStatusPacket object from the given payload.

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

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

Parsed Transmit Status packet.
Exceptions
Type Condition
System.ArgumentException

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

If payload == null.

See Also