Class ModemStatusPacket

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

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

RF module status messages are sent from the module in response to specific conditions and indicates the state of the modem in that moment.

Constructors

ModemStatusPacket(ModemStatusEvent)

Class constructor. Instantiates a new ModemStatusPacket object with the given modem status.

Declaration
public ModemStatusPacket(ModemStatusEvent modemStatusEvent)
Parameters
Type Name Description
ModemStatusEvent modemStatusEvent

The modem status event enumeration entry.
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

Status

The modem status event enumeration entry.

Declaration
public ModemStatusEvent Status { get; }
Property Value
Type Description
ModemStatusEvent
See Also

Methods

CreatePacket(Byte[])

Creates a new ModemStatusPacket object from the given payload.

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

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

Parsed Modem status packet.
Exceptions
Type Condition
System.ArgumentException

If payload[0] != APIFrameType.MODEM_STATUS.GetValue() or if payload.Length < XBeeLibrary.Core.Packet.Common.ModemStatusPacket.MIN_API_PAYLOAD_LENGTH.
System.ArgumentNullException

If payload == null.

See Also