Overcurrent

Automation Interface
 OMICRON Test Universe

Manual Version: OverAut.ENU.5 - Year: 2012

© OMICRON electronics. All rights reserved.
This manual is a publication of OMICRON electronics GmbH.
All rights including translation reserved. Reproduction of any kind, e.g., photocopying, microfilming, optical
character recognition and/or storage in electronic data processing systems, requires the explicit consent of
OMICRON electronics.
Reprinting, wholly or in part, is not permitted. The product information, specifications, and technical data
embodied in this manual represent the technical status at the time of writing and are subject to change without
prior notice.
We have done our best to ensure that the information given in this manual is useful, accurate, up-to-date and
reliable. However, OMICRON electronics does not assume responsibility for any inaccuracies which may be
present.
The user is responsible for every application that makes use of an OMICRON product.

2
 Contents

Contents

Overcurrent Automation Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Object Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Application Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Document Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
TestSettings Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
FixedTrigger Obeject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
BinaryOutputs Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
BinaryOutput Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
HWInfo Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
TestObject Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Properties of the Device section of the TO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Properties of the Overcurrent section of the TO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Other properties of the TO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
FaultGroup Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
TripChar Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

3
 OMICRON Test Universe

UserPoints Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
UserPoint Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Test Object Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Shots Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Shot Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
PuDoTest Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Example of Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

4
 Overcurrent Automation Interface

Overcurrent Automation Interface

Object Hierarchy
Figure 1:
Object hierarchy of an
Overcurrent Document

5
 OMICRON Test Universe

Reference
The following section contains the enumeration of all the properties and
methods that will be available via automation in the OMOvcBND module.

Application Object
The application object is the root of the OMICRON Overcurrent object hierarchy.
It is the only object that can be created directly by other OLE Automation
controllers (e.g. MS Excel using CreateObject).
This object is unique within the OMICRON Overcurrent Module. If you want to
create another Application object with CreateObject, a new instance of the
OMICRON Overcurrent program is started to handle this object.
You can use this object as a starting point to navigate through the hierarchy tree.
You can get references to the Document Object (Document) and the Predefined
Constant Values (Constants) objects.

Properties
Application (read only)

Syntax: object.Application

Type: Object (Application)

Description: Returns the application itself, for coherence.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim app As Object
Set app = Ovc.Application 'app must be the same
object as Ovc

6
 Overcurrent Automation Interface

Constants (read only)

Syntax: object.Constants

Type: Object (Constants)

Description: Returns the object containing the constant values (Constants)

you can use across Overcurrent automation.

Example: Dim otm As Object

Dim Ovc As Object
Dim Con As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Set Con = Ovc.Constants

Document (read only)

Syntax: object.Document

Type: Object (Document)

Description: This property returns a Document Object (Document). The

Document contains all test data, settings and results.

Example: Dim otm As Object

Dim Ovc As Object
Dim Con As Object
Dim Doc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Set Con = Ovc.Constants
Set Doc = Ovc.Document

7
 OMICRON Test Universe

Name (read only)

Syntax: object.Name

Type: String

Description: Returns the name of the application.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim Name As String
Set Name = Ovc.Name

Parent (read only)

Syntax: object.Parent

Type: Object

Description: This property always returns the parent object in the object
hierarchy. In this case it is the Application Object itself
(Application).

Example: Dim otm As Object

Dim Ovc As Object
Dim Con As Object
Dim Parent As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Set Parent = Ovc.Parent
'In this case, Parent will be the same
'object as Ovc

8
 Overcurrent Automation Interface

Visible

Syntax: object.Visible

Type: Boolean

Description: Shows/hides the main application window.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
'Is the application visible?
If Ovc.Visible then
MsgBox "Application is already visible"
Else 'Make the application visible
Ovc.Visible = True
End If

Note: If you use an external OLE Automation controller (e.g. OMICRON Control
Center) and you create the Application Object (Application) therefore
starting the OMICRON Overcurrent program, you have to set the visible
property to TRUE before you see the main window of the application.

Methods
Quit

Syntax: object.Quit

Return type: None

Description: Terminates execution of the application.

Example: Dim otm As Object

Dim Ovc As Object
Set otm = Document.TestModules(1)
Set Ovc = otm.Specific
Ovc.Test
Ovc.Quit

9
 OMICRON Test Universe

Document Object
With the Document Object (Document) you have access to the data in the
Overcurrent module.

Properties
Application (read only)

Syntax: Object.Application

Type: Object (Application)

Description: Returns the Application Object (Application).

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim app As Object
Set app = Ovc.Application
'app must be the same object as Ovc

10
 Overcurrent Automation Interface

ChangeAllowed (read only)

Syntax: object.ChangeAllowed

Type: Boolean

Description: This property returns True if the document can be modified.

Trying to modify a read-only document, or any of the objects
contained therein, will cause a Protection exception.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
If Ovc.Document.ChangeAllowed Then
MsgBox "the document is read-write"
Else
Msg Box "the document is Read-Only"
End If

Comment

Syntax: object.Comment

Type: String

Description: This property allows access to the comment string that can be
shown in the report.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
'Set comment in the report
Ovc.Document.Comment = "This test is
simulated"

11
 OMICRON Test Universe

HwInfo (read only)

Syntax: object.HwInfo

Type: Object (HwInfo)

Description: Get the HwInfo object to access different properties of the

hardware.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim hwInfo As Object
Set hwInfo = Ovc.Document.HwInfo

Parent (read only)

Syntax: object.Parent

Type: Object

Description: This property always returns the parent object in the object
hierarchy. In this case it is the Application Object (Application).

12
 Overcurrent Automation Interface

PuDoTest (read only)

Syntax: object.PuDoTest

Type: Object (PuDoTest)

Description: This property returns the PuDoTest object, which allows

access to the Pickup/Dropout test.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim pickupTest As Object
Set pickupTest = Ovc.Document.PuDoTest
If pickupTest.Type =
Ovc.Constants.PUDO_TEST_NONE Then
MsgBox "Pickup - Dropout test is not
enabled"
End If

Shots (read only)

Syntax: object.Shots

Type: Object (Shots)

Description: Returns the Shots collection object. This object holds the list of
overcurrent test points that form the test sequence.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim shots As Object
Set shots = Ovc.Document.Shots
MsgBox "There are " + Str(shots.Count) +
"shots defined."

13
 OMICRON Test Universe

TestObject (read only)

Syntax: object.TestObject

Type: Object (TestObject)

Description: Returns the TestObject object.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim to As Object
Set to = Ovc.Document.TestObject

TestSettings

Syntax: object.TestSettings

Type: Object (TestSetting)

Description: Returns the TestSettings object.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim settings As Object
Set settings = Ovc.Document.TestSettings

14
 Overcurrent Automation Interface

Version (read only)

Syntax: object.Version

Type: String

Description: Returns the version of the OMMeter module in form

"M.mm.bbb" where:
M: major
m: minor
b: build

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
MsgBox = "Module version is " +
Ovc.Document.Version

15
 OMICRON Test Universe

Methods
UpdateAllViews(hint)l

Syntax: object.UpdateAllViews(hint)
Long hint

Type: None

Description: This method updates the UI and the report. The optional Hint
parameter is used to add information that the views can
interpret. By calling this method without parameters, all the UI
is fully updated.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Ovc.Document.Comment = "This is an Automation
test"
Ovc.Document.UpdateAllViews

16
 Overcurrent Automation Interface

TestSettings Object

Properties
AbsMaxTime

Syntax: object.AbsMaxTime

Type: Double

Description: Get / set the maximum fault time - absolute, in seconds.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim settings As Object
Set settings = Ovc.Document.TestSettings
settings.AbsMaxTime = 240.0

Application (read only)

Syntax: object.Application

Type: Object (Application)

Description: Returns the Application object (Application).

17
 OMICRON Test Universe

BinaryOutputs (read only)

Syntax: object.BinaryOutputs

Type: Object (BinaryOutputs)

Description: Get the BinaryOutputs object to access the Binary Outputs in

the module.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim bin As Object
Set bin =
Ovc.Document.TestSettings.BinaryOutputs

DelayTime

Syntax: object.DelayTime

Type: Double

Description: Get / set the delay time in seconds. This is the time between
shots where all the output magnitudes will be 0.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim settings As Object
Set settings = Ovc.Document.TestSettings
settings.DelayTime = 0.1

18
 Overcurrent Automation Interface

FaultType

Syntax: object.FaultType

Type: Long

Description: Get: Returns the type of fault of the first shot. If no shot is
available, the type of fault of the first PUDO test will be
returned. If no PUDO test exists, the current value of the user
interface will be returned.
Set: Sets the type of fault of all existing shots and PUDO tests.
If none is available the value of the user interface will be set.
The possible values for this property are:
FAULT_L1E
FAULT_L2E
FAULT_L3E
FAULT_L1L2
FAULT_L3L1
FAULT_L2L3
FAULT_L1L2L3
FAULT_3I0 (Zero-sequence fault)
FAULT_I2 (Negative sequence fault)

Example: Dim otm As Object

Dim Ovc As Object
Dim Con As object
Dim settings As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Set Con = Ovc.Constants
Set settings = Ovc.Document.TestSettings
settings.FaultType = Con.FAULT_L1L2L3'Three-
phase fault

19
 OMICRON Test Universe

FaultVAngle

Syntax: object.FaultVAngle

Type: Double

Description: Get: Returns the fault angle for the voltages in degree of the
first shot. If no shot is available, the fault angle of the first
PUDO test will be returned. If no PUDO test exists, the current
value of the user inteface will be returned.
Set: Sets the fault angle for the voltages in degree of all
existing shots and PUDO tests. If none is available the value of
the user interface will be set.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim settings As Object
Set settings = Ovc.Document.TestSettings
settings.FaultVAngle = 45.0

LoadIsRel

Syntax: object.LoadIsRel

Type: Boolean

Description: Get / set whether the load current is fixed for all shots (False)
or different for each fault and equal to a fraction of the fault
current for each point (True).

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim settings As Object
Set settings = Ovc.Document.TestSettings
settings.LoadIsRel = True

20
 Overcurrent Automation Interface

LoadCurrent

Syntax: object.LoadCurrent

Type: Double

Description: Get / set the Load Current in times In. This setting will be used
by the module when LoadIsRel is False.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim settings As Object
Set settings = Ovc.Document.TestSettings
settings.LoadCurrent = 0.85

LoadCurrentRel

Syntax: object.LoadCurrentRel

Type: Double

Description: Get / set the Load Current in times Ifault. This setting will be
used by the module when LoadIsRel is True.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim settings As Object
Set settings = Ovc.Document.TestSettings
settings.LoadCurrentRel = 0.90

21
 OMICRON Test Universe

PreFaultTime

Syntax: object.PreFaultTime

Type: Double

Description: Get / set the pre-fault time in seconds.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim settings As Object
Set settings = Ovc.Document.TestSettings
settings.PreFaultTime = 0'Proceed directly to
the fault

FaultVoltageLN

Syntax: object.FaultVoltageLN

Type: Double

Description: Get / set the line to neutral fault voltage, in Volts. This value is
linked to FaultVoltageLL, so changes in one of them are
reflected on the other.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim settings As Object
Set settings = Ovc.Document.TestSettings
settings.FaultVoltageLN = 63.51

22
 Overcurrent Automation Interface

FaultVoltageLL

Syntax: object.FaultVoltageLL

Type: Double

Description: Get / set the line to line fault voltage, in Volts. This value is
linked to FaultVoltageLN, so changes in one of them are
reflected on the other..

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim settings As Object
Set settings = Ovc.Document.TestSettings
settings.FaultVoltageLL =110.0

FixedTrigger (read only)

Syntax: object.FixedTrigger

Type: Object (FixedTrigger)

Description: Get a FixedTrigger object for access to the trigger condition in

the module.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim trigger As Object
Set trigger =
Ovc.Document.TestSettings.FixedTrigger

23
 OMICRON Test Universe

GroupOfFault (read only)

Syntax: object.GroupOfFault

Type: Long

Description: Get the group to which the fault set in FaultType belongs. Each
group may have its own settings for each of the three
protective units (I>, I>> and I>>>)
The possible values for this property are:
GROUP_LN All the line to ground faults
GROUP_LL All the line to line faults, including L1L2L3
GROUP_3I0 Includes the Zero-sequence fault
GROUP_I2 Includes the Negative sequence fault
GROUP_I1 Includes the Positive sequence fault

Example: Dim otm As Object

Dim Ovc As Object
Dim Con As object
Dim settings As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Set Con = Ovc.Constants
Set settings = Ovc.Document.TestSettings
settings.FaultType = Con.FAULT_L1L2L3'Three-
phase fault
If settings.GroupOfFault <> Con.Group_LL Then
MsgBox "ERROR: Fault was not correctly
set"
End If

Parent (read only)

Syntax: object.Parent

Type: Object (Document)

Description: This property always returns the parent object in the object
hierarchy. In this case it is the Document Object (Document).

24
 Overcurrent Automation Interface

RelMaxTime

Syntax: object.AbsMaxTime

Type: Double

Description: Get / set the maximum fault time - relative, in %.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim settings As Object
Set settings = Ovc.Document.TestSettings
settings.RelMaxTime = 100.0

25
 OMICRON Test Universe

FixedTrigger Obeject
This object allows reading and setting the Fixed Trigger object. This king of
trigger has a fixed number of binary inputs plus one trigger criterion (AND or
OR).

Properties
Input (index)

Syntax: object.Input(index)
Integer index (1 to 10

Type: Long

Description: Get / set the state of a given input.

The possible values for this property are:
TRIG_POS (Input must be active for the trigger to
be fulfilled)
TRIG_NEG (Input must be inactive for the trigger
to be fulfilled)
TRIG_DONTCARE (Input does not affect the trigger)
It is only possible to set the input if it is assigned to a physical
input (InputSelected has returned True) - otherwise the write
operation will have no effect, and the read operation will always
return TRIGGER_DONT_CARE..

InputName (index) (read only)

Syntax: object.InputName(index)
Integer index (1 to 10)

Type: String

Description: Get the name of a given input. This name is the same that will
appear in the UI.

26
 Overcurrent Automation Interface

InputSelected(index) (read only)

Syntax: object.InputSelected(index)
Integer index (1 to 10)

Type: Boolean

Description: Returns true if the input is selected - that is, if there is a

physical input associated to the logical input.

Logic

Syntax: object. Logic

Type: Long

Description: Get / set the logic relationship between the trigger inputs.
The possible values for this property are:
LOGIC_AND (The logic AND of all inputs activates the
trigger)
LOGIC_OR (The logic OR of all inputs activates the
trigger)

27
 OMICRON Test Universe

Trigger Example
Dim otm As Object
Dim Ovc As Object
Dim Con As object
Set otm = Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Set Con = Ovc.Constants
Dim trigger As Object
Set trigger = Ovc.Document.TestSettings.FixedTrigger
'In the Hw configuration there is an input named "Trip"
'We want to set that one to "Positive" and all the rest to
"Don't care"
Dim tripFound As Boolean
Dim i As Integer
For i = 1 To 10
If trigger.InputSelected(i) Then
If trigger.InputName(i) = "Trip" Then
trigger.Input(i) = Con.TRIG_POS
tripFound = True
Exit For
Else
trigger.Input(i) = Con.TRIG_DONTCARE
End If
End If
Next i
If Not tripFound Then
MsgBox("ERROR: Trip input was not found")
Else
trigger.Logic = Con.LOGIC_OR
End If

28
 Overcurrent Automation Interface

BinaryOutputs Collection Object

This object allows access to the assigned binary outputs. The outputs will be set
to the programmed values during test, so this is a test setting, and not direct
control of the CMC hardware.
The OMOvcBND module does not control expanded I/O devices, so only the on-
device binary outputs can be controlled from this object.

Properties
Count (read only)

Syntax: object.Count

Type: Long

Description: Returns the number of binary outputs that are assigned to

physical outputs.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim bin As Object
Set bin =
Ovc.Document.TestSettings.BinaryOutputs
MsgBox "There are " + Str(bin.Count) +
"output(s) assigned"

29
 OMICRON Test Universe

Item (Default Property - read only)

Syntax: object.Item(SignalID)
Long SignalID - Signal ID of the binary output

Type: Object (BinaryOutput)

Description: This property returns a Binary Output Object (BinaryOutput)

from the Binary Outputs Collection. The parameter is the signal
ID of the binary output in the collection. Signal IDs are
constants from the Constants object. Their possible values are:
sigidUSER_OUTBIN_DEF1
sigidUSER_OUTBIN_DEF2
sigidUSER_OUTBIN_DEF3
sigidUSER_OUTBIN_DEF4
sigidUSER_OUTBIN_DEF5
sigidUSER_OUTBIN_DEF6
sigidUSER_OUTBIN_DEF7
sigidUSER_OUTBIN_DEF8

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
'Set binary output for User Defined Binary
Output 1
Dim st As Object
Set st = Ovc.Document.TestSettings
Dim out As Object
Set out = st.BinaryOutputs(Ovc.Constants.
sigidUSER_OUTBIN_DEF1)
out.Value = 1

30
 Overcurrent Automation Interface

ItemIndex (read only)

Syntax: object.Item(Index)
Variant Index - Index number of the binary output

Type: Object (BinaryOutput)

Description: This property returns a Binary Output Object (BinaryOutput)

from the Binary Outputs Collection. The index is the number of
the binary output in the collection (between 1 and BinaryOut-
puts.Count).

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
'Set all binary outputs
Dim st As Object
Set st = Ovc.Document.TestSettings
For i = 1 To st.BinaryOutputs.Count
st.BinaryOutputs.ItemIndex(i).Value = 1
Next

31
 OMICRON Test Universe

BinaryOutput Object

Properties
Value (default property)

Syntax: object.Value

Type: Boolean

Description: This property is True when the binary output is set (active), and
False when it is not (inactive).

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
'Set binary output for User Defined Binary
Output 1
Dim st As Object
Set st = Ovc.Document.TestSettings
Dim out As Object
Set out = st.BinaryOutputs(Ovc.Constants.
sigidUSER_OUTBIN_DEF1)
out.Value = 1

32
 Overcurrent Automation Interface

Name (read only)

Syntax: object.Name

Type: String

Description: Get the name of the output (as set by the user in the Hardware
Configuration dialog).

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
'Get name of User Defined Binary Output 1
Dim st As Object
Set st = Ovc.Document.TestSettings
Dim out As Object
Set out = st.BinaryOutputs(Ovc.Constants.
sigidUSER_OUTBIN_DEF1)
MsgBox "The name of the output is " + out.Name

33
 OMICRON Test Universe

HWInfo Object
This object allows reading some values from the hardware. All the values are
read-only

Properties

34
 Overcurrent Automation Interface

CMCSerNo (read only)

Syntax: object.CMCSerNo

Type: String

Description: Returns the serial number of the CMC test set that is used for
the test. In case of off-line testing (no CMC connected), the
returned string will be "???????"

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim CMCSer As String
CMCSer = Ovc.Document.HwInfo.CMCSerNo

CMCType (read only)

Syntax: object.CMCType

Type: String

Description: Returns the type of the CMC test set that is used for the test
(e.g., "CMC256-6"). In case of off-line testing (no CMC
connected), the returned type is the one you selected for the
test simulation.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim CMCTpye As String
CMCTpye = Ovc.Document.HwInfo.CMCType

35
 OMICRON Test Universe

CMCIDStr (read only)

Syntax: object.CMCIDStr

Type: String

Description: ID string of the selected CMC test set.

In case of off-line testing (no CMC connected), an empty string
is returned.

Example: Dim otm As Object

Dim Ovc As Object
Set otm =
Document.InsertObject("OMOvcBND.Document")
Set Ovc = otm.Specific
Dim CMCIDStr As String
CMCIDStr = Ovc.Document.HwInfo.CMCIDStr

36
 Overcurrent Automation Interface

TestObject Object
This object allows access to the Overcurrent Test Object, including the Device
block.
When changing the value of the Test Object settings, the Test Module must be
reconfigured to adapt to the new settings, which is done automatically after each
change of a Test Object setting. As this can take a noticeable amount of time,
the TestObject automation object provides a flag to disable the automatic
reconfiguration. The property AutoUpdate, True by default, selects whether or
not the OMOvcBND module should be automatically configured whenever any
settings are changed. If the user sets this property to False, then he should call
the PostProcessTOChanges method after he is finished doing changes.
PostProcessTOChanges is called automatically when the TestObject object
is destroyed, if any changes had been made and not processed.

Properties of the Device section of the TO

AddInfo1

Syntax: object.AddInfo1

Type: String

Description: Get / set the device's additional info / 1..

AddInfo2

Syntax: object.AddInfo2

Type: String

Description: Get / set the device's additional info / 2.

Address

Syntax: object.Address

Type: String

Description: Get / set the device's address.

37
 OMICRON Test Universe

BayAddr

Syntax: object.BayAddr

Type: String

Description: Get / set the Address of the Bay.

BayName

Syntax: object.BayName

Type: String

Description: Get / set the Name of the Bay.

CTRatio (Read Only)

Syntax: object.CTRatio

Type: String

Description: Get the ratio of the CT. This Value is equal to Iprim / INom.

DebounceTime

Syntax: object.DebounceTime

Type: String

Description: Get / set the binary inputs debounce time in s.

DeglitchTime

Syntax: object.DeglitchTime

Type: String

Description: Get / set the binary inputs deglitch time in s.

DevType

Syntax: object.DevType

Type: String

38
 Overcurrent Automation Interface

Description: Get / set the device's type.

Fnom

Syntax: object.Fnom

Type: String

Description: Get / set the nominal frequency in Hz.

IMax

Syntax: object.IMax

Type: String

Description: Get / set the device's maximum current in A.

This is the highest current that can be applied to the device by
the OMICRON equipment without risk of damage.

INom

Syntax: object.INom

Type: String

Description: Get / set the nominal current in A.

Iprim

Syntax: object.Iprim

Type: String

Description: Get / set the primary current in A.

Manufacturer

Syntax: object.Manufacturer

Type: String

Description: Get / set the device manufacturer's description.

39
 OMICRON Test Universe

Name

Syntax: object.Name

Type: String

Description: Get / set the device name.

Phases

Syntax: object.Phases

Type: String

Description: Get / set the device's number of phases.

PTRatio (Read Only)

Syntax: object.PTRatio

Type: String

Description: Get the ratio of the PT. This value is equal to Vprim / VNom.

ResidualI

Syntax: object.ResidualI

Type: String

Description: Get / set the device's residual I ratio (IN / Inom).

ResidualV

Syntax: object.ResidualV

Type: String

Description: Get / set the device's residual V ratio (IN / Inom).

40
 Overcurrent Automation Interface

Serial

Syntax: object.Serial

Type: String

Description: Get / set the device's serial number as string.

SubsAddr

Syntax: object.SubsAddr

Type: String

Description: Get / set the address of the substation.

SubsName

Syntax: object.SubsName

Type: String

Description: Get / set the device's serial number as string.

VMax

Syntax: object.VMax

Type: String

Description: Get / set the device's maximum voltage in V.

This is the highest voltage that can be applied to the device by
the OMICRON equipment without risk of damage.

VNom

Syntax: object.VNom

Type: String

Description: Get / set the nominal voltage in V.

41
 OMICRON Test Universe

Vprim

Syntax: object.Vprim

Type: String

Description: Get / set the primary voltage in V.

Properties of the Overcurrent section of the TO

CurrTolAbs

Syntax: object.CurrTolAbs

Type: String

Description: Get / set the Absolute Current Tolerance in times In.

CurrTolRel

Syntax: object.CurrTolRel

Type: String

Description: Get / set the Relative Current Tolerance in %.

CurrTToBus

Syntax: object.CurrTToBus

Type: String

Description: True is the Current transformer is grounded towards the

busbar, False if it is grounded towards the line.

Directional

Syntax: object.Directional

Type: String

Description: Get / set whether the module will use Voltages.

42
 Overcurrent Automation Interface

FaultGroup(index) (read only)

Syntax: object.FaultGroup(Index)
Long Index

Type: Object (FaultGroup)

Description: Get the FaultGroup object. The index must be one of the
following:
GROUP_LNAll the line to ground faults
GROUP_LL All the line to line faults, including L1L2L3
GROUP_I0 Includes the Zero-sequence fault
GROUP_I2 Includes the Negative sequence fault

PwrTOnBus

Syntax: object.PwrTOnBus

Type: String

Description: True is the power transformer is grounded on the busbar, False

if it is grounded on the line.

TimeTolAbs

Syntax: object.TimeTolAbs

Type: String

Description: Get / set the Absolute Time Tolerance in seconds.

TimeTolRel

Syntax: object.TimeTolRel

Type: String

Description: Get / set the Relative Time Tolerance in %.

43
 OMICRON Test Universe

Other properties of the TO

Application (read only)l

Syntax: object.Application

Type: String

Description: Get / set the Relative Time Tolerance in %.

Parent (read only)

Syntax: object.Parent

Type: String

Description: This property always returns the parent object in the object
hierarchy. In this case it is the Document Object (Document).

AutoUpdate

Syntax: object.AutoUpdate

Type: String

Description: Get / set whether the module will be updated automatically

after changes to the TestObject parameters. If this property is
set to False, it is the responsibility of the programmer to update
the module after all the changes are done, by calling the
UpdateAfterChanges method.
This is not a property of the Overcurrent Test Object, but of the
TestObject automation object. Therefore, the variable is
destroyed when the TestObject is destroyed, and is reset to its
default value of True every time a new TestObject is created. .

44
 Overcurrent Automation Interface

Methods
UpdateAfterChanges()

Syntax: object.UpdateAfterChanges()

Type: String

Description: Updates the module after changes to the Test Object. If

AutoUpdate is True, the module will be automatically updated
after each change to the Test Object. To gain efficiency, the
programmer can set AutoUpdate to False and call this method
expressly after all changes are done. Please note that in that
case, the module will be in an unpredictable state after any
changes to the Test Object are made, and until this method is
called..

45
 OMICRON Test Universe

FaultGroup Object
This object allows access to the protective units in a Fault Group. All fault groups
have by design the same structure and the same parameters. There are three
protective units per group, of which the second and third units (I>> and I>>>) are
Definite Time, while the first unit (I>) can be definite time or Inverse time with an
adjustable characteristic.

Properties
IGrActive

Syntax: object.IGrActive

Type: Boolean

Description: Get / set whether the I> protective unit is active. The unit can
be configured regardless of the value of this parameter..

IGrIpickup

Syntax: object.IGrIpickup

Type: Double

Description: Get / set the pickup value for the I> protective unit in times In..

IGrTimeIndex

Syntax: object.IGrTimeIndex

Type: Double

Description: Get / set the Time index for the tripping characteristic of the I>
protective unit. If the unit is set to Definite Time, this parameter
is considered as the operating time, in seconds. If the unit is
set to a curve, this parameter is considered as the time index
for the curve, and has no dimension. .

46
 Overcurrent Automation Interface

IGr2Active

Syntax: object.IGr2Active

Type: Boolean

Description: Get / set whether the I>> protective unit is active. The unit can
be configured regardless of the value of this parameter.

IGr2Ipickup

Syntax: object.IGr2Ipickup

Type: Double

Description: Get / set the pickup value for the I>> protective unit in times In.

Gr2OperTime

Syntax: object.IGr2OperTime

Type: Double

Description: Get / set the operating time for the I>> protective unit, in
seconds.

IGr3Active

Syntax: object.IGr3Active

Type: Boolean

Description: Get / set whether the I>>> protective unit is active. The unit can
be configured regardless of the value of this parameter..

IGr3Ipickup

Syntax: object.IGr3Ipickup

Type: Double

Description: Get / set the pickup value for the I>>> protective unit in times
In..

47
 OMICRON Test Universe

IGr3OperTime

Syntax: object.IGr3OperTime

Type: Double

Description: Get / set the operating time for the I>>> protective unit, in
seconds.

ResetRatio

Syntax: object.ResetRatio

Type: Double

Description: Get / set the nominal Reset Ratio (Ipickup / Idropoff) for the
group. If TestSettings.EvaluateResetRatio is True, this will be
the nominal value against which the measured ratio is
evaluated. The value of this property goes from 1 to 5 in steps
of 0.01..

TripChar (read only)

Syntax: object.TripChar

Type: object (TripChar)

Description: Get the TripChar object for access to the tripping characteristic
of the I> protective unit..

StageCount (read only)

Syntax: object.StageCount

Type: Long

Description: Returns the amount of Stages which are defined for a specific
Fault Group (Element Type).

48
 Overcurrent Automation Interface

Methods
CreateStage

Syntax: CreateStage ()

Return type: object (TripChar)

Description: Creates a new Stage with a Definite Time Characteristic

DeleteStage (Index)

Syntax: DeleteStage (Index)

Long Index

Description: Deletes a Stage at the specified Index

GetStage (Index)

Syntax: GetStage (Index)

Long Index

Return type: object (TripChar)

Description: Returns the Stage (Trip Char) at the specified Index

49
 OMICRON Test Universe

TripChar Object
Gives access to the Tripping Characteristic object. This characteristic can be
predefined or user-set. The predefined characteristics are: Definite time.

Properties
A (read only)

Syntax: object.A

Return type: Double

Description: Get the A parameter from the characteristic formulas. This

property is meaningless unless IsInverse or IsI2t are True.

B (read only)

Syntax: object.B

Return type: Double

Description: Get the B parameter from the characteristic formulas. This

property is meaningless unless IsInverse is True.

IsDefiniteTime (read only)

Syntax: object.IsDefiniteTime

Return type: Boolean

Description: True if the characteristic is Definite Time..

IsI2t (read only)

Syntax: object.IsI2t

Return type: Boolean

Description: True if the characteristic follows the I2t formula.

50
 Overcurrent Automation Interface

IsInverse (read only)

Syntax: object.IsInverse

Return type: Boolean

Description: True if the characteristic is Inverse.

IsPredefined (read only)

Syntax: object.IsPredefined

Return type: Boolean

Description: True if the characteristic is among the predefined ones.

Predefined characteristic can be set just with their identifiers,
and it is not necessary to set all their parameters.

IsUserChar (read only)

Syntax: object.IsUserChar

Return type: Boolean

Description: True if the characteristic is user-defined.

K1 (read only)

Syntax: object.K1

Return type: Double

Description: Get the K1 parameter from the characteristic formulas. This

property is meaningless unless IsInverse is True.

51
 OMICRON Test Universe

K2 (read only)

Syntax: object.K2

Return type: Double

Description: Get the K2 parameter from the characteristic formulas. This

property is meaningless unless IsInverse is True..

Name

Syntax: object.Name

Return type: String

Description: Get or Sets the characteristic's name.

P (read only)

Syntax: object.P

Return type: Double

Description: Get the P parameter from the characteristic formulas. This

property is meaningless unless IsInverse or IsI2t are True.

Q (read only)

Syntax: object.Q

Return type: Double

Description: Get the Q parameter from the characteristic formulas. This

property is meaningless unless IsInverse or IsI2t are True.

52
 Overcurrent Automation Interface

UserPoints (read only)

Syntax: object.UserPoints

Return type: object (UserPoints)

Description: Get the UserPoints collection object. The points contained in

this collection define the shape of the user-defined
characteristics. For all the others, they have no influence.

Methods
SetPredefinedChar (type)

Syntax: SetPredefinedChar (type)

Long type

Return type: Boolean

Description: Set the characteristic to one of the predefined types; the

possible types are the following:
PREDEF_DEFINITE Definite time
PREDEF_NORMAL_INVERSEInverse
PREDEF_VERY_INVERSEVery Inverse
PREDEF_EXTR_INVERSEExtremely Inverse

This method returns True if the operation was successful,

False otherwise.

53
 OMICRON Test Universe

SetI2tChar(Name, A, P, Q)

Syntax: SetI2tChar(Name, A, P, Q)
String Name
Double A
Double P
Double Q

Return type: Boolean

Description: Set the characteristic to I2t, with the provided parameters.

Returns True if the operation was successful, False otherwise.

SetInverseChar(Name, A, B, P, Q, K1, K2)

Syntax: SetInverseChar(Name, A, B, P, Q, K1, K2)

String Name
Double A
Double B
Double P
Double Q
Double K1
Double K2

Return type: Boolean

Description: Set the characteristic to Inverse, with the provided parameters.

Returns True if the operation was successful, False otherwise.

54
 Overcurrent Automation Interface

SetUserChar(Name)

Syntax: SetUserChar(Name)
String Name

Return type: Boolean

Description: Set the characteristic to User Char, with the provided name.
Returns True if the operation was successful, False otherwise.

Note: We use this method to give a name to the User Characteristic and
activate it. Please note that this method will clear the User Point
array (UserPoints object). After using this method, the points must
be added to UserPoints. It is important to know that the points in
UserPoints will be deleted if SetInverseChar,
SetPredefinedChar or SetI2tChar are called; also, that
UserPoints will be read-only until the characteristic has been set
to User Char with this method.

55
 OMICRON Test Universe

UserPoints Collection Object

Properties
Count (read only)

Syntax: object.Count

Type: Long

Description: Returns the number of points in the user-defined characteristic.

Item (Default Property - read only)

Syntax: object.Item(Index)
Long Index

Type: Object (UserPoint)

Description: This property returns a user point Object (UserPoint) from the
UserPoints collection. The index is the number of the entry in
the list (between 1 and UserPoints.Count). If no index is given,
the UserPoints Collection Object is returned (reference to self)

56
 Overcurrent Automation Interface

Methods
Add(Ipu, Time)

Syntax: Add(Ipu, Time)

Double Ipu
Double Time

Type: object (UserPoint)

Description: Creates a new user point and adds it to the collection. Returns
the UserPoint object if the point was successfully created and
added, Nothing if the method could not add the point. Points
added to the characteristic are automatically by increasing
current values, so it is not safe to assume that the newly added
point will be at the end of the collection: it can be anywhere.

The user must provide the current in times the pickup current,
and the corresponding time. It is not possible to add points
having the same current value as one point already in the
table. The user characteristic must follow a down-and-right
direction, points that would create an upward or leftward
direction of the characteristic are not allowed.

Remove (index)

Syntax: Remove(Index)
Long Index

Type: Boolean

Description: Removes a point from the list. Index must be between 1 and
UserPoints.Count. Returns True if the point was removed,
False otherwise. Please note that it is permitted to remove all
points of a characteristic.

57
 OMICRON Test Universe

RemoveAll()

Syntax: RemoveAll()

Type: Boolean

Description: Removes all points from the characteristic. The resulting

characteristic is valid, if quite useless.

58
 Overcurrent Automation Interface

UserPoint Object

Properties
Current (read only)

Syntax: object.Q

Type: Double

Description: Get the point's current in times the pickup current. This value is
set when the point is added with the UserPoints.Add method.

Time (read only)

Syntax: object.Q

Type: Double

Description: Get the time in seconds. This value is set when the point is
added with the UserPoints.Add method.

59
 OMICRON Test Universe

Test Object Example

This example will set the Test Object to the configuration of an Overcurrent
protection. We will use the GE-Multilin DFP100 as a template (GE DFP
100.RIO), but we will change some of the operating characteristics to show
usage of every characteristic setting method.
Option Explicit
Dim oc As Object
Dim ocApp As Object
Dim ocConst As Object
Dim ocTO As Object

Public Sub OnCmdScriptRun()

Set oc = Document.TestModules(1)'Object (TestModule)

oc.Connect

Set ocApp = oc.Specific

Set ocConst = ocApp.Constants
Set ocTO = ocApp.Document.TestObject

'Since we are going to do many changes, we

'disable the TO AutoUpdate feature

ocTO.AutoUpdate = False

'Let's begin with the TO common settings,

ocTO.Name = "DFP 100"

ocTO.Phases = 3
ocTO.Manufacturer = "GE"
ocTO.DevType = "50/51"
ocTO.VMax = 168.0
ocTO.INom = 1.0
ocTO.IMax = 12.5
ocTO.Fnom = 50.0
ocTO.DeglitchTime = 0
ocTO.DebounceTime = 0

'Now, the overcurrent common settings

ocTO.Directional = True
ocTO.PwrTOnBus = False

60
 Overcurrent Automation Interface

ocTO.CurrTToBus = False
ocTO.CurrTolRel = 10
ocTO.CurrTolAbs = 0.1
ocTO.TimeTolRel = 3
ocTO.TimeTolAbs = 0.1

'After the general settings, let's set the groups one by one

Dim group As Object

Dim char As Object

Set group = ocTO.FaultGroup(ocConst.GROUP_LN)

Set char = group.TripChar

group.IGrActive = True
group.IGrIpickup = 5
group.IGrTimeIndex = 1
char.SetInverseChar("GE DFP100 VI", 3.922, 0.0982, 2, 1,
0, 0)

group.IGr2Active = True
group.IGr2Ipickup = 100
group.IGr2OperTime = 0.1
group.IGr3Active = False
group.IGr3Ipickup = 100
group.IGr3OperTime = 1

Set group = ocTO.FaultGroup(ocConst.GROUP_LL)

Set char = group.TripChar

group.IGrActive = True
group.IGrIpickup = 5
group.IGrTimeIndex = 1

'Here we deviate from the relay's settings in the RIO file

char.SetUserChar("UserChar")

'The points can be entered in any order, we do not have

to enter them sorted

char.UserPoints.Add(1.05, 100.0)
char.UserPoints.Add(1.20, 40.0)
char.UserPoints.Add(1.50, 28.0)

61
 OMICRON Test Universe

char.UserPoints.Add(2.00, 23.0)

group.IGr2Active = True
group.IGr2Ipickup = 100
group.IGr2OperTime = 0.1
group.IGr3Active = False
group.IGr3Ipickup = 100
group.IGr3OperTime = 1

Set group = ocTO.FaultGroup(ocConst.GROUP_I2)

Set char = group.TripChar

group.IGrActive = True
group.IGrIpickup = 1
group.IGrTimeIndex = 1
char.SetPredefinedChar(ocConst.PREDEF_NORMAL_INVERSE)

group.IGr2Active = True
group.IGr2Ipickup = 4
group.IGr2OperTime = 0.1
group.IGr3Active = False
group.IGr3Ipickup = 10
group.IGr3OperTime = 0.05

Set group = ocTO.FaultGroup(ocConst.GROUP_I0)

Set char = group.TripChar

group.IGrActive = True
group.IGrIpickup = 1
group.IGrTimeIndex = 1
char.SetPredefinedChar(ocConst.PREDEF_NORMAL_INVERSE)

group.IGr2Active = True
group.IGr2Ipickup = 4
group.IGr2OperTime = 0.1
group.IGr3Active = False
group.IGr3Ipickup = 10
group.IGr3OperTime = 0.05

Set char = Nothing

Set group = Nothing

ocTO.AutoUpdate = True'This will invoke

UpdateAfterChanges() automatically

62
 Overcurrent Automation Interface

ocApp.Quit

Set ocTO = Nothing

Set ocConst = Nothing
Set ocApp = Nothing
Set oc = Nothing
End Sub

63
 OMICRON Test Universe

Shots Collection Object

This collection holds the individual points that make up the test sequence.

Properties
Count (read only))

Syntax: object.Count

Type: Long

Description: Returns the number of points in the test table..

Item (Default Property - read only)

Syntax: object.Item(Index)
Long Index

Type: Object (UserPoint)

Description: This property returns a test point (Shot) from the Shots
collection. The index is the number of the entry in the list
(between 1 and Shots.Count). If no index is given, the Shots
Collection Object is returned (reference to self)

Methods
Add (Itest))

Syntax: Add(Itest)
Double Itest

Type: object (Shot)

Description: Creates a new test point and adds it to the collection. Returns
the Shot object if the point was successfully created and
added, Nothing if the method could not add the point. New
points are added at the end of the test point list. The user must
provide the current in absolute values.

64
 Overcurrent Automation Interface

Remove (Index)

Syntax: Remove(Index)
Long Index

Return type: Boolean

Description: Removes a point from the list. Index must be between 1 and
Shots.Count. Returns True if the point was removed, False
otherwise.

RemoveAll()

Syntax: RemoveAll()

Return type: Boolean

Description: Removes all test points from the list.

65
 OMICRON Test Universe

Shot Object
This object gives access to the test point's nominal values and results.

Properties
ActualTime (read only)

Syntax: object.ActualTime

Return type: Double

Description: Get the actual test time in seconds or -1 if no trip was detected.
This property is meaningful only when TestStatus is
TEST_TESTED

FaultLoop

Syntax: object.FaultLoop

Return type: Long

Description: Get or Sets the Fault Loop. Please use the AutoConst Object
to determine the values for the different Fault Loops.

GetRelativeToElementType (read only)

Syntax: object.GetRelativeToElementType

Return type: Long

Description: Get the type of the relative element

The property will return one of the following values:
ET_PHASE
ET_RESIDUAL
ET_POSITIVE_SEQUENCE
ET_NEGATIVE_SEQUENCE
ET_ZERO_SEQUENCE
ET_UNBALANCED

66
 Overcurrent Automation Interface

GetRelativeToElementName (read only)

Syntax: object.GetRelativeToElementName

Return type: String

Description: Get the Name of the relative Element

MaxTime (read only)

Syntax: object.MaxTime

Return type: Double

Description: Get the maximum permissible trip time for the point in seconds,
or -1 if it is infinite (no trip).

MinTime (read only)

Syntax: object.MinTime

Return type: Double

Description: Get the minimum permissible trip time for the point in seconds,
or -1 if it is infinite (no trip).

NominalTime (read only)

Syntax: object.NominalTime

Return type: Double

Description: Get the nominal trip time for the point in seconds, or -1 if it is
infinite (no trip).

67
 OMICRON Test Universe

OkStatus (read only)

Syntax: object.OkStatus

Return type: Long

Description: Passed / failed status of the point.

The property will return one of the following values:
OK_FAILED
OK_PASSED
OK_NOT_TESTED

Overload (read only)

Syntax: object.Overload

Return type: Boolean

Description: True if overload was detected during testing of this point. The
user must then decide whether the value of OkStatus is still
useful. This property is meaningful only when TestStatus is
TEST_TESTED.

RelError (read only)

Syntax: object.RelError

Return type: Double

Description: Get the relative error for the point, in %. This property is
meaningful only when TestStatus is TEST_TESTED.

TestCurrent (read only)

Syntax: object.TestCurrent

Return type: Double

Description: Get the test current for the point in times Ipickup.

68
 Overcurrent Automation Interface

TestCurrentAbs (read only)

Syntax: object.TestCurrentAbs

Return type: Double

Description: Get the test current for the point in A.

TestStatus (read only)

Syntax: object.TestStatus

Return type: Long

Description: Get the status of the test point. The property will return one of
the following values:
TEST_TESTED The point is fully tested
TEST_NOT_TESTED The point is not tested
TEST_OUT_OF_RANGE Not tested - out of range
TEST_OUT_OF_TIMERANGE Not tested - out of time range
TEST_TRIP_PREFAULT Not tested - tripped during
prefault
Out or range happens when the currents and/or voltages
necessary to test the point according to the user's
specifications exceed the hardware's limits or any of the
maximums set in the Test Object for the relay's protection
(TestObject.VMax and TestObject.IMax).
Out of time range happens when the maximum test time
exceeds the limits of the module. Please note that this does not
include "No tripping", which resolves to the maximum fault time
(absolute or relative, as appropriate.)
If the point tripped during pre-fault, the results are
meaningless, since the fault values where not even applied -
no times will be found in this case.

69
 OMICRON Test Universe

PuDoTest Object
This object allows access to the Pickup / Dropout test in the overcurrent module.

Properties
Dropout (read only)

Syntax: object.Dropout

Type: Double

Description: Get the relay's dropout value. The user must first consult
TestStatus to see if the value is meaningful.

Evaluate

Syntax: object.Evaluate

Type: Boolean

Description: Get / set whether the test will be evaluated. If the test is not
evaluated, its result will not be used for the module's
evaluation.

Overload (read only)

Syntax: object.Overload

Type: Double

Description: True if overload was detected during testing. The user must
then decide whether Pickup and Dropout are still useful.

Passed (read only)

Syntax: object.Passed

Type: Boolean

Description: Get whether the pickup test was passed (True) or failed
(False). This value is meaningful only if TestStatus is PU_-
TESTED and Evaluate is True.

70
 Overcurrent Automation Interface

Pickup (read only)

Syntax: object.Pickup

Type: Double

Description: Get the relay's pickup value. The user must first consult
TestStatus to see if the value is meaningful.

Resolution

Syntax: object.Resolution

Type: Double

Description: Get / set the resolution of the test, in cycles. This value affects
the timing of the Pu/Do test steps.

RelError (read only)

Syntax: object.RelError

Type: Double

Description: Get the relative error of the Pu/Do ratio, in percent. This value
is meaningful only if TestStatus is PU_TESTED.

TripValue

Syntax: object.TripValue

Type: Double

Description: Get / set the value of the initial trip for the EM test, in times the
pickup current.

71
 OMICRON Test Universe

Type

Syntax: object.Type

Type: Long

Description: Get / set the type of Pickup/Dropout test to be performed. The

values can be PUDO_TEST_NONENo test will be performed
PUDO_TEST_STARTTest for relays with Start contact
PUDO_TEST_EMTest for EM relays without start contact (or
full simulation)

TestStatus (read only)

Syntax: object.TestStatus

Type: Long

Description: Get the status of the Pickup/Dropout test.

The property will return one of the following values:
PU_TESTED
PU_NO_START
PU_NO_DROPOUT
PU_NO_PICKUP
PU_OUT_OF_RANGE
PU_NOT_TESTED
PU_OUT_OF_TIME_RANGE
PU_NOT_TRIPPED
PU_EM_NO_PICKUP
PU_EM_NO_DROPOUT
PU_EM_TIME_TOO_HIGH

Note: The following section describes the scope and meaning of the
values for TestStatus.
PU_TESTED applies to both types of tests. It means that the test was fully
completed and both the Pickup and the Dropout values were found. All results
are valid.
PU_NO_START applies only to the Start test. It means that the Start contact
never was active. Often this is a signal of wrong wiring or incorrect configuration
of the Trigger (FixedTrigger object.) No results are valid

72
 Overcurrent Automation Interface

PU_NO_DROPOUT applies only to the Start test. It means that no Dropout

value was detected (the Start contact remained active even when the down
sweep reached its lower limit.) No results are valid.
PU_NO_PICKUP applies only to the Start test. It means that no pickup value
was detected (the Start contact remained inactive even when the up sweep
reached its upper limit.) The dropout value (PuDoTest.Dropout) is valid.
PU_OUT_OF_RANGE applies to both tests. Some point of the test sequence
exceeds the hardware's limits or any of the maximums set in the Test Object for
the relay's protection (TestObject.VMax and TestObject.IMax). No results are
valid.
PU_NOT_TESTED applies to both tests. The test was not performed, and
therefor no results are valid.
PU_OUT_OF_TIME_RANGE and PU_EM_TIME_TOO_HIGH apply only to the
EM test. The trip time of the point selected for the initial trip of the test (obtained
automatically from the operating characteristic) exceeds the module's
(PU_OUT_OF_TIME_RANGE) or the CMC's (PU_EM_TIME_TOO_HIGH)
limits. No results are valid.
PU_NOT_TRIPPED applies only to the EM test. It means that the initial trip was
not detected. No results are valid.
PU_EM_NO_PICKUP applies only to the EM test. It means that the pickup value
could not be determined. No results are valid.
PU_EM_NO_DROPOUT applies only to the EM test. It means that the dropout
value could not be determined. The pickup value (PuDoTest.Pickup) is valid.
TestStatusStr (read only)

Syntax: object.TestStatusStr

Type: String

Description: Returns a localized string describing the status of the test.

Useful for display in customized reports.

73
 OMICRON Test Universe

Example of Test
This example will set the Pu/Do test and a list of points, will perform a test and
will read some results.

Option Explicit
Dim oc As Object
Dim ocApp As Object
Dim ocConst As Object
Dim ocShots As Object
Dim ocPuDo As Object

Public Sub OnCmdScriptRun()

Set oc = Document.TestModules(1) 'Object (TestModule)
oc.Connect

Set ocApp = oc.Specific

Set ocConst = ocApp.Constants
Set ocShots = ocApp.Document.Shots
Set ocPuDo = ocApp.Document.PuDoTest

oc.Clear 'Clear all previous results in the module

ocShots.RemoveAll
ocShots.Add( 1.05)
ocShots.Add( 1.25)
ocShots.Add( 2.00)
ocShots.Add(10.00)

ocPuDo.Type = ocConst.PUDO_TEST_START 'relay with start

contact
ocPuDo.Resolution = 10 '10 cycles step value
ocPuDo.Evaluate = True 'Evaluate the pickup test

oc.Test 'Perform the test

If Not oc.SufficientHardware Then
MsgBox "TEST COULD NOT BE PERFORMED - Insufficient
hardware!!"
GoTo LeaveApp
End If

'Now check that all points are passed, and the overload
status

74
 Overcurrent Automation Interface

Dim singleShot As Object

Dim Failed As Boolean
Dim Overloaded As Boolean

Failed = False
Overloaded = False

For Each singleShot In ocShots

If singleShot.OkStatus <> ocConst.OK_PASSED Then
If Not Failed Then Failed = True 'Latch to True
End If
If singleShot.Overload Then
If Not Overloaded Then Overloaded = True' Latch
to True
End If
Next singleShot

'Let's get now same information from the pickup test

If ocPuDo.TestStatus = ocConst.PU_TESTED Then
If ocPuDo.Overload Then
Overloaded = True
End If
If ocPuDo.Evaluate AND NOT ocPuDo.Passed Then
Failed = True
End If
End If

Set singleShot = Nothing

Dim msg As String

If Failed Then
msg = msg + "Not all points passed"
Else
msg = msg + "All points passed"
End If
If Overloaded Then
msg = msg + vbCrLf + "WARNING: Overload was detected
during test!!"
End If

If ocPuDo.TestStatus = ocConst.TEST_TESTED Then

msg = msg + vbCrLf + "Pickup Value: " +
Str(ocPuDo.Pickup)

75
 OMICRON Test Universe

msg = msg + vbCrLf + "Droput Value: " +

Str(ocPuDo.Dropout)
Else
msg = msg + vbCrLf + "Pickup/Dropout test did not
finish successfully!"
msg = msg + vbCrLf + ocPuDo.TestStatusStr
End If

MsgBox msg

LeaveApp:
ocApp.Quit

Set ocShots = Nothing

Set ocPuDo = Nothing
Set ocConst = Nothing
Set ocApp = Nothing

End Sub

76
 Support

Support
When you are working with our products we want to provide you with the
greatest possible benefits. If you need any support, we are here to assist you!

24/7 Technical Support – Get Support

www.omicron.at/support
www.omicronusa.com/support
Offering our customers outstanding support is one of our top priorities. At our
technical support hotline, you can reach well-educated technicians for all of your
questions. Around the clock – competent and free of charge.
Make use of our 24/7 international technical support hotline: +43 59495 4444.
Additionally, you can find our Service Center or Sales Partner closest to you at
www.omicron.at or www.omicronusa.com.

Customer Area – Stay Informed

www.omicron.at/customer
www.omicronusa.com/customer
The customer area on our website is an international knowledge exchange
platform. Download the latest software updates for all products and share your
own experiences in our user forum.
Browse through the knowledge library and find application notes, conference
papers, articles about daily working experiences, user manuals and much more.

OMICRON Academy – Learn More

www.omicron.at/academy
www.omicronusa.com/academy
Learn more about your product in one of the training courses offered by the
OMICRON Academy.

OMICRON electronics GmbH, Oberes Ried 1, 6833 Klaus, Austria, +43 59495

77
 Support

78