XBee C# library API reference

Show / Hide Table of Contents

Class RemoteXBeeDevice

This class represents a remote XBee device.

Inheritance
System.Object
AbstractXBeeDevice
RemoteXBeeDevice
RemoteDigiMeshDevice
RemoteDigiPointDevice
RemoteRaw802Device
RemoteZigBeeDevice
Inherited Members
AbstractXBeeDevice.DEFAULT_RECEIVE_TIMETOUT
AbstractXBeeDevice.TIMEOUT_BEFORE_COMMAND_MODE
AbstractXBeeDevice.TIMEOUT_ENTER_COMMAND_MODE
AbstractXBeeDevice.PARAMETER_NODE_ID
AbstractXBeeDevice.TIMEOUT_READ_PACKET
AbstractXBeeDevice.dataReader
AbstractXBeeDevice.currentFrameID
AbstractXBeeDevice.receiveTimeout
AbstractXBeeDevice.localXBeeDevice
AbstractXBeeDevice.logger
AbstractXBeeDevice.bluetoothPassword
AbstractXBeeDevice.network
AbstractXBeeDevice.PacketReceived
AbstractXBeeDevice.DataReceived
AbstractXBeeDevice.IOSampleReceived
AbstractXBeeDevice.ModemStatusReceived
AbstractXBeeDevice.ExplicitDataReceived
AbstractXBeeDevice.UserDataRelayReceived
AbstractXBeeDevice.BluetoothDataReceived
AbstractXBeeDevice.MicroPythonDataReceived
AbstractXBeeDevice.SerialDataReceived
AbstractXBeeDevice.SMSReceived
AbstractXBeeDevice.IPDataReceived
AbstractXBeeDevice.FirmwareVersion
AbstractXBeeDevice.HardwareVersion
AbstractXBeeDevice.HardwareVersionString
AbstractXBeeDevice.XBee16BitAddr
AbstractXBeeDevice.XBee64BitAddr
AbstractXBeeDevice.XBeeProtocol
AbstractXBeeDevice.SignalStrength
AbstractXBeeDevice.OperatingMode
AbstractXBeeDevice.ApplyConfigurationChangesEnabled
AbstractXBeeDevice.NodeID
AbstractXBeeDevice.IsInitialized
AbstractXBeeDevice.ConnectionInterface
AbstractXBeeDevice.IsOpen
AbstractXBeeDevice.ReceiveTimeout
AbstractXBeeDevice.APIOutputMode
AbstractXBeeDevice.ReadDeviceInfo()
AbstractXBeeDevice.SetIOConfiguration(IOLine, IOMode)
AbstractXBeeDevice.GetIOConfiguration(IOLine)
AbstractXBeeDevice.SetDIOValue(IOLine, IOValue)
AbstractXBeeDevice.GetDIOValue(IOLine)
AbstractXBeeDevice.SetPWMDutyCycle(IOLine, Double)
AbstractXBeeDevice.GetPWMDutyCycle(IOLine)
AbstractXBeeDevice.GetADCValue(IOLine)
AbstractXBeeDevice.SetDestinationAddress(XBee64BitAddress)
AbstractXBeeDevice.GetDestinationAddress()
AbstractXBeeDevice.SetIOSamplingRate(Int32)
AbstractXBeeDevice.GetIOSamplingRate()
AbstractXBeeDevice.SetDIOChangeDetection(ISet<IOLine>)
AbstractXBeeDevice.GetDIOChangeDetection()
AbstractXBeeDevice.ApplyChanges()
AbstractXBeeDevice.ReadIOSample()
AbstractXBeeDevice.SetParameter(String, Byte[])
AbstractXBeeDevice.GetParameter(String)
AbstractXBeeDevice.ExecuteParameter(String)
AbstractXBeeDevice.SoftwareReset()
AbstractXBeeDevice.SetNodeID(String)
AbstractXBeeDevice.GetPANID()
AbstractXBeeDevice.SetPANID(Byte[])
AbstractXBeeDevice.GetPowerLevel()
AbstractXBeeDevice.SetPowerLevel(PowerLevel)
AbstractXBeeDevice.WriteChanges()
AbstractXBeeDevice.EnableBluetooth()
AbstractXBeeDevice.DisableBluetooth()
AbstractXBeeDevice.GetBluetoothMacAddress()
AbstractXBeeDevice.UpdateBluetoothPassword(String)
AbstractXBeeDevice.GetAddressString()
AbstractXBeeDevice.SendATCommand(ATCommand)
AbstractXBeeDevice.SendXBeePacketAsync(XBeePacket)
AbstractXBeeDevice.SendXBeePacket(XBeePacket, EventHandler<PacketReceivedEventArgs>)
AbstractXBeeDevice.SendXBeePacket(XBeePacket)
AbstractXBeeDevice.GetNextFrameID()
AbstractXBeeDevice.SendAndCheckXBeePacket(XBeePacket, Boolean)
AbstractXBeeDevice.CheckATCommandResponseIsValid(ATCommandResponse)
AbstractXBeeDevice.GetAssociationIndicationStatus()
AbstractXBeeDevice.ForceDisassociate()
AbstractXBeeDevice.SendUserDataRelay(XBeeLocalInterface, Byte[])
AbstractXBeeDevice.SendBluetoothData(Byte[])
AbstractXBeeDevice.SendMicroPythonData(Byte[])
AbstractXBeeDevice.SendSerialData(Byte[])
AbstractXBeeDevice.Open()
AbstractXBeeDevice.Close()
AbstractXBeeDevice.DetermineOperatingMode()
AbstractXBeeDevice.GetNetwork()
AbstractXBeeDevice.SendPacket(XBeePacket, EventHandler<PacketReceivedEventArgs>)
AbstractXBeeDevice.SendPacketAsync(XBeePacket)
AbstractXBeeDevice.SendPacket(XBeePacket)
AbstractXBeeDevice.SendDataAsync(RemoteXBeeDevice, Byte[])
AbstractXBeeDevice.SendData(RemoteXBeeDevice, Byte[])
AbstractXBeeDevice.SendBroadcastData(Byte[])
AbstractXBeeDevice.ReadData()
AbstractXBeeDevice.ReadData(Int32)
AbstractXBeeDevice.ReadDataFrom(RemoteXBeeDevice)
AbstractXBeeDevice.ReadDataFrom(RemoteXBeeDevice, Int32)
AbstractXBeeDevice.ReadUserDataRelay()
AbstractXBeeDevice.ReadUserDataRelay(Int32)
AbstractXBeeDevice.ReadExplicitData()
AbstractXBeeDevice.ReadExplicitData(Int32)
AbstractXBeeDevice.ReadExplicitDataFrom(RemoteXBeeDevice)
AbstractXBeeDevice.ReadExplicitDataFrom(RemoteXBeeDevice, Int32)
AbstractXBeeDevice.SendExplicitDataAsync(XBee64BitAddress, Byte, Byte, Byte[], Byte[], Byte[])
AbstractXBeeDevice.SendExplicitDataAsync(XBee64BitAddress, XBee16BitAddress, Byte, Byte, Byte[], Byte[], Byte[])
AbstractXBeeDevice.SendExplicitDataAsync(RemoteXBeeDevice, Byte, Byte, Byte[], Byte[], Byte[])
AbstractXBeeDevice.SendExplicitData(XBee64BitAddress, Byte, Byte, Byte[], Byte[], Byte[])
AbstractXBeeDevice.SendExplicitData(XBee64BitAddress, XBee16BitAddress, Byte, Byte, Byte[], Byte[], Byte[])
AbstractXBeeDevice.SendExplicitData(RemoteXBeeDevice, Byte, Byte, Byte[], Byte[], Byte[])
AbstractXBeeDevice.SendBroadcastExplicitData(Byte, Byte, Byte[], Byte[], Byte[])
AbstractXBeeDevice.SendData(XBee64BitAddress, Byte[])
AbstractXBeeDevice.SendData(XBee64BitAddress, XBee16BitAddress, Byte[])
AbstractXBeeDevice.SendDataAsync(XBee64BitAddress, Byte[])
AbstractXBeeDevice.SendDataAsync(XBee64BitAddress, XBee16BitAddress, Byte[])
AbstractXBeeDevice.SetBluetoothPassword(String)
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)
Namespace: XBeeLibrary.Core
Assembly: XBeeLibrary.Core.dll
Syntax
public class RemoteXBeeDevice : AbstractXBeeDevice

Constructors

RemoteXBeeDevice(AbstractXBeeDevice, XBee64BitAddress)

Class constructor. Instantiates a new RemoteXBeeDevice object with the given local XBeeDevice which contains the connection interface to be used.

Declaration
public RemoteXBeeDevice(AbstractXBeeDevice localXBeeDevice, XBee64BitAddress addr64)
Parameters
Type Name Description
AbstractXBeeDevice localXBeeDevice

The local XBee device that will behave as connection interface to communicate with this remote XBee device.

XBee64BitAddress addr64

The 64-bit address to identify this remote XBee device.

Exceptions
Type Condition
System.ArgumentException

If localXBeeDevice is remote.

System.ArgumentNullException

If localXBeeDevice == null or if addr64 == null.

See Also
XBeeDevice
XBee64BitAddress

RemoteXBeeDevice(AbstractXBeeDevice, XBee64BitAddress, XBee16BitAddress, String)

Class constructor. Instantiates a new RemoteXBeeDevice object with the given local XBeeDevice which contains the connection interface to be used.

Declaration
public RemoteXBeeDevice(AbstractXBeeDevice localXBeeDevice, XBee64BitAddress addr64, XBee16BitAddress addr16, string ni)
Parameters
Type Name Description
AbstractXBeeDevice localXBeeDevice

The local XBee device that will behave as connection interface to communicate with this remote XBee device.

XBee64BitAddress addr64

The 64-bit address to identify this remote XBee device.

XBee16BitAddress addr16

The 16-bit address to identify this remote XBee device. It might be null.

System.String ni

The node identifier of this remote XBee device. It might be null.

Exceptions
Type Condition
System.ArgumentException

If localXBeeDevice is remote.

System.ArgumentNullException

If localXBeeDevice == null or if addr64 == null.

See Also
XBeeDevice
XBee16BitAddress
XBee64BitAddress

Properties

IsRemote

Always true, since this is a remote device.

Declaration
public override bool IsRemote { get; }
Property Value
Type Description
System.Boolean
Overrides
AbstractXBeeDevice.IsRemote

Methods

GetLocalXBeeDevice()

Returns the local XBee device.

Declaration
public AbstractXBeeDevice GetLocalXBeeDevice()
Returns
Type Description
AbstractXBeeDevice

The local XBee device.

Reset()

Performs a software reset on this XBee device and blocks until the process is completed.

Declaration
public override void Reset()
Overrides
AbstractXBeeDevice.Reset()
Exceptions
Type Condition
InterfaceNotOpenException

If this device connection is not open.

XBeeException

If there is any other XBee related error.

ToString()

Returns the string representation of this device.

Declaration
public override string ToString()
Returns
Type Description
System.String

The string representation of this device.

Overrides
AbstractXBeeDevice.ToString()

See Also

RemoteDigiMeshDevice
RemoteDigiPointDevice
RemoteRaw802Device
RemoteZigBeeDevice
Product page More documentation Official site About Digi Contact us Support
©2019 Digi International Inc. All rights reserved.
Digi International Inc.