Class CompModeA
Version 1.0
Modified 04-OCT-2005 14:02:49.03
 Mode for analog components with an analog reference output and a digital order
 output.

 The object handles an object graph with Auto/Man buttons to switch mode
 and Start/Stop buttons to control the unit in manual mode.

 The mode object handles several modes and configurations. The controlled
 unit can be handled locally or remotely.

 - Local mode    The unit is controlled from a local panel close to the drive.

 - Remote mode   The unit is controlled from the control system, either by
                 the operator from the object graph, or by PLC program.

 The local mode has higher prioriy than the remote.

 The mode handling also contains an extern and intern mode.

 - Intern mode   The unit is handled by the built-in Auto/Man function,
                 basically from the Auto/Man buttons in the object graph.

 - Extern mode   The built-in Auto/Man function is not used. Auto/Man is
                 handled from the plc program and other graphs.

 Which of these modes that are present depends on the configuration.

 Modes that can be configured

 - Intern          Auto/Manual mode is controlled from buttons in the
                   object graph. This is the default configuration.
 - Extern          Auto/Manual mode is controlled from the PLC program.
                   The Auto/Man buttons are removed from the object graph
                   but the Start/Stop buttons are still present.
                   Set attribute OpIntOnly to 1.
 - Extern only     Auto/Manual mode is controlled from the PLC program.
                   No Auto/Man or Start/Stop  buttons are present in the
                   object graph. Set attribute OpExtOnly to 1.
 - Intern only     Only manual mode is present, and the Auto/Man buttons
                   are removed. Set OpIntOnly to 1.
 - Local           When the local panel is activated, and the Start/Stop
                   buttons of the local panel is used. To disable this
                   mode, set OpNoLocal to 1.

 The Start/Stop buttons can also be configured to show On/Off instead.

 The object is for example used in BaseFcPPO3MotorAggr, a motor aggregate with
 frequency converter.

Object Graph


 The Auto/Man buttons changes mode in remote control, and the Start/Stop
 buttons are used to manually control the drive at remote control.

 - The Start button has toggle function, i.e. if the unit is already
   started it will be stopped.

 - The Auto/Man buttons changes mode in remote control.

 - In local mode, the local indicator is yellow, and the Start/Stop buttons
   are dimmed. Control via Auto/Man is disabled.

 - The Extern indicator (not present in the graph above) displays when
   Auto/Man is controlled externally and the Auto/Man buttons are hidden.

 - When the mode is Auto, the Start/Stop buttons are dimmed.

 - If mode extern only is configured, both the Auto/Man and the Start/Stop
   buttons are hidden, and the Extern indicator is always green. Auto/Man
   should be displayed in some other way.

 - The Start indicator displays status of the feedback from the controlled
   unit.

Configuration


 The Mode object CompModeA handles an analog and a digitl order output that
 can be configured in many different ways. It contains the functions

 - Start/Stop order, or alternatively On/Off.
 - Error handling for maneuvering, 5 alarm.
 - Buttons are dimmed and made insensitive to avoid incorrect handling.

 The order output is controlled in three different ways

 - by the ExtStart input pin of the function object, when the object
   is in Auto mode.
 - from the Start/Stop buttons in the object graph, whan the object
   is in Manual mode.
 - by the LocalStart input pin of the function object, when the object
   is in local mode.

 Note that only one of the configuration attributes, OpExtAndIntMan, OpIntOnly
 and OpExtOnly should be set.

Component Configuration
 -StartStop     Text of Start/Stop buttons in object graph is Start/Stop.
 -OnOff         Text of Start/Stop buttons is On/Off.

Mode control from object graph

 The figure displays a configuration (the default), where all the functions
 are activated. The operator selects auto or manual mode with the buttons
 Auto/Man. In auto the order outputs is controlled by the digital input
 ExtStart and the analog input RefAuto in the function object. The ExtControl
 input is not used in this configuration.

 By setting OpIntOnly to 1, the extern Auto/Man control from the plc program
 is disabled, i.e. the input ExtStart and AutoRef are not used.

Mode control from the plc and manual control from object graph

 The figure shows when Auto/Man mode is controlled by the ExtControl input
 of the function object. Auto is activated by setting ExtControl to 1. The order
 output is now controlled by the ExtStart input, and the Start/Stop buttons are
 dimmed. To get this configuration, set OpExtAndIntMan to 1.
 This is the only configuration alternative where the ExtControl input is used.

 The right figure shows when Auto/Man mode and maneuvering Start/Stop in manual
 mode is controlled outside the object. By setting OpExtOnly to 1 also the
 Start/Stop buttons are removed in the graph and the control of the order output
 is handled by the ExtStart input only, i.e. the mode is not handled in the object
 and no buttons are visible.

Mode control from the plc and no manual control from object graph

 The figure shows when Auto/Man mode is controlled by the ExtControl input
 of the function object, the manual control is handled outside the object.
 To get this configuration, set OpExtOnly to 1. The outputs are now controlled
 only by the ExtStart and AutoRef inputs. This configuration is rarely used.

Local mode

 The figure shows when local mode is activated, i.e the LocalMod input is 1.
 The control of the order output is now handled by pushbuttons on a local panel
 via inputs in the function object. Local mode disables auto and manual control,
 i.e. local control has highest priority.

Start/Stop buttons and indication
 The Start indication is green when the Feedback input is 1. Normally the
 feedback of the unit is connected to the Feedback input.

Error handling
 If the Ready input is reset, the normal behavior is to force the object to
 manual mode. This force can be disabled by setting OpNoAutoToMan to 1.

 If ready is 0 the order output is interlocked in all different modes.

 If the object is interlocked when the operator tries to change mode, an
 alarm is sent. Normally buttons are dimmed to avoid incorrect actions.

 If the error output is set in Local or Auto mode, actions should be taken
 to avoid unwanted restarts, by resetting the control order to the inputs
 ExtStart and LocalStart.

Plc coding
 For plc coding the function object CompModeAFo is used.
 Create a function object in the plc editor and connect it to the current
 object with the connect function.

See also



RtBody attributes pwr_sClass_CompModeA
String80 Description   Optional description.
The description is for example viewed in the navigator and in
the object graph.
CompModeAGCEnum GraphConfiguration   Enumeration for object graph configuration.
Handled by the ConfigureComponent method.
Boolean OpAuto   Switch to Auto mode.
OpAuto is normally set from the Auto button in the object graph,
and automatically reset by the program.
Boolean OpMan   Switch to Manual mode.
OpMan is normally set from the Auto button in the object graph,
and automatically reset by the program.
Boolean OpManStart   Manual start order.
OpManStart is normally set from the Start button in the object graph,
and automatically reset by the program.
Boolean OpManStop   Manual stop order.
OpManStop is normally set from the Stop button in the object graph,
and automatically reset by the program.
Boolean LocalMode   Shows if Local mode is active.
Local mode is normally set by a switch on a local panel, which is
connected to the LocalMode input of the function object.
Boolean LocalStart   Shows if local start is active.
Local start is normally set by a button on a local panel, which is
connected to the LocalStart input of the function object.
Boolean Ready   Shows if object is ready to start.
Reflects the value of the Ready input of the function object.
If ready is not set, start is inhibited for all modes.
Boolean Feedback   Shows the feedback value, normally the contactor feedback.
Reflects the value of the Feedback input of the function object.
Boolean Order   The order output. When order is high the unit is started.
Reflects the value of the Order output of the function object.
Boolean AutoMode   Auto mode is active.
Boolean ManStart   Manual start order is active.
Boolean ManOrdDim   When ManOrdDim is set, the Start/Stop buttons in the object graph are dimmed.
Boolean AutoModDim   When AutoOrdDim is set, the Auto button in the object graph is dimmed.
Boolean ManModDim   When ManModDim is set, the Man button in the object graph is dimmed.
Boolean LocalModHide   When LocalModeHide is set, the Local indicator in the object graph is hidden.
Boolean ManAutoHide   When ManAutoHide is set, the Auto/Man buttons in the object graph is hidden.
Boolean ManOrdHide   When ManOrdHide is set, the Start/Stop buttons in the object graph are hidden.
Boolean ExternOrdHide   When ExternOrdHide is set, the Extern indicator in the object graph is hidden.
Boolean OpIntOnly   Configuration attribute to support only manual mode, i.e. the unit can only
be controlled from the Start/Stop buttons in the object graph. the Auto/Man
buttons are removed, and the extern control inputs of the function object are
disabled.
Boolean OpNoLocal   Configuration attribute to not handle Local mode.
Boolean OpNoAutoToMan   Configuration attribute to keep Auto mode if Ready is lost.
Normally Manual mode is forced when Ready is reset. Note
that the unit can be restarted when Ready is set again.
Boolean OpExtOnly   Configuration attribute to disable manual control. All buttons
in the object graph are removed.
Boolean OpExtAndIntMan   Configuration attribute to enable Auto/Man control via the ExtControl
input of the function object. The Auto/Man buttons in the object graph
are removed. When the ExtControl input is high, the mode is set to Auto
and the Start/Stop buttons are dimmed. When ExtControl is low, mode is
set to manual.
Boolean OpNoUpdateManRef   Configures that OpRefMan is not updated with the auto reference value
in Auto mode.
Float32 OpRefMan   Manual analog reference set from the object graph.
In auto mode the value is automatically updated with the auto
reference to enable smooth mode switching. The update can be
inhibited by setting OpNoUpdateManRef to 1.
Float32 OpMinRefMan   Min value for manual reference.
Float32 OpMaxRefMan   Max value for manual reference.
Boolean OpDisableLocalAlarm   Configuration attribute to disable the alarm when local mode is activated.
Float32 OutRef   The analog output reference.
DSupComp AlarmNotReadyM   Alarm text for manual start attempt when unit is not ready. B-alarm.
DSupComp AlarmNotReadyA   Alarm text for attempt to set Auto mode when unit is not ready. B-alarm.
DSupComp Alarm1LocalMod   Alarm text for manual start attempt when unit is in local mode. B-alarm.
DSupComp Alarm2LocalMod   Alarm text when local mode is activated. B-alarm.
DSupComp AlarmNotManOrd   Alarm text for manual start attempt when unit is in Auto mode. B-alarm.
String8 IndMode   Text string to show the current mode in the object symbol.
Contains "L" in local mode, "M" in manual mode and is empty in auto mode.
AttrRef PlcConnect   The plc function object connected to this object.


Template Object
AlarmNotReadyM.DetectOn 1
AlarmNotReadyM.DetectText Check interlocks. Manual start is not allowed, not ready
AlarmNotReadyM.EventType 64
AlarmNotReadyM.EventPriority 66
AlarmNotReadyM.EventFlags 7
AlarmNotReadyM.MoreText
AlarmNotReadyM.Attribute BaseComponent:Class-CompModeA-Template
AlarmNotReadyM.CtrlPosition 1
AlarmNotReadyM.LockAttribute 1
AlarmNotReadyA.DetectOn 1
AlarmNotReadyA.DetectText Check interlocks. Automode is not allowed, not ready
AlarmNotReadyA.EventType 64
AlarmNotReadyA.EventPriority 66
AlarmNotReadyA.EventFlags 7
AlarmNotReadyA.MoreText
AlarmNotReadyA.Attribute BaseComponent:Class-CompModeA-Template
AlarmNotReadyA.CtrlPosition 1
AlarmNotReadyA.LockAttribute 1
Alarm1LocalMod.DetectOn 1
Alarm1LocalMod.DetectText Local mode is activated, remote control is not allowed
Alarm1LocalMod.EventType 64
Alarm1LocalMod.EventPriority 66
Alarm1LocalMod.EventFlags 7
Alarm1LocalMod.MoreText
Alarm1LocalMod.Attribute BaseComponent:Class-CompModeA-Template
Alarm1LocalMod.CtrlPosition 1
Alarm1LocalMod.LockAttribute 1
Alarm2LocalMod.DetectOn 1
Alarm2LocalMod.DetectText Local mode is activated
Alarm2LocalMod.EventType 64
Alarm2LocalMod.EventPriority 66
Alarm2LocalMod.EventFlags 7
Alarm2LocalMod.MoreText
Alarm2LocalMod.Attribute BaseComponent:Class-CompModeA-Template
Alarm2LocalMod.CtrlPosition 1
Alarm2LocalMod.LockAttribute 1
AlarmNotManOrd.DetectOn 1
AlarmNotManOrd.DetectText Automode active. Manual start/stop order is not allowed
AlarmNotManOrd.EventType 64
AlarmNotManOrd.EventPriority 66
AlarmNotManOrd.EventFlags 7
AlarmNotManOrd.MoreText
AlarmNotManOrd.Attribute BaseComponent:Class-CompModeA-Template
AlarmNotManOrd.CtrlPosition 1
AlarmNotManOrd.LockAttribute 1


Attributes detail


Description Attribute
Class Attribute
Type String80
Flags
Body RtBody
 Optional description.
 The description is for example viewed in the navigator and in
 the object graph.

GraphConfiguration Attribute
Class Attribute
Type CompModeAGCEnum
Flags
Body RtBody
 Enumeration for object graph configuration.
 Handled by the ConfigureComponent method.

OpAuto Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|State|Noedit
Body RtBody
 Switch to Auto mode.
 OpAuto is normally set from the Auto button in the object graph,
 and automatically reset by the program.

OpMan Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|State|Noedit
Body RtBody
 Switch to Manual mode.
 OpMan is normally set from the Auto button in the object graph,
 and automatically reset by the program.

OpManStart Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|State|Noedit
Body RtBody
 Manual start order.
 OpManStart is normally set from the Start button in the object graph,
 and automatically reset by the program.

OpManStop Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|State|Noedit
Body RtBody
 Manual stop order.
 OpManStop is normally set from the Stop button in the object graph,
 and automatically reset by the program.

LocalMode Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 Shows if Local mode is active.
 Local mode is normally set by a switch on a local panel, which is
 connected to the LocalMode input of the function object.

LocalStart Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 Shows if local start is active.
 Local start is normally set by a button on a local panel, which is
 connected to the LocalStart input of the function object.

Ready Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 Shows if object is ready to start.
 Reflects the value of the Ready input of the function object.
 If ready is not set, start is inhibited for all modes.

Feedback Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 Shows the feedback value, normally the contactor feedback.
 Reflects the value of the Feedback input of the function object.

Order Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 The order output. When order is high the unit is started.
 Reflects the value of the Order output of the function object.

AutoMode Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 Auto mode is active.

ManStart Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 Manual start order is active.

ManOrdDim Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 When ManOrdDim is set, the Start/Stop buttons in the object graph are dimmed.

AutoModDim Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 When AutoOrdDim is set, the Auto button in the object graph is dimmed.

ManModDim Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 When ManModDim is set, the Man button in the object graph is dimmed.

LocalModHide Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 When LocalModeHide is set, the Local indicator in the object graph is hidden.

ManAutoHide Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 When ManAutoHide is set, the Auto/Man buttons in the object graph is hidden.

ManOrdHide Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 When ManOrdHide is set, the Start/Stop buttons in the object graph are hidden.

ExternOrdHide Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 When ExternOrdHide is set, the Extern indicator in the object graph is hidden.

OpIntOnly Attribute
Class Attribute
Type Boolean
Flags ReduTransfer
Body RtBody
 Configuration attribute to support only manual mode, i.e. the unit can only
 be controlled from the Start/Stop buttons in the object graph. the Auto/Man
 buttons are removed, and the extern control inputs of the function object are
 disabled.

OpNoLocal Attribute
Class Attribute
Type Boolean
Flags ReduTransfer
Body RtBody
 Configuration attribute to not handle Local mode.

OpNoAutoToMan Attribute
Class Attribute
Type Boolean
Flags ReduTransfer
Body RtBody
 Configuration attribute to keep Auto mode if Ready is lost.
 Normally Manual mode is forced when Ready is reset. Note
 that the unit can be restarted when Ready is set again.

OpExtOnly Attribute
Class Attribute
Type Boolean
Flags ReduTransfer
Body RtBody
 Configuration attribute to disable manual control. All buttons
 in the object graph are removed.

OpExtAndIntMan Attribute
Class Attribute
Type Boolean
Flags ReduTransfer
Body RtBody
 Configuration attribute to enable Auto/Man control via the ExtControl
 input of the function object. The Auto/Man buttons in the object graph
 are removed. When the ExtControl input is high, the mode is set to Auto
 and the Start/Stop buttons are dimmed. When ExtControl is low, mode is
 set to manual.

OpNoUpdateManRef Attribute
Class Attribute
Type Boolean
Flags ReduTransfer
Body RtBody
 Configures that OpRefMan is not updated with the auto reference value
 in Auto mode.

OpRefMan Attribute
Class Attribute
Type Float32
Flags ReduTransfer
Body RtBody
 Manual analog reference set from the object graph.
 In auto mode the value is automatically updated with the auto
 reference to enable smooth mode switching. The update can be
 inhibited by setting OpNoUpdateManRef to 1.

OpMinRefMan Attribute
Class Attribute
Type Float32
Flags ReduTransfer
Body RtBody
 Min value for manual reference.

OpMaxRefMan Attribute
Class Attribute
Type Float32
Flags ReduTransfer
Body RtBody
 Max value for manual reference.

OpDisableLocalAlarm Attribute
Class Attribute
Type Boolean
Flags ReduTransfer
Body RtBody
 Configuration attribute to disable the alarm when local mode is activated.

OutRef Attribute
Class Attribute
Type Float32
Flags ReduTransfer|Noedit
Body RtBody
 The analog output reference.

AlarmNotReadyM Attribute
Class Attribute
Type DSupComp
Flags Class
Body RtBody
 Alarm text for manual start attempt when unit is not ready. B-alarm.

AlarmNotReadyA Attribute
Class Attribute
Type DSupComp
Flags Class
Body RtBody
 Alarm text for attempt to set Auto mode when unit is not ready. B-alarm.

Alarm1LocalMod Attribute
Class Attribute
Type DSupComp
Flags Class
Body RtBody
 Alarm text for manual start attempt when unit is in local mode. B-alarm.

Alarm2LocalMod Attribute
Class Attribute
Type DSupComp
Flags Class
Body RtBody
 Alarm text when local mode is activated. B-alarm.

AlarmNotManOrd Attribute
Class Attribute
Type DSupComp
Flags Class
Body RtBody
 Alarm text for manual start attempt when unit is in Auto mode. B-alarm.

IndMode Attribute
Class Attribute
Type String8
Flags Noedit
Body RtBody
 Text string to show the current mode in the object symbol.
 Contains "L" in local mode, "M" in manual mode and is empty in auto mode.

PlcConnect Attribute
Class Attribute
Type AttrRef
Flags
Body RtBody
 The plc function object connected to this object.
 This attribute is set when the function object is connected from
 the plc editor by the connect function.