FB_GetUPSStatus

Requirements under NT4, Win2K, WinXP, WinXP embedded:

• The Beckhoff UPS software components are installed (additional tab under Control Panel->Energy Options->Beckhoff UPS Configuration );.
• The UPS has been configurated with the Windows UPS service ( Control Panel->Energy Options->UPS ) or the Beckhoff Shell extension ( Control Panel->Energy Options->Beckhoff UPS Configuration ). Further information about the UPS configuration can be found in the considering documentation.

Requirements under Windows CE:

• Beckhoff CE devices with 24 V UPS service are delivered with a special Beckhoff Battery Driver for Windows CE. The driver is included in the standard CE Image. No further configuration settings are required.

With the FB_GetUPSStatus function block the PLC can read the status of a UPS hardware. The block is level triggered, which means that the status information is only cyclically read while the bEnable input is set. To maintain system loading at a low level, the status information is only read approximately 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.

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

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