XBee C# library API reference

Show / Hide Table of Contents

Class RemoteZigBeeDevice

This class represents a remote ZigBee device.

Inheritance
System.Object
AbstractXBeeDevice
RemoteXBeeDevice
RemoteZigBeeDevice
Inherited Members
RemoteXBeeDevice.IsRemote
RemoteXBeeDevice.Reset()
RemoteXBeeDevice.ToString()
RemoteXBeeDevice.GetLocalXBeeDevice()
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.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.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 RemoteZigBeeDevice : RemoteXBeeDevice

Constructors

RemoteZigBeeDevice(AbstractXBeeDevice, XBee64BitAddress)

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

Declaration
public RemoteZigBeeDevice(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 ZigBee device.

XBee64BitAddress addr64

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

Exceptions
Type Condition
System.ArgumentException

If localXBeeDevice is remote or if localXBeeDevice != ZIGBEE.

System.ArgumentNullException

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

See Also
XBeeDevice
XBee64BitAddress

RemoteZigBeeDevice(AbstractXBeeDevice, XBee64BitAddress, XBee16BitAddress, String)

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

Declaration
public RemoteZigBeeDevice(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 ZigBee device.

XBee64BitAddress addr64

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

XBee16BitAddress addr16

The 16-bit address to identify this remote ZigBee device. It might benull.

System.String ni

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

Exceptions
Type Condition
System.ArgumentException

If localXBeeDevice is remote or if localXBeeDevice != ZIGBEE.

System.ArgumentNullException

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

See Also
XBeeDevice
XBee16BitAddress
XBee64BitAddress

RemoteZigBeeDevice(ZigBeeDevice, XBee64BitAddress)

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

Declaration
public RemoteZigBeeDevice(ZigBeeDevice localXBeeDevice, XBee64BitAddress addr64)
Parameters
Type Name Description
ZigBeeDevice localXBeeDevice

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

XBee64BitAddress addr64

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

Exceptions
Type Condition
System.ArgumentException

If localXBeeDevice is remote.

System.ArgumentNullException

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

See Also
XBee64BitAddress
ZigBeeDevice

Properties

XBeeProtocol

The protocol of the XBee device.

Declaration
public override XBeeProtocol XBeeProtocol { get; }
Property Value
Type Description
XBeeProtocol
Overrides
AbstractXBeeDevice.XBeeProtocol
See Also
ZIGBEE

Methods

ForceDisassociate()

Forces this XBee device to immediately disassociate from the network and re-attempt to associate.

Declaration
public void ForceDisassociate()
Remarks

Only valid for End Devices.

Exceptions
Type Condition
InterfaceNotOpenException

If this device connection is not open.

TimeoutException

If there is a timeout executing the force disassociate command.

XBeeException

If there is any other XBee related error.

See Also
GetAssociationIndicationStatus()

GetAssociationIndicationStatus()

Returns the current association status of this XBee device.

Declaration
public AssociationIndicationStatus GetAssociationIndicationStatus()
Returns
Type Description
AssociationIndicationStatus

The association indication status of the XBee device.

Remarks

It indicates occurrences of errors during the last association request.

Exceptions
Type Condition
ATCommandEmptyException

If the AI command returns a null or an empty value.

InterfaceNotOpenException

If this device connection is not open.

TimeoutException

If there is a timeout reading the association indication status.

XBeeException

If there is any other XBee related error.

See Also
ForceDisassociate()
AssociationIndicationStatus

See Also

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