Class TX16Packet

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

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

A TX Request message will cause the module to transmit data as an RF Packet.

Constructors

TX16Packet(Byte, XBee16BitAddress, Byte, Byte[])

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

Declaration
public TX16Packet(byte frameID, XBee16BitAddress destAddress16, byte transmitOptions, byte[] rfData)
Parameters
Type Name Description
System.Byte frameID

The Frame ID.
XBee16BitAddress destAddress16

The 16-bit address of the destination device.
System.Byte transmitOptions

The bitfield of supported transmission options.
System.Byte[] rfData

The RF Data that is sent to the destination device.
Exceptions
Type Condition
System.ArgumentException

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

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 RF data to send.

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

TransmitOptions

The transmit options bitfield.

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

Methods

CreatePacket(Byte[])

Creates a new TX16Packet object from the given payload.

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

The API frame payload. It must start with the frame type corresponding to a TX16 Request packet (0x01). The byte array must be in API mode.
Returns
Type Description
TX16Packet

Parsed TX16 Request packet.
Exceptions
Type Condition
System.ArgumentException

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

If payload == null.

See Also