AnnuCheck Automation Interface PDF

Annunciation Checker
Automation Interface
OMICRON Test Universe
Manual Version: AnnucheckAut.ENU.3 - Year 2013

© 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
Annunciation Checker Automation Interface . . . . . . . . . . . . . . . . . . . . . . . . . .3

Object Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Application Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Document Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Signals Collection Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Signal Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
nonFCSignals collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
nonFCSignal Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
BinOuts Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
BinOut Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Locations Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Location Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
TestPoints Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
3
TestPoint Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Constants Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
4
Annunciation Checker Automation Interface
Annunciation Checker Automation

Interface
Object Hierarchy
Figure 1:
Object hierarchy of an
AnnuCheck document
5
Application Object
Properties
Application (read only)
The application object is the root of the OMICRON Annunciation Checker 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 Annunciation Checker. If you want to
create another Application object with CreateObject, a new instance of the
OMICRON Annunciation Checker 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.
Constants (read only)
Syntax: object.Constants
Type: Object (Constants)
Description: Returns the object with the Constant Values (Constants) you
can use with several functions.
Example: Dim otm As Object

Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim constants As Object
Set constants = annu.Constants
6
Document (read only)
Syntax: object.Document
Type: Object (Document)
Description: This property returns a Document Object (Document).

Dim annu As Object
Set otm =
Dim doc As Object
Set doc = annu.Document
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).

Dim annu As Object
Set otm =
Dim obj As Object
Set obj = annu.Parent
7
Visible
Syntax: object.Visible
Type: Boolean
Description: Shows/hides the main application window.

Dim annu As Object
Set otm =
'Is the application visible ?
If annu.Visible then
MsgBox "Application is visible"
Else
'Make the application visible
annu.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)
(and start the OMICRON Annunciation Checker application) you
have to set the visible property to True to see the main window of
the application.
8
Methods
Quit
Syntax: object.Quit
Return type: None
Description: This command quits the OMICRON Annunciation Checker

application and closes all open windows and the document.

Dim annu As Object
Set otm =
annu.Quit
9
Document Object
With the Document Object (Document) you can control the document.
From this object you can get references to the Signals Collection Object
(Signals) (definition of test signals) and the Measurements Collection Object
(Measurements) (definition of measurement conditions and results).
Properties
Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).

Dim annu As Object
Set otm =
Dim app As Object
Set app = annu.Document.Application
Parent (read only)
Type: Object
hierarchy. In this case it is the Application Object
(Application).

Dim annu As Object
Set otm =
Dim obj As Object
Set obj = annu.Document.Parent
10
Signals (read only)
Syntax: object.Signals
Type: Object (Signals)
Description: This property returns the Signals Collection Object (Signals)

of the document. With this object you can manipulate all the
signals in your document.

Dim annu As Object
Set otm =
Dim signals As Object
Set signals = annu.Document.Signals
Locations (read only)
Syntax: object.Locations
Type: Object (Locations)
Description: This property returns the Locations Collection Object

(Locations) of the document. With this object you can
manipulate all the locations in your document.

Dim annu As Object
Set otm =
Dim locations As Object
Set locations= annu.Document.Locations
11
Comment
Syntax: object.Comment
Type: String
Description: This property represents the comment of the document (see

Edit / Comment menu command).
Example: 'Change document comment

Dim otm As Object
Dim annu As Object
Set otm =
annu.Document.Comment = "This is my new
comment." & vbCrLf & "Line2"
MsgBox annu.Document.Comment
Autolock
Syntax: object.Autolock
Type: Boolean
Description: Set this property to True to automatically lock each test point
once it was assessed. Locked test points cannot be changed
or retested anymore. Clear the test results to unlock the test
points.

Dim otm As Object
Dim annu As Object
Set otm =
annu.Document.Autolock = True
12
LockTestedTestPoints
Syntax: object.LockTestedTestPoints()
Type: None
Description: This method locks all tested test points. Locked test points
cannot be changed or retested anymore. Clear the test
results to unlock the test points.

Dim otm As Object
Dim annu As Object
Set otm =
annu.Document.LockTestedTestPoints()
13
Signals Collection Object

Properties

Dim annu As Object
Set otm =
Dim app As Object
Set app = annu.Document.Signals.Application
14
Count (read only)
Syntax: object.Count
Type: Long
Description: This property returns the number of signals in the document.

Note that there will always be at least one signal in the signals
collection.

Dim annu As Object
Set otm =
'Count twice
Dim s As Object
Dim ss As Object
i = 0
Set ss = annu.Document.Signals
For Each s in ss
i = i+1
Next
If i = ss.Count then
MsgBox "We've counted correctly"
End If
Parent (read only)
Type: Object
hierarchy. In this case it is the Document Object (Document).

Dim annu As Object
Set otm =
Dim obj As Object
Set obj = annu.Document.Signals.Parent
15
Item (default property)
Syntax: object.Item(Index)
(optional) Variant Index - Index number of the signal
Return type: Object (Signal)
Description: This method returns Signal Object from the Signals Collection
of the specified Index (must be between 1 and Signals.Count).
Note that there will always be at least one signal in the signals
collection.

Dim annu As Object
Set otm =
Dim signal As Object
Set signal = signals(1)
16
Methods
Add
Syntax: object.Add()
Return type: Object (Signal)
Description: This method adds a new Signal to the Signals collection. The
reference to the newly created Signal Object is returned.
Dim annu As Object
Set otm =
'Add signal Dim signals As Object Dim signal
As Object
Set signal = signals.Add
Remove
Syntax: object.Remove(Index)
Long Index - Index of the signal to remove
Return type: None
Description: This method removes the signal specified by the index from
the signals collection. At least one signal must always exist,
therefore you will get an error message if you try to remove
the last signal in the collection.
Dim annu As Object
Set otm =
'Add signal
signals.Add
'And now remove it
signals.Remove(2)
17
RemoveMulti
Syntax: object.RemoveMulti(IndexBegin, IndexEnd)

Long IndexBegin - Index of the first signal to remove
Long IndexEnd - Index of the last signal to remove
Return type: None
Description: This method removes the signals specified by indexBegin and
IndexEnd from the signals collection. At least one signal must
always exist, therefore you will get an error message if you try
to remove the last signal from the collection.
Dim annu As Object
Set otm =
'Add signal
signals.Add
signals.Add
signals.Add
'And now remove the signals
signals.RemoveMulti(2, 4)
18
Move
Syntax: object.Move(IndexFrom, IndexTo)

Long IndexFrom - Index of the signal to move
Long IndexTo - Index of the target where the signal is to be
moved to
Return type: None
Description: This method moves the signal specified by IndexFrom from
the signals collection to a new location specified by IndexTo.
IndexFrom and IndexTo have to be in range between 1 and
object.Count, else an error message occurs.
Dim annu As Object
Set otm =
'Add signal
signals.Add
signals.Add
'And now move the signal from
'position 1 to position 2
signals.Move(1, 2)
19
MoveMulti
Syntax: object.MoveMulti(beginIndexFrom, endIndexFrom, IndexTo)

Long beginIndexFrom - Index of the first signal to move
Long endIndexFrom - Index of the end signal to move
Long IndexTo - Index of the target where the multiple signals
are to be moved to
Return type: None
Description: This method moves the signals specified by beginIndexFrom
and endIndexFrom from the signals collection to a new
location specified by IndexTo. beginIndexFrom,
endIndexFrom and IndexTo have to be in range between 1
and object.Count, else an error message occurs.
Dim annu As Object
Set otm =
'Add signal
signals.Add
signals.Add
signals.Add
'And now move the specified signals
'to position 2
signals.MoveMulti(1, 2, 2)
20
Duplicate
Syntax: object.Duplicate(IndexFrom, IndexTo)

Long IndexFrom - Index of the signal to duplicate
Long IndexTo - Index of the target where the signal is to be
duplicated to
Return type: None
Description: This method duplicates the signal specified by IndexFrom
from the signals collection to a new signal specified by
indexTo. IndexFrom and IndexTo have to be in range between
1 and object.Count, else an error message occurs.
Dim annu As Object
Set otm =
'Add signal
signals.Add
signals.Add
'And now duplicate the signal from
'position 1 to position 2
signals.Duplicate(1, 2)
21
Duplicate Multi
Syntax: object.DuplicateMulti(beginIndexFrom, endIndexFrom,

IndexTo)
Long beginIndexFrom - Index of the first signal to duplicate
Long endIndexFrom - Index of the end signal to duplicate
Long IndexTo - Index of the target where the multiple signals
are to be duplicated to
Return type: None
Description: This method duplicates the signals specified by
beginIndexFrom and endIndexFrom from the signals
collection to a new location specified by indexTo.
beginIndexFrom, endIndexFrom, and indexTo have to be in
range between 1 and object.Count, else an error message
occurs.
Dim annu As Object
Set otm =
'Add signal
signals.Add
signals.Add
signals.Add
'And now duplicate specified signals
'to position 2
signals.DuplicateMulti(1, 2, 2)
22
Signal Object
Properties
FCState
Syntax: object.FCState
Type: Object (FCState)
Description: This property returns the FCState Object of a given Signal.

Dim annu As Object
Set otm =
Dim fcState As Object
Set fcState =
annu.Document.Signals(1).FCState
BinOuts (read only)
Syntax: object.BinOuts
Type: Object (BinOuts)
Description: This property returns the Binary Outputs Collection Object

(BinOuts) of a given Signal Object (Signal). With this object
you can manipulate the binary outputs settings of the signal.

Dim annu As Object
Set otm =
Dim binouts As Object
Set binouts =
annu.Document.Signals(1).BinOuts
23
TestPoints (read only)
Syntax: object.TestPoints
Type: Object (TestPoints)
Description: This property returns the Test Points Collection Object of a

given Signal Object. With this object you can manipulate the
individual test points for this signal.

Dim annu As Object
Set otm =
Dim testpoints As Object
Set testpoints =
annu.Document.Signals(1).TestPoints
nonFCSignals (read only)
Syntax: object.nonFCSignals
Type: Object (nonFCSignals)
Description: This property returns the nonFCSignals Collection Object of

the Signal.
These are the "extra" analog outputs that are not included in
the FCSignals collection, for example, the fourth voltage
output, or the second current triplet of a CMC256 would be
included in this collection.

Dim annu As Object
Set otm =
Dim nonfcsignals As Object
Set nonfcsignals =
annu.Document.Signals(1).nonFCSignals
24
Name
Syntax: object.Name
Type: String
Description: This property represents the name of the signal.
Example: 'Change signal name and display it

Dim otm As Object
Dim annu As Object
Set otm =
Set signal = annu.Document.Signals(1)
signal.Name = "Signal 20"
MsgBox signal.Name
25
Type
Syntax: object.Type
Type: Long
Description: This property allows you to read, or set the type of the signal.
0 = Shot
1 = Steady State
2 = No Output
There are constants defined in the Constants object for
convienence:
cSignalTypeShot, cSignalTypeSteadyState,
cSignalTypeNoOutput

Dim annu As Object
Set otm =
Dim signal As Object Set signal =
annu.Document.Signals(1)
If signal.type =
annu.Constants.cSignalTypeShot Then
signal.type =
annu.Constants.cSignalTypeSteadyState
End If
26
LED
Syntax: object.LED
Type: String
Description: This property allows you to read or set the LED of a Signal.
Example: 'Change signal name and display it

Dim otm As Object
Dim annu As Object
Set otm =
signal.LED = "01"
PreFaultCurr
Syntax: object.PreFaultCurr
Type: double
Description: This property allows you to read or set the pre-fault current (in
amps) of the Signal.
Example: 'Change signal name and display it Dim otm As

Object
Dim annu As Object
Set otm =
' Set prefault current to 1.5 A
signal.PreFaultCurr = 1.5
27
PreFaultTime
Syntax: object.PreFaultTime
Type: double
Description: This property allows you to read or set the pre-fault time (in
seconds) of the Signal.

Object
Dim annu As Object
Set otm =
' Set prefault time to 0.5 seconds
signal.PreFaultTime = 0.5
MaxFaultTime
Syntax: object.MaxFaultTime
Type: double
Description: This property allows you to read or set the post-fault time (in

Object
Dim annu As Object
Set otm =
' Set maxfault time to 5 seconds
signal.MaxFaultTime = 5.0
28
PostFaultTime
Syntax: object.PostFaultTime
Type: double
Description: This property allows you to read or set the post-fault time (in

Dim annu As Object
Set otm =
' Set maxfault time to 1 second
signal.PostFaultTime = 1.0
Instructions
Syntax: object.Instructions
Type: string
Description: This property allows you to read or set the Instructions text of
the Signal.

Dim annu As Object
Set otm =
signal.Instructions = "Connect T2"
29
PopupMsg
Syntax: object.PopupMsg
Type: string
Description: This property allows you to read or set the pop-up message of
the Signal.

Dim annu As Object
Set otm =
signal.PopupMsg = "Press reset before running
shot"
TriggerID
Syntax: object.TriggerID
Type: long
Description: This property specifies the signal ID of the trigger input of the
Signal.

Dim annu As Object
Set otm =
annu.Document.Signals(1).TriggerID =
annu.Constants.sigidTRIP
30
TriggerCondition
Syntax: object.TriggerCondition
Type: long
Description: This property specifies the trigger condition of the trigger input.
It can be is "Negative" (0), "Positive" (1) or "Don't care" (2).
0 = "Negative" means that the trigger condition occurs when
the binary input goes from 1 -> 0.
1 = "Positive" means that the trigger condition occurs when
2 = "Don't care" means that the binary input is ignored.
Dim annu As Object
Set otm =
annu.Document.Signals(1).TriggerID =
'Trigger condition will occur when Trip goes
from 0 to 1
annu.Document.Signals(1).TriggerCondition = 0
BinOutLatching
Syntax: object.BinOutLatching
Type: Boolean
Description: This property specifies the latching behaviour for all binary
outputs. It is not possible to define the latching for each binary
output.
True = Latching On
False = Latching Off
Dim annu As Object
Set otm =
'Switch latching for all binary outputs on
annu.Document.Signals(1).BinOutLatching = True
31
nonFCSignals collection
These are the "extra" analog outputs that are not included in the FCSignals
collection, for example, the fourth voltage output, or the second current triplet of
a CMC256 would be included in this collection.
Properties

Dim annu As Object
Set otm =
Dim app As Object
Set app =
annu.Document.Signals(1).nonFCSignals.Appli-
cation
Count (read only)
Type: Long
Description: This property returns the number of non FC signals in the

signal.

Dim annu As Object
Set otm =
MsgBox "Number of nonFCSignals in signal 1: " &
annu.Document.Signals(1).nonFCSignals.Count
32
(optional) Variant Index - Index number of the non FC signal
Return type: Object (nonFCSignal)
Description: This method returns an nonFCSignal Object from the

nonFCSignals Collection. The parameter is the signal ID of
the nonFCSignal. Signal IDs are constants from the Constants
object.

Dim annu As Object
Set otm =
annu.Visible = True
'Set amplitude of V(1)-1 to 2A
' Note: this presumes that the signal has been
routed in the HCC!
signal.nonFCSignals(annu.Constants.sigidUSER_
U1_1).Amplitude = 2.0
33
ItemIndex
Syntax: object.ItemIndex(Index)
Variant Index - Index number of the non FC signal
Return type: Object (nonFCSignal).
Description: This method returns an nonFCSignal Object from the

nonFCSignals Collection. The index is the number of the
analog output in the collection (between 1 and
nonFCSignals.Count).

Dim annu As Object
Set otm =
'Set amplitude of all nonFCSignals to 0
For i = 1 To signal.nonFCSignals.Count
signal.nonFCSignals.ItemIndex(i).Amplitude =
0.0
Next i
34
nonFCSignal Object
Properties
Amplitude
Syntax: object.Amplitude
Return type: Double
Description: This property specifies the amplitude of the nonFCSignal.

Dim annu As Object
Set otm =
'Set amplitude of V(1)-1 to 2A
routed in the HCC!
U1_1).Amplitude = 2.0
35
Frequency
Syntax: object.Frequency
Return type: Double
Description: This property specifies the frequency of the nonFCSignal.

Dim annu As Object
Set otm =
'Set frequency of V(1)-1 to 60Hz' Note: this
presumes that the signal has been routed in
the HCC!Dim signal As Object
Set signal =
annu.Document.Signals(1)signal.nonFCSignals(a
nnu.Constants.sigidUSER_U1_1).Frequency =
60.0
Phase
Syntax: object.Phase
Return type: Double
Description: This property specifies the phase of the nonFCSignal.

Dim annu As Object
Set otm =
'Set phase of V(1)-1 to 37.4°
routed in the HCC!
U1_1).Phase = 37.4
36
BinOuts Collection Object

Properties

Dim annu As Object
Set otm =
Dim app As Object
Set app =
annu.Document.Signals(1).BinOuts.Application
Count (read only)
Type: Long
Description: This property returns the number of binary outputs in the

signal.

Dim annu As Object
Set otm =
MsgBox "Number of binary outputs in signal 1: " &
annu.Document.Signals(1).BinOuts.Count
37
Syntax: object.Item(SignalID)
Long SignalID - Signal ID of the binary output
Return type: Object (BinOut)
Description: This method returns a Binary Output Object (BinOut) 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.

Dim annu As Object
Set otm =
'Set binary output for circuit breaker Dim
signal As Object
signal.BinOuts(annu.Constants.sigidUSER_
OUTBIN_DEF1).Value = 1
38
ItemIndex
Syntax: object.ItemIndex(Index)
Variant Index - Index number of the binary output
Return type: Object (BinOut)
Description: This method returns a Binary Output Object (BinOut) from the
Binary Outputs Collection. The index is the number of the
binary output in the collection (between 1 and BinOuts.Count).

Dim annu As Object
Set otm =
'Set all binary outputs
For i = 1 To signal.BinOuts.Count
signal.BinOuts.ItemIndex(i).Value = 1
Next i
39
BinOut Object
Properties
Value (default property)
Syntax: object.Value
Type: Boolean
Description: This property specifies whether the binary output is set

(active) or not (inactive).

Dim annu As Object
Set otm =
'Set binary output for circuit breaker
signal.BinOuts(annu.Constants.
sigidUSER_OUTBIN_DEF1).Value = 1
40
Locations Collection Object

Properties

Dim annu As Object
Set otm =
Dim app As Object
Set app = annu.Document.Locations.Application
Parent (read only)
Type: Object
hierarchy. In this case it is the Document Object (Document).

Dim annu As Object
Set otm =
Dim obj As Object
Set obj = annu.Document.Locations.Parent
41
Count (read only)
Type: Long
Description: This property returns the number of locations in the test
document. Note that there will always be at least one location
in the locations collection.
Dim annu As Object
Set otm =
Dim testpoint As Object i = 0 Set testpoints =
annu.Document.Signals(1).TestPoints For Each
testpoint in testpointsi = i+1 Next
If i = testpoints.Count then
MsgBox "Counted correctly" End If
(optional) Variant Index - Index number of the location
Return type: Object (Location)
Description: This method returns a Location Object from the Locations
Collection at the specified Index (must be between 1 and
Locations.Count). Note that there will always be at least one
location in the locations collection.
Object
Dim annu As Object
Set otm =
set locations = annu.Document.Locations
Dim location As Object
Set location = locations(1)
42
Methods
Add
Syntax: object.Add()
Return type: Object (Location)
Description: This method adds a new Location to the Locations collection.
The reference to the newly created Location Object is
returned.
Dim annu As Object
Set otm =
Dim locations As Object Dim location As Object
Set locations = annu.Document.Locations
Set location = locations.Add
Remove
Syntax: object.Remove(Index)
Long Index - Index of the location to remove
Return type: None
Description: This method removes the location specified by the index from
the locations collection. At least one location must always
exist, therefore you will get an error message if you try to
remove the last location in the collection.

Dim annu As Object
Set otm =
set locations = annu.Document.Locations
locations.Add
'And now remove it
locations.Remove(2)
43
RemoveMulti
Syntax: object.RemoveMulti(IndexBegin, IndexEnd)

Long IndexBegin - Index of the first location to remove
Long IndexEnd - Index of the last location to remove
Return type: None
Description: This method removes the locations specified by indexBegin
and IndexEnd from the locations collection. At least one signal
must always exist, therefore you will get an error message if
you try to remove the last location from the collection.
Dim annu As Object
Set otm =
Set locations = annu.Document.Signals
locations.Add
locations.Add
locations.Add
'And now remove the multiple locations
locations.RemoveMulti(2, 4)
44
Move
Syntax: object.Move(IndexFrom, IndexTo)

Long IndexFrom - Index of the location to move
Long IndexTo - Index of the target where the location is to be
moved to
Return type: None
Description: This method moves the location specified by IndexFrom from
the locations collection to a new location specified by IndexTo.
IndexFrom and IndexTo have to be in range between 1 and
object.Count, else an error message occurs.
Dim annu As Object
Set otm =
locations.Add
locations.Add
'And now move it from location 1 to
'location 2
locations.Move(1, 2)
45
Move Multi
Syntax: object.MoveMulti(beginIndexFrom, endIndexFrom, IndexTo)

Long beginIndexFrom - Index of the first location to move
Long endIndexFrom - Index of the end location to move
Long IndexTo - Index of the target where the the multiple
locations are to be moved to
Return type: None
Description: This method moves the locations specified by
beginIndexFrom and endIndexFrom from the locations
collection to a new location specified by IndexTo.
beginIndexFrom, endIndexFrom and IndexTo have to be in
occurs.
Dim annu As Object
Set otm =
locations.Add
locations.Add
locations.Add
'And now move the specified locations
locations.MoveMulti(1, 2, 2)
46
Duplicate
Syntax: object.Duplicate(IndexFrom, IndexTo)

Long IndexFrom - Index of the location to duplicate
Long IndexTo - Index of the target where the location is to be
duplicated to
Return type: None
Description: This method duplicates the location specified by IndexFrom
from the locations collection to a new location specified by
indexTo. IndexFrom and IndexTo have to be in range between
1 and object.Count, else an error message occurs.
Dim annu As Object
Set otm =
locations.Add
locations.Add
'And now duplicate the location from
'location 1 to location 2
locations.Duplicate(1, 2)
47
Duplicate Multi
Syntax: object.DuplicateMulti(beginIndexFrom, endIndexFrom,

IndexTo)
Long beginIndexFrom - Index of the first location to duplicate
Long endIndexFrom - Index of the end location to duplicate
Long IndexTo - Index of the target where the multiple locations
are to be duplicated to
Return type: None
Description: This method duplicates the locations specified by
beginIndexFrom and endIndexFrom from the locations
collection to a new location specified by indexTo.
beginIndexFrom, endIndexFrom, and indexTo have to be in
occurs.
Dim annu As Object
Set otm =
locations.Add
locations.Add
locations.Add
'And now duplicate the specified locations
locations.DuplicateMulti(1, 2, 2)
48
Location Object
Properties
Name
Syntax: object.Name
Return type: String
Description: This property represents the name of the location.
Example: 'Change location name and display it Dim otm

As Object
Dim annu As Object
Set otm =
Dim location As Object Set location =
annu.Document.Locations(1)
location.Name = "Location 20"
MsgBox location.Name
49
TestPoints Collection Object

Properties
Return type: Object (Application)

Dim annu As Object
Set otm =
Dim app As Object
Set app =
annu.Document.Signals(1).TestPoints.Application
Count (read only)
Return type: Long
Description: This property returns the number of test points in the signal.

Dim annu As Object
Set otm =
Dim testpoint As Object i = 0 Set testpoints =
annu.Document.Signals(1).TestPoints For Each
testpoint in testpoints i = i+1 Next If i =
testpoints.Count then
MsgBox "Counted correctly" End If
50
(optional) Variant Index - Index number of the testpoint
Return type: Object (TestPoint)
Description: This method returns a TestPoint Object from the TestPoints

Collection at the specified Index (must be between 1 and
TestPoints.Count).
Note that there will always be at least one testpoint in the
testpoints collection.

Dim annu As Object
Set otm =
'Add 2 testpoints Dim testpoints As Object set
testpoints =
annu.Document.Signals(1).TestPoints
Dim testpoint As Object
Set testpoint = testpoints(1)
51
TestPoint Object
Properties
Used
Syntax: object.Used
Return type: boolean
Description: This property allows you to enable or disable the testpoint.

Dim annu As Object
Set otm =
Dim testpoint As Object Set testpoint =
annu.Document.Signals(1).TestPoints(1)
If testpoint.Used Then
MsgBox "Test point enabled"
End If
' disable testpoint
testpoint.Used = False
52
Expected
Syntax: object.Expected
Return type: String
Description: This property allows you to set or read the Expected result of
the testpoint.

Dim annu As Object
Set otm =
testpoint.Expected = "On"
MsgBox testpoint.Expected
Measured
Syntax: object.Measured
Return type: String
Description: This property allows you to set or read the Measured result of
the testpoint.

Dim annu As Object
Set otm =
testpoint.Measured = "On"
MsgBox testpoint.Measured
53
Assessment
Syntax: object.Assessment
Return type: long
Description: This property allows you to set or read the Assessment of the
testpoint.
0 = not tested
1 = passed
2 = failed
There are constants defined in the Constants object for
convenience:
cTestPointNotTested, cTestPointPassed, cTestPointFailed

Dim annu As Object
Set otm =
Set testpoint =
testpoint.Assessment = cTestPointFailed
MsgBox testpoint.Assessment
54
Locked
Syntax: object.Locked
Return type: Boolean
Description: Returns a Boolean value if test point is locked (read-only)

Dim annu As Object
Set otm =
Set testpoint =
testpoint.Locked
Instructions
Syntax: object.Instruction
Return type: String
Description: This property allows for reading or setting the instruction text
of the test point.

Dim annu As Object
Set otm =
Set testpoint =
testpoint.Instructions = "Connect T2"
55
PopupMsg
Syntax: object.PopupMessage
Return type: String
Description: This property allows for reading or setting up the pop-up

message of the test point.

Dim annu As Object
Set otm =
Set testpoint =
testpoint.Popupmessage = "Press reset before
running shot"
TriggerID
Syntax: object.TriggerID
Return type: Long
Description: This property specifies the signal ID of the trigger input of the
test point.

Dim annu As Object
Set otm =
Set testpoint =
testpoint.TriggerID =
56
TriggerCondition
Syntax: object.TriggerCondition
Return type: Long
Description: This property specifies the trigger condition of the trigger

input. It can take the values "negative" (0), "positive" (1) or
"don't care" (2).
• 0 = "negative" means that the trigger condition occurs when
• 1 = "positive" means that the trigger condition occurs when
• 2 = "don't care" means that the binary input is ignored.

Dim annu As Object
Set otm =
Set annu = otm.Specific Dim testpoint As
Object
Set testpoint =
testpoint.TriggerID =
'Trigger condition will occur when Trip goes
from 0 to 1
testpoint.TriggerCondition = 0
57
InputMode
Syntax: object.InputMode
Return type: Long
Description: This property specifies the input mode of the test point. It can
be manual (const.cInputModeManual), input value
(const.cInputModeInputValue) or trigger
(const.cInputModeTrigger).

Dim annu As Object
Set otm =
Object
Set testpoint =
testpoint.InputMode =
annu.Constants.cInputModeManual
58
DoAutoAssessment
Syntax: object.DoAutoAssessment
Return type: Boolean
Description: This property sets the auto assessment property of the test
point. It this property is set to True, the test point will be
assessed automatically after the shot is done.
It is not available in Manual input mode.
In the input mode Input Value, after the Measured Value is
entered, the test point will be assessed regarding Expected
Value, Absolute and Relative Tolerance.
In case of the Trigger input mode, after the shot is done, the
test point will be automatically assessed according to the
trigger event during the shot.

Dim annu As Object
Set otm =
Object
Set testpoint =
testpoint.DoAutoAssessment = True
59
ExpectedValue
Syntax: object.ExpectedValue
Return type: Double
Description: This property specifies the Expected Value of the test point. It
is available in input mode Input Value, only.

Dim annu As Object
Set otm =
Object
Set testpoint =
testpoint.ExpectedValue = 20.5
MeasuredValue
Syntax: object.MeasuredValue
Return type: Double
Description: This property specifies the Measured Value of the Test Point.
It is available in input mode Input Value, only.

Dim annu As Object
Set otm =
Object
Set testpoint =
testpoint.MeasuredValue = 20.5
60
Unit
Syntax: object.Unit
Return type: Long
Description: This property specifies the Unit of the Expected Value, the
Measured Value and the Absolute Tolerance of the Test Point.
It is available in input mode Input Value, only.
Available units:
• cUnitNone - no unit
• cUnitSeconds - seconds (s)
• cUnitAmper - ampers (A)
• cUnitVolt - volts (V)
• cUnitOhm - ohm (?)
• cUnitPower - wat (W)
• cUnitApparentPower - volt amper (VA)
• cUnitReactivePower - volt amper reactive (var).

Dim annu As Object
Set otm =
Object
Set testpoint =
testpoint.Unit = annu.Constants.cUnitAmper
61
AbsoluteTolerance
Syntax: object.AbsoluteTolerance
Return type: Long
Description: This property specifies the Absolute Tolerance of the Test

Point. It is available in input mode Input Value, only.

Dim annu As Object
Set otm =
Object
Set testpoint =
testpoint.AbsoluteTolerance = 1.5
RelativeTolerance
Syntax: object.RelativeTolerance
Return type: Long
Description: This property specifies the relative Tolerance (in percent) of

the Test Point. It is available in input mode Input Value, only.

Dim annu As Object
Set otm =
Object
Set testpoint =
testpoint.RelativeTolerance = 5
62
Constants Object
Properties
The following is a list of all signal IDs supported by the OMICRON Annunciation
Checker.
Analog Outputs
sigidUL1N
sigidUL2N
sigidUL3N
sigidUSER_U1_1
sigidUSER_U1_2
sigidUSER_U1_3
sigidUSER_U2_1
sigidUSER_U2_2
sigidUSER_U2_3
sigidUSER_U3_1
sigidUSER_U3_2
sigidUSER_U3_3
sigidUSER_U4_1
sigidUSER_U4_2
sigidUSER_U4_3
sigidIL1
sigidIL2
sigidIL3
sigidI_N
sigidI_0
sigidI_1
sigidI_2
sigidI_PRIM_L1
sigidI_PRIM_L2
63
sigidI_PRIM_L3
sigidI_ZERO_PRIM
sigidI_SEC_L1
sigidI_SEC_L2
sigidI_SEC_L3
sigidI_ZERO_SEC
sigidI_TERT_L1
sigidI_TERT_L2
sigidI_TERT_L3
sigidI_ZERO_TERT
sigidUSER_I1_1
sigidUSER_I1_2
sigidUSER_I1_3
sigidUSER_I2_1
sigidUSER_I2_2
sigidUSER_I2_3
sigidUSER_I3_1
sigidUSER_I3_2
sigidUSER_I3_3
sigidUSER_I4_1
sigidUSER_I4_2
sigidUSER_I4_3
Binary Inputs
sigidTRIP
sigidSTART
64
Binary Outputs
sigidAUX_CONT
sigidAUX_CONT_L1
sigidAUX_CONT_L2
sigidAUX_CONT_L3
sigidUSER_OUTBIN_DEF1
Miscellanous
cTestPointPassed
cTestPointFailed
cTestPointNotTested
cSignalTypeShot
cSignalTypeSteadyState
cSignalTypeNoOutput
Input Mode
cInputModeManual
cInputModeInputValue
cInputModeTrigger
65
Units
cUnitNone
cUnitSeconds
cUnitVolt
cUnitAmper
cUnitOhm
cUnitPower
cUnitApparentPower
cUnitReactivePower
66
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
67
Support
68

AnnuCheck Automation Interface PDF

Caricato da

Informazioni sul documento

Titolo originale

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

AnnuCheck Automation Interface PDF

Caricato da

Copyright:

Formati disponibili

Annunciation Checker

Manual Version: AnnucheckAut.ENU.3 - Year 2013

Annunciation Checker Automation Interface . . . . . . . . . . . . . . . . . . . . . . . . . .3

Annunciation Checker Automation

Type: Object (Constants)

Example: Dim otm As Object

Document (read only)

Type: Object (Document)

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

Example: Dim otm As Object

Parent (read only)

Example: Dim otm As Object

Description: Shows/hides the main application window.

Example: Dim otm As Object

Note: If you use an external OLE Automation controller (e.g., OMICRON

Return type: None

Description: This command quits the OMICRON Annunciation Checker

Example: Dim otm As Object

Type: Object (Application)

Description: Returns the Application Object (Application).

Example: Dim otm As Object

Parent (read only)

Example: Dim otm As Object

Signals (read only)

Type: Object (Signals)

Description: This property returns the Signals Collection Object (Signals)

Example: Dim otm As Object

Locations (read only)

Type: Object (Locations)

Description: This property returns the Locations Collection Object

Example: Dim otm As Object

Description: This property represents the comment of the document (see

Example: 'Change document comment

Example: 'Change document comment

Example: 'Change document comment

Signals Collection Object

Type: Object (Application)

Description: Returns the Application Object (Application).

Example: Dim otm As Object

Count (read only)

Description: This property returns the number of signals in the document.

Example: Dim otm As Object

Parent (read only)

Example: Dim otm As Object

Item (default property)

Return type: Object (Signal)

Example: Dim otm As Object

Syntax: object.RemoveMulti(IndexBegin, IndexEnd)

Syntax: object.Move(IndexFrom, IndexTo)

Syntax: object.MoveMulti(beginIndexFrom, endIndexFrom, IndexTo)

Syntax: object.Duplicate(IndexFrom, IndexTo)

Syntax: object.DuplicateMulti(beginIndexFrom, endIndexFrom,

Type: Object (FCState)

Description: This property returns the FCState Object of a given Signal.

Example: Dim otm As Object

BinOuts (read only)

Type: Object (BinOuts)

Description: This property returns the Binary Outputs Collection Object

Example: Dim otm As Object

TestPoints (read only)

Type: Object (TestPoints)

Description: This property returns the Test Points Collection Object of a

Example: Dim otm As Object