Class XBeeProtocolExtensions

Inheritance

System.Object

XBeeProtocolExtensions

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 static class XBeeProtocolExtensions

Methods

DetermineProtocol(XBeeProtocol, HardwareVersion, String)

Determines the XBee protocol based on the given Hardware and firmware versions.

Declaration

public static XBeeProtocol DetermineProtocol(this XBeeProtocol source, HardwareVersion hardwareVersion, string firmwareVersion)

Parameters

Type	Name	Description
XBeeProtocol	source
HardwareVersion	hardwareVersion	The hardware version of the protocol to determine.
System.String	firmwareVersion	The firmware version of the protocol to determine.

Returns

Type	Description
XBeeProtocol	The XBee protocol corresponding to the given hardware and firmware versions.

Get(Format, Int32)

Gets the XBeeProtocol associated to the given ID.

Declaration

public static XBeeProtocol Get(this Format source, int id)

Parameters

Type	Name	Description
Format	source
System.Int32	id	The ID of the XBeeProtocol to retrieve.

Returns

Type	Description
XBeeProtocol	The XBeeProtocol associated to the given ID.

GetDescription(XBeeProtocol)

Gets the XBee protocol description.

Declaration

public static string GetDescription(this XBeeProtocol source)

Parameters

Type	Name	Description
XBeeProtocol	source

Returns

Type	Description
System.String	XBee protocol description.

GetID(XBeeProtocol)

Gets the XBee protocol ID.

Declaration

public static int GetID(this XBeeProtocol source)

Parameters

Type	Name	Description
XBeeProtocol	source

Returns

Type	Description
System.Int32	XBee protocol ID.

ToDisplayString(XBeeProtocol)

Returns the XBeeProtocol in string format.

Declaration

public static string ToDisplayString(this XBeeProtocol source)

Parameters

Type	Name	Description
XBeeProtocol	source

Returns

Type	Description
System.String	The XBeeProtocol in string format.