0% found this document useful (0 votes)
15 views60 pages

Overcurrent Automation Interface Manual

CMC-256-3

Uploaded by

LALOUI YOUCEF
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
15 views60 pages

Overcurrent Automation Interface Manual

CMC-256-3

Uploaded by

LALOUI YOUCEF
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

Overcurrent

Automation Interface
OMICRON Test Universe

Manual Version: [Link].2


© OMICRON electronics 2005. All rights reserved.
This Reference Manual is a publication of OMICRON electronics GmbH.
All rights including translation reserved. Reproduction of any kind, e.g., photocopying, microfilming or
storage in electronic data processing systems, requires the explicit consent of OMICRON electronics.
Reprinting, wholly or in part, is not permitted.
This Reference Manual represents the technical status at the time of printing. The product information,
specifications, and all technical data contained within this reference manual are not contractually
binding. OMICRON electronics reserves the right to make changes at any time to the technology and/or
configuration without announcement. OMICRON electronics is not to be held liable for statements and
declarations given in this reference manual. The user is responsible for every application described in
this reference manual and its results. OMICRON electronics explicitly exonerates itself from all liability
for mistakes in this manual.

2
OMICRON Test Universe Overcurrent Automation Interface

1 Contents
1 Contents .............................................................................................................................................................3
2 Introduction........................................................................................................................................................8
3 Object Hierarchy .................................................................................................................................................9
4 Reference..........................................................................................................................................................10
4.1 Application Object......................................................................................................................................10
4.1.1 Properties ............................................................................................................................................10
[Link] Application (read only)..................................................................................................................10
[Link] Constants (read only) ....................................................................................................................10
[Link] Document (read only) ...................................................................................................................11
[Link] Name (read only) ..........................................................................................................................11
[Link] Parent (read only)..........................................................................................................................11
[Link] Visible ...........................................................................................................................................12
4.1.2 Methods..............................................................................................................................................12
[Link] Quit ..............................................................................................................................................12
4.2 Document Object .......................................................................................................................................13
4.2.1 Properties ............................................................................................................................................13
[Link] Application (read only)..................................................................................................................13
[Link] ChangeAllowed (read only) ...........................................................................................................13
[Link] Comment......................................................................................................................................13
[Link] HwInfo (read only) ........................................................................................................................14
[Link] Parent(read only)...........................................................................................................................14
[Link] PuDoTest (read only) .....................................................................................................................14
[Link] Shots (read only) ...........................................................................................................................14
[Link] TestObject (read only) ...................................................................................................................15
[Link] TestSettings (read only) .................................................................................................................15
[Link] Version (read only) ......................................................................................................................15
4.2.2 Methods..............................................................................................................................................16
[Link] UpdateAllViews(hint) ....................................................................................................................16
4.3 TestSettings Object.....................................................................................................................................17
4.3.1 Properties ............................................................................................................................................17
[Link] AbsMaxTime .................................................................................................................................17
[Link] Application (read only)..................................................................................................................17
[Link] BinaryOutputs (read only) .............................................................................................................17
[Link] DelayTime .....................................................................................................................................17
[Link] FaultType ......................................................................................................................................18
[Link] FaultVAngle ..................................................................................................................................18
[Link] LoadIsRel ......................................................................................................................................19
[Link] LoadCurrent..................................................................................................................................19
[Link] LoadCurrentRel .............................................................................................................................19
[Link] PreFaultTime ...............................................................................................................................20
[Link] FaultVoltageLN ...........................................................................................................................20
[Link] FaultVoltageLL ............................................................................................................................20
[Link] GroupOfFault (read only) ............................................................................................................21
[Link] Parent (read only)........................................................................................................................21

3
OMICRON Test Universe Overcurrent Automation Interface

[Link] RelMaxTime ................................................................................................................................21


[Link] TriggerLogic ................................................................................................................................22
4.4 BinaryOutputs Collection Object .................................................................................................................23
4.4.1 Properties ............................................................................................................................................23
[Link] Application (read only)..................................................................................................................23
[Link] Count (read only) ..........................................................................................................................23
[Link] Item (Default Property - read only) ................................................................................................24
[Link] ItemIndex (read only) ....................................................................................................................24
[Link] Parent (read only)..........................................................................................................................24
4.5 BinaryOutput Object...................................................................................................................................25
4.5.1 Properties ............................................................................................................................................25
[Link] Value (default property) ................................................................................................................25
[Link] Name (read only) ..........................................................................................................................25
4.6 BinaryInputs Collection Object....................................................................................................................26
4.6.1 Properties ............................................................................................................................................26
[Link] Application (read only)..................................................................................................................26
[Link] Count (read only) ..........................................................................................................................26
[Link] Item (Default Property - read only) ................................................................................................27
[Link] ItemIndex (read only) ....................................................................................................................27
[Link] Parent (read only)..........................................................................................................................28
4.7 BinaryInput Object .....................................................................................................................................29
4.7.1 Properties ............................................................................................................................................29
[Link] TriggerCondition (default property)...............................................................................................29
[Link] Name (read only) ..........................................................................................................................29
4.8 HwInfo Object............................................................................................................................................30
4.8.1 Properties ............................................................................................................................................30
[Link] CMCIDStr (read only) ....................................................................................................................30
[Link] CMCSerNo (read only)...................................................................................................................30
[Link] CMCType (read only).....................................................................................................................30
4.9 TestObject Object .......................................................................................................................................31
4.9.1 Properties of the Device section of the TO............................................................................................31
[Link] AddInfo1 ......................................................................................................................................31
[Link] AddInfo2 ......................................................................................................................................31
[Link] Address.........................................................................................................................................31
[Link] BayAddr ........................................................................................................................................31
[Link] BayName ......................................................................................................................................31
[Link] CTRatio (Read Only) ......................................................................................................................31
[Link] DebounceTime..............................................................................................................................32
[Link] DeglitchTime.................................................................................................................................32
[Link] DevType ........................................................................................................................................32
[Link] Fnom ..........................................................................................................................................32
[Link] IMax ...........................................................................................................................................32
[Link] INom ..........................................................................................................................................32
[Link] Iprim...........................................................................................................................................32
[Link] Manufacturer..............................................................................................................................32
[Link] Name..........................................................................................................................................33
[Link] Phases.........................................................................................................................................33

4
OMICRON Test Universe Overcurrent Automation Interface

[Link] PTRatio (Read Only).....................................................................................................................33


[Link] ResidualI .....................................................................................................................................33
[Link] ResidualV ....................................................................................................................................33
[Link] Serial...........................................................................................................................................33
[Link] SubsAddr ....................................................................................................................................33
[Link] SubsName ..................................................................................................................................33
[Link] VMax ..........................................................................................................................................34
[Link] VNom .........................................................................................................................................34
[Link] Vprim .........................................................................................................................................34
4.9.2 Properties of the Overcurrent section of the TO ...................................................................................34
[Link] AutoReset .....................................................................................................................................34
[Link] CurrTolAbs....................................................................................................................................34
[Link] CurrTolRel .....................................................................................................................................34
[Link] CurrTToBus ...................................................................................................................................34
[Link] Directional ....................................................................................................................................35
[Link] FaultGroup(index) (read only)........................................................................................................35
[Link] PwrTOnBus ...................................................................................................................................35
[Link] TimeTolAbs ...................................................................................................................................35
[Link] TimeTolRel ....................................................................................................................................35
4.9.3 Other properties of the TO...................................................................................................................35
[Link] Application (read only)..................................................................................................................35
[Link] Parent (read only)..........................................................................................................................35
[Link] AutoUpdate ..................................................................................................................................36
4.9.4 Methods..............................................................................................................................................36
[Link] UpdateAfterChanges() ..................................................................................................................36
4.10 FaultGroup object ....................................................................................................................................37
4.10.1 Properties ..........................................................................................................................................37
[Link] IGrActive.....................................................................................................................................37
[Link] IGrIpickup ...................................................................................................................................37
[Link] IGrTimeIndex...............................................................................................................................37
[Link] IGr2Active...................................................................................................................................37
[Link] IGr2Ipickup .................................................................................................................................37
[Link] IGr2OperTime .............................................................................................................................37
[Link] IGr3Active...................................................................................................................................38
[Link] IGr3Ipickup .................................................................................................................................38
[Link] IGr3OperTime .............................................................................................................................38
[Link] ResetRatio.................................................................................................................................38
[Link] TripChar (read only) ..................................................................................................................38
4.11 TripChar object.........................................................................................................................................39
4.11.1 Properties ..........................................................................................................................................39
[Link] A (read only) ...............................................................................................................................39
[Link] AutoresetR ..................................................................................................................................39
[Link] AutoresetT ..................................................................................................................................39
[Link] B (read only) ...............................................................................................................................39
[Link] C (read only) ...............................................................................................................................39
[Link] D (read only) ...............................................................................................................................39
[Link] E (read only) ...............................................................................................................................40

5
OMICRON Test Universe Overcurrent Automation Interface

[Link] IsAutoreset (read only) ................................................................................................................40


[Link] IsDefiniteTime (read only)............................................................................................................40
[Link] IsI2t (read only) ....................................................................................................................40
[Link] IsIAC (read only)........................................................................................................................40
[Link] IsInverse (read only) ..................................................................................................................40
[Link] IsPredefined (read only).............................................................................................................40
[Link] IsUserChar (read only) ...............................................................................................................40
[Link] K1 (read only) ...........................................................................................................................41
[Link] K2 (read only) ...........................................................................................................................41
[Link] Name (read only) ......................................................................................................................41
[Link] P (read only) .............................................................................................................................41
[Link] Q (read only).............................................................................................................................41
[Link] UserPoints (read only) ...............................................................................................................41
4.11.2 Methods............................................................................................................................................42
[Link] SetPredefChar(type) ....................................................................................................................42
[Link] SetI2tChar(Name, A, P, Q)...........................................................................................................42
[Link] SetIACChar(Name, A, B, C, D, E) .................................................................................................42
[Link] SetInverseChar(Name, A, B, P, Q, K1, K2) ....................................................................................43
[Link] SetUserChar(Name).....................................................................................................................43
4.12 UserPoints collection object......................................................................................................................44
4.12.1 Properties ..........................................................................................................................................44
[Link] Count (read only) ........................................................................................................................44
[Link] Item (Default Property - read only) ..............................................................................................44
4.12.2 Methods............................................................................................................................................44
[Link] Add(Ipu, Time)............................................................................................................................44
[Link] Remove(index) ............................................................................................................................44
[Link] RemoveAll() ................................................................................................................................45
4.13 UserPoint object .......................................................................................................................................46
4.13.1 Properties ..........................................................................................................................................46
[Link] Current (read only)......................................................................................................................46
[Link] Time (read only) ..........................................................................................................................46
4.14 Test Object example .................................................................................................................................47
4.15 Shots collection object .............................................................................................................................50
4.15.1 Properties ..........................................................................................................................................50
[Link] Count (read only) ........................................................................................................................50
[Link] Item (Default Property - read only) ..............................................................................................50
4.15.2 Methods............................................................................................................................................50
[Link] Add(Itest, optional relTo, optional Backward)..............................................................................50
[Link] Remove(Index) ............................................................................................................................51
[Link] RemoveAll() ................................................................................................................................51
[Link] Sort(order) ..................................................................................................................................51
4.16 Shot object...............................................................................................................................................52
4.16.1 Properties ..........................................................................................................................................52
[Link] IRelative (read only).....................................................................................................................52
[Link] ActualTime (read only) ................................................................................................................52
[Link] MaxTime (read only) ...................................................................................................................52
[Link] MinTime (read only)....................................................................................................................52

6
OMICRON Test Universe Overcurrent Automation Interface

[Link] NominalTime (read only) .............................................................................................................52


[Link] OkStatus (read only)....................................................................................................................52
[Link] Overload (read only) ...................................................................................................................53
[Link] RelativeTo (read only)..................................................................................................................53
[Link] RelError (read only) .....................................................................................................................53
[Link] TestCurrent (read only)..............................................................................................................53
[Link] TestCurrentAbs (read only)........................................................................................................53
[Link] TestStatus (read only)................................................................................................................54
4.17 PuDoTest object .......................................................................................................................................55
4.17.1 Properties ..........................................................................................................................................55
[Link] Dropout (read only) ....................................................................................................................55
[Link] Evaluate ......................................................................................................................................55
[Link] Overload (read only) ...................................................................................................................55
[Link] Passed (read only) .......................................................................................................................55
[Link] Pickup (read only) .......................................................................................................................55
[Link] Resolution...................................................................................................................................55
[Link] RelError (read only) .....................................................................................................................56
[Link] TripValue ....................................................................................................................................56
[Link] Type............................................................................................................................................56
[Link] TestStatus (read only)................................................................................................................56
[Link] TestStatusStr (read only) ...........................................................................................................57
4.18 Example of Test ........................................................................................................................................58

7
OMICRON Test Universe Overcurrent Automation Interface

2 Introduction
The OMICRON OMOvcBND test module provides the capabilities to test overcurrent protective relays. It can be
used stand-alone or embedded in the OMICRON Control Center. In this case, it is possible to use the module as an
Automation Server from any automation client, especially form the Control Center Script Language.

To use the module efficiently, it is very convenient to be well acquainted with its capabilities and testing concept.
Please refer to the OMICRON Overcurrent documentation and on-line help for a detailed description of the
module.

8
OMICRON Test Universe Overcurrent Automation Interface

3 Object Hierarchy

Application

Constants

Document

Test Settings

Binary Outputs

Binary Inputs

Hardware Info

Test Object

Fault Group

Trip Characteristic

User Points Collection

User Point

Shots Collection

Shot

Pu/Do Test

9
OMICRON Test Universe Overcurrent Automation Interface

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

4.1 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.

4.1.1 Properties

[Link] Application (read only)


Syntax: [Link]
Type: Object (Application)
Description: Returns the application itself, for coherence.
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim app As Object
Set app = [Link] ‘app must be the
‘same object as Ovc

[Link] Constants (read only)


Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Set Con = [Link]

10
OMICRON Test Universe Overcurrent Automation Interface

[Link] Document (read only)


Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Set Con = [Link]
Set Doc = [Link]

[Link] Name (read only)


Syntax: [Link]
Type: String
Description: Returns the name of the application.
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim Name As String
Set Name = [Link]

[Link] Parent (read only)


Syntax: [Link]
Type: Object (Application)
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 = [Link](“[Link]”)
Set Ovc = [Link]
Set Parent = [Link] ‘In this case, Parent will be the same
‘object as Ovc

11
OMICRON Test Universe Overcurrent Automation Interface

[Link] Visible
Syntax: [Link]
Type: Boolean
Description: Shows/hides the main application window.
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
'Is the application visible?
If [Link] then
MsgBox "Application is already visible"
Else 'Make the application visible
[Link] = 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.

4.1.2 Methods

[Link] Quit
Syntax: [Link]()
Return Type: none
Description: Terminates execution of the application.
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](1)
Set Ovc = [Link]
[Link]
[Link]

12
OMICRON Test Universe Overcurrent Automation Interface

4.2 Document Object


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

4.2.1 Properties

[Link] Application (read only)


Syntax: [Link]
Type: Object (Application)
Description: Returns the application object (Application).
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim app As Object
Set app = [Link] ‘app must be the
‘same object as Ovc

[Link] ChangeAllowed (read only)


Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
If [Link] Then
MsgBox "the document is read-write"
Else
Msg Box "the document is Read-Only"
End If

[Link] Comment
Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
‘Set comment in the report
[Link] = “This test is simulated”

13
OMICRON Test Universe Overcurrent Automation Interface

[Link] HwInfo (read only)


Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Dim hwInfo As Object
Set hwInfo = [Link]

[Link] Parent(read only)


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

[Link] PuDoTest (read only)


Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Dim pickupTest As Object
Set pickupTest = [Link]
If [Link] = [Link].PUDO_TEST_NONE Then
MsgBox "Pickup – Dropout test is not enabled"
End If

[Link] Shots (read only)


Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Dim shots As Object
Set shots = [Link]
MsgBox "There are " + Str([Link]) + "shots defined."

14
OMICRON Test Universe Overcurrent Automation Interface

[Link] TestObject (read only)


Syntax: [Link]
Type: Object (TestObject)
Description: Returns the TestObject object
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim to As Object
Set to = [Link]

[Link] TestSettings (read only)


Syntax: [Link]
Type: Object (TestSetting)
Description: Returns the TestSettings object.
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim settings As Object
Set settings = [Link]

[Link] Version (read only)


Syntax: [Link]
Type: String
Description: Returns the version of the OMMeter module in form “[Link]” where:
M: major
m: minor
b: build
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
MsgBox = “Module version is “ + [Link]

15
OMICRON Test Universe Overcurrent Automation Interface

4.2.2 Methods

[Link] UpdateAllViews(hint)
Syntax: [Link](hint)
Long hint
Return 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 = [Link](“[Link]”)
Set Ovc = [Link]
[Link] = “This is an Automation test”
[Link]

16
OMICRON Test Universe Overcurrent Automation Interface

4.3 TestSettings Object


This object allows access to the settings that are common for all test shots.

4.3.1 Properties

[Link] AbsMaxTime
Syntax: [Link]
Type: Double
Description: Get / Set the maximum fault time – absolute, in seconds.
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim settings As Object
Set settings = [Link]
[Link] = 240.0

[Link] Application (read only)


Syntax: [Link]
Type: Object (Application)
Description: Returns the Application object (Application).

[Link] BinaryOutputs (read only)


Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Dim bin As Object
Set bin = [Link]

[Link] DelayTime
Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Dim settings As Object
Set settings = [Link]
[Link] = 0.1

17
OMICRON Test Universe Overcurrent Automation Interface

[Link] FaultType
Syntax: [Link]
Type: Long
Description: Get / Set the type of fault for which the test will be performed. The Overcurrent
module can only test in one fault loop, this property selects which one is tested.
The possible values for this property are:
FAULT_L1E
FAULT_L2E
FAULT_L3E
FAULT_L1L2
FAULT_L3L1
FAULT_L2L3
FAULT_L1L2L3
FAULT_I0 (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 = [Link](“[Link]”)
Set Ovc = [Link]
Set Con = [Link]
Set settings = [Link]
[Link] = Con.FAULT_L1L2L3 ‘Three-phase fault

[Link] FaultVAngle
Syntax: [Link]
Type: Double
Description: Get / Set the Fault angle for the voltages in degrees. If the [Link]
property is True, this property controls the angle between voltages and current
according to the particular fault model for each fault.
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim settings As Object
Set settings = [Link]
[Link] = 45.0

18
OMICRON Test Universe Overcurrent Automation Interface

[Link] LoadIsRel
Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Dim settings As Object
Set settings = [Link]
[Link] = True

[Link] LoadCurrent
Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Dim settings As Object
Set settings = [Link]
[Link] = 0.85

[Link] LoadCurrentRel
Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Dim settings As Object
Set settings = [Link]
[Link] = 0.90

19
OMICRON Test Universe Overcurrent Automation Interface

[Link] PreFaultTime
Syntax: [Link]
Type: Double
Description: Get / Set the pre-fault time in seconds
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim settings As Object
Set settings = [Link]
[Link] = 0 'Proceed directly to the fault

[Link] FaultVoltageLN
Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Dim settings As Object
Set settings = [Link]
[Link] = 63.51

[Link] FaultVoltageLL
Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Dim settings As Object
Set settings = [Link]
[Link] =110.0

20
OMICRON Test Universe Overcurrent Automation Interface

[Link] GroupOfFault (read only)


Syntax: [Link]
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_I0 Includes the Zero-sequence fault
GROUP_I2 Includes the Negative sequence fault
Example: Dim otm As Object
Dim Ovc As Object
Dim Con As object
Dim settings As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Set Con = [Link]
Set settings = [Link]
[Link] = Con.FAULT_L1L2L3 ‘Three-phase fault
If [Link] <> Con.Group_LL Then
MsgBox "ERROR: Fault was not correctly set"
End If

[Link] Parent (read only)


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

[Link] RelMaxTime
Syntax: [Link]
Type: Double
Description: Get / Set the maximum fault time – relative, in %.
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim settings As Object
Set settings = [Link]
[Link] = 100.0

21
OMICRON Test Universe Overcurrent Automation Interface

[Link] TriggerLogic
Syntax: [Link]
Type: long
Description: Get / Set the logic for the binary trigger. The possible values are:

LOGIC_AND
LOGIC_OR
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim settings As Object
Set settings = [Link]
[Link] = [Link].LOGIC_AND

22
OMICRON Test Universe Overcurrent Automation Interface

4.4 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 controls expanded I/O devices, and outputs both in the CMC itself and in the expansion
device(s) can be controlled from this class.

4.4.1 Properties

[Link] Application (read only)


Syntax: [Link]
Type: Object (Application)
Description: Returns the application object (Application).

[Link] Count (read only)


Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
Dim bin As Object
Set bin = [Link]
MsgBox "There are " + Str([Link]) + "output(s) assigned"

23
OMICRON Test Universe Overcurrent Automation Interface

[Link] Item (Default Property - read only)


Syntax: [Link](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 = [Link](“[Link]”)
Set Ovc = [Link]
'Set binary output for User Defined Binary Output 1
Dim st As Object
Set st = [Link]
Dim out As Object
Set out = [Link]([Link].sigidUSER_OUTBIN_DEF1)
[Link] = 1

[Link] ItemIndex (read only)


Syntax: [Link](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 [Link]).
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
'Set all binary outputs
Dim st As Object
Set st = [Link]
For i = 1 To [Link]
[Link](i).Value = 1
Next i

[Link] Parent (read only)


Syntax: [Link]
Type: Object (TestSettings)
Description: This property always returns the parent object in the object hierarchy. In this case it is
the Test Settings Object (TestSettings).

24
OMICRON Test Universe Overcurrent Automation Interface

4.5 BinaryOutput Object

4.5.1 Properties

[Link] Value (default property)


Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
'Set binary output for User Defined Binary Output 1
Dim st As Object
Set st = [Link]
Dim out As Object
Set out = [Link]([Link]. sigidUSER_OUTBIN_DEF1)
[Link] = 1

[Link] Name (read only)


Syntax: [Link]
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 = [Link](“[Link]”)
Set Ovc = [Link]
'Get name of User Defined Binary Output 1
Dim st As Object
Set st = [Link]
Dim out As Object
Set out = [Link]([Link]. sigidUSER_OUTBIN_DEF1)
MsgBox "The name of the output is " + [Link]

25
OMICRON Test Universe Overcurrent Automation Interface

4.6 BinaryInputs Collection Object


This object allows access to the assigned binary Inputs. All the inputs in this collection will form the binary Trigger,
each one having its individual trigger condition. The inputs are managed by the system based on their signal ID,
so if an input is assigned to another physical input, it may change positions in the collection; but still it will keep
its signal ID and trigger condition.

The OMOvcBND module controls expanded I/O devices, and inputs both in the CMC itself and in the expansion
device(s) can be controlled from this class.

4.6.1 Properties

[Link] Application (read only)


Syntax: [Link]
Type: Object (Application)
Description: Returns the application object (Application).

[Link] Count (read only)


Syntax: [Link]
Type: Long
Description: Returns the number of binary inputs that are assigned to physical inputs.
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim bin As Object
Set bin = [Link]
MsgBox "There are " + Str([Link]) + " input(s) assigned"

26
OMICRON Test Universe Overcurrent Automation Interface

[Link] Item (Default Property - read only)


Syntax: [Link](SignalID)
Long SignalID – Signal ID of the binary input
Type: Object (BinaryInput)
Description: This property returns a Binary Input Object (BinaryInput) from the Binary Inputs
Collection. The parameter is the signal ID of the binary input in the collection. Signal
IDs are constants from the Constants object. Their possible values are:

sigidTRIP
sigidSTART
sigidUSER_INPBIN_DEF1
sigidUSER_INPBIN_DEF2
sigidUSER_INPBIN_DEF3
sigidUSER_INPBIN_DEF4
sigidUSER_INPBIN_DEF5
sigidUSER_INPBIN_DEF6
sigidUSER_INPBIN_DEF7
sigidUSER_INPBIN_DEF8
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
'Set binary input for TRIP signal
Dim st As Object
Set st = [Link]
Dim trip As Object
Set trip = [Link]([Link])
[Link] = [Link].TRIG_POS
Dim start As Object
Set start = [Link]([Link])
[Link] = [Link].TRIG_DONTCARE

[Link] ItemIndex (read only)


Syntax: [Link](Index)
Variant Index – Index number of the binary input in the collection
Type: Object (BinaryInput)
Description: This property returns a Binary Input Object (BinaryInput) from the Binary Inputs
Collection. The index is the number of the binary input in the collection (between 1
and [Link]).
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
'Print names of the binary inputs
Dim st As Object
Set st = [Link]
For i = 1 To [Link]
MsgBox [Link](i).Name + vbCrLf
Next i

27
OMICRON Test Universe Overcurrent Automation Interface

[Link] Parent (read only)


Syntax: [Link]
Type: Object (TestSettings)
Description: This property always returns the parent object in the object hierarchy. In this case it is
the Test Settings Object (TestSettings).

28
OMICRON Test Universe Overcurrent Automation Interface

4.7 BinaryInput Object

4.7.1 Properties

[Link] TriggerCondition (default property)


Syntax: [Link]
Type: long
Description: Get/Set the trigger behavior of this input. The possible trigger conditions are:

TRIG_POS Condition fulfilled when input is active


TRIG_NEG Condition fulfilled when input is not active
TRIG_DONTCARE Condition always fulfilled
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
'Set binary input for TRIP signal
Dim st As Object
Set st = [Link]
Dim trip As Object
Set trip = [Link]([Link])
[Link] = [Link].TRIG_POS
Dim start As Object
Set start = [Link]([Link])
[Link] = [Link].TRIG_DONTCARE

[Link] Name (read only)


Syntax: [Link]
Type: String
Description: Get the name of the input (as set by the user in the Hardware Configuration dialog).
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
'Get name of first input in the collection
Dim st As Object
Set st = [Link]
Dim inp As Object
Set inp = [Link](1)
MsgBox "The name of the first input is " + [Link]

29
OMICRON Test Universe Overcurrent Automation Interface

4.8 HwInfo Object


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

4.8.1 Properties

[Link] CMCIDStr (read only)


Syntax: [Link]
Type: String
Description: Returns the ID of the CMC used in the test.
Generally it will be “1”; in case of off-line testing, the string will be empty.
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim CMCID As String
CMCID = [Link]

[Link] CMCSerNo (read only)


Syntax: [Link]
Type: String
Description: Returns the Serial Number of the CMC used in the test.
In case of off-line testing, the string will be “???????”
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim CMCSer As String
CMCSer = [Link]

[Link] CMCType (read only)


Syntax: [Link]
Type: String
Description: Returns the Type of the CMC used in the test (e.g. “CMC256-6”)
In case of off-line testing, it will return the type of the simulated device selected.
Example: Dim otm As Object
Dim Ovc As Object
Set otm = [Link](“[Link]”)
Set Ovc = [Link]
Dim CMCType As String
CMCSer = [Link]

30
OMICRON Test Universe Overcurrent Automation Interface

4.9 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.

4.9.1 Properties of the Device section of the TO

[Link] AddInfo1
Syntax: object.AddInfo1
Type: String
Description: Get / Set the device's additional info / 1.

[Link] AddInfo2
Syntax: object.AddInfo2
Type: String
Description: Get / Set the device's additional info / 2.

[Link] Address
Syntax: [Link]
Type: String
Description: Get / Set the device's address.

[Link] BayAddr
Syntax: [Link]
Type: String
Description: Get / Set the Address of the Bay.

[Link] BayName
Syntax: [Link]
Type: String
Description: Get / Set the Name of the Bay.

[Link] CTRatio (Read Only)


Syntax: [Link]
Type: Double
Description: Get the ratio of the CT. This Value is equal to Iprim / INom.

31
OMICRON Test Universe Overcurrent Automation Interface

[Link] DebounceTime
Syntax: [Link]
Type: Double
Description: Get / Set the binary inputs debounce time in s.

[Link] DeglitchTime
Syntax: [Link]
Type: Double
Description: Get / Set the binary inputs deglitch time in s.

[Link] DevType
Syntax: [Link]
Type: String
Description: Get / Set the device's type.

[Link] Fnom
Syntax: [Link]
Type: Double
Description: Get / Set the nominal frequency in Hz.

[Link] IMax
Syntax: [Link]
Type: Double
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.

[Link] INom
Syntax: [Link]
Type: Double
Description: Get / Set the nominal current in A.

[Link] Iprim
Syntax: [Link]
Type: Double
Description: Get / Set the primary current in A.

[Link] Manufacturer
Syntax: [Link]
Type: String
Description: Get / Set the device manufacturer's description.

32
OMICRON Test Universe Overcurrent Automation Interface

[Link] Name
Syntax: [Link]
Type: String
Description: Get / Set the device name.

[Link] Phases
Syntax: [Link]
Type: Long
Description: Get / Set the device's number of phases.

[Link] PTRatio (Read Only)


Syntax: [Link]
Type: Double
Description: Get the ratio of the PT. This value is equal to Vprim / VNom.

[Link] ResidualI
Syntax: [Link]
Type: Double
Description: Get / Set the device’s residual I ratio (IN / Inom).

[Link] ResidualV
Syntax: [Link]
Type: Double
Description: Get / Set the device’s residual V ratio (IN / Inom).

[Link] Serial
Syntax: [Link]
Type: String
Description: Get / Set the device’s serial number as string.

[Link] SubsAddr
Syntax: [Link]
Type: String
Description: Get / Set the address of the substation.

[Link] SubsName
Syntax: [Link]
Type: String
Description: Get / Set the device’s serial number as string.

33
OMICRON Test Universe Overcurrent Automation Interface

[Link] VMax
Syntax: [Link]
Type: Double
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.

[Link] VNom
Syntax: [Link]
Type: Double
Description: Get / Set the nominal voltage in V.

[Link] Vprim
Syntax: [Link]
Type: Double
Description: Get / Set the primary voltage in V.

4.9.2 Properties of the Overcurrent section of the TO

[Link] AutoReset
Syntax: [Link]
Type: Boolean
Description: True if the formula for the automatic calculation of the Reset Time (delay time) is to
be used, False otherwise. Please note that not all characteristics may use the
automatic calculation of the reset time. The parameter is meaningless unless
[Link] is true, although it will be set none the less.

[Link] CurrTolAbs
Syntax: [Link]
Type: Double
Description: Get / Set the Absolute Current Tolerance in times In.

[Link] CurrTolRel
Syntax: [Link]
Type: Double
Description: Get / Set the Relative Current Tolerance in %.

[Link] CurrTToBus
Syntax: [Link]
Type: Boolean
Description: True is the Current transformer is grounded towards the busbar, False if it is
grounded towards the line.

34
OMICRON Test Universe Overcurrent Automation Interface

[Link] Directional
Syntax: [Link]
Type: Boolean
Description: Get / Set whether the module will use Voltages.

[Link] FaultGroup(index) (read only)


Syntax: [Link](Index)
Long Index
Type: Object (FaultGroup)
Description: Get the FaultGroup object. The index must be one of the following:
GROUP_LN All 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

[Link] PwrTOnBus
Syntax: [Link]
Type: Boolean
Description: True is the power transformer is grounded on the busbar, False if it is grounded on
the line.

[Link] TimeTolAbs
Syntax: [Link]
Type: Double
Description: Get / Set the Absolute Time Tolerance in seconds.

[Link] TimeTolRel
Syntax: [Link]
Type: Double
Description: Get / Set the Relative Time Tolerance in %.

4.9.3 Other properties of the TO

[Link] Application (read only)


Syntax: [Link]
Type: Object (Application)
Description: Returns the application object (Application).

[Link] Parent (read only)


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

35
OMICRON Test Universe Overcurrent Automation Interface

[Link] AutoUpdate
Syntax: [Link]
Type: Boolean
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.

4.9.4 Methods

[Link] UpdateAfterChanges()
Syntax: [Link]()
Return Type: none
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.

36
OMICRON Test Universe Overcurrent Automation Interface

4.10 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.

4.10.1 Properties

[Link] IGrActive
Syntax: [Link]
Type: Boolean
Description: Get / Set whether the I> protective unit is active. The unit can be configured
regardless of the value of this parameter.

[Link] IGrIpickup
Syntax: [Link]
Type: Double
Description: Get / Set the pickup value for the I> protective unit in times In.

[Link] IGrTimeIndex
Syntax: [Link]
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.

[Link] 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.

[Link] IGr2Ipickup
Syntax: object.IGr2Ipickup
Type: Double
Description: Get / Set the pickup value for the I>> protective unit in times In.

[Link] IGr2OperTime
Syntax: object.IGr2OperTime
Type: Double
Description: Get / Set the operating time for the I>> protective unit, in seconds.

37
OMICRON Test Universe Overcurrent Automation Interface

[Link] 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.

[Link] IGr3Ipickup
Syntax: object.IGr3Ipickup
Type: Double
Description: Get / Set the pickup value for the I>>> protective unit in times In.

[Link] IGr3OperTime
Syntax: object.IGr3OperTime
Type: Double
Description: Get / Set the operating time for the I>>> protective unit, in seconds.

[Link] ResetRatio
Syntax: [Link]
Type: Double
Description: Get / Set the nominal Reset Ratio (Ipickup / Idropoff) for the group. If
[Link] 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

[Link] TripChar (read only)


Syntax: [Link]
Type: object (TripChar)
Description: Get the TripChar object for access to the tripping characteristic of the I> protective
unit.

38
OMICRON Test Universe Overcurrent Automation Interface

4.11 TripChar object


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

4.11.1 Properties

[Link] A (read only)


Syntax: object.A
Type: Double
Description: Get the A parameter from the characteristic formulas. This property is meaningless
unless IsInverse, IsI2t or IsIAC are True.

[Link] AutoresetR
Syntax: [Link]
Type: Double
Description: Get/Set the R factor from the Auto Reset formula. This property is meaningless unless
IsAutoreset is True.

[Link] AutoresetT
Syntax: [Link]
Type: Double
Description: Get/Set the T exponent from the Auto Reset formula. This property is meaningless
unless IsAutoreset is True.

[Link] B (read only)


Syntax: object.B
Type: Double
Description: Get the B parameter from the characteristic formulas. This property is meaningless
unless IsInverse or IsIAC are True.

[Link] C (read only)


Syntax: object.C
Type: Double
Description: Get the C parameter from the characteristic formulas. This property is meaningless
unless IsIAC is True.

[Link] D (read only)


Syntax: object.D
Type: Double
Description: Get the D parameter from the characteristic formulas. This property is meaningless
unless IsIAC is True.

39
OMICRON Test Universe Overcurrent Automation Interface

[Link] E (read only)


Syntax: object.E
Type: Double
Description: Get the E parameter from the characteristic formulas. This property is meaningless
unless IsIAC is True.

[Link] IsAutoreset (read only)


Syntax: [Link]
Type: Boolean
Description: True if the characteristic may have automatic calculation of the Reset Time.

[Link] IsDefiniteTime (read only)


Syntax: [Link]
Type: Boolean
Description: True if the characteristic is Definite Time.

[Link] IsI2t (read only)


Syntax: object.IsI2t
Type: Boolean
Description: True if the characteristic follows the I2t formula.

[Link] IsIAC (read only)


Syntax: [Link]
Type: Boolean
Description: True if the characteristic follows the IAC formula.

[Link] IsInverse (read only)


Syntax: [Link]
Type: Boolean
Description: True if the characteristic is Inverse.

[Link] IsPredefined (read only)


Syntax: [Link]
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.

[Link] IsUserChar (read only)


Syntax: [Link]
Type: Boolean
Description: True if the characteristic is user-defined.

40
OMICRON Test Universe Overcurrent Automation Interface

[Link] K1 (read only)


Syntax: object.K1
Type: Double
Description: Get the K1 parameter from the characteristic formulas. This property is meaningless
unless IsInverse is True.

[Link] K2 (read only)


Syntax: object.K2
Type: Double
Description: Get the K2 parameter from the characteristic formulas. This property is meaningless
unless IsInverse is True.

[Link] Name (read only)


Syntax: [Link]
Type: String
Description: Get the characteristic's name.

[Link] P (read only)


Syntax: object.P
Type: Double
Description: Get the P parameter from the characteristic formulas. This property is meaningless
unless IsInverse or IsI2t are True.

[Link] Q (read only)


Syntax: object.Q
Type: Double
Description: Get the Q parameter from the characteristic formulas. This property is meaningless
unless IsInverse or IsI2t are True.

[Link] UserPoints (read only)


Syntax: [Link]
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.

41
OMICRON Test Universe Overcurrent Automation Interface

4.11.2 Methods

[Link] SetPredefChar(type)
Syntax: SetPredefChar(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_INVERSE Inverse
PREDEF_VERY_INVERSE Very Inverse
PREDEF_EXTR_INVERSE Extremely Inverse

This method returns True if the operation was successful, False otherwise.

[Link] 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.

[Link] SetIACChar(Name, A, B, C, D, E)
Syntax: SetIACChar(Name, A, B, C, D, E)
String Name
Double A
Double B
Double C
Double D
Double E
Return Type: Boolean
Description: Set the characteristic to IAC, with the provided parameters. Returns True if the
operation was successful, False otherwise.

42
OMICRON Test Universe Overcurrent Automation Interface

[Link] 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.

[Link] 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.

43
OMICRON Test Universe Overcurrent Automation Interface

4.12 UserPoints collection object

4.12.1 Properties

[Link] Count (read only)


Syntax: [Link]
Type: Long
Description: Returns the number of points in the user-defined characteristic.

[Link] Item (Default Property - read only)


Syntax: [Link](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
[Link]). If no index is given, the UserPoints Collection Object is
returned (reference to self)

4.12.2 Methods

[Link] Add(Ipu, Time)


Syntax: Add(Ipu, Time)
Double Ipu
Double Time
Return 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.

[Link] Remove(index)
Syntax: Remove(Index)
Long Index
Return Type: Boolean
Description: Removes a point from the list. Index must be between 1 and [Link].
Returns True if the point was removed, False otherwise. Please note that it is
permitted to remove all points of a characteristic.

44
OMICRON Test Universe Overcurrent Automation Interface

[Link] RemoveAll()
Syntax: RemoveAll()
Return Type: Boolean
Description: Removes all points from the characteristic. The resulting characteristic is valid, if quite
useless.

45
OMICRON Test Universe Overcurrent Automation Interface

4.13 UserPoint object

4.13.1 Properties

[Link] 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 [Link] method.

[Link] 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
[Link] method.

46
OMICRON Test Universe Overcurrent Automation Interface

4.14 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 [Link]), 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 = [Link](1) 'Object (TestModule)
[Link]

Set ocApp = [Link]


Set ocConst = [Link]
Set ocTO = [Link]

'Since we are going to do many changes, we


'disable the TO AutoUpdate feature

[Link] = False

'Let's begin with the TO common settings,

[Link] = "DFP 100"


[Link] = 3
[Link] = "GE"
[Link] = "50/51"
[Link] = 168.0
[Link] = 1.0
[Link] = 12.5
[Link] = 50.0
[Link] = 0
[Link] = 0

'Now, the overcurrent common settings

[Link] = True
[Link] = False
[Link] = False
[Link] = 10
[Link] = 0.1
[Link] = 3
[Link] = 0.1

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

Dim group As Object


Dim char As Object

47
OMICRON Test Universe Overcurrent Automation Interface

Set group = [Link](ocConst.GROUP_LN)


Set char = [Link]

[Link] = True
[Link] = 5
[Link] = 1
[Link]("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 = [Link](ocConst.GROUP_LL)


Set char = [Link]

[Link] = True
[Link] = 5
[Link] = 1

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

[Link]("UserChar")

'The points can be entered in any order, we do not have to enter them sorted

[Link](1.05, 100.0)
[Link](1.20, 40.0)
[Link](1.50, 28.0)
[Link](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 = [Link](ocConst.GROUP_I2)


Set char = [Link]

[Link] = True
[Link] = 1
[Link] = 1
[Link](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 = [Link](ocConst.GROUP_I0)

48
OMICRON Test Universe Overcurrent Automation Interface

Set char = [Link]

[Link] = True
[Link] = 1
[Link] = 1
[Link](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

[Link] = True 'This will invoke UpdateAfterChanges() automatically

[Link]

Set ocTO = Nothing


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

49
OMICRON Test Universe Overcurrent Automation Interface

4.15 Shots collection object


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

4.15.1 Properties

[Link] Count (read only)


Syntax: [Link]
Type: Long
Description: Returns the number of points in the test table.

[Link] Item (Default Property - read only)


Syntax: [Link](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 [Link]). If no index is given,
the Shots Collection Object is returned (reference to self)

4.15.2 Methods

[Link] Add(Itest, optional relTo, optional Backward)


Syntax: Add(Irel, relTo, Backward)
Double Itest
Optional Long relTo
Optional Boolean Backward
Return Type: object (Shot)

50
OMICRON Test Universe Overcurrent Automation Interface

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. If the points in the list
had been sorted, the addition of a new point may require that the list be re-sorted by
invoking the Sort method. This would break the link between the point in the table
and the object returned by the method, and must therefore not be done until the
object has been released.

The user must provide the current in times the pickup current of a given protective
unit, and the unit relative to which the point is defined. If no unit is provided, the
point will be added relative to I>. It is not possible to add points having the same
relative value respect to the same unit as one point already in the table. However, it is
possible to add points that resolve to the same location in the I/t diagram as long as
they are defined relative to different units.

It is also possible to define the point as Backward. If the parameter is not provided,
the point will be entered as Forward. It is only possible to add Backward points
when the [Link] setting is True. Otherwise, the point will not be
added and the method will return Nothing. Two points can have the same Itest and
be relative to the same unit if one is Forward and the other is Backward.

Possible values for the relTo parameter are: UNIT_IGR (I>), UNIT_IGR2 (I>>)and
UNIT_IGR3(I>>>).

[Link] Remove(Index)
Syntax: Remove(Index)
Long Index
Return Type: Boolean
Description: Removes a point from the list. Index must be between 1 and [Link]. Returns
True if the point was removed, False otherwise.

[Link] RemoveAll()
Syntax: RemoveAll()
Return Type: Boolean
Description: Removes all test points from the list.

[Link] Sort(order)
Syntax: Sort(order)
optional Long order
Return Type: none
Description: Sorts the points in the characteristic by current values. The parameters can be:
SORT_ASCENDING The points are sorted with the lower currents first
SORT_DESCENDING The points are sorted with the higher currents first
If the order parameter is missing, SORT_ASCENDING will be assumed.
Note: Please note that the points cannot be returned to their original order once sorted. Also, the sorting only
applies to the points already in the table, new points are added unsorted at the end of the table.

51
OMICRON Test Universe Overcurrent Automation Interface

4.16 Shot object


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

4.16.1 Properties

[Link] IRelative (read only)


Syntax: [Link]
Type: Double
Description: Get the relative value of the point's definition. Points are defined as relative to one of
the protective units.

[Link] ActualTime (read only)


Syntax: [Link]
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

[Link] MaxTime (read only)


Syntax: [Link]
Type: Double
Description: Get the maximum permissible trip time for the point in seconds, or –1 if it is infinite
(no trip).

[Link] MinTime (read only)


Syntax: [Link]
Type: Double
Description: Get the minimum permissible trip time for the point in seconds, or –1 if it is infinite
(no trip).

[Link] NominalTime (read only)


Syntax: [Link]
Type: Double
Description: Get the nominal trip time for the point in seconds, or –1 if it is infinite (no trip).

[Link] OkStatus (read only)


Syntax: [Link]
Type: Long
Description: Passed / failed status of the point.
The property will return a value from among the following:
OK_FAILED
OK_PASSED
OK_NOT_TESTED

52
OMICRON Test Universe Overcurrent Automation Interface

[Link] Overload (read only)


Syntax: [Link]
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

[Link] RelativeTo (read only)


Syntax: [Link]
Type: Long
Description: Unit, relative to which the point is defined.
The property will return a value from among the following:
UNIT_IGR
UNIT_IGR2
UNIT_IGR3

[Link] RelError (read only)


Syntax: [Link]
Type: Double
Description: Get the relative error for the point, in %. This property is meaningful only when
TestStatus is TEST_TESTED.

[Link] TestCurrent (read only)


Syntax: [Link]
Type: Double
Description: Get the test current for the point in times the pickup current of the I> unit.

[Link] TestCurrentAbs (read only)


Syntax: [Link]
Type: Double
Description: Get the test current for the point in A.

53
OMICRON Test Universe Overcurrent Automation Interface

[Link] TestStatus (read only)


Syntax: [Link]
Type: Long
Description: Get the status of the test point. The property will return a value from among the
following:
TEST_TESTED The point is fully tested
TEST_NOT_TESTED The point is not tested
TEST_SKIPPED Not tested – defined relative to an inactive unit
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 pre-fault

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 ([Link] and
[Link]).
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 will be meaningless, since the fault
values where not even applied – no times will be measured in this case.

54
OMICRON Test Universe Overcurrent Automation Interface

4.17 PuDoTest object


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

4.17.1 Properties

[Link] Dropout (read only)


Syntax: [Link]
Type: Double
Description: Get the relay's dropout value. The user must first consult TestStatus to see if the
value is meaningful.

[Link] Evaluate
Syntax: [Link]
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.

[Link] Overload (read only)


Syntax: [Link]
Type: Boolean
Description: True if overload was detected during testing. The user must then decide whether
Pickup and Dropout are still useful.

[Link] Passed (read only)


Syntax: [Link]
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.

[Link] Pickup (read only)


Syntax: [Link]
Type: Double
Description: Get the relay's pickup value. The user must first consult TestStatus to see if the value
is meaningful.

[Link] Resolution
Syntax: [Link]
Type: Double
Description: Get / Set the resolution of the test, in cycles. This value affects the timing of the
Pu/Do test steps.

55
OMICRON Test Universe Overcurrent Automation Interface

[Link] RelError (read only)


Syntax: [Link]
Type: Double
Description: Get the relative error of the Pu/Do ratio, in percent. This value is meaningful only if
TestStatus is PU_TESTED.

[Link] TripValue
Syntax: [Link]
Type: Double
Description: Get / Set the value of the initial trip for the EM test, in times the pickup current.

[Link] Type
Syntax: [Link]
Type: Long
Description: Get / Set the type of Pickup/Dropout test to be performed. The values can be
PUDO_TEST_NONE No test will be performed
PUDO_TEST_START Test for relays with Start contact
PUDO_TEST_EM Test for EM relays without start contact (or full simulation)

[Link] TestStatus (read only)


Syntax: [Link]
Type: Long
Description: Get the status of the Pickup/Dropout test.
The property will return a value from among the following:
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

56
OMICRON Test Universe 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 ([Link]) 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 ([Link] and [Link]). 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 ([Link]) is valid.

[Link] TestStatusStr (read only)


Syntax: [Link]
Type: String
Description: Returns a localized string describing the status of the test. Useful for display in
customized reports.

57
OMICRON Test Universe Overcurrent Automation Interface

4.18 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.
The points are defined to be at 0.95, 1.05, 1.5, 2.0 and 5.0 times Ipickup for each protective unit.

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 = [Link](1) 'Object (TestModule)
[Link]

Set ocApp = [Link]


Set ocConst = [Link]
Set ocShots = [Link]
Set ocPuDo = [Link]

[Link] 'Clear all previous results in the module


[Link]
[Link](0.95, ocConst.UNIT_IGR)
[Link](1.05, ocConst.UNIT_IGR)
[Link](1.50, ocConst.UNIT_IGR)
[Link](2.00, ocConst.UNIT_IGR)
[Link](5.00, ocConst.UNIT_IGR)

[Link](0.95, ocConst.UNIT_IGR2)
[Link](1.05, ocConst.UNIT_IGR2)
[Link](1.50, ocConst.UNIT_IGR2)
[Link](2.00, ocConst.UNIT_IGR2)
[Link](5.00, ocConst.UNIT_IGR2)

[Link](0.95, ocConst.UNIT_IGR3)
[Link](1.05, ocConst.UNIT_IGR3)
[Link](1.50, ocConst.UNIT_IGR3)
[Link](2.00, ocConst.UNIT_IGR3)
[Link](5.00, ocConst.UNIT_IGR3)

[Link] = ocConst.PUDO_TEST_START 'relay with start contact


[Link] = 10 '10 cycles step value
[Link] = True 'Evaluate the pickup test

[Link] 'Perform the test


If Not [Link] Then
MsgBox "TEST COULD NOT BE PERFORMED - Insufficient hardware!!"
GoTo LeaveApp
End If

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

58
OMICRON Test Universe Overcurrent Automation Interface

Dim singleShot As Object


Dim Failed As Boolean
Dim Overloaded As Boolean
Failed = False
Overloaded = False

For Each singleShot In ocShots


'Points defined relative to inactive units will not be tested,
'so we must check before considering the point's status

If [Link] <> ocConst.TEST_SKIPPED Then


If [Link] <> ocConst.OK_PASSED Then
If Not Failed Then Failed = True 'Latch to True
End If
If [Link] Then
If Not Overloaded Then Overloaded = True 'Latch to True
End If
End If
Next singleShot

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


If [Link] = ocConst.PU_TESTED Then
If [Link] Then
Overloaded = True
End If
If [Link] AND NOT [Link] 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 [Link] = ocConst.TEST_TESTED Then


msg = msg + vbCrLf + "Pickup Value: " + Str([Link])
msg = msg + vbCrLf + "Droput Value: " + Str([Link])
Else
msg = msg + vbCrLf + "Pickup/Dropout test did not finish successfully!"
msg = msg + vbCrLf + [Link]
End If

MsgBox msg

LeaveApp:
[Link]

59
OMICRON Test Universe Overcurrent Automation Interface

Set ocShots = Nothing


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

End Sub

60

You might also like