FB_S_UPS_BAPI

The function block FB_S_UPS_BAPI can be used on devices with 1-second UPS and with BIOS-API from version v1.15, in order to control the 1-second UPS from the PLC.

When the function block is first called, the data for accessing the 1-second UPS are determined via BIOS-API. This process takes several cycles. This is followed by cyclic testing for power failure. When the persistent data are written next, the access data for the PLC are saved persistently, so that during subsequent boot operations the check for power failures can take place immediately after the PLC start.

In the event of a power failure the charge state of the 1-second UPS is checked every 50 ms, every 200 ms if voltage is present and the capacity is less than 90%, and every second if voltage is present and the capacity is more than 90%. This also takes place via BIOS-API access.

In the event of a power failure the function block FB_S_UPS_BAPI can be used to save the persistent data and/or execute a quick shutdown, depending on the selected mode. The default input values of the FB_S_UPS_BAPI should be retained.

The 1-second UPS does not have sufficient capacity for bridging power failures. Only the Compact Flash/CFast card/Micro SD can be used for data storage, in view of the fact that the UPS capacity is not sufficient for operating a hard disk.

The 1-second UPS can be used only for a few seconds in the event of a power failure in order, to save persistent data. The data must be saved in the fast “persistent mode” “SPDM_2PASS”, even though this can lead to real-time violations. Make sure you configure adequate router memory for saving the persistent data.

Irrespective of the mode and irrespective of whether data were saved or the quick shutdown was executed, the 1-second UPS switches off the mainboard after the discharging of the capacitors.

Note

Loss of data

If other applications or the PLC keep further files open or write to them, file errors may occur if the 1-second UPS switches off the controller.

Function block modes

A QuickShutdown is performed automatically in the eSUPS_WrPersistData_Shutdown mode (standard setting) after the storage of the persistent data.

In the eSUPS_WrPersistData_NoShutdown mode only the persistent data are saved, no QuickShutdown is performed.

In eSUPS_ImmediateShutdown mode a quick shutdown is executed immediately, without saving data.

In the eSUPS_CheckPowerStatus mode only a check is performed as to whether a power failure has occurred. If this is the case, the function block only switches back to the PowerOK state after the expiry of tRecoverTime (10s).

Inputs

VAR_INPUT
    sNetID          : T_AmsNetId:= ''; (* '' = local netid *)
    iPLCPort        : UINT; (* PLC Runtime System for writing persistent data *)
    tTimeout        : TIME := DEFAULT_ADS_TIMEOUT; (* ADS Timeout *)
    eUpsMode        : E_S_UPS_Mode := eSUPS_WrPersistData_Shutdown; (* UPS mode (w/wo writing persistent data, w/wo shutdown) *)
    ePersistentMode : E_PersistentMode := SPDM_2PASS; (* mode for writing persistent data *)
    tRecoverTime    : TIME := T#10s; (* ON time to recover from short power failure in mode eSUPS_WrPersistData_NoShutdown/eSUPS_CheckPowerStatus *)
END_VAR

Name	Type	Description
sNetID	T_AmsNetId	AmsNetID of the controller
iPLCPort	UINT	Port number of the PLC runtime system (851 for the first PLC runtime system, 852 for the second PLC runtime system, etc.). If you do not specify a port number, the function block then automatically determines the port of the PLC runtime system.
tTimeout	TIME	Timeout for writing the persistent data or the quick shutdown
eUpsMode	E_S_UPS_Mode	Defines whether persistent data are to be written and whether a quick shutdown is to be executed. The default value is eSUPS_WrPersistData_Shutdown, i.e. a quick shutdown is executed automatically once the persistent data have been saved.
ePersistentMode	E_PersistentMode	Mode for writing the persistent data. Default value is SPDM_2PASS.
tRecoverTime	TIME	Time after which the UPS reverts to the PowerOK status in the event of UPS modes without shutdown. tRecoverTime must be somewhat longer than the maximum holding time of the UPS in order to ensure that the capacitors are fully charged.

Outputs

VAR_OUTPUT
    bPowerFailDetect  : BOOL; (* TRUE while powerfailure is detected *)
    eState            : E_S_UPS_State; (* current ups state *)
    nCapacity         : BYTE; (* actual capacity of UPS *)
    bBusy             : BOOL; (* TRUE: function block is busy *)
    bError            : BOOL; (* FALSE: function block has error *)
    nErrID            : UDINT; (* FB error ID *)
END_VAR

Name	Type	Description
bPowerFailDetect	BOOL	TRUE during power failure. FALSE if the supply voltage is present.
eState	E_S_UPS_State	Internal state of the function block
nCapacity	BYTE	Current charge state of the capacitors in percent (0..100%)
bBusy	BOOL	TRUE, as long as the function block is active.
bError	BOOL	FALSE if an error has occurred.
nErrID	UDINT	Error number

Requirements

Development environment	Target platform	PLC libraries to include
TwinCAT v3.1 B4020.32	Platforms that support the BIOS API from v1.15	Tc2_SUPS