Solartron Metrology AMETEK Orbit3 Instructions de montage

502989 - Orbit3 Software manual Issue 32 Page 1 of 117

Orbit®3 Software ManualOrbit®3 Software Manual

1.1 DO UMENTATION ROSS REFEREN E

502914 Orbit3 Modules manual Details on installation and electrical

requirements.

502990 Orbit3 System manual Details on installation and electrical

requirements for the Orbit Library

compatible products

1.2 TRADEMARKS AND OPYRIGHTS

Information in this document is subject to change without notice.

No part of this document may be reproduced or transmitted in any form or by means,

electronic or mechanical, for any purpose, without the express permission of Solartron

Metrology.

Microsoft®, Windows®XP, Windows®Vista, Windows®7, Windows®8, Windows®10,

Excel®, VBA, VB and the .NET Framework are registered trademarks or trademarks of

Microsoft orporation in the United States and/or other countries.

Delphi® and ++ Builder® are registered trademarks of Embarcadero.

All other brand names, product names or trademarks belong to their respective

holders.

The Bluetooth® word mark and logos are registered trademarks owned by Bluetooth

SIG, Inc and any use of such marks by Solartron Metrology is under license.

Orbit® is a registered trademark of Solartron Metrology Ltd

1.3 ONTA T INFORMATION

For updated information, troubleshooting guide and to see our full range of products,

visit our website: http://www.solartronmetrology.com

502989 - Orbit3 Software manual Issue 32 Page 2 of 117

TABLE OF CONTENTS
1 Documentation  ross Reference.....................................................................................2
2 Trademarks and  opyrights.............................................................................................2
3  ontact Information..........................................................................................................2
TABLE OF CONTENTS......................................................................................................3
INTROD CTION.................................................................................................................8
1 Scope...............................................................................................................................8
2 Navigating this document.................................................................................................9
3 Terms and Abbreviations..................................................................................................9
3.1 Abbreviations....................................................................................................................................... 9
SOFTWARE INTERFACING TO ORBIT..........................................................................10
1 Introduction....................................................................................................................10
2 OrbitLibrary....................................................................................................................10
2.1  ompatibility...................................................................................................................................... 11
2.2 OrbitLibrary  ode Reference............................................................................................................. 11
2.3 OrbitLibrary  ode UML Diagram........................................................................................................ 11
3 Orbit Library Test............................................................................................................11
4 Orbit G S.......................................................................................................................11
5 OrbMeasure Lite (retired)...............................................................................................12
6 Orbit3 Excel® add-in......................................................................................................12
7 Orbit3  ode Examples...................................................................................................12
7.1 Excel VBA  OM Example.................................................................................................................. 12
8 Using Orbit without Windows.........................................................................................12
9 Orbit Troubleshooting.....................................................................................................13
ORBIT  TILITY PROGRAMS..........................................................................................13
1 Orbit3 Registration.........................................................................................................13
2 Orbit3 Reporter..............................................................................................................13
3 Orbit3 Updater................................................................................................................13
4 Orbit3 Network Power  alculator..................................................................................13
5 RS232IM Helper.............................................................................................................13
6 OrbitA S  onfigurator...................................................................................................13
7 Orbit3Gateway  onfigurator..........................................................................................14
8 PIM Utility.......................................................................................................................14
9 Orbit3  onfocal Updater................................................................................................14
10 W M  onfigurator.......................................................................................................14
11 WHT-M Maintenance Tool............................................................................................14
12 Air Gauge Utility...........................................................................................................14
POWER  P CONDITIONS...............................................................................................15
1.1 RS232IM Default Baud Rate............................................................................................................. 15
MEAS REMENT MODES................................................................................................16
1 Overview........................................................................................................................16
2 Basic Measurement Mode.............................................................................................17
3 Difference Mode.............................................................................................................17
4 Buffered Mode................................................................................................................18
4.1 Introduction........................................................................................................................................ 18
4.2 Synchronized Mode........................................................................................................................... 18
502989 - Orbit3 Software manual Issue 32 Page 3 of 117

4.3 Sample Mode.................................................................................................................................... 19
4.4 External Master Mode - Using EIM / DIOM2......................................................................................19
5 ReadBurst......................................................................................................................19
6 Dynamic Modes.............................................................................................................20
6.1 Introduction to Dynamic Modes......................................................................................................... 20
6.2 Introduction to Dynamic 2.................................................................................................................. 20
6.3 Why Use Dynamic Mode................................................................................................................... 20
6.4  ollection Rate.................................................................................................................................. 21
6.5 Implementing Dynamic2.................................................................................................................... 21
6.6 Dynamic Mode System  onstraints...................................................................................................22
6.7 Dynamic Data.................................................................................................................................... 22
6.8 Dynamic External Master Mode......................................................................................................... 22
6.8.1 EIM DynamicMasterMode Property............................................................................................ 23
6.8.2 DIOM2 DynamicMasterMode Property....................................................................................... 23
6.8.3 TxSync Property......................................................................................................................... 23
6.8.4 Sync Pulse Rate when using EIM as a Sync source..................................................................24
6.9 Requirements for Dynamic Mode...................................................................................................... 24
6.10 Hints and Tips on Using Dynamic Mode..........................................................................................25
6.11 Dynamic Schemes........................................................................................................................... 26
6.11.1 Dynamic Scheme 1 – USBIM controller as the Sync source....................................................26
6.11.2 Dynamic Scheme 2 - Encoder as the Sync source...................................................................27
7 Reading Rate  omparison.............................................................................................28
7.1 USBIM MK2  ontroller reading rates................................................................................................28
7.2 ETHIM  ontroller reading rates......................................................................................................... 29
7.3 RS232IM MK2  ontroller reading rates.............................................................................................30
7.4 WIM  ontroller reading rates............................................................................................................. 30
8 Summary........................................................................................................................30
ORBIT FEAT RES AND COMMANDS...........................................................................31
1 HotSwap.........................................................................................................................31
1.1 Using Orbit3 without Hot Swap.......................................................................................................... 32
2 FindHotswapped............................................................................................................32
3  lear T ONs..................................................................................................................32
4 Ping................................................................................................................................33
5 Readinginunits...............................................................................................................33
6 Orbit Speed....................................................................................................................33
ORBIT LIBRARY..............................................................................................................34
1 Overview........................................................................................................................34
1.1 Networks Object................................................................................................................................ 35
1.2 Network Object.................................................................................................................................. 35
1.3 Modules Object.................................................................................................................................. 35
1.4 Module Object................................................................................................................................... 35
2 Referencing the Orbit Library.........................................................................................36
3 Orbit Library  OM Interface...........................................................................................38
4 Migrating from the original Orbit  OM Library...............................................................38
EXAMPLE CODE - WALK THRO GH..........................................................................39
1 Overview......................................................................................................................39
1.1  OM Interface................................................................................................................................. 39
2  onnecting to the Orbit Library....................................................................................39
2.1 Initialising The OrbitServer.............................................................................................................. 40
2.2  onnecting to The OrbitServer........................................................................................................ 40
2.2.1 WIM  ontrollers........................................................................................................................ 41
2.3 Disconnecting from The OrbitServer................................................................................................ 41
3 Listing Orbit Networks..................................................................................................41
4 Adding Orbit Modules...................................................................................................41
4.1 Listing Orbit Modules....................................................................................................................... 42
4.2 Add Module...................................................................................................................................... 43
502989 - Orbit3 Software manual Issue 32 Page 4 of 117

4.3 Notify Add Module........................................................................................................................... 43
4.4 Ping................................................................................................................................................. 43
4.5 FindHotSwapped............................................................................................................................. 44
4.6 Delete Module................................................................................................................................. 44
4.7  lear All Modules............................................................................................................................. 44
4.8  lear T ON Memory....................................................................................................................... 45
4.9  hange Address.............................................................................................................................. 45
4.10 Load and Save Network................................................................................................................ 45
5 Getting Module Readings............................................................................................47
5.1  onfiguring Modules........................................................................................................................ 47
5.2 Module Status.................................................................................................................................. 47
6 Reading Modes............................................................................................................50
6.1 ReadBurst Mode.............................................................................................................................. 50
6.2 Dynamic Modes 1 & 2...................................................................................................................... 51
6.2.1 Dynamic External Master Mode............................................................................................... 53
6.3 Buffered Mode................................................................................................................................. 54
6.4 Difference Mode.............................................................................................................................. 56
6.5 RefMark Mode................................................................................................................................. 56
ORBIT LIBRARY TEST..................................................................................................57
1 Introduction...................................................................................................................57
2 Features.......................................................................................................................57
3 User Guide...................................................................................................................59
3.1 Getting Started................................................................................................................................. 59
3.2 Usage.............................................................................................................................................. 60
3.2.1 Server Tab................................................................................................................................ 60
3.2.2 Network Tab.............................................................................................................................. 61
3.2.3 Module Tab............................................................................................................................... 62
3.2.4 Read Burst Mode Tab............................................................................................................... 67
3.2.5 Dynamic Mode Tab................................................................................................................... 68
3.2.6 Difference Mode Tab................................................................................................................. 69
3.2.7 Buffered Mode Tab................................................................................................................... 70
3.2.8 Ref Mark Mode Tab.................................................................................................................. 71
3.2.9 Results Window........................................................................................................................ 72
4 Source  ode................................................................................................................73
4.1 Development Tools.......................................................................................................................... 73
4.1.1 Microsoft Visual Studio  # Express..........................................................................................73
4.2 Opening the Project File.................................................................................................................. 73
4.2.1  ompiling.................................................................................................................................. 75
4.2.2 Running.................................................................................................................................... 75
4.3 Navigating the Source  ode............................................................................................................ 76
MOD LE SPECIFIC OPERATION.................................................................................80
1 Digital Probe (DP)........................................................................................................80
1.1 Introduction...................................................................................................................................... 80
1.2 Programmable Resolution............................................................................................................... 80
1.3 Programmable Electrical Measurement Bandwidth.........................................................................81
1.4 Probe disconnect detection............................................................................................................. 81
2 Analogue Input Module (AIM)......................................................................................82
3 Air Gauge Module (AGM).............................................................................................83
3.1 Introduction...................................................................................................................................... 83
3.2 Mastering......................................................................................................................................... 83
3.2.2 Mastering using the Air Gauge Utility.......................................................................................83
3.2.3 Implementing Mastering........................................................................................................... 85
3.3 AGM Module Additional Properties and Methods............................................................................87
4 Linear Encoder (LE).....................................................................................................88
4.1 Introduction...................................................................................................................................... 88
4.2 Linear Encoder & Reference Mark.................................................................................................. 88
5 Encoder Input Module (EIM)........................................................................................89
5.1 Introduction...................................................................................................................................... 89
5.2 EIM Module Properties.................................................................................................................... 89
502989 - Orbit3 Software manual Issue 32 Page 5 of 117

6 Digital Input Output Module (DIOM)............................................................................91
6.1 Introduction...................................................................................................................................... 91
6.2 DIOM Module Properties................................................................................................................. 91
6.3 DIOM Pin Members......................................................................................................................... 91
6.4 Setting Pin  onfiguration................................................................................................................. 91
6.5 Read Inputs..................................................................................................................................... 91
6.6 Set Outputs...................................................................................................................................... 92
6.7 Improving Reading Integrity............................................................................................................. 92
6.8 DIOM operation example................................................................................................................. 93
6.9 Legacy............................................................................................................................................. 93
6.9.1 Read Inputs.............................................................................................................................. 93
6.9.2 Set Outputs.............................................................................................................................. 93
7 Digital Input Output Module V2 (DIOM2).....................................................................95
7.1 Introduction...................................................................................................................................... 95
7.2 Output Pins...................................................................................................................................... 95
7.3 Active States.................................................................................................................................... 95
7.3.1 Outputs..................................................................................................................................... 95
7.3.2 Inputs....................................................................................................................................... 96
7.4 Output Mode.................................................................................................................................... 96
7.5 DIOM2 Module Properties............................................................................................................... 96
7.6 DIOM2 Pin Members....................................................................................................................... 97
7.7 Read Inputs..................................................................................................................................... 97
7.8 Set Outputs...................................................................................................................................... 97
7.9 Improving Reading Integrity............................................................................................................. 98
7.10 External Master Mode.................................................................................................................... 98
8 Digimatic Interface Module (DIM)................................................................................99
8.1 Introduction...................................................................................................................................... 99
8.2  hanging the Mode of Operation..................................................................................................... 99
8.3 Update Reading Information............................................................................................................ 99
9 Laser Triangulation Sensors (LT & LTH)....................................................................100
9.1 LT  onfiguration............................................................................................................................ 100
9.1.1 Reading and Writing Settings................................................................................................. 100
9.2 LTH  onfiguration.......................................................................................................................... 100
9.2.1 Reading and Writing Settings................................................................................................. 100
10  onfocal Module......................................................................................................101
10.1 Optimising settings...................................................................................................................... 101
10.2  onfocal Properties..................................................................................................................... 101
10.2.1 Get/Set Integration............................................................................................................... 101
10.2.2 Get/Set Brightness............................................................................................................... 101
10.2.3 Get/Set Read Mode.............................................................................................................. 101
10.2.4 Get/Set Averaging................................................................................................................ 101
10.2.5 Read Second  hannel in Units............................................................................................ 102
11 Wireless  onnection Module (W M).......................................................................103
11.1  ompatibility................................................................................................................................ 103
11.2 W M_Device class...................................................................................................................... 103
11.2.1 Properties............................................................................................................................. 103
11.2.2 Methods................................................................................................................................ 103
11.2.3 Reading Devices.................................................................................................................. 103
11.2.4 Settings class....................................................................................................................... 106
11.3 Tagged readings Example........................................................................................................... 108
ORBIT ERROR CODES AND ERROR HANDLING....................................................109
1 General......................................................................................................................109
2 Handling Errors..........................................................................................................109
2.1 Error Handling When Using the Orbit Library................................................................................109
3  ommon Errors..........................................................................................................109
3.1 No Error......................................................................................................................................... 109
3.2 Under and Over Range.................................................................................................................. 109
3.3 Overspeed Error............................................................................................................................ 109
3.4 No Probe Error............................................................................................................................... 110
4 ModuleStatus.............................................................................................................110
5 Orbit Errors.................................................................................................................111
502989 - Orbit3 Software manual Issue 32 Page 6 of 117

14 APPENDIX A - ORBIT COMPATIBILITY ROADMAP..................................................114

14.1 Modules......................................................................................................................114

14.1.1 Orbit3............................................................................................................................................. 114

14.1.2 Module ompatibility...................................................................................................................... 115

14.1.3 Module Release History................................................................................................................. 116

14.2 ontrollers & Software...............................................................................................116

15 REVISION HISTORY....................................................................................................117

502989 - Orbit3 Software manual Issue 32 Page 7 of 117

3 INTROD CTION

3.1 S OPE

The Orbit®3 Measurement System is a modular measurement system that can be put

together quickly, easily and is cost effective. It allows different types of sensors to be

easily mixed and integrated on a single network independent of sensor technology. In

addition to linear probes and linear displacement transducers, third party sensors can

easily be integrated. This, combined with programmable input and output modules for

interfacing to external equipment makes the Orbit®3 Measurement System a flexible

solution for measurement applications.

Typically an Orbit®3 Measurement System will consist of four elements: windows

support Measurements Modules with T- onnectors, Measurement System

controllers, power supplies and cables. All of which can be obtained from the same

supplier, thus guaranteeing compatibility and accelerating system integration.

The Orbit®3 Measurement System also includes a range of readouts for stand alone

measurement systems; these also can be used as a basic interface to a PL .

This document defines the software protocol of the Orbit®3 Measurement System and

provides information and guidance on using the OrbitLibrary.

The information is principally for users of P systems who wish to develop software

applications for use with the Orbit Measurement System.

Orbit can also be used with low level commands using the RS232IM ontroller

Module. These commands are detailed in the Orbit3 Low Level ommand manual

(503303), available on request.

This manual should be used in conjunction with the Orbit®3 System manual & the

Orbit®3 Module manual.

The measurement and mechanical performance of individual products is detailed in

the appropriate sections of the manuals.

Support software is supplied for all versions of Windows, from XP onwards (both 32 &

64 bit versions).

Examples are provided for # and ++.

502989 - Orbit3 Software manual Issue 32 Page 8 of 117

3.2 NAVIGATING THIS DO UMENT

This is a large document, which is a useful reference when writing Orbit applications.

Hyperlinks are included to aid navigation.

To return to the point where you have jumped from, most pdf readers

have a ‘Previous Page View’ button, alternatively use the keyboard

shortcut 'ALT' + left arrow key.

3.3 TERMS AND ABBREVIATIONS

For terms associated with the Orbit3 measurement system, see the Orbit3 System

manual.

3.3.1 Abbreviations

AIM Analogue Input Module

AGM Air Gauge Module

DP Digital Probe (e.g. DP10)

DIOM Digital Input Output Module

DIOM2 Digital Input Output Module V2

EIM Encoder Input Module

LE Linear Encoder

LT Laser Triangulation Probe

LTH High performance Laser Triangulation Probe

DIM Digimatic Interface Module

W M Wireless onnection Module

M (Orbit) Module

PIE Probe Interface Electronics

USBIM USB Interface Module

RS232IM RS232 Interface ontroller

RS485IM RS485 Interface ontroller

ETHIM Ethernet Interface ontroller

ORBIT®Orbit communication protocol

OSPW Orbit Support Pack for Windows

WIM Bluetooth Wireless Interface ontroller

4K MODE Synchronised Measurement at 3096 readings per second

2K MODE Synchronised Measurement at 1953 readings per second

1K MODE Synchronised Measurement at 976 readings per second

VBA Visual Basic for applications

OM omponent Object Model

DLL Dynamic Link Library

502989 - Orbit3 Software manual Issue 32 Page 9 of 117

4 SOFTWARE INTERFACING TO ORBIT

4.1 INTRODU TION

The Orbit®3 Support Pack for Windows covers interfacing Orbit to a P with Microsoft

Windows Operating System. It contains an Install program which will installs the Orbit

drivers, software libraries, applications and manuals on to your hard disc.

Included with Orbit®3 Support Pack for Windows is the Orbit library. This is the

simplest and best tool to use to communicate with an Orbit Measurement System.

See the Orbit®3 System manual for installation details, including PC

specification and updating Windows drivers.

After installing, a desktop shortcut to the 'Orbit3 Suite' dashboard will appear.

The dashboard looks like this:

4.2 ORBITLIBRARY

The Orbit Library is specifically designed for the Microsoft .NET Framework that is

included with all Windows operating systems from Windows XP onwards.

Using the Orbit Library greatly simplifies the development of Orbit systems since it:

•Provides a more modern object orientated software design.

502989 - Orbit3 Software manual Issue 32 Page 10 of 117

Table des matières

Autres manuels Solartron Metrology Système de contrôle

Solartron Metrology

Solartron Metrology AMETEK ORBIT ACS SI100 Manuel utilisateur

Solartron Metrology

Solartron Metrology SI8500 Manuel utilisateur

Manuels Système de contrôle populaires d'autres marques

Pentair Pool Products

Pentair Pool Products Compool Manuel utilisateur

ComfortNET

ComfortNET CTK04 Manuel utilisateur

Fireye

Fireye InSight II 95DSS3 Manuel utilisateur

CAME

CAME G3000 Manuel utilisateur

Idemia

Idemia MorphoAccess VP MD Manuel utilisateur

Axis

Axis P1445-LE-3 Manuel utilisateur

HEIDENHAIN

HEIDENHAIN TNC 150 B Manuel utilisateur

CNC-Step

CNC-Step High-Z T-Series Manuel utilisateur

Doosan

Doosan DVF Series Manuel utilisateur

Honeywell

Honeywell KAP 140 Manuel utilisateur

Honeywell

Honeywell vk41 series Manuel utilisateur

AirBench

AirBench FPW Guide d'installation

Cypress

Cypress HHR-3160 Manuel utilisateur

CAME

CAME GLT40AOS Manuel utilisateur

Zonex

Zonex GEN II -VVT Guide de l'utilisateur

Altronics

Altronics K 9650 Manuel utilisateur

micro-trak

micro-trak RoadMaster Manuel utilisateur

micro-trak

micro-trak Calc-An-Acre II Manuel utilisateur