annucheck automation interface
TRANSCRIPT
-
8/13/2019 AnnuCheck Automation Interface
1/48
Annunciation Checker
Automation Interface
TEST UNIVERSE
-
8/13/2019 AnnuCheck Automation Interface
2/48
OMICRON Test Universe
2
Manual Version: AnnucheckAut.AE.2 OMICRON electronics 2008. 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 and
entirely 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.
OMICRON electronics translates this manual from the source language English into a number of other
languages. Any translation of this manual is done for local requirements, and in the event of a dispute
between the English and a non-English version, the English version of this manual shall govern.
-
8/13/2019 AnnuCheck Automation Interface
3/48
Contents
3
Contents
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
AnnuCheck Automation Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
Object Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Application Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Document Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Signals Collection Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Signal Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
nonFCSignals collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
nonFCSignal Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
BinOuts Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
BinOut Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Locations Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Location Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
TestPoints Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
http://preface_cms251.pdf/http://preface_cms251.pdf/ -
8/13/2019 AnnuCheck Automation Interface
4/48
OMICRON Test Universe
4
TestPoint Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Constants Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
-
8/13/2019 AnnuCheck Automation Interface
5/48
5
AnnuCheck Automation Interface
AnnuCheck Automation Interface
Object Hierarchy
Figure 1:
Object hierarchy of an
AnnuCheck document
-
8/13/2019 AnnuCheck Automation Interface
6/48
-
8/13/2019 AnnuCheck Automation Interface
7/48
7
AnnuCheck Automation Interface
Document (read only)
Parent (read only)
Syntax: object.Document
Type: Object (Document)
Description: This property returns a Document Object (Document).
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim doc As Object
Set doc = annu.Document
Syntax: object.Parent
Type: Object
Description: This property always returns the parent object in the object
hierarchy. In this case it is theApplicationObject
(Application).
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim obj As Object
Set obj = annu.Parent
-
8/13/2019 AnnuCheck Automation Interface
8/48
OMICRON Test Universe
8
Visible
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.
Syntax: object.Visible
Type: Boolean
Description: Shows/hides the main application window.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
'Is the application visible ?
If annu.Visible then
MsgBox "Application is visible"
Else
'Make the application visibleannu.Visible = TRUE
End If
-
8/13/2019 AnnuCheck Automation Interface
9/48
9
AnnuCheck Automation Interface
MethodsQuit
Syntax: object.Quit
Return type: None
Description: This command quits the OMICRON Annunciation Checker
application and closes all open windows and the document.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
annu.Quit
-
8/13/2019 AnnuCheck Automation Interface
10/48
OMICRON Test Universe
10
Document ObjectWith 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
Application (read only)
Parent (read only)
Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim app As Object
Set app = annu.Document.Application
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).
Example: Dim otm As ObjectDim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim obj As Object
Set obj = annu.Document.Parent
-
8/13/2019 AnnuCheck Automation Interface
11/48
11
AnnuCheck Automation Interface
Signals (read only)
Locations (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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim signals As Object
Set signals = annu.Document.Signals
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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim locations As Object
Set locations= annu.Document.Locations
-
8/13/2019 AnnuCheck Automation Interface
12/48
OMICRON Test Universe
12
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 =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
annu.Document.Comment = "This is my new
comment." & vbCrLf & "Line2"
MsgBox annu.Document.Comment
-
8/13/2019 AnnuCheck Automation Interface
13/48
13
AnnuCheck Automation Interface
Signals Collection ObjectProperties
Application (read only)
Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim app As Object
Set app = annu.Document.Signals.Application
-
8/13/2019 AnnuCheck Automation Interface
14/48
OMICRON Test Universe
14
Count (read only)
Parent (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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
'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
Syntax: object.Parent
Type: Object
Description: This property always returns the parent object in the object
hierarchy. In this case it is the Document Object (Document).
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim obj As Object
Set obj = annu.Document.Signals.Parent
-
8/13/2019 AnnuCheck Automation Interface
15/48
15
AnnuCheck Automation Interface
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 signalscollection.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim signals As Object
Set signals = annu.Document.Signals
Dim signal As Object
Set signal = signals(1)
-
8/13/2019 AnnuCheck Automation Interface
16/48
OMICRON Test Universe
16
MethodsAdd
Remove
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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
'Add signal Dim signals As Object Dim signal
As Object
Set signals = annu.Document.SignalsSet signal = signals.Add
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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")Set annu = otm.Specific
'Add signal
Dim signals As Object
Set signals = annu.Document.Signals
signals.Add
'And now remove it
signals.Remove(2)
-
8/13/2019 AnnuCheck Automation Interface
17/48
17
AnnuCheck Automation Interface
Signal ObjectProperties
FCState
BinOuts (read only)
Syntax: object.FCState
Type: Object (FCState)
Description: This property returns the FCState Object of a given Signal.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim fcState As Object
Set fcState =
annu.Document.Signals(1).FCState
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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim binouts As Object
Set binouts =
annu.Document.Signals(1).BinOuts
-
8/13/2019 AnnuCheck Automation Interface
18/48
OMICRON Test Universe
18
TestPoints (read only)
nonFCSignals (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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim testpoints As Object
Set testpoints =
annu.Document.Signals(1).TestPoints
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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim nonfcsignals As Object
Set nonfcsignals =
annu.Document.Signals(1).nonFCSignals
-
8/13/2019 AnnuCheck Automation Interface
19/48
19
AnnuCheck Automation Interface
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 =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim signal As Object
Set signal = annu.Document.Signals(1)
signal.Name = "Signal 20"
MsgBox signal.Name
-
8/13/2019 AnnuCheck Automation Interface
20/48
OMICRON Test Universe
20
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 OutputThere are constants defined in the Constants object for
convienence:
cSignalTypeShot, cSignalTypeSteadyState,
cSignalTypeNoOutput
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim signal As Object Set signal =
annu.Document.Signals(1)
If signal.type =
annu.Constants.cSignalTypeShot Then
signal.type =
annu.Constants.cSignalTypeSteadyState
End If
-
8/13/2019 AnnuCheck Automation Interface
21/48
21
AnnuCheck Automation Interface
LED
PreFaultCurr
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 =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim signal As Object
Set signal = annu.Document.Signals(1)
signal.LED = "01"
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 AsObject
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim signal As Object
Set signal = annu.Document.Signals(1)
' Set prefault current to 1.5 A
signal.PreFaultCurr = 1.5
OMICRON T t U i
-
8/13/2019 AnnuCheck Automation Interface
22/48
OMICRON Test Universe
22
PreFaultTime
MaxFaultTime
Syntax: object.PreFaultTime
Type: double
Description: This property allows you to read or set the pre-fault time (in
seconds) of the Signal.
Example: 'Change signal name and display it Dim otm As
Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim signal As Object Set signal =
annu.Document.Signals(1)
' Set prefault time to 0.5 secondssignal.PreFaultTime = 0.5
Syntax: object.MaxFaultTime
Type: double
Description: This property allows you to read or set the post-fault time (inseconds) of the Signal.
Example: 'Change signal name and display it Dim otm As
Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim signal As Object Set signal =
annu.Document.Signals(1)
' Set maxfault time to 5 seconds
signal.MaxFaultTime = 5.0
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
23/48
23
AnnuCheck Automation Interface
PostFaultTime
Instructions
Syntax: object.PostFaultTime
Type: double
Description: This property allows you to read or set the post-fault time (in
seconds) of the Signal.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim signal As Object Set signal =
annu.Document.Signals(1)
' Set maxfault time to 1 second
signal.PostFaultTime = 1.0
Syntax: object.Instructions
Type: string
Description: This property allows you to read or set the Instructions text of
the Signal.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim signal As Object Set signal =
annu.Document.Signals(1)
signal.Instructions = "Connect T2"
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
24/48
OMICRON Test Universe
24
PopupMsg
TriggerID
Syntax: object.PopupMsg
Type: string
Description: This property allows you to read or set the pop-up message of
the Signal.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim signal As Object Set signal =
annu.Document.Signals(1)
signal.PopupMsg = "Press reset before running
shot"
Syntax: object.TriggerID
Type: long
Description: This property specifies the signal ID of the trigger input of the
Signal.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
annu.Document.Signals(1).TriggerID =
annu.Constants.sigidTRIP
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
25/48
25
AnnuCheck Automation Interface
TriggerCondition
BinOutLatching
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 whenthe binary input goes from 0 -> 1.
2 = "Don't care" means that the binary input is ignored.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specificannu.Document.Signals(1).TriggerID =
annu.Constants.sigidTRIP
'Trigger condition will occur when Trip goes
from 0 to 1
annu.Document.Signals(1).TriggerCondition = 0
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
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
'Switch latching for all binary outputs on
annu.Document.Signals(1).BinOutLatching=True
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
26/48
26
nonFCSignals collectionThese 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
Application (read only)
Count (read only)
Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim annu As Object
Set otm =Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim app As Object
Set app =
annu.Document.Signals(1).nonFCSignals.Appli-
cation
Syntax: object.Count
Type: Long
Description: This property returns the number of non FC signals in the
signal.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
MsgBox "Number of nonFCSignals in signal 1: " &
annu.Document.Signals(1).nonFCSignals.Count
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
27/48
27
Item (default property)
Syntax: object.Item(Index)
(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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
annu.Visible = True
'Set amplitude of V(1)-1 to 2A
' Note: this presumes that the signal has been
routed in the HCC!
Dim signal As Object
Set signal = annu.Document.Signals(1)
signal.nonFCSignals(annu.Constants.sigidUSER_
U1_1).Amplitude = 2.0
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
28/48
28
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).
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
'Set amplitude of all nonFCSignals to 0
Dim signal As Object
Set signal = annu.Document.Signals(1)
For i = 1 To signal.nonFCSignals.Count
signal.nonFCSignals.ItemIndex(i).Amplitude =
0.0
Next i
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
29/48
29
nonFCSignal ObjectProperties
Amplitude
Syntax: object.Amplitude
Return type: Double
Description: This property specifies the amplitude of the nonFCSignal.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
'Set amplitude of V(1)-1 to 2A
' Note: this presumes that the signal has been
routed in the HCC!
Dim signal As Object
Set signal = annu.Document.Signals(1)
signal.nonFCSignals(annu.Constants.sigidUSER_
U1_1).Amplitude = 2.0
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
30/48
30
Frequency
Phase
Syntax: object.Frequency
Return type: Double
Description: This property specifies the frequency of the nonFCSignal.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
'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
Syntax: object.Phase
Return type: Double
Description: This property specifies the phase of the nonFCSignal.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
'Set phase of V(1)-1 to 37.4
' Note: this presumes that the signal has beenrouted in the HCC!
Dim signal As Object
Set signal = annu.Document.Signals(1)
signal.nonFCSignals(annu.Constants.sigidUSER_
U1_1).Phase = 37.4
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
31/48
31
BinOuts Collection ObjectProperties
Application (read only)
Count (read only)
Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim app As Object
Set app =
annu.Document.Signals(1).BinOuts.Application
Syntax: object.Count
Type: Long
Description: This property returns the number of binary outputs in thesignal.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
MsgBox "Number of binary outputs in signal 1: " &annu.Document.Signals(1).BinOuts.Count
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
32/48
32
Item (default property)
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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
'Set binary output for circuit breaker Dim
signal As Object
Set signal = annu.Document.Signals(1)
signal.BinOuts(annu.Constants.sigidUSER_
OUTBIN_DEF1).Value = 1
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
33/48
33
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).
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
'Set all binary outputs
Dim signal As Object
Set signal = annu.Document.Signals(1)
For i = 1 To signal.BinOuts.Count
signal.BinOuts.ItemIndex(i).Value = 1
Next i
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
34/48
34
BinOut ObjectProperties
Value (default property)
Syntax: object.Value
Type: Boolean
Description: This property specifies whether the binary output is set
(active) or not (inactive).
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
'Set binary output for circuit breaker
Dim signal As Object
Set signal = annu.Document.Signals(1)
signal.BinOuts(annu.Constants.
sigidUSER_OUTBIN_DEF1).Value = 1
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
35/48
35
Locations Collection ObjectProperties
Application (read only)
Parent (read only)
Syntax: object.Application
Type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim app As Object
Set app = annu.Document.Locations.Application
Syntax: object.Parent
Type: Object
Description: This property always returns the parent object in the object
hierarchy. In this case it is the Document Object (Document).
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim obj As Object
Set obj = annu.Document.Locations.Parent
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
36/48
36
Count (read only)
Item (default property)
Syntax: object.Count
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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim testpoints As Object
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
Syntax: object.Item(Index)
(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.
Example: 'Change signal name and display it Dim otm As
Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim locations As Object
set locations = annu.Document.Locations
Dim location As Object
Set location = locations(1)
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
37/48
37
Methods
Add
Remove
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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim locations As Object Dim location As Object
Set locations = annu.Document.Locations
Set location = locations.Add
Syntax: object.Remove(Index)
Long Index - Index of the signal 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.
Example: Dim otm As Object
Dim annu As Object
Set otm =Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim locations As Object
set locations = annu.Document.Locations
locations.Add
'And now remove it
locations.Remove(2)
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
38/48
38
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 =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim location As Object Set location =
annu.Document.Locations(1)
location.Name = "Location 20"
MsgBox location.Name
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
39/48
39
TestPoints Collection Object
Properties
Application (read only)
Count (read only)
Syntax: object.Application
Return type: Object (Application)
Description: Returns the Application Object (Application).
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim app As Object
Set app =
annu.Document.Signals(1).TestPoints.Applica-
tion
Syntax: object.Count
Return type: Long
Description: This property returns the number of test points in the signal.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim testpoints As ObjectDim 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
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
40/48
40
Item (default property)
Syntax: object.Item(Index)
(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.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
'Add 2 testpoints Dim testpoints As Object settestpoints =
annu.Document.Signals(1).TestPoints
Dim testpoint As Object
Set testpoint = testpoints(1)
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
41/48
41
TestPoint Object
Properties
Used
Syntax: object.Used
Return type: boolean
Description: This property allows you to enable or disable the testpoint.
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
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
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
42/48
42
Expected
Syntax: object.Expected
Return type: String
Description: This property allows you to set or read the Expected result of
the testpoint.
Example: Dim otm As Object
Dim annu As ObjectSet otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim testpoint As Object Set testpoint =
annu.Document.Signals(1).TestPoints(1)
testpoint.Expected = "On"
MsgBox testpoint.Expected
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
43/48
43
Measured
Syntax: object.Measured
Return type: String
Description: This property allows you to set or read the Measured result of
the testpoint.
Example: Dim otm As Object
Dim annu As ObjectSet otm =
Document.InsertObject("OMAnnuCheck.Document")
Set annu = otm.Specific
Dim testpoint As Object Set testpoint =
annu.Document.Signals(1).TestPoints(1)
testpoint.Measured = "On"
MsgBox testpoint.Measured
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
44/48
44
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
Example: Dim otm As Object
Dim annu As Object
Set otm =
Document.InsertObject("OMAnnuCheck.Document")Set annu = otm.Specific
Dim testpoint As Object
Set testpoint =
annu.Document.Signals(1).TestPoints(1)
testpoint.Assessment = cTestPointFailed
MsgBox testpoint.Assessment
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
45/48
45
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_NsigidI_0
sigidI_1
sigidI_2
sigidI_PRIM_L1
sigidI_PRIM_L2
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
46/48
46
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_3sigidUSER_I4_1
sigidUSER_I4_2
sigidUSER_I4_3
Binary Inputs
sigidTRIP
sigidSTART
Binary Outputs
sigidAUX_CONT
sigidAUX_CONT_L1
sigidAUX_CONT_L2
sigidAUX_CONT_L3
AnnuCheck Automation Interface
-
8/13/2019 AnnuCheck Automation Interface
47/48
47
sigidUSER_OUTBIN_DEF1
sigidUSER_OUTBIN_DEF2
sigidUSER_OUTBIN_DEF3
sigidUSER_OUTBIN_DEF4
sigidUSER_OUTBIN_DEF5
sigidUSER_OUTBIN_DEF6
sigidUSER_OUTBIN_DEF7
sigidUSER_OUTBIN_DEF8
Miscellanous
cTestPointPassed
cTestPointFailed
cTestPointNotTested
cSignalTypeShot
cSignalTypeSteadyState
cSignalTypeNoOutput
OMICRON Test Universe
-
8/13/2019 AnnuCheck Automation Interface
48/48
48