FB_GetUPSStatus

Requirements:

Beckhoff UPS software components have been installed:

Windows 7, Windows Embedded Standard 7 and higher: Configuration dialog under "Start->Programs->Beckhoff->UPS Software Components".
NT4, Win2K, WinXP, WinXP embedded: Additional tab under “Control Panel->Power Options->Beckhoff UPS Configuration” or “Control Panel->Power Options->UPS”.
Beckhoff CE devices with 24 V UPS support are delivered with a special Beckhoff Battery Driver for Windows CE. The driver is included in the standard CE image for these devices.

The UPS has been activated and configured. You can find more information about UPS configuration in the corresponding advanced UPS software and device documentation.

Windows 7, Windows Embedded Standard 7 and higher: Configuration dialog under "Start->Programs->Beckhoff->UPS Software Components".
NT4, Win2K, WinXP, WinXP embedded: Configuration dialog under “Control Panel->Power Options->Beckhoff UPS Configuration”.
Windows CE: The UPS function is disabled by default and must be enabled via a RegFile. Newer images have a configuration dialog under "Start->Control Panel->BECKHOFF UPS Configuration".

The FB_GetUPSStatus function block reads the status of the UPS hardware from the PLC. The function block is level triggered, which means that the status information of the UPS is only cyclically read while the bEnable input is set. To keep the system load low, the status information is read every ~4.5 s. When the bValid output is set, the most recently read data is valid. The most recent read cycle was, in other words, executed without error. If an error occurs, the read cycle is repeated, and the error signal is automatically reset as soon as the cause of the error (e.g. no communication with the UPS) has been corrected.

Inputs

VAR_INPUT
    sNetId   : T_AmsNetId;
    nPort    : T_AmsPort;(* 0 = Windows UPS service / Windows Battery Driver *)
    bEnable  : BOOL;
END_VAR

Name	Type	Description
sNetId	T_AmsNetID	A string with the network address of the TwinCAT computer whose UPS status is to be read can be specified here. For the local computer an empty string may be specified.
nPort	T_AmsPort	The ADS port number. Set this value to zero. Other port numbers are reserved for future applications.
bEnable	BOOL	The UPS status is read cyclically if this input is set.

Outputs

VAR_OUTPUT
    bValid     :BOOL;
    bError     :BOOL;
    nErrId     :UDINT;
    stStatus   :ST_UPSStatus;
END_VAR

Name	Type	Description
bValid	BOOL	If this output is set, the data in the ST_UPSStatus structure are valid (no error occurred during the last reading cycle).
bError	BOOL	This output is set if an error occurred when executing the function.
nErrId	UDINT	Returns the ADS error number or the command-specific error code (table) if the bError output is set.

Error codes	Error description
0x0000	No error
0x8001	UPS configuration error. It is possible that the UPS is not configured correctly or that no UPS is configured at all.
0x8002	Communication error. Communication with the UPS was interrupted.
0x8003	Error during the reading of the status data.

Name	Type	Description
stStatus	ST_UPSStatus	Structure with the status information of the UPS.

Not all UPS devices can provide all status information. Some devices, for example, cannot supply the BatteryLifeTime or BatteryReplace status.

Example:

Online data with status information of a UPS:

FB_GetUPSStatus 4:

Requirements

Development environment	Target platform	UPS hardware	PLC libraries to be integrated (category group)
TwinCAT v3.1.0	PC or CX (x86, x64, ARM)	Beckhoff BAPI v1; Beckhoff P24Vxxxx; Beckhoff CP903x card (PCI/ISA); Beckhoff CX2100-09x4 models (e.g. CX2100-0904 or CX2100-0914 + "Smart Battery" CX2900-0192); The APC devices that come supplied with Beckhoff Industrial PC support the Smart protocol and can be configured with the Windows UPS service.	Tc2_IoFunctions (IO)