3BTG811792-3034 / A Page 1

Functional Description

Ratio01 - Ratio Station Version 5.2-0

3BTG811792-3034 / A Page 2

NOTICE

The information in this document is subject to change without notice and should not be construed as a commitment by ABB. ABB assumes no responsibility for any errors that may appear in this document.

In no event shall ABB be liable for direct, indirect, special, incidental or consequential damages of any nature or kind arising from the use of this document, nor shall ABB be liable for incidental or consequential damages arising from use of any software or hardware described in this document.

This document and parts thereof must not be reproduced or copied without written permission from ABB, and the contents thereof must not be imparted to a third party nor used for any unauthorized purpose.

The software or hardware described in this document is furnished under a license and may be used, copied, or disclosed only in accordance with the terms of such license.

TRADEMARKS

Copyright © 2012 ABB

All rights reserved.

Release: February 2012

Document number: 3BTG811792-3034

3BTG811792-3034 / A Page 3

Table of Contents

Section 1 - Introduction .................................................................................. 5

General ......................................................................................................................... 5

Section 2 - Function Block & Data Types ..................................................... 7

Function Block............................................................................................................. 7 Data Types ................................................................................................................... 8

Ratio01_InPar .................................................................................................................. 8 Ratio01_OutPar ............................................................................................................... 9 Ratio01_Opr ..................................................................................................................... 9

Permission ................................................................................................................. 10

Section 3 - Function ...................................................................................... 11

Control Modes ........................................................................................................... 11 Balance Mode ................................................................................................................ 11 Manual Mode ................................................................................................................. 11 Auto Mode...................................................................................................................... 11 E1 Mode ......................................................................................................................... 11

Function ..................................................................................................................... 12 Range ......................................................................................................................... 12 Ratio Limitation ......................................................................................................... 12 Output Limitation....................................................................................................... 13 Ramp Function .......................................................................................................... 13 Tracking ..................................................................................................................... 13 Alarm Limits ............................................................................................................... 13 Interlocks ................................................................................................................... 14 Interaction Window ................................................................................................... 14 Text Configuration ..................................................................................................... 17

Section 3 - Operator Function...................................................................... 19

Process Display ......................................................................................................... 19 Faceplate .................................................................................................................... 20

Aspect Link .................................................................................................................... 20 Reduced Faceplate and Faceplate ............................................................................... 20 Extended Faceplate ....................................................................................................... 21

Interlock Display ........................................................................................................ 24 Object Display............................................................................................................ 25 Object Trend Display ................................................................................................. 25 Alarm & Event ............................................................................................................ 26

Alarm & Event List ........................................................................................................ 26 Alarm Message .............................................................................................................. 26 Event Message .............................................................................................................. 26

3BTG811792-3034 / A Page 4

3BTG811792-3034 / A Page 5

Section 1 - Introduction

General Ratio01 is a functional unit for ratio control in ControlIT, to be operated from 800xA System.

Ratio01 has the following functions and properties: Different control modes, set by operator or by control logic Bumpless change between different control modes Controllable change rate of output Output & ratio limitation High & low limits supervision Interlocks function Alarm & Event detection and handling

3BTG811792-3034 / A Page 6

3BTG811792-3034 / A Page 7

Section 2 - Function Block & Data Types

Function Block Name Data Type Attributes

Direction

FD Port

Initial value Description

Name string coldretain in yes 'Ratio01' Object name Description string coldretain in yes 'Descr' Object description Enable bool coldretain in yes true Enable object Track_A bool coldretain in yes false Selection of tracking ref. (0= No tracking,

1=Ratioref is tracking ExtRef) MV real retain in yes Measured Value Speed4 real coldretain in yes 20 Max output change rate (unit/s) ManEnbl bool coldretain in yes true Enable Man mode AutoEnbl bool coldretain in yes true Enable Auto mode E1Enbl bool coldretain in yes true Enable E1 mode ExtRatio real retain in yes External ratio in E1 mode SeqE1 bool retain in yes Order mode to E1 Local bool retain in yes Order mode to Local BalIn bool retain in yes Order mode to Balance SeqMan bool retain in yes Order mode to Man SeqAuto bool retain in yes Order mode to Auto BalRef real coldretain in yes 0.0 Balance Reference Clamp bool retain in yes Order mode to Clamp ClampRef real coldretain in yes 0.0 Clamp Reference EOLim bool retain in yes Enable external output limit EOLL real coldretain in yes 0.0 External Output Low Limit EOHL real coldretain in yes 100.0 External Output High Limit EGainE bool retain in yes External Gain Enable EGain real coldretain in yes External Gain EBiasE bool retain in yes External Bias Enable EBias real coldretain in yes External Bias IB1 bool retain in yes true Process Interlock 1 IB2 bool retain in yes true Process Interlock 2 IB3 bool retain in yes true Process Interlock 3 IB4 bool retain in yes true Process Interlock 4 IB1Ref real coldretain in yes 0.0 Reference for Process Interlock 1 IB2Ref real coldretain in yes 0.0 Reference for Process Interlock 2 IB3Ref real coldretain in yes 0.0 Reference for Process Interlock 3 IB4Ref real coldretain in yes 0.0 Reference for Process Interlock 4 AlcBlk bool retain in yes Block alarm AlarmAck bool retain in yes Acknowledge alarm MVAlarms Alarm4Limit by_ref in yes MV alarm configuration InPar Ratio01_InPar by_ref in yes In Parameter EventName string coldretain in yes '||Ratio01_' Event name RatioRef real retain out yes Ratio Reference WRatio real retain out yes Working ratio Out real retain out yes Output Out_EQ_LL bool retain out yes Output less than or equal to Low Limit Out_EQ_HL bool retain out yes Output greater than or equal to High Limit Bal bool retain out yes Balance mode

3BTG811792-3034 / A Page 8

Name Data Type Attributes Directi

on FD

Port Initial value Description

Man bool retain out yes Man mode Auto bool retain out yes Auto mode E1 bool retain out yes E1 mode BalOut bool retain out yes Balance Out Ratio_EQ_LL bool retain out yes Ratio less than or equal to Low Limit Ratio_EQ_HL bool retain out yes Ratio greater than or equal to High Limit MV_GT_H2 bool retain out yes MV greater than or equal to High High

Limit (H2) MV_GT_H1 bool retain out yes MV greater than or equal to High Limit

(H1) MV_LT_L1 bool retain out yes MV less than or equal to Low Limit (L1) MV_LT_L2 bool retain out yes MV less than or equal to Low Low Limit

(L2) NoInt bool retain out yes No Interlocks OutPar Ratio01_OutPar by_ref out yes Out Parameter Opr Ratio01_Opr by_ref out yes Operator order

Data Types Ratio01_InPar

Ratio01_InPar data type contains all configuration parameter available in Ratio01. Configuration can be entered by writing value to this structured data type and connecting it to input InPar of Ratio01 function block.

Name Data Type Attributes Initial value

ISP value Description

Class dint coldretain 500 AE class Severity dint coldretain 1000 AE severity MVRange RangeReal coldretain MV Range SPRange RangeReal coldretain SP Range OUTRange RangeReal coldretain OUT Range SPLimit RangeLimit coldretain SP limit OUTLimit RangeLimit coldretain OUT limit InitMode dint coldretain 5 Init mode (5 = Man ; 6 = Auto ; 7 = E1) SeqManEvBlk bool coldretain true Block event for SeqMan SeqAutoEvBlk bool coldretain true Block event for SeqAuto SeqE1EvBlk bool coldretain true Block event for SeqE1 AlcBlkEvBlk bool coldretain true Block event for AlcBlk EOLimEvBlk bool coldretain true Block event for EOLim LocalEvBlk bool coldretain true Block event for Local BalInEvBlk bool coldretain true Block event for BalIn ClampEvBlk bool coldretain true Block event for Clamp IB1 IBInParType3 coldretain Configuration for IB1 IB2 IBInParType3 coldretain Configuration for IB2 IB3 IBInParType3 coldretain Configuration for IB3 IB4 IBInParType3 coldretain Configuration for IB4 OUTIncDec real coldretain 2.0 Increase/Decrease step of output (In

percentage of range) SPIncDec real coldretain 1.0 Increase/Decrease step of setpoint (In

percentage of range) Gain real coldretain 1.0 Gain Bias real coldretain 0.0 Bias

3BTG811792-3034 / A Page 9

Name Data Type Attributes Initial value

ISP value Description

FunctionType bool coldretain false Function (0 = multiply ; 1 = divide) HystType bool coldretain false Hysterisis type (0 = Unit, 1 = Percent)

Ratio01_OutPar Ratio01_OutPar data type contains all information on the object which not available on the

output parameter of the function block.

Name Data Type Attributes Initial value

ISP value Description

AlarmBlk bool retain Alarm blocked IntlkBlk bool retain Interlock blocked IntlkBlkActive bool retain Interlock blocked active EnOverrideAll bool retain Override All button enabled Mode dint retain Active mode NormalMode bool retain Normal mode (Active mode = Init mode) IB1Ind bool retain IB1 interlocked IB2Ind bool retain IB2 interlocked IB3Ind bool retain IB3 interlocked IB4Ind bool retain IB4 interlocked AU_MVH2 bool retain UnAcknowledge Alarm for MV > H2 AU_MVH1 bool retain UnAcknowledge Alarm for MV > H1 AU_MVL1 bool retain UnAcknowledge Alarm for MV < L1 AU_MVL2 bool retain UnAcknowledge Alarm for MV < L2 ALB_H2 bool retain High High MV alarm blocked ALB_H1 bool retain High MV alarm blocked ALB_L1 bool retain Low MV alarm blocked ALB_L2 bool retain Low Low MV alarm blocked

Ratio01_Opr Ratio01_Opr data type contains all operator order.

Name Data Type Attributes Initial value

ISP value Description

BlockAlarm bool retain Operator block alarms ALB_H2 bool retain Operator block alarm limit H2 ALB_H1 bool retain Operator block alarm limit H1 ALB_L1 bool retain Operator block alarm limit L1 ALB_L2 bool retain Operator block alarm limit L2 Man bool retain Operator order Manual mode Auto bool retain Operator order Auto mode E1 bool retain Operator order E1 mode Incr real retain Operator order Increase SP command Decr real retain Operator order Decrease SP command OverrideAll bool retain Operator override all interlocks IB1Override bool retain Operator override IB1 interlock IB2Override bool retain Operator override IB2 interlock IB3Override bool retain Operator override IB3 interlock IB4Override bool retain Operator override IB4 interlock AutoSP real coldretain Operator enter Auto Ratio ManOUT real coldretain Operator enter Man OUT

3BTG811792-3034 / A Page 10

Permission All variables in Ratio01_InPar data type are set with Configure permission in 800xA system.

All variables in Ratio01_Opr data type are set with Operate permission.

The variable permission can be configured according to the plant requirement. This can be done by adding Property Attribute Override aspect for the object in Control Structure or for the object type in Object Type Structure.

3BTG811792-3034 / A Page 11

Section 3 - Function

Control Modes There are four different control modes are available in priority order: Balance, Man, Auto and

E1. Active mode is indicated on the faceplate and object display. These modes can also be blocked individually from operator access. When in one particular mode, control from other location is blocked. Balance Mode

In Balance mode, the control output follows the input parameter BalRef. Balance mode can be activated by setting the input parameter Local or BalIn of the function

block. When activated by input parameter Local, an indication BaLo is presented in graphic elements and faceplate. When activated by input parameter BalIn, an indication Bal is presented instead. Manual Mode

Manual mode is the default init mode of the Ratio01. Manual mode can be activated as long as Local and BalIn is not active.

In this mode, operator directly sets the control output from the faceplate’s dialog entry window. Manual mode can be activated from the Man button on the faceplate or with a rising edge pulse to the input SeqMan of the function block. An indication M or Man is presented on the graphic elements and faceplate. To enable Man button on the faceplate, the input parameter ManEnbl must set to True.

Manual mode can also be activated by the setting the input parameter Clamp of the function block. The output will follow the input parameter ClampRef. An indication MCp is presented on the graphic elements and faceplate. During this condition, the output value set by operator is ignored. Auto Mode

In this mode, operator directly sets the ratio from the faceplate’s dialog entry window.

As long as Local and BalIn is not active, Auto can be activated from the Auto button on the faceplate or with a rising edge pulse to the input SeqAuto of the function block. An indication of A or Auto is presented on the graphic elements and faceplate. To enable Auto button on the faceplate, the input parameter AutoEnbl must set to True. E1 Mode

In this mode, the ratio is controlled by the input parameter ExtRef. As long as Local, BalIn and Clamp is not active, E1 mode can be activated from the E1

button on the faceplate or with a rising edge pulse to the input SeqE1 of the function block. An

3BTG811792-3034 / A Page 12

indication of E1 is presented on the graphic elements and faceplate. To enable E1 button on the faceplate, the input parameter E1Enbl must set to True.

The table below describes the control mode activation and priority of Ratio01. Signal Balance Manual Auto E1 Input Local (1) BaLo - - - Input BalIn (1) Bal - - - Input Clamp (1) - MCp - - Operator Man - M - - Input SeqMan (2) - M - Operator Auto - - A - Input SeqAuto (2) - - A - Operator E1 - - - E1 Input SeqE1 (2) - - - E1

1. On leaving Balance or Manual Clamped, Manual mode is always obtained, unless other signal commands another mode. 2. The arrow indicates that only a rising edge signal will trigger the mode change.

Function Ratio01 has two basic functions:

- Output = MV * (Working Ratio * Gain ) + Bias

- Output = MV / (Working Ratio * Gain ) + Bias

The selection of the above functions can be set from in the interaction window. When Function Type is 0, then multiply function is selected. If Function Type is 1, then divide function is selected.

Range Range parameter can be set from interaction window. Measured value, ratio and control

output have their own parameter. It includes Min, Max, Decimal/Fraction and Unit.

Ratio Limitation The value from ExtRatio when in E1 mode or operator input when in Auto mode is limited to

upper limit H and lower limit L before passed to the output WRatio.

Ratio limit can be entered from interaction window or extended faceplate. When limitation is not necessary, the Max and Min of ratio shall be used as the upper and lower limit.

For upper limit, the value of Ratio_EQ_HL will be set when WRatio H. It will be reset when the WRatio is lower than the ratio limit. For lower limit, the value of Ratio_EQ_LL will be set when WRatio L. It will be reset when the WRatio is greater than the ratio limit.

3BTG811792-3034 / A Page 13

Output Limitation The control output value is normally limited to the Max and Min of the output signal, but it’s

possible to define upper limit H and lower limit L within the signal range.

Internal output limit can be entered from interaction window or extended faceplate. It can also be set externally in logic via input parameter EOHL and EOLL. The activation of input parameter EOLim determines whether external limit or internal limit is applied to the output limitation.

The upper limit can be set equal to the lower limit, but lower limit cannot be set greater than the upper limit.

For upper limit, the value of Out_EQ_HL will be set when Out H. It will be reset when the Out is lower than the output limit. For lower limit, the value of Out_EQ_LL will be set when Out L. It will be reset when the Out is greater than the output limit.

Ramp Function Ramp function is introduced into the signal path to determine the maximum permitted rate of

change of certain signal. The maximum permitted rate of changed is determine by the input parameter Speed(x) and is specified in unit per second.

Speed4 determines the maximum output change rate in Manual or Clamp mode.

Tracking Ratio01 has tracking function the ratio reference on return to different control modes. It can be

configured to track the ExtRatio. Tracking function is configured using input parameter Track_A. Track_A Description

False No tracking (default value)

True The ratio reference is tracking ExtRatio when in E1 mode. It will stays at the current value on return to Auto mode

Alarm Limits Ratio01 monitor the measured value MV and compared it with two upper (H1 and H2) and two

lower (L1 and L2) alarm limits. When determining the MV alarm limits, it is recommended to follow the rule: H2 > H1 > L1 > L2. Alarm limit can be entered from interaction window or extended faceplate.

It’s possible to select whether the hysteresis is in unit or in percentage. If percentage is selected, then actual hysteresis used internally is calculated by multiplying the percentage against the signal range.

For upper alarm limit, the value of MV_GT_H1 and MV_GT_H2 will be set when MV > H1 and MV > H2 respectively. It will be reset when the MV is lower than the alarm limit minus the respective hysteresis. For lower alarm limit, the value of MV_LT_L1 and MV_LT_L2 will be set when MV < L1 and MV < L2 respectively. It will be reset when the MV is greater than the alarm limit plus the respective hysteresis.

3BTG811792-3034 / A Page 14

The value of MV_GT_H2, MV_GT_H1, MV_LT_L1 and MV_LT_L2 will always be monitored even if the alarm and event is not activated (AEConfig set to 0).

All alarm limits can be blocked altogether or individually. Alarm blocking can be done from faceplate or from function block using AlcBlk or MVAlarms.

Interlocks The Ratio01 control can be interlocked by signals from the process or control logic. Interlocks

are active when the value is False. There are 4 process interlocks available: IB1 - IB4. All can be configured to accept blocking by the operator.

When interlock is active, the control output will be set to a value defined in the IB1Ref - IB4Ref. If the active interlock is at the IB1, the output will be set based on value in IB1Ref. The same condition applies to IB2, IB3 and IB4. Interlock supervision is performed in the priority order IB1, IB2, IB3 and IB4.

These interlocks do not change the current control mode, but can be overridden by Manual Forced, when selected by the operator. If the control mode is Manual when the interlock is released, the output will stay at the interlock-value.

Interaction Window Interaction Window is used to configure the object’s parameter in the Control Builder. It is only

accessible when Control Builder is in Online mode by right clicking the function block.

The main Interaction Window shows the name and description of the function block. The buttons are link to open the sub-window.

1. General Par Name and Description can be entered from interaction window or from the function block

parameters directly. After performing Name Uploader, these values will be used as Object Name and Description and shown in faceplate.

Class defines the process section or area in which alarms are grouped. By utilizing Class, the alarms can be filtered. Valid values are 1 - 9999. Severity defines the alarm priority for general alarms. Valid values are 1 - 1000 where 1000 is the highest priority.

3BTG811792-3034 / A Page 15

2. Event Block & Init Mode Event Block is used to block the event message generated due to changes in value from logic

connection. To enable event for selected message, press the button to set the value to 0. The text message for each event is stored in the AE Translator aspect. List of events for all operator activity is managed in 800xA system with Audit Trail functionality.

Init Mode defines the initial mode of the object when cold download is performed. By default, the init mode for Ratio01 is Manual mode.

3. Interlock Setting When Block Event is disabled (set to 0), changes in value of the interlock will generate an

event message. The text message for each event is stored in the AE Translator aspect.

Enabling the Opr Block (set to 1) will give operator the possibility to override the interlock(s) from faceplate.

4. Unit & Range Unit & Range covers minimum and maximum range, unit and decimal number for MV, Ratio

and Output.

3BTG811792-3034 / A Page 16

Limit Control defines the percentage value of changes for Ratio (in Auto mode) and Output (in Man mode) when faceplate button Dec or Inc is pressed. It also defines the High and Low Limit of Ratio and Output operator can enter from faceplate when in Auto and Manual mode respectively.

5. Alarm Setting Four MV alarm limits can be configured, two high limits and two low limits. Each alarm limit

has its own configuration and can be defined individually. AE Config can be set in 3 different ways: 0 = No Alarm or Event will be generated 1 = Alarm and Event will be generated 2 = Only Event will be generated

If AE Config is set to 1, alarm will be generated if the limit stays active longer than alarm delay time. Otherwise, alarm will not be generated.

When MV Alarm Hysteresis in Percentage (%) is activated (set to 1), the hysteresis will be in percentage and calculated against the range.

6. Parameters Parameters define the setting for Ratio01. It includes the selection of Multiply (set to 0) or

Divide (set to 1), Gain and Bias.

3BTG811792-3034 / A Page 17

Text Configuration Text Configuration aspect is used to define the text properties of the object, such as modes,

interlocks and info texts. It is accessible in the Control Structure. The length of the each text should not exceed more than 50 characters, except for modes name which is limited to 10 characters only.

3BTG811792-3034 / A Page 18

3BTG811792-3034 / A Page 19

Section 3 - Operator Function

Process Display Ratio01 has the following graphic elements which can be inserted into graphic displays.

3BTG811792-3034 / A Page 20

The following display shows the presentation in graphic elements under different states.

Faceplate Aspect Link

Icon Aspect View

Operator Note

Interlocks Display

Object Display

Object Trend Display

Reduced Faceplate and Faceplate

Reduced Faceplate and Faceplate give basic information about the object. Size and contents have been optimized to cover most of the normal process operator action. Process values presented in bargraph are available in Faceplate.

Reduce Faceplate is the default view.

3BTG811792-3034 / A Page 21

Reduced Faceplate Faceplate

Extended Faceplate

The extended faceplate gives more detailed information about the object. Additional information about the object is available in tabs.

1. Control 2

This tab show the remote ratio which will be used if control mode is changed to E1 mode.

3BTG811792-3034 / A Page 22

2. T Curve

Trim Curve is used to present value in the last 4 minutes period. It contains 3 traces: MV (for Measured Value), WRatio (for Ratio) and Out (for Output).

3. Limits 1

MV alarm limit, hysteresis and alarm delay can be defined in this tab. Alarm limit will be visible if configured as alarm & event (indicated with AE) or event only (indicated with E). If alarm is blocked, then it will be indicated with B.

When alarm limit is active, a red square indication is shown in front of the limit. Alarm will be generated if the limit stays active for more than the alarm delay time. It will be indicated with the blinking red square indication as long as not acknowledged.

User with Tune permission can change the alarm limits, while hysteresis and alarm delay can be adjusted by user with Configure permission. If MV Alarm Hyst in Percentage (%) is checked, then hysteresis entered is calculated as percentage of the range.

3BTG811792-3034 / A Page 23

4. Limits 2 Ratio and output limit can be defined in this tab. When limit is active, a yellow square

indication is shown in front of the limit. User with Tune permission can change the limits. Input field for output limit will be disabled if the external limitation is active.

5. Parameters

Gain and Bias setting for Ratio01 can be configured here. User with Tune permission can adjust these values. Function can only be set from Interaction Window.

6. Block

Checkbox Override Interlock will override all blockable interlocks. It is enabled when at least one interlock is configured blockable.

Operator can block each MV alarm limit individually or all alarms by ticking on the checkbox. Checkbox Block All Alarms is enabled when at least one of MV limits or signal faults is configured as alarm. Checkbox for blocking individual MV alarm limit is enabled when the respective MV limit is configured as alarm. It will be disabled when external control for the respective MV limit is activated.

Un-ticking checkbox Enable Object will bring the object to Out Of Service mode.

3BTG811792-3034 / A Page 24

7. Tracking

Tracking configuration for the ratio is shown in this tab.

8. Info

Relevant information about the object can be entered here.

Interlock Display Interlock Display shows the actual status of all interlocks. Operator can override individual

interlock or all interlocks which is blockable. Blockable, Block Event and Interlock Texts are set with Configure permission.

When interlock is active, a yellow square indication will be shown in front of the interlock. When operator blocks an interlock, a BX text indication will be shown. If the interlock is active, it will be in red color. Otherwise it will be in yellow color.

3BTG811792-3034 / A Page 25

Object Display Object Display can be used to get the complete overview of the object. It has detailed

information of the MV value and range, ratio value and range, output value and range, alarm limit, ratio and output limitation, parameters and available control modes.

Object Trend Display Values stored can be presented graphically in the form of curves in Object Trend Display

aspect. By default, Ratio01 presents 3 traces: MV, WRatio and Out. It uses the trend template PP Library Control Object Trend in Library Structure.

3BTG811792-3034 / A Page 26

Alarm & Event Alarm & Event List

All alarm & event list aspect is configured to follow the templates defined in PP Library Alarm & Event List Configurations in Library Structure.

Alarm Message The Message Description is hardcoded in the function block and cannot be modified. The

Condition text is stored in the AE Translator aspect in Object Type Structure and support NLS functionality.

Resource Id Condition Message Description MVH1 MV > H1 Alarm MVH2 MV > H2 Alarm MVL1 MV < L1 Alarm MVL2 MV < L2 Alarm

Event Message The Message Description is stored in the AE Translator aspect in Object Type Structure and

support NLS functionality. Resource Id Message Description

AlarmAck Alarm acknowledged by program AlcBlk Alarm blocked by program BalInOff BalIn Off BalInOn BalIn On ClampOff Clamp Off ClampOn Clamp On EOLimOff EOLim Off EOLimOn EOLim On IB1Off IB1 Off IB1On IB1 On

3BTG811792-3034 / A Page 27

Resource Id Message Description IB2Off IB2 Off IB2On IB2 On IB3Off IB3 Off IB3On IB3 On IB4Off IB4 Off IB4On IB4 On LocalOff Local Off LocalOn Local On SeqAuto SeqAuto SeqE1 SeqE1 SeqMan SeqMan