XBee C# library API reference

Show / Hide Table of Contents

Namespace XBeeLibrary.Core.Models

Classes

AbstractXBeeSetting

This class provides common functionality for all XBee settings.

APIOutputModeExtensions

AssociationIndicationStatusExtensions

ATCommand

This class represents an AT command used to read or set different properties of the XBee device.

ATCommandResponse

This class represents the response of an AT Command sent by the connected XBee device or by a remote device after executing an AT Command.

ATCommandStatusExtensions

ATStringCommandsStructExtensions

CellularAssociationIndicationStatusExtensions

DiscoveryOptionsExtensions

ExplicitXBeeMessage

This class represents an Explicit XBee message containing the remote XBee device the message belongs to, the content (data) of the message, a flag indicating if the message is a broadcast message (was received or is being sent via broadcast) and all the application layer fields: source endpoint, destination endpoint, cluster ID and profile ID.

FormatExtensions

HardwareVersion

This class represents the hardware version number of an XBee device.

HardwareVersionEnumExtensions

IPMessage

This class represents an IP message containing the IP address the message belongs to, the source and destination ports, the IP protocol, and the content (data) of the message.

IPProtocolExtensions

ModemStatusEventStructExtensions

OperatingModeExtensions

PowerLevelExtensions

Range

This class represents the range of values valid for an XBee setting.

SMSMessage

This class represents an SMS message containing the phone number that sent the message and the content (data) of the message.

SpecialByteExtensions

SrpErrorExtensions

SrpPhaseExtensions

UserDataRelayMessage

This class represents a User Data Relay message containing the source interface from which the message was sent and the data.

XBee16BitAddress

This class represents a 16-bit network address.

XBee64BitAddress

This class represents a 64-bit address (also known as MAC address).

XBeeCategory

This class represents an XBee category of settings.

XBeeDiscoveryStatusExtensions

XBeeFirmware

This class represents an XBee firmware.

XBeeIMEIAddress

This class represents an IMEI address used by cellular devices.

XBeeLocalInterfaceExtensions

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).

XBeePacketsQueue

This class represents a queue of XBee packets used for sequential packet reading.

XBeeProtocolExtensions

XBeeSettingButton

This class represents an XBee setting that can be interacted with through a button.

XBeeSettingCombo

This class represents an XBee setting that can be interacted with through a combo.

XBeeSettingNoControl

This class represents an XBee setting that can only be read.

XBeeSettingNumber

This class represents an XBee setting that can be interacted with through an input and its format is a number.

XBeeSettingText

This class represents an XBee setting that can be interacted with through a text input.

XBeeTransmitStatusExtensions

Enums

APIOutputMode

Enumerates the different API output modes. The API output mode establishes the way data will be output through the serial interface of an XBee device.

AssociationIndicationStatus

Enumerates the different association indication status.

ATCommandStatus

Enumerates all the possible states of an AT Command after executing it.

ATStringCommands

Enumerates several AT commands used to parse AT command packets. The list of AT Command alias listed here represents those AT commands whose values should be parsed as strings.

CellularAssociationIndicationStatus

Enumerates the different association indication statuses for the Cellular protocol.

DiscoveryOptions

Enumerates the different options used in the discovery process.

Format

Enumerates the different field formats of XBee settings.

HardwareVersionEnum

Enumerates the different hardware versions of the XBee devices.

IPProtocol

Enumerates the different IP protocols.

ModemStatusEvent

Enumerates the different modem status events. This enumeration list is intended to be used within the ModemStatusPacket packet.

OperatingMode

Enumerates the different working modes of the XBee device. The operating mode establishes the way a user communicates with an XBee device through its serial interface.

PowerLevel

Enumerates the different power levels. The power level indicates the output power value of a radio when transmitting data.

RemoteATCommandOptions

This class lists all the possible options that can be set while transmitting a remote AT Command.

SpecialByte

Enumerates all the special bytes of the XBee protocol that must be escaped when working on API 2 mode.

SrpError

This enumeration lists all the available errors of the SRP authentication.

SrpPhase

This enumeration lists all the available phases of the SRP authentication.

XBeeDiscoveryStatus

Enumerates all the possible states of the discovery. Discovery status field is part of the TransmitStatusPacket indicating the status of the discovery when a packet is sent.

XBeeLocalInterface

Enumerates the different XBee local interfaces used in the Relay API packets.

XBeeProtocol

Enumerates the available XBee protocols. The XBee protocol is determined by the combination of hardware and firmware of an XBee device.

XBeeReceiveOptions

Enumerates all the possible options that have been set while receiving an XBee packet.

XBeeTransmitOptions

This enumeration lists all the possible options that can be set while transmitting an XBee data packet.

XBeeTransmitStatus

Enumerates the different transmit status. Transmit status field is part of the TransmitStatusPacket indicating the status of the transmission.

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