AnnuCheck Automation Interface.pdf

8/10/2019 AnnuCheck Automation Interface.pdf

1/66

Annunciation Checker

Automation Interface


2/66

2

OMICRON Test Universe

Manual Version: AnnucheckAut.AE.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.


3/66

Contents

3

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Location Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

TestPoints Collection Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
http://preface_cms251.pdf/http://preface_cms251.pdf/


4/66

4


TestPoint Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Constants Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63


5/66

5

Annunciation Checker Automation Interface

Annunciation Checker AutomationInterface

Object Hierarchy

Figure 1:

Object hierarchy of an

AnnuCheck document


6/66


6

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 ObjectSet otm =

Document.InsertObject("OMAnnuCheck.Document")

Set annu = otm.Specific

Dim constants As Object

Set constants = annu.Constants


7/66

7


Document (read only)

Parent (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

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 ObjectDim annu As Object

Set otm =



Dim obj As Object

Set obj = annu.Parent


8/66


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.


Dim annu As Object

Set otm =



'Is the application visible ?

If annu.Visible then

MsgBox "Application is visible"

Else

'Make the application visibleannu.Visible = TRUE

End If


9/66

9


MethodsQuit

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


10/66


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


Parent (read only)

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


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


11/66

11


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.


Dim annu As Object

Set otm =



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.


Dim annu As Object

Set otm =



Dim locations As Object

Set locations= annu.Document.Locations


12/66


12

Comment

Autolock

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

Syntax: object.Autolock

Type: Boolean

Description: Set this property to Trueto 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


13/66

13


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()


14/66


14

Signals Collection ObjectProperties






Dim annu As Object

Set otm =



Dim app As Object

Set app = annu.Document.Signals.Application


15/66

15


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.


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


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


16/66


16

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.


Dim annu As Object

Set otm =





Dim signal As Object

Set signal = signals(1)


17/66

17


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.


Dim annu As Object

Set otm =



'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: NoneDescription: 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 =Document.InsertObject("OMAnnuCheck.Document")


'Add signal



signals.Add

'And now remove it

signals.Remove(2)


18/66


18

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 signalDim signals As Object


signals.Add

signals.Add

signals.Add

'And now remove the signals

signals.RemoveMulti(2, 4)


19/66

19


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 =


Set annu = otm.Specific'Add signal



signals.Add

signals.Add

'And now move the signal from

'position 1 to position 2

signals.Move(1, 2)


20/66


20

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



'Add signal



signals.Add

signals.Add

signals.Add'And now move the specified signals

'to position 2

signals.MoveMulti(1, 2, 2)


21/66

21


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 =


Set annu = otm.Specific'Add signal



signals.Add

signals.Add

'And now duplicate the signal from

'position 1 to position 2

signals.Duplicate(1, 2)

O C O


22/66


22

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.


Set otm =



'Add signal



signals.Addsignals.Add

signals.Add

'And now duplicate specified signals

'to position 2

signals.DuplicateMulti(1, 2, 2)



23/66

23


Signal ObjectProperties

FCState

BinOuts (read only)

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

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 =

Document.InsertObject("OMAnnuCheck.Document")Set annu = otm.Specific

Dim binouts As Object

Set binouts =

annu.Document.Signals(1).BinOuts



24/66


24

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.


Dim annu As Object

Set otm =



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.


Dim annu As Object



Dim nonfcsignals As Object

Set nonfcsignals =

annu.Document.Signals(1).nonFCSignals



25/66

25


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



26/66

26

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


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



27/66

27

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 =





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 As

Object

Dim annu As Object

Set otm =





' Set prefault current to 1.5 A

signal.PreFaultCurr = 1.5



28/66

28

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.


Object

Dim annu As Object

Set otm =





' 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 (in



Object

Dim annu As Object

Set otm =





' Set maxfault time to 5 seconds

signal.MaxFaultTime = 5.0



29/66

29

PostFaultTime

Instructions

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

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"



30/66

30

PopupMsg

TriggerID

Syntax: object.PopupMsg

Type: string

Description: This property allows you to read or set the pop-up message of

the Signal.







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.


Dim annu As Object

Set otm =



annu.Document.Signals(1).TriggerID =

annu.Constants.sigidTRIP



31/66

31

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.


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

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



32/66

32

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


Count (read only)





Dim annu As Object

Set otm =



Dim app As Object

Set app =

annu.Document.Signals(1).nonFCSignals.Appli-

cation


Type: Long

Description: This property returns the number of non FC signals in the

signal.


Set otm =



MsgBox "Number of nonFCSignals in signal 1: " &

annu.Document.Signals(1).nonFCSignals.Count



33/66

33



(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



34/66

34

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



35/66

35

nonFCSignal ObjectProperties

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

' Note: this presumes that the signal has been

routed in the HCC!




U1_1).Amplitude = 2.0



36/66

36

Frequency

Phase

Syntax: object.Frequency

Return type: Double

Description: This property specifies the frequency of the nonFCSignal.


Dim annu As Object



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


Dim annu As Object

Set otm =



'Set phase of V(1)-1 to 37.4' Note: this presumes that the signal has been

routed in the HCC!




U1_1).Phase = 37.4



37/66

37

BinOuts Collection Object

Properties


Count (read only)





Dim annu As Object

Set otm =



Dim app As Object

Set app =annu.Document.Signals(1).BinOuts.Application


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



38/66

38


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 ObjectSet signal = annu.Document.Signals(1)

signal.BinOuts(annu.Constants.sigidUSER_

OUTBIN_DEF1).Value = 1



39/66

39

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


Set signal = annu.Document.Signals(1)For i = 1 To signal.BinOuts.Count

signal.BinOuts.ItemIndex(i).Value = 1

Next i



40/66

40

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 breakerDim signal As Object


signal.BinOuts(annu.Constants.

sigidUSER_OUTBIN_DEF1).Value = 1



41/66

41

Locations Collection Object

Properties


Parent (read only)





Dim annu As Object

Set otm =



Dim app As Object

Set app = annu.Document.Locations.Application


Type: Object

Description: This property always returns the parent object in the objecthierarchy. 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



42/66

42

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





set locations = annu.Document.Locations

Dim location As Object

Set location = locations(1)



43/66

43

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 =



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 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 locations = annu.Document.Locations

locations.Add

'And now remove it

locations.Remove(2)



44/66

44

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 ifyou 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)



45/66

45

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)



46/66

46

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 bybeginIndexFrom 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)



47/66

47

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 byindexTo. 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)



48/66

48

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)



49/66

49

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



50/66

50

TestPoints Collection Object

Properties


Count (read only)


Return type: Object (Application)



Dim annu As Object

Set otm =



Dim app As Object

Set app =annu.Document.Signals(1).TestPoints.Application


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



51/66

51



(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 thetestpoints collection.


Dim annu As Object

Set otm =



'Add 2 testpoints Dim testpoints As Object settestpoints =

annu.Document.Signals(1).TestPoints

Dim testpoint As Object

Set testpoint = testpoints(1)



52/66

52

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



53/66

53

Expected

Measured

Syntax: object.Expected

Return type: String

Description: This property allows you to set or read the Expected result of

the testpoint.






annu.Document.Signals(1).TestPoints(1)

testpoint.Expected = "On"

MsgBox testpoint.Expected

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



54/66

54

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 = failedThere are constants defined in the Constants object for

convenience:

cTestPointNotTested, cTestPointPassed, cTestPointFailed


Dim annu As Object

Set otm =

Document.InsertObject("OMAnnuCheck.Document")Set annu = otm.Specific


Set testpoint =


testpoint.Assessment = cTestPointFailed

MsgBox testpoint.Assessment



55/66

55

Locked

Instructions

Syntax: object.Locked

Return type: Boolean

Description: Returns a Boolean value if test point is locked (read-only)


Dim annu As Object




Set testpoint =


testpoint.Locked

Syntax: object.Instruction

Return type: String

Description: This property allows for reading or setting the instruction text

of the test point.


Set otm =




Set testpoint =


testpoint.Instructions = "Connect T2"



56/66

56

PopupMsg

TriggerID

Syntax: object.PopupMessage

Return type: String

Description: This property allows for reading or setting up the pop-up

message of the test point.






Set testpoint =


testpoint.Popupmessage = "Press reset before

running shot"

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 =




57/66

57

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


I tM d


58/66

58

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 =

annu.Document.Signals(1).TestPoints(1)testpoint.InputMode =

annu.Constants.cInputModeManual


DoAutoAssessment


59/66

59

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.


Set otm =



Object

Set testpoint =


testpoint.DoAutoAssessment = True


ExpectedValue


60/66

60

ExpectedValue

MeasuredValue

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

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 =

annu.Document.Signals(1).TestPoints(1)testpoint.MeasuredValue = 20.5


Unit


61/66

61

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


AbsoluteTolerance


62/66

62

RelativeTolerance

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

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 =

annu.Document.Signals(1).TestPoints(1)testpoint.RelativeTolerance = 5


Constants Object


63/66

63

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


64/66


Binary Outputs


65/66

65

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


Units


66/66

66

cUnitNone

cUnitSeconds

cUnitVolt

cUnitAmper

cUnitOhm

cUnitPower

cUnitApparentPower

cUnitReactivePower

Documents

AnnuCheck Automation Interface.pdf