You are on page 1of 18

CBConfiguration

Automation Interface

OMICRON Test Universe

Manual Version: CBConfAut.ENU.3 - Year: 2012


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

Contents

Contents
CBConfiguration Automation Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Object Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Application Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Document (read only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Name (read only). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Parent (read only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Document Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Parent (read only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Application (read only). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
SimActive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
TripTime (read only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
CloseTime (read only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
CB52abPercent (read only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
InitClosed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
AutoReset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
AutoResetTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
R52aCBNotClosedTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
R52bCBOpenTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
R52aCBClosedTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
R52bCBNotOpenTime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
RecloserModeActive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

OMICRON Test Universe

CBConfiguration Automation Interface

CBConfiguration Automation
Interface
Object Hierarchy
Figure 1:
Object hierarchy of an
CBCfg document

Application Object
The application object is the root of the OMICRON CB Configuration 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 CB Configuration. If you want to
create another Application object with CreateObject, a new instance of the
OMICRON CB Configuration program is started to handle this object.
You can get a reference to the Document Object (Document).

OMICRON Test Universe

Properties
Document (read only)
Syntax:

object.Document

Type:

Object (Document)

Description:

This property returns a Document Object (Document).

Example:

Dim otm As Object


Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
Dim doc As Object
Set doc = cbcfg.Document

Name (read only)


Syntax:

object.Name

Type:

String

Description:

Returns the name of the application.

Example:

Dim otm As Object


Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
Dim Str As String
Set Str = cbcfg.Name

Parent (read only)

Syntax:

object.Parent

Type:

Object

Description:

This property always returns the parent object in the object


hierarchy. In this case it is the Application Object
(Application).

CBConfiguration Automation Interface

Example:

Dim otm As Object


Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
Dim obj As Object
Set obj = cbcfg.Parent

Visible
Syntax:

object.Visible

Type:

Boolean

Description:

Shows/hides the main application window.

Example:

Dim otm As Object


Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
'Is the application visible ?
If cbcfg.Visible then
MsgBox "Application is visible"
Else
'Make the application visible
cbcfg.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 CB Configuration application) you have to set the visible property to
True to see the main window of the application.

Methods
Quit
Syntax:

object.Quit

Return type:

None

OMICRON Test Universe

Description:

This command quits the OMICRON CB Configuration


application and closes all open windows and the document.

Example:

Dim otm As Object


Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
cbcfg.Quit

CBConfiguration Automation Interface

Document Object
With the Document Object (Document) you can control the document.

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

Example:

Dim otm As Object


Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
Dim obj As Object
Set obj = cbcfg.Parent

Application (read only)


Syntax:

object.Application

Type:

Object (Application)

Description:

This property returns the Application Object (Application).

Example:

Dim otm As Object


Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
Dim app As Object Set app =
cbcfg.Document.Application

OMICRON Test Universe

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 cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
cbcfg.Document.Comment = "This is my new
comment." & vbCrLf & "Line2"
MsgBox cbcfg.Document.Comment

SimActive
Syntax:

object.SimActive

Type:

Boolean

Description:

This property specifies whether the CB simulation is active


(True) or inactive (False).

Example:

'Let's deactivate the CB simulation


Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
cbcfg.Document.SimActive = False

10

CBConfiguration Automation Interface

TripTime (read only)


Syntax:

object.TripTime

Type:

Double

Description:

This property specifies the CB trip time in seconds or cycles


(depending on the setting in the module).

Example:

'Reads the trip time


Dim otm As Object
Dim cbcfg As OMCBCfg.Application
Dim tripTimeValue As Double
Set otm = Document.TestModules(1)
Set cbcfg = otm.Specific
tripTimeValue = cbcfg.Document.TripTime

CloseTime (read only)


Syntax:

object.CloseTime

Type:

Double

Description:

This property specifies the CB close time in seconds or cycles


(depending on the setting in the module).

Example:

'Reads the close time


Dim otm As Object
Dim cbcfg As OMCBCfg.Application
Dim tripTimeValue As Double
Set otm = Document.TestModules(1)
Set cbcfg = otm.Specific
closeTimeValue = cbcfg.Document.CloseTime

11

OMICRON Test Universe

CB52abPercent (read only)


Syntax:

object.CB52aPercent

Type:

Double

Description:

This Property reads the CB 52a, 52b time in percent.

Example:

'Reads the CB 52a,52b time


Dim otm As Object
Dim cbcfg As OMCBCfg.Application
Dim cb52abValue As Double
Set otm = Document.TestModules(1)
Set cbcfg = otm.Specific
cb52abValue = cbcfg.Document.CB52abPercent

InitClosed

12

Syntax:

object.InitClosed

Type:

Boolean

Description:

This property specifies wether the CB should be initially


closed (True) or open (False).

Example:

'The CB should initially be closed


Dim otm As Object
Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
cbcfg.Document.InitClosed = True

CBConfiguration Automation Interface

AutoReset
Syntax:

object.AutoReset

Type:

Boolean

Description:

This property specifies wether the CB should return to the


initial state automatically (see also properties InitClosed and
AutoResetTime).

Example:

'The CB should not return to the initial state


automatically
Dim otm As Object
Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
cbcfg.Document.AutoReset = False

AutoResetTime
Syntax:

object.AutoResetTime

Type:

Double

Description:

This property specifies the time after which the CB should


return to the initial state automatically (see also properties
InitClosed and AutoReset).

Example:

'The CB should return to the initial state


automatically after 200ms
Dim otm As Object
Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
cbcfg.Document.AutoReset = True
cbcfg.Document.AutoResetTime = 0.2

13

OMICRON Test Universe

R52aCBNotClosedTime
Syntax:

object.R52aCBNotClosedTime

Type:

Double

Description:

Read/set the time interval from the occurrence of the trip


command to the moment 52a becomes inactive (contact
opens).

Example:

'Set the 52a CB not closed time


Dim otm As Object
Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
cbcfg.Document.R52aCBNotClosedTime = 0.06
'60ms

R52bCBOpenTime

14

Syntax:

object.R52bCBOpenTime

Type:

Double

Description:

Read/set the time interval from the occurrence of the trip


command to the moment 52b becomes active (contact
closes).

Example:

'Set the 52b CB open time


Dim otm As Object
Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
cbcfg.Document.R52bCBOpenTime = 0.07 '70ms

CBConfiguration Automation Interface

R52aCBClosedTime
Syntax:

object.R52aCBClosedTime

Type:

Double

Description:

Read/set the time interval from the occurrence of the reclose


signal to the moment 52a becomes active (contact closes).

Example:

'Set the 52a CB closed time


Dim otm As Object
Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
cbcfg.Document.R52aCBClosedTime = 0.11 '110ms

R52bCBNotOpenTime
Syntax:

object.R52bCBNotOpenTime

Type:

Double

Description:

Read/set the time interval from the occurrence of the reclose


signal to the moment 52b becomes inactive (contact opens).

Example:

'Set the 52b CB not open time


Dim otm As Object
Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
cbcfg.Document.R52bCBNotOpenTime = 0.02 '20ms

15

OMICRON Test Universe

RecloserModeActive

16

Syntax:

object.RecloserModeActive

Type:

Boolean

Description:

Read/set if the CB is in Recloser mode or not.

Example:

'Set the CB in Recloser mode


Dim otm As Object
Dim cbcfg As Object
Set otm =
Document.InsertObject("OMCBCfg.Document")
Set cbcfg = otm.Specific
cbcfg.Document.RecloserModeActive = True

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

17

Support

18