Class ExplicitRxIndicatorPacket

This class represents an Explicit RX Indicator packet. Packet is built using the parameters of the constructor or providing a valid API payload.

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

When the modem receives an RF packet it is sent out the UART using this message type (when AO=1).

This packet is received when external devices send explicit addressing packets to this module.

Among received data, some options can also be received indicating transmission parameters.

Constructors

ExplicitRxIndicatorPacket(XBee64BitAddress, XBee16BitAddress, Byte, Byte, Byte[], Byte[], Byte, Byte[])

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

Declaration
public ExplicitRxIndicatorPacket(XBee64BitAddress sourceAddress64, XBee16BitAddress sourceAddress16, byte sourceEndpoint, byte destEndpoint, byte[] clusterID, byte[] profileID, byte receiveOptions, byte[] rfData)
Parameters
Type Name Description
XBee64BitAddress sourceAddress64

The 64-bit address of the sender device.
XBee16BitAddress sourceAddress16

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

The endpoint of the source that initiated the transmission.
System.Byte destEndpoint

The endpoint of the destination the message was addressed to.
System.Byte[] clusterID

The cluster ID the packet was addressed to.
System.Byte[] profileID

The profile ID the packet was addressed to.
System.Byte receiveOptions

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

The received RF data.
Exceptions
Type Condition
System.ArgumentException

If profileID.Length != 2 or if clusterID.Length != 2.
System.ArgumentNullException

If sourceAddress64 == null or if sourceAddress16 == null.
See Also

Fields

DATA_CLUSTER

Declaration
public static readonly byte[] DATA_CLUSTER
Field Value
Type Description
System.Byte[]

DATA_ENDPOINT

Declaration
public static readonly byte DATA_ENDPOINT
Field Value
Type Description
System.Byte

DIGI_PROFILE

Declaration
public static readonly byte[] DIGI_PROFILE
Field Value
Type Description
System.Byte[]

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.

ClusterID

The cluster ID used in the transmission.

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

DestEndpoint

The destination endpoint of the transmission.

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

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

ProfileID

The profile ID used in the transmission.

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

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[]

SourceAddress16

The 16 bit sender/source address.

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

SourceAddress64

The 64 bit sender/source address.

Declaration
public XBee64BitAddress SourceAddress64 { get; }
Property Value
Type Description
XBee64BitAddress
See Also

SourceEndpoint

The source endpoint of the transmission.

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

Methods

CreatePacket(Byte[])

Creates a new ExplicitRxIndicatorPacket object from the given payload.

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

The API frame payload. It must start with the frame type corresponding to an Explicit RX Indicator packet (0x91). The byte array must be in API mode.
Returns
Type Description
ExplicitRxIndicatorPacket

Parsed Explicit RX Indicator packet.
Exceptions
Type Condition
System.ArgumentException

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

If payload == null.

See Also