Liebert GXT/GXT2 UPS Driver

Modified on 2010/12/15 11:09 by Administrator — Categorized as: Driver

This driver supports the ESP-II protocol. It was tested with a GXT1000MT-120 and GXT2-1000RT120 models.

Manufacturer: Liebert

Primary Communications Port: Serial


Configuration Settings


Events

State Rectifier PFC Changed

Occurs when the UPS's current PFC state (on/off) changes.

Whenever Filter:

none

EventArgs:


State DCDC Converter Changed

Occurs when the UPS's current DC DC Converter state (on/off) changes.

Whenever Filter:

none

EventArgs:


State Inverter Changed

Occurs when the UPS's current Inverter state (on/off) changes.

Whenever Filter:

none

EventArgs:


State Overtemp Changed

Occurs when the UPS's current Overtemp state (on/off) changes.

Whenever Filter:

none

EventArgs:


State Battery Test Changed

Occurs when the UPS's current BatteryTest state (on/off) changes.

Whenever Filter:

none

EventArgs:


State Battery Mode Changed

Occurs when the UPS's current PFC state (on/off) changes.

Whenever Filter:

none

EventArgs:


State Bypass Mode Changed

Occurs when the UPS's current Bypass Mode state (on/off) changes.

Whenever Filter:

none

EventArgs:


State Replace Battery Changed

Occurs when the UPS's current Replace Battery state (on/off) changes.

Whenever Filter:

none

EventArgs:


State Overload Changed

Occurs when the UPS's current Overload state (on/off) changes.

Whenever Filter:

none

EventArgs:


State Shutdown Pending Changed

Occurs when the UPS's current Shutdown Pending state (on/off) changes.

Whenever Filter:

none

EventArgs:


State Low Battery State Changed

Occurs when the UPS's current Low Battery state (on/off) changes.

Whenever Filter:

none

EventArgs:


Ready State Changed

The device's running and ready state changed.

Whenever Filter:

none

EventArgs:


Instance Properties

Model

Gets the Liebert UPS Model.

Accessibility : Read Only

Type: String

Firmware

Gets the Liebert UPS Firmware.

Accessibility : Read Only

Type: String

SerialNumber

Gets the Liebert UPS Serial Number.

Accessibility : Read Only

Type: String

ManufacturingDate

Gets the Liebert UPS Manufacturing Date.

Accessibility : Read Only

Type: String

Temperature

Get the temperature in degree Celsius.

Accessibility : Read Only

Type: Number

BatteryVoltage

Get the battery voltage in Volts.

Accessibility : Read Only

Type: Number

BatteryCapacity

Get the battery capacity in %.

Accessibility : Read Only

Type: Number

BatteryCurrent

Get the battery current in Ampere.

Accessibility : Read Only

Type: Number

InputFrequency

Get the input frequency in Hz.

Accessibility : Read Only

Type: Number

OutputFrequency

Get the output frequency in Hz.

Accessibility : Read Only

Type: Number

BypassFrequency

Get the bypass frequency in Hz.

Accessibility : Read Only

Type: Number

InputVoltage

Get the input voltage in Volt.

Accessibility : Read Only

Type: Number

OutputVoltage

Get the output voltage in Volt.

Accessibility : Read Only

Type: Number

BypassVoltage

Get the bypass voltage in Volt.

Accessibility : Read Only

Type: Number

OutputCurrent

Get the output current in Ampere.

Accessibility : Read Only

Type: Number

OutputRealPower

Get the output real power in Watts.

Accessibility : Read Only

Type: Number

OutputApparentPower

Get the output apparent power in VoltAmpere.

Accessibility : Read Only

Type: Number

OutputLoadPercent

Get the output load in %.

Accessibility : Read Only

Type: Number

BatteryExpectedRuntime

Get the battery expected runtime (for actual load) in minute.

Accessibility : Read Only

Type: Number

StateRectifierPFC

Gets the Rectifier/PFC state (on/off). In normal operation, the rectifier/power factor correction (PFC) circuit converts utility AC power to regulated DC power for use by the inverter, while ensuring that the waveshape of the input current used by the UPS is near ideal.

Accessibility : Read Only

Type: Boolean

StateDCDCConverter

Gets the DC-DC Converter state (on/off). The DC-DC converter utilizes energy from the battery system and raises the DC voltage to the optimum operating voltage for the inverter.

Accessibility : Read Only

Type: Boolean

StateInverter

Gets the Inverter state (on/off). In normal operation, the inverter utilizes the DC output of the power factor correction circuit and “inverts” it into precise, regulated sinewave AC power. Upon a utility power failure, the inverter receives its required energy from the battery through the DC-DC converter.

Accessibility : Read Only

Type: Boolean

StateOvertemp

Gets the Overtemp state (on/off).

Accessibility : Read Only

Type: Boolean

StateBatteryTest

Gets the BatteryTest state (on/off).

Accessibility : Read Only

Type: Boolean

StateBatteryMode

Gets the Battery Mode state (on/off).

Accessibility : Read Only

Type: Boolean

StateBypassMode

Gets the Bypass Mode state (on/off).

Accessibility : Read Only

Type: Boolean

StateReplaceBattery

Gets the Replace Battery state (on/off).

Accessibility : Read Only

Type: Boolean

StateOverload

Gets the Overload state (on/off).

Accessibility : Read Only

Type: Boolean

StateShutdownPending

Gets the Shutdown Pending state (on/off).

Accessibility : Read Only

Type: Boolean

StateLowBattery

Gets the Low Battery state (on/off).

Accessibility : Read Only

Type: Boolean

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

SendRawCommand ( String )

Sends a command that may otherwise not be supported by the driver. Potentially dangerous.

Syntax

void SendRawCommand( String cmd )

Parameters

cmd : Command to be be sent.

SetOutputOn

Set UPS output to ON.

Syntax

void SetOutputOn( )

Parameters

none

SetOutputOff

Set UPS output to OFF. Note: the UPS has a configured delay before turning output OFF.

Syntax

void SetOutputOff( )

Parameters

none

SetPropertyForDuration ( String, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, Number arrayIndex, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
arrayIndex : The property's array index to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.