Class ATCommand

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

Inheritance
System.Object
ATCommand
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 ATCommand
Remarks

AT commands can be sent directly to the connected device or to remote devices and may have parameters. After executing an AT Command, an AT Response is received from the device.

Constructors

ATCommand(String)

Initializes a new instance of the ATCommand class.

Declaration
public ATCommand(string command)
Parameters
Type Name Description
System.String command

The AT Command alias.
Exceptions
Type Condition
System.ArgumentNullException

If command is null.
System.ArgumentException

If the Length of command is not 2.

ATCommand(String, Byte[])

Initializes a new instance of the class ATCommand.

Declaration
public ATCommand(string command, byte[] parameter)
Parameters
Type Name Description
System.String command

The AT Command alias.
System.Byte[] parameter

The command parameter expressed as a byte array.
Remarks

If not parameter is required, the constructor ATCommand(String) is recommanded.

Exceptions
Type Condition
System.ArgumentNullException

If command is null.
System.ArgumentException

If the Length of command is not 2.

ATCommand(String, String)

Initializes a new instance of the ATCommand class.

Declaration
public ATCommand(string command, string parameter)
Parameters
Type Name Description
System.String command

The AT Command alias.
System.String parameter

The command parameter expressed as a string.
Remarks

If not parameter is required, the constructor ATCommand(String) is recommanded.

Exceptions
Type Condition
System.ArgumentNullException

If command is null.
System.ArgumentException

If the Length of command is not 2.

Properties

Command

The AT command name.

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

Parameter

The AT command parameter value.

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

ParameterString

The AT command parameter in string format.

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

See Also