XBee C# library API reference

Show / Hide Table of Contents

Class XBeeMessage

This class represents an XBee message containing the remote XBee device the message belongs to, the content (data) of the message and a flag indicating if the message is a broadcast message (was received or is being sent via broadcast).

Inheritance
System.Object
XBeeMessage
ExplicitXBeeMessage
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: XBeeLibrary.Core.Models
Assembly: XBeeLibrary.Core.dll
Syntax
public class XBeeMessage
Remarks

This class is used within the XBee C# Library to read data sent by remote devices.

Constructors

XBeeMessage(RemoteXBeeDevice, Byte[])

Initializes new instance of class XBeeMessage.

Declaration
public XBeeMessage(RemoteXBeeDevice remoteXBeeDevice, byte[] data)
Parameters
Type Name Description
RemoteXBeeDevice remoteXBeeDevice

The remote XBee device the message belongs to.

System.Byte[] data

Byte array containing the data of the message.

See Also
RemoteXBeeDevice

XBeeMessage(RemoteXBeeDevice, Byte[], Boolean)

Initializes new instance of class XBeeMessage.

Declaration
public XBeeMessage(RemoteXBeeDevice remoteXBeeDevice, byte[] data, bool isBroadcast)
Parameters
Type Name Description
RemoteXBeeDevice remoteXBeeDevice

The remote XBee device the message belongs to.

System.Byte[] data

Byte array containing the data of the message.

System.Boolean isBroadcast

Indicates if the message was received via broadcast.

Exceptions
Type Condition
System.ArgumentNullException

If remoteXBeeDevice is null or if data is null.

See Also
RemoteXBeeDevice

Properties

Data

The data as byte array containing the data of the message.

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

DataString

Gets the data of the message in string format.

Declaration
public string DataString { get; }
Property Value
Type Description
System.String

The data of the message in string format.

Device

The remote XBee device this message is associated to.

Declaration
public RemoteXBeeDevice Device { get; }
Property Value
Type Description
RemoteXBeeDevice

IsBroadcast

Gets whether or not the message was received via broadcast.

Declaration
public bool IsBroadcast { get; }
Property Value
Type Description
System.Boolean
Product page More documentation Official site About Digi Contact us Support
©2019 Digi International Inc. All rights reserved.
Digi International Inc.