Class XBeeFirmware

This class represents an XBee firmware.

Inheritance

System.Object

XBeeFirmware

Implements

System.ICloneable

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: XBeeLibrary.Core.Models

Assembly: XBeeLibrary.Core.dll

Syntax

public class XBeeFirmware : ICloneable

Constructors

XBeeFirmware(String, String, String, String, String, String, String, String, String)

Class constructor. Instantiates a new XBeeFirmware object with the provided parameters.

Declaration

public XBeeFirmware(string family, string productName, string hardwareVersion, string compatibilityNumber, string firmwareVersion, string configBufferLocation, string flashPageSize, string crcBufferLength, string function)

Parameters

Type	Name	Description
System.String	family	XBee product family name.
System.String	productName	XBee product name.
System.String	hardwareVersion	Hardware version the firmware is compatible with.
System.String	compatibilityNumber	Compatibility number of the XBee firmware.
System.String	firmwareVersion	XBee firmware version.
System.String	configBufferLocation	Configuration buffer location of the XBee firmware.
System.String	flashPageSize	Flash page size (in bytes) of the XBee firmware.
System.String	crcBufferLength	CRC buffer length of the XBee firmware.
System.String	function	XBee function.

Fields

EXTENSION_EBIN

Declaration

public const string EXTENSION_EBIN = ".ebin"

Field Value

Type	Description
System.String

EXTENSION_EHX2

Declaration

public const string EXTENSION_EHX2 = ".ehx2"

Field Value

Type	Description
System.String

Properties

ActiveNetworkIndex

Indicates the index of the current active network (index starts at 1).

Declaration

public int ActiveNetworkIndex { get; set; }

Property Value

Type	Description
System.Int32

BinaryFileLocation

Path where the binary file is located.

Declaration

public string BinaryFileLocation { get; set; }

Property Value

Type	Description
System.String

Categories

List of configuration categories of the firmware.

Declaration

public List<XBeeCategory> Categories { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<XBeeCategory>

CompatibilityNumber

Compatibility number of the XBee firmware.

Declaration

public string CompatibilityNumber { get; }

Property Value

Type	Description
System.String

ConfigBufferLocation

Configuration buffer location of the XBee firmware.

Declaration

public string ConfigBufferLocation { get; }

Property Value

Type	Description
System.String

CrcBufferLength

CRC buffer length of the XBee firmware.

Declaration

public string CrcBufferLength { get; }

Property Value

Type	Description
System.String

DefinitionFileContent

String containing the full content of the XML definition file.

Declaration

public string DefinitionFileContent { get; set; }

Property Value

Type	Description
System.String

DefinitionFileLocation

Path where the XML definition file is located.

Declaration

public string DefinitionFileLocation { get; }

Property Value

Type	Description
System.String

Family

XBee product family name.

Declaration

public string Family { get; }

Property Value

Type	Description
System.String

FirmwareVersion

Version of the XBee firmware.

Declaration

public string FirmwareVersion { get; }

Property Value

Type	Description
System.String

FirstTimeRead

Indicates whether the settings have been read at least 1 time or not.

Declaration

public bool FirstTimeRead { get; set; }

Property Value

Type	Description
System.Boolean

FlashPageSize

Flash page size (in bytes) of the XBee firmware.

Declaration

public string FlashPageSize { get; }

Property Value

Type	Description
System.String

Function

XBee function.

Declaration

public string Function { get; }

Property Value

Type	Description
System.String

HardwareVersion

Hardware version the firmware is compatible with.

Declaration

public string HardwareVersion { get; set; }

Property Value

Type	Description
System.String

Initialized

Indicates whether the firmware is initialized (categories and settings have been parsed and listed) or not.

Declaration

public bool Initialized { get; set; }

Property Value

Type	Description
System.Boolean

ModemUrl

URL where the modem firmware associated to the XBee firmware is stored.

Declaration

public string ModemUrl { get; set; }

Property Value

Type	Description
System.String

ModemVersion

Version of the modem firmware associated to the XBee firmware.

Declaration

public string ModemVersion { get; set; }

Property Value

Type	Description
System.String

ProductName

XBee product name.

Declaration

public string ProductName { get; }

Property Value

Type	Description
System.String

Region

Region string identifier of the firmware.

Declaration

public string Region { get; set; }

Property Value

Type	Description
System.String

Methods

AddDependency(String, String)

Adds a setting dependency.

Declaration

public void AddDependency(string atCommand, string dependsOn)

Parameters

Type	Name	Description
System.String	atCommand	Setting that has a dependency.
System.String	dependsOn	Setting that depends on atCommand.

Remarks

[XCTUNG-1180] Range may contain a reference to another AT command.

Clone()

Creates a shallow copy of the XBeeFirmware.

Declaration

public object Clone()

Returns

Type	Description
System.Object	The copy of the XBeeFirmware

CloneFirmware()

Clones and returns the XBee firmware object.

Declaration

public XBeeFirmware CloneFirmware()

Returns

Type	Description
XBeeFirmware	The cloned XBee firmware object.

Equals(Object)

Returns whether this object is equal to the given one.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The object to compare if it is equal to this one.

Returns

Type	Description
System.Boolean	true if this object is equal to the given one, false otherwise.

Overrides

System.Object.Equals(System.Object)

FillContents()

Parses and fills the contents of this XBee firmware.

Declaration

public void FillContents()

GetAtSetting(String)

Returns the setting corresponding to the provided atCommand in any category of the firmware.

Declaration

public AbstractXBeeSetting GetAtSetting(string atCommand)

Parameters

Type	Name	Description
System.String	atCommand	The AT command corresponding to the setting to get.

Returns

Type	Description
AbstractXBeeSetting	The setting corresponding to the provided AT command.

GetAtSettings()

Returns the list of settings defined in the firmware.

Declaration

public List<AbstractXBeeSetting> GetAtSettings()

Returns

Type	Description
System.Collections.Generic.List<AbstractXBeeSetting>	The list of settings defined in the firmware.

GetATSettingsNumber()

Returns the total number of settings contained in the XBee firmware.

Declaration

public int GetATSettingsNumber()

Returns

Type	Description
System.Int32	The total number of setings of the firmware.

GetBinaryFileWithExtensionPath()

Returns the path where the binary file of this XBee firmware is located, including the extension of the binary.

Declaration

public string GetBinaryFileWithExtensionPath()

Returns

Type	Description
System.String	The path (with extension) where the binary file of this XBee firmware is located

GetCommonAtSettings()

Returns the list of settings that don't support multiple networks. If the firmware only supports 1 network, this method returns the same list as GetAtSettings().

Declaration

public List<AbstractXBeeSetting> GetCommonAtSettings()

Returns

Type	Description
System.Collections.Generic.List<AbstractXBeeSetting>	The list of settings that don't support multiple networks.

GetDependencies(String)

Gets the dependencies of the given setting.

Declaration

public List<string> GetDependencies(string atCommand)

Parameters

Type	Name	Description
System.String	atCommand	Setting of which obtain the dependencies.

Returns

Type	Description
System.Collections.Generic.List<System.String>	List of AT commands that depend on the given one.

GetDualAtSettings()

Returns the list of settings that can be configured for multiple networks.

Declaration

public List<AbstractXBeeSetting> GetDualAtSettings()

Returns

Type	Description
System.Collections.Generic.List<AbstractXBeeSetting>	The list of settings that can be configured for multiple networks.

GetHashCode()

Returns the Hash code of this object.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	The Hash code of this object.

Overrides

System.Object.GetHashCode()

GetNumberOfNetworks()

Retrieves the number of networks addressed by this firmware.

Declaration

public int GetNumberOfNetworks()

Returns

Type	Description
System.Int32	The number of networks addressed by this firmware.

GetSerialBaudRate()

Returns the XBee value (value stored in the XBee module) of the baud rate setting of the firmware.

Declaration

public int GetSerialBaudRate()

Returns

Type	Description
System.Int32	The XBee value of the baud rate setting of the firmware.

GetSerialDataBits()

Returns the number of serial data bits.

Declaration

public int GetSerialDataBits()

Returns

Type	Description
System.Int32	The number of serial data bits.

GetSerialParity()

Returns the XBee value (value stored in the XBee module) of the serial parity setting of the firmware.

Declaration

public int GetSerialParity()

Returns

Type	Description
System.Int32	The XBee value of the serial parity setting of the firmware.

GetSerialStopBits()

Returns the XBee value (value stored in the XBee module) of the stop bits setting of the firmware.

Declaration

public int GetSerialStopBits()

Returns

Type	Description
System.Int32	The XBee value of the stop bits setting of the firmware.

GetSupportedBinaries()

Returns a string containing the supported binaries separated by '|' char.

Declaration

public static string GetSupportedBinaries()

Returns

Type	Description
System.String	A string containing the supported binaries.

HasSerialInterface()

Returns whether the XBee firmware has serial interface or not.

Declaration

public bool HasSerialInterface()

Returns

Type	Description
System.Boolean	true if the firmware has serial interface, false otherwise.

SetDefinitionFilePath(String)

Sets the path where the XML definition file of this XBee firmware is located.

Declaration

public void SetDefinitionFilePath(string definitionFileLocation)

Parameters

Type	Name	Description
System.String	definitionFileLocation	The XML definition file path.

SupportsMultipleNetworks()

Returns whether this firmware addresses multiple networks or not.

Declaration

public bool SupportsMultipleNetworks()

Returns

Type	Description
System.Boolean	true if the firmware addresses more than 1 network, false otherwise.

ToString()

Returns a string representation of this object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string representation of this object.

Overrides

System.Object.ToString()

Implements

System.ICloneable