Class RX16Packet

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

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

When the module receives an RF packet, it is sent out the UART using this message type.

This packet is the response to TX (transmit) 16 Request packets.

Constructors

RX16Packet(XBee16BitAddress, Byte, Byte, Byte[])

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

Declaration
public RX16Packet(XBee16BitAddress sourceAddress16, byte rssi, byte receiveOptions, byte[] rfData)
Parameters
Type Name Description
XBee16BitAddress sourceAddress16

The 16-bit address of the sender device.
System.Byte rssi

The received signal strength indicator.
System.Byte receiveOptions

The bitField of receive options.
System.Byte[] rfData

The received RF data.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

If rssi < 0 or if rssi > 255.
System.ArgumentNullException

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

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

ReceiveOptions

The receive options bitfield.

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

RFData

The received RF data

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

RSSI

The Received Signal Strength Indicator (RSSI).

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

SourceAddress16

The 16 bit sender/source address.

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

Methods

CreatePacket(Byte[])

Creates a new RX16Packet object from the given payload.

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

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

Parsed RX16 packet.
Exceptions
Type Condition
System.ArgumentException

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

If payload == null.

See Also