Variable name

Data format

I/O

C

Devices

Description

BatCapacity

VT=i8

R

APC620

APC810

PPC800

Remaining capacity of the UPS battery in percent. 5

-1 = Cannot determine capacity

BatCurrent

VT=f32

R

APC620

APC810

APC910

PPC800

PPC900

> 0: Charging current of the UPS battery in mA.

< 0: Discharge current of the UPS battery in mA.

BatDeviceId

VT=u32

R

4

APC620

APC810

PPC800

Device ID of UPS battery (or ID of user's own UPS battery).

BatModelNumber

VT=string VL=41

R

4

APC620

APC810

PPC800

Model number of UPS battery (or description of user's own UPS battery).

BatRuntime

VT=u32

R

APC620

APC810

PPC800

Remaining runtime of the UPS battery in seconds. 2

0 = Cannot determine runtime

BatSettings

VT=u8 VN=256

R

4

APC620

APC810

PPC800

UPS battery settings.

For B&R-internal use only!

BatSettingsVersion

VT=string VL=8

R

4

APC620

APC810

PPC800

Version of the UPS battery settings.

Example: "1.02"

BatTemperature

VT=i8

R

APC620

APC810

APC910

PPC800

PPC900

Temperature of the UPS battery in degrees °C: 1

The value -128 is shown if the temperature cannot be measured.

If the permitted temperature range is exceeded, a temperature alarm is triggered by the UPS (see Status). The permitted temperature range is defined in the UPS battery settings. It can be displayed e.g. in the B&R Control Center.

BatVoltage

VT=f32

R

APC620

APC810

APC910

PPC800

PPC900

Voltage of the UPS battery in volts.

CompatibilityId

VT=u16

R

3

APC620

APC810

PPC800

UPS compatibility ID.

Detected

VT=boolean

R

ü

APC620

APC810

APC910

PPC800

PPC900

Code for whether the UPS has been detected:

0 = Not detected

1 = Detected

DeviceId

VT=u32

R

3

APC620

APC810

PPC800

Device ID of the UPS.

FactoryData

VT=u8 VN=256

R

3

obsolete - replaced by FactorySettings

FactorySettings

VT=u8 VN=256

R

3

APC620

APC810

PPC800

UPS factory settings.

For B&R-internal use only!

FactorySettingsVersion

VT=string VL=8

R

3

APC620

APC810

PPC800

Version of factory settings

Example: "1.02"

FactoryVersion

VT=string VL=8

R

3

obsolete - replaced by FactorySettingsVersion

FirmwareVersion

VT=string VL=16

R

APC620

APC810

PPC800

UPS firmware version.

Example: "1.10"

HardwareRevision

VT=string VL=5

R

3

APC620

APC810

PPC800

Hardware revision of the UPS.

Linked

VT=boolean

R

APC620

APC810

APC910

PPC800

PPC900

Code for whether the UPS is connected:

0 = Not connected

1 = Connected, communication with UPS is functioning properly.

ModelNumber

VT=string VL=41

R

3

APC620

APC810

PPC800

Model number of the UPS.

OnBatCycles

VT=u16

R

ü

APC910

PPC900

Number of battery operation cycles (e.g. power failures) of the UPS

OnBatHours

VT=u16

R

APC910

PPC900

Number of hours of UPS battery operation.

SerialNumber

VT=string VL=12

R

3

APC620

APC810

PPC800

UPS serial number.

SpecialsData

VT=u32

R

APC620

APC810

APC910

PPC800

PPC900

For B&R-internal use only!

Status

VT=u32

R

APC620

APC810

APC910

PPC800

PPC900

UPS status: 6

Bit 0 = 1: Supply voltage OK

Bit 1 = 1: Battery settings missing or invalid

Bit 2 = 1: Battery operation

Bit 3 = 1: Battery status "Very low"

Bit 4 = 1: Reversed battery polarity 9

Bit 5 = 1: Battery error (missing, defective, incorrect voltage/current/temperature)

Bit 6 = 1: Battery life exhausted 2

Bit 7 = 1: Shutdown active

Bit 8 = 1: Overcurrent alarm 1

Bit 9 = 1: Factory settings missing or invalid 1

Bit 10 = 1: APC add-on UPS: User settings missing or invalid 1, APC IF UPS: User settings not supported 7

Bit 15 = 1: Battery temperature exceeded or can't be measured 1 5

Type

VT=string VL=5

R

APC620

APC810

APC910

PPC800

PPC900

Type of UPS: "UPSI" for APC add-on UPS or "UPSII" for APC IF USV. 8

VendorId

VT=u32

R

3

APC620

APC810

PPC800

ID of the UPS manufacturer (B&R = 0).

1

Requires UPS firmware version 1.10 or higher on the APC610, APC810, PPC800.

2

Not supported by the current APC add-on UPS firmware 1.10.

3

The value can only be modified by updating the factory settings.

4

The value can only be modified by updating the battery settings.

5

100% is only supplied by the current UPS firmware if the battery is fully charged.

6

In APC add-on UPS firmware version 1.07 or lower, the status is sometimes shown as 0 when changing between battery operation and normal operation. Normally, bit 0 or bit 2 is always set.

7

Requires MTCX version 1.04 or higher on the APC910.

8

Up to version 2.0 of the driver, the APC IF UPS is registered as UPSI on the APC910/PPC900.

9

Requires APC add-on UPS firmware version 1.08 or higher.