UPS information in Windows registry

BatteryCapacity

REG_DWORD

The percent of battery capacity remaining in the UPS. This element is represented as a value in the range of 0 through 100 percent. (The displayed value is rounded to the nearest integer.)

0

BatteryStatus

REG_DWORD

The current status of the UPS batteries. This member can be of the following value:

• 0 := The battery status is unknown;
• 1 := The batteries are OK;
• 2 := The batteries need to be replaced;

0

CommStatus

REG_DWORD

The status of the communication path to the UPS. This member can be of the following value:

• 0 := The communication path to the UPS is unknown;
• 1 := The communication path to the UPS is OK;
• 2 := The communication path to the UPS has been lost;

0

FirmwareRev

REG_SZ

Reports the UPS firmware revision as a displayable string.

""

SerialNumber

REG_SZ

Reports the UPS serial number as a displayable string.

""

TotalUPSRuntime

REG_DWORD

The amount of remaining UPS run time, in minutes.

0

TotalUPSRuntimeSec

REG_DWORD

The amount of remaining UPS run time, in seconds. Implemented in UPS software v3.0.0.13 and higher.

0

UtilityPowerStatus

REG_DWORD

Reports the status of utility-supplied power into the UPS. This member can be of the following value:

• 0 := The status of utility-supplied power is unknown;
• 1 := Utility-supplied power is OK;
• 2 := A power failure has occurred;

0

TcPowerFailCnt

REG_DWORD

Power fail counter. Increments every time the UPS service detects power fail.

0

BatteryReplaceDate

REG_SZ

Set battery replace date. The latest battery replace date can be set using the Beckhoff UPS Configuration->Configure device.. dialog command. Implemented in UPS software v3.0.0.8 and higher.

""

TcChargeFlags

REG_DWORD

Battery charge status flags. This member can be one or more of the following values (bits):

Bits0..7 := General battery status flags (if all bits are set to 0 => unknown status).

• Bit0 := Load status "High" (bit is set);
• Bit1 := Load status "Low" (bit is set);
• Bit2 := Load status "Critical" (bit is set);
• Bit3 := Load status "Charging" (bit is set);
• Bits4..6 := Reserved (all bits are 0);
• Bit7 := No battery (bit is set);
• Bits8..15 := Special status information (if all bits are set to 0 => state ok or unknown).
• Bit8 := UPS fan error (bit is set);
• Bit9 := Over Temperature (bit is set). Implemented in UPS software v3.0.018 and higher;
• Bit10 := Battery replace service intervall has expired (bit is set). Implemented in UPS software v3.0.0.8 and higher;
• Bit11 := Under Temperature (bit 11 ist set). Implemented in UPS software v3.0.018 and higher;
• Bit12 := Fuse Not Ok (bit 12 is set). Implemented in UPS software v3.0.018 and higher;
• Bit13 := Alarm1 (reserved for later use, bit is 0);
• Bit14 := Alarm2 (reserved for later use, bit is 0);
• Bit15 := Alarm3 (reserved for later use, bit is 0);
• Bits16..31 := reserved for later use (all bits are 0);

0

BatteryHardwareVersion

REG_SZ

Hardware version of battery unit. Implemented in UPS software v3.0.0.13 and higher.

""

BatteryProductionDate

REG_SZ

Manufacturing date of the battery unit. Implemented in UPS software v3.0.0.13 and higher.

""

BatteryRatedCapacity

REG_DWORD

Rated battery capacity (mAh). Implemented in UPS software v3.0.0.13 and higher.

0

BatterySerialNumber

REG_SZ

Serial number of battery unit. Implemented in UPS software v3.0.0.13 and higher.

""

Vendor

REG_SZ

UPS vendor name

"(None)"

Model

REG_SZ

UPS model name

""

RunTaskEnable

REG_DWORD

Enable/disable the configuration of the Task Scheduler shutdown task:

• 0 := Disable;
• 1 := Enable;
• other values are not allowed;

0

TaskName

REG_SZ

Name of the Task Scheduler shutdown task. The Beckhoff UPS configuration dialog is creating shutdown task with the name: "UPS System Shutdown Program".

""

TaskFolder

REG_SZ

Folder name of the Task Scheduler shutdown task. Empty string is representing the root folder. Implemented only in UPS software v3.0.0.10 and higher.

""

TaskCompatibility

REG_DWORD

Task Scheduler v1.0 compatibility settings. Implemented only in UPS software v3.0.0.10 and higher.

• 0 := Automatic, use the newest Task Scheduler interface version (currently v2.0);
• 1 := Force use of Task Scheduler v1.0 interface;
• 2 := Force use of Task Scheduler v2.0 interface;
• other values are not allowed;

0

RunTaskWait

REG_DWORD

The max. run time (execution time) of the shutdown task in seconds. After this time the UPS service continues the windows shutdown process.

Implemented/available only in UPS software v3.0.0.8 and higher and available only under Windows Vista, W7, WES 7 (32 and 64 bit) Older operating systems have fixed max. run time value of 30 seconds.

30

ShutdownOnBatteryEnable

REG_DWORD

Enable/disable the shutdown of operating system after critical alarm:

• 0 := Disable;
• 1 := Enable;
• other values are not allowed;

1

ShutdownOnBatteryWait

REG_DWORD

Max. run time on batteries before critical alarm. This element is represented as value in range from 0 through 720 minutes. Other values are not allowed.

2

ShutdownOnBatteryWaitUnit

REG_DWORD

Unit of max. run time on batteries before critical alarm. Implemented only in UPS software v3.0.0.13 and higher.

• 0 := Seconds. Available only under Windows Vista, W7, WES 7  (32 and 64 bit).
• 1 := Minutes.

1

NotifyEnable

REG_DWORD

Enable/disable sending of "power fail" messages:

• 0 := Disable;
• 1 := Enable;
• other values are not allowed;

0

TurnUPSOffEnable

REG_DWORD

Activate/deactivate switching off the UPS outputs after shutdown:

• 0 := Deactivate;
• 1 := Activate (switch off);
• other values are not allowed;

1

TurnUPSOffWait

REG_DWORD

Max. delay time in seconds to switch off the UPS output to save battery charge. The allowed values may vary and depends on the used UPS model.

180

BatteryReplaceNotifyEnable

REG_DWORD

Enable/disable logging of battery replace warnings in Window Eventlog:

• 0 := Disable;
• 1 := Enable;
• other values are not allowed.

Implemented in UPS software v3.0.0.8 and higher.

0

BatteryReplaceNotifyWait

REG_DWORD

Months between the latest battery replace date (if known) and the first battery replace warning in the Windows Eventlog. This element is represented as value in range from 0 through 480 months. Other values are not allowed.

Implemented in UPS software v3.0.0.8 and higher.

60

TcTurnUPSProtOffWait

REG_DWORD

Max. delay time for switching off UPS protection after session end (user shutdown or restart) in seconds. With shorter times, the PC (and the UPS) can be switched off more quickly after a shutdown. However, during a restart the PC may not be fully protected against voltage failure. With longer times and shutdown, it takes longer for the PC (and the UPS) to switch off. On the other hand, during a restart the PC is protected during the complete start-up phase. During a restart, UPS protection is activated before the delay time has elapsed once the UPS service has resumed communication with the UPS.

360

FirstMessageDelay

REG_DWORD

Seconds between the power failure and first message send to the user.

5

MessageInterval

REG_DWORD

Seconds between subsequent power fail messages send to the user.

20