Solartron Metrology AMETEK Orbit3 Software Manual
  1. Manuals
  2. Brands
  3. Solartron Metrology Manuals
  4. Control Systems
  5. AMETEK Orbit3
  6. Software manual

Solartron Metrology AMETEK Orbit3 Software Manual

Digital network
Hide thumbs
Table of Contents

Advertisement

Quick Links

®
®
Orbit
Orbit
3 Software Manual
3 Software Manual
502989 - Orbit3 Software manual
Issue 32
Page 1 of 117

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the AMETEK Orbit3 and is the answer not in the manual?

Questions and answers

Related Manuals for Solartron Metrology AMETEK Orbit3

Summary of Contents for Solartron Metrology AMETEK Orbit3

  • Page 1 ® ® Orbit Orbit 3 Software Manual 3 Software Manual 502989 - Orbit3 Software manual Issue 32 Page 1 of 117...

  • Page 2: Documentation Cross Reference

    ® 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 CONTACT INFORMATION...

  • Page 3: Table Of Contents

    TABLE OF CONTENTS 1.1 Documentation Cross Reference..................2 1.2 Trademarks and Copyrights.....................2 1.3 Contact Information......................2 2 TABLE OF CONTENTS......................3 INTRODUCTION.........................8 Scope..........................8 3.2 Navigating this document....................9 3.3 Terms and Abbreviations....................9 3.3.1 Abbreviations............................4 SOFTWARE INTERFACING TO ORBIT................10 Introduction........................10 OrbitLibrary........................10 4.2.1 Compatibility............................4.2.2 OrbitLibrary Code Reference......................4.2.3 OrbitLibrary Code UML Diagram......................
  • Page 4 7.4.3 Sample Mode............................ 7.4.4 External Master Mode - Using EIM / DIOM2..................19 ReadBurst........................19 7.6 Dynamic Modes......................20 7.6.1 Introduction to Dynamic Modes......................7.6.2 Introduction to Dynamic 2........................7.6.3 Why Use Dynamic Mode........................7.6.4 Collection Rate..........................7.6.5 Implementing Dynamic2........................7.6.6 Dynamic Mode System Constraints....................7.6.7 Dynamic Data............................
  • Page 5 10.4.3 Notify Add Module........................... 10.4.4 Ping..............................10.4.5 FindHotSwapped..........................10.4.6 Delete Module..........................10.4.7 Clear All Modules..........................10.4.8 Clear TCON Memory........................10.4.9 Change Address..........................10.4.10 Load and Save Network........................ 10.5 Getting Module Readings....................47 10.5.1 Configuring Modules........................10.5.2 Module Status..........................10.6 Reading Modes......................50 10.6.1 ReadBurst Mode..........................
  • Page 6 12.6 Digital Input Output Module (DIOM)................91 12.6.1 Introduction............................12.6.2 DIOM Module Properties......................... 12.6.3 DIOM Pin Members......................... 12.6.4 Setting Pin Configuration......................... 12.6.5 Read Inputs............................. 12.6.6 Set Outputs............................12.6.7 Improving Reading Integrity......................12.6.8 DIOM operation example......................... 12.6.9 Legacy............................. 12.6.9.1 Read Inputs..........................12.6.9.2 Set Outputs..........................12.7 Digital Input Output Module V2 (DIOM2)..............95 12.7.1 Introduction............................
  • Page 7 14 APPENDIX A - ORBIT COMPATIBILITY ROADMAP..........114 14.1 Modules........................114 14.1.1 Orbit3............................. 14.1.2 Module Compatibility........................14.1.3 Module Release History......................... 14.2 Controllers & Software....................116 15 REVISION HISTORY....................117 502989 - Orbit3 Software manual Issue 32 Page 7 of 117...

  • Page 8: Introduction

    INTRODUCTION 3.1 SCOPE 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.

  • Page 9: Navigating This Document

    3.2 NAVIGATING THIS DOCUMENT 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.

  • Page 10: Software Interfacing To Orbit

    SOFTWARE INTERFACING TO ORBIT 4.1 INTRODUCTION ® The Orbit 3 Support Pack for Windows covers interfacing Orbit to a PC 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. ®...

  • Page 11: Compatibility

    Allows the end user to avoid learning about the intricacies of the ‘low level’ Orbit • interface. In particular, this: ◦ Calls all the necessary functions in the correct order. ◦ Handles the timing constraints of different modules and controllers. ◦...

  • Page 12: Orbmeasure Lite (Retired)

    Input and Output via Orbit DIOM modules is supported for taking readings and displaying statuses such as logging readings and error conditions.  Orbit GCS is not installed with the Orbit Support Pack for Windows. The base version is available as a free download from the Solartron Website.

  • Page 13: Orbit Troubleshooting

    4.9 ORBIT TROUBLESHOOTING A useful utility for helping to diagnose software problems is the Orbit3 Reporter. The software produces a log file, which can then be sent to your supplier, along with a description of the problem itself, to aid technical support. ORBIT UTILITY PROGRAMS These programs are all available as part of the installation of the Orbit3 Support Pack for Windows.

  • Page 14: Orbit3Gateway Configurator

    5.7 ORBIT3GATEWAY CONFIGURATOR A utility for configuring MODIM controllers with their attached PLC and Orbit3 networks 5.8 PIM UTILITY A utility for configuring PIM controllers with their attached PLC and Orbit3 networks 5.9 ORBIT3 CONFOCAL UPDATER This application enables the user to update the firmware of Confocal Controllers (requires both an Orbit and Ethernet connection).

  • Page 15: Power Up Conditions

    POWER UP CONDITIONS On power up, the default conditions for all modules are: Basic Measurement Mode • The Orbit Network Speed (Baud Rate) is 187.5 K Baud, (see Orbit Speed). • In addition, on power up default conditions for Digital Probes & AIMs are: Resolution defaults to14 bits, (see Programmable Resolution).

  • Page 16: Measurement Modes

    MEASUREMENT MODES 7.1 OVERVIEW Each of the following reading commands and modes have been developed to accommodate the differing scenarios and challenges that commonly present themselves to manufacturing and metrology systems. Each mode, although seemingly similar, has definitive differences; some of these initially appear subtle. The aim of this document is to provide simple and clear explanations to what each reading mode or command is, the basics of how it does it, and importantly, what each mode can be used for.

  • Page 17: Basic Measurement Mode

    7.2 BASIC MEASUREMENT MODE Each Orbit Module type has both simple get reading commands; ReadingInCounts and ReadingInUnits; returning the reading in the modules pre-configured unit of measurement.. For modules such as the EIM or DIOM that do not have a specific unit of measure, getting the the ReadingInUnits, will return the ReadingInCounts.

  • Page 18: Buffered Mode

    7.4 BUFFERED MODE 7.4.1 Introduction Buffered capable Orbit modules have internal memory that can store up to 3000 synchronised readings at a reading rate of 244 reading / second, which can then be retrieved by the Orbit Library. All measurements are 14 bit, (for DP, LT, LTH, AGM and AIM only). Currently buffered capability is restricted to Digital Probes, LT, LTH, AIMs, AGMs and DIOM.

  • Page 19: Sample Mode

    7.4.3 Sample Mode Once started, this mode sets all buffered enabled modules to store readings each time the Network OrbitBuffered Sample method is called. This Sample method is broadcast to all buffered enabled modules, hence these readings are synchronised to each other. 7.4.4 External Master Mode - Using EIM / DIOM2 In a similar way to External Master Mode in dynamic, an Encoder Input Module (EIM) or the DIOM2 (see...

  • Page 20: Dynamic Modes

    7.6 DYNAMIC MODES 7.6.1 Introduction to Dynamic Modes Dynamic mode provides a method of obtaining synchronized measurements at high speed from Digital Probes, EIM, AGM, AIM, DIOM and other compatible Orbit products. This mode is of importance when measuring moving objects. It gives the user the ability to take high-speed measurements from a set of transducers that are sampled at the same point in time –...

  • Page 21: Collection Rate

    7.6.4 Collection Rate A dynamic collection is defined by the rate of time that each sync (a collection of readings) is spaced. The Orbit Library supports the traditional dynamic sync rates of 1k, 2k and 4k, as well as the dynamic2custom (Dynamic 2) rate.

  • Page 22: Dynamic Mode System Constraints

    7.6.6 Dynamic Mode System Constraints For the DP, LE AIM Modules only, care should be taken to ensure that the reading rate (Averaging) is set high enough for the faster Dynamic collection rates, otherwise loss of information will occur. Therefore, the Measurement Bandwidth and the Dynamic Collection Rate should be programmed compliant with the table below: Measurement Collection Rate...

  • Page 23: Eim Dynamicmastermode Property

    Note that in this mode, the EIM / DIOM2 triggers the syncs. Therefore, it will not be part of the dynamic collection itself. The external master is selected by setting the OrbitDynamic MasterAddress property to the module address of the EIM / DIOM2 to be used as external master. The EIM / DIOM2 master only triggers sync to modules with lower addresses.

  • Page 24: Sync Pulse Rate When Using Eim As A Sync Source

    Dynamic 2 Therefore, the TxSync value set will be lower than expected (divided by the Syncs per Block value). (e.g. in Dynamic 2k mode for an encoder with 3,600 counts per revolution, setting TxSync to 5 will produce 1 block of readings for every 10 counts = 1 per degree) Use Dynamic2 to avoid this issue.

  • Page 25: Hints And Tips On Using Dynamic Mode

    For controller compatibility, refer to Controllers & Software To be able to use Dynamic mode, ensure that you are running the latest software for modules, controllers and Orbit3 Support Pack For Windows. Should problems occur, the Orbit3 Reporter should be run to check the firmware / software of the Orbit Measurement system connected.

  • Page 26: Dynamic Schemes

    7.6.11 Dynamic Schemes The example scenarios / schemes illustrate how dynamic mode operates. Refer to the Orbit3 Code Examples, Orbit Library Test and the OrbitLibrary Code Reference for more details 7.6.11.1Dynamic Scheme 1 – USBIM controller as the Sync source This scenario is used to illustrate measuring the profile of a rotating cam shaft when time triggered readings are required.

  • Page 27: Dynamic Scheme 2 - Encoder As The Sync Source

    7.6.11.2Dynamic Scheme 2 - Encoder as the Sync source This scenario is used to illustrate measuring the profile of a rotating cam shaft when angle triggered readings are required. In this example, a cam shaft has four DPs (Digital Probes) measuring various positions.

  • Page 28: Reading Rate Comparison

    7.7 READING RATE COMPARISON 7.7.1 USBIM MK2 Controller reading rates The graph shows a comparison of the reading modes available using the USBIM MK2 Controller. Note that reading rates will vary with differing PC systems. Example. From the graph, for 50 Modules with Readburst in Ultra speed mode, each Module has a reading rate of approximately 500 readings per second.

  • Page 29: Ethim Controller Reading Rates

    7.7.2 ETHIM Controller reading rates Module Reading Rates For ETHIM 1000 Test Details PC: Quad core 2.8GHz 4GB RAM ETHIM Controller ReadBurst (Low Speed) ReadBurst (High Speed) Normal (Low Speed) Normal (High Speed) Number Of Modules The graph shows a comparison of the reading modes available using the ETHIM Controller.

  • Page 30: Rs232Im Mk2 Controller Reading Rates

    7.7.3 RS232IM MK2 Controller reading rates Module Reading Rates For RS232IM Test Details ReadBurst 115200 (Low Speed) PC: Quad core 2.8GHz 4GB RAM ReadBurst 115200 (High Speed) RS232IM Controller Normal 115200 (Low Speed) Tested at 115200 Baud Normal 115200 (High Speed) Number Of Modules The graph shows a comparison of the reading modes available using the RS232IM MK2 Controller.

  • Page 31: Orbit Features And Commands

    ORBIT FEATURES AND COMMANDS 8.1 HOTSWAP Note: To use this mode in its simplest form requires Orbit3 compatible TCONS and Modules. However to fully use this mode requires one of the following Orbit Controllers: USBIM MK2, RS232IM, RS232IM MK2 or ETHIM and the Orbit Library. Hot Swap is a feature of Orbit3 and is the ability to 'assume' a module's Orbit identity.

  • Page 32: Using Orbit3 Without Hot Swap

    8.1.1 Using Orbit3 without Hot Swap Question. What happens if you don’t want to use the Hot Swap function? Answer. You can use the system normally without Hotswap. Basically it’s transparent unless you choose to take advantage of it. If you don’t want to use Hotswap, don’t change anything, it’ll just work as it always did.

  • Page 33: Ping

    8.4 PING To use this mode requires one of the following Orbit Controllers: USBIM MK2, RS232IM, RS232IM MK2 or ETHIM and the Orbit Library along with Orbit3 compatible TCONS and Modules. This Orbit3 command interrogates the specified Orbit network to find all modules connected on it.

  • Page 34: Orbit Library

    Standard 187.5k (Default) High 1.5M Ultra 2.25M Note. For both High and Ultra speeds, ensure that the recommended Orbit cable and power supply configuration is used. See the Orbit 3 System manual for details. ORBIT LIBRARY 9.1 OVERVIEW The following diagram shows a top-down view of the Orbit Library. The Primary object is OrbitServer;...

  • Page 35: Networks Object

    Primary Object Object name: OrbitServer Orbit Server is the primary Object in the Orbit Library hierarchy. It contains the whole Orbit Measurement system, connecting to it, disconnecting from it and providing system wide controls, providing the network's object to the users and maintaining it.

  • Page 36: Referencing The Orbit Library

    Add a Reference by Project->Add Reference This will bring up the 'Add Reference' window. Select the 'Browse' tab. For 64 bit machines, navigate to C:\Program Files (x86)\Solartron Metrology\Orbit3 Support Pack for Windows\Drivers\Library or for 32 bit machines, navigate to C:\Program Files\Solartron Metrology\Orbit3...
  • Page 37 In the References section of the Solution Explorer, the OrbitLibrary reference should be visible. 502989 - Orbit3 Software manual Issue 32 Page 37 of 117...

  • Page 38: Orbit Library Com Interface

    9.3 ORBIT LIBRARY COM INTERFACE The Orbit Library is designed to work as a COM library to allow interfacing to older, legacy programs that do not support the .NET Framework (e.g. Microsoft Excel 97 VBA). COM Interface for more details. 9.4 MIGRATING FROM THE ORIGINAL ORBIT COM LIBRARY The basic hierarchy of the Orbit Library is similar to that of the Orbit COM in that it uses an OrbitServer, OrbitNetwork(s) and OrbitModule(s).

  • Page 39: Example Code - Walk Through

    10 EXAMPLE CODE - WALK THROUGH 10.1 OVERVIEW The Orbit Library provides an accessible way to receive readings with a variety of methods and performance specific modes to cater for a wide range of metrology needs. This section takes the supplied examples included with the Orbit3 Support Pack for Windows, and expands upon them.

  • Page 40: Initialising The Orbitserver

    10.2.1 Initialising The OrbitServer To create an instance of the OrbitServer a reference must be made to OrbitLibrary.dll assembly. See Referencing the Orbit Library The Orbit Library types must then be imported from the Solartron.Orbit3 namespace. C# (.NET) using Solartron.Orbit3; C++ (COM) #include "Orbit3CppCOMExample.h"...

  • Page 41: Wim Controllers

    If another instance of the OrbitServer attempts to connect to Orbit, when • another instance has already been connected, the OrbitServer will throw an exception stating that the Orbit Library is already in use. 10.2.2.1 WIM Controllers With WIM controllers (which operate via Bluetooth), the Connect() method will only find them if already paired (see the Orbit System manual for pairing instructions).

  • Page 42: Listing Orbit Modules

    The different methods to add, remove and configure Orbit 3 modules are described in the following sub-sections. 10.4.1 Listing Orbit Modules Modules can be listed in the same manner networks can be listed. The listing below print the ID for each OrbitModule connected to Orbit.Networks[NETINDEX]. (.NET) const int NETINDEX = 0;...

  • Page 43: Add Module

    10.4.2 Add Module OrbitModule.Modules.Add() allows a specific Orbit 3 module to be added to a network by passing the exact module ID string of module; for example, '100C619P19'. (.NET) Orbit.Networks.[NETINDEX].Modules.AddModule("100C619P19"); C++ (COM) OrbitNetworkPtr OrbNet = Orbit->Networks->get_Item(NetIndex); OrbNet->Modules->AddModule(WideString("100C619P19")) The Add function has been designed with a input text box in mind. An implemented example of this can be found within the Orbit Library Test 10.4.3 Notify Add Module...

  • Page 44: Findhotswapped

    OrbNet->Modules->Ping(); 10.4.5 FindHotSwapped OrbitNetwork.Modules.FindHotSwapped() shall add all HotSwapCapable OrbitModules to the OrbitNetwork when the TCON that the Orbit 3 Module is attached to has valid entry in memory for the OrbitModule. The function returns the number of new modules added to the network. (.NET) modulesFound = Orbit.Networks.[NETINDEX].Modules.FindHotSwapped();...

  • Page 45: Clear Tcon Memory

    OrbNet->Modules->ClearModules(); This function will clear the OrbitNetwork of OrbitModules, but leave TCON memory intact, allowing FindHotSwapped() to find HotSwapCapable OrbitModules still attached to the OrbitNetwork. 10.4.8 Clear TCON Memory OrbitNetwork.Modules.ClearTcons() shall remove all OrbitModules from an OrbitNetwork, as well as clearing the memory on all TCONs attached to the BUS that have an Orbit 3 Module attached.
  • Page 46 To Load an orbit network there are 2 options 1)just load the file - if one or more modules is loaded it will return true, otherwise it will return false; note that the module count should be checked to ensure you have all the modules.

  • Page 47: Getting Module Readings

    10.5 GETTING MODULE READINGS There are two calls that are made available to receive a single reading from an OrbitModule, OrbitModule.ReadingInCounts, and OrbitModule.ReadingInUnits. The former returning a reading in Counts, which is a representation of the full scale resolution for DP / AIM) of a module. The latter, ReadingInUnits will the return a reading in the base units of measure (e.g.
  • Page 48 502989 - Orbit3 Software manual Issue 32 Page 48 of 117...
  • Page 49 C++ (COM) OrbitNetworkPtr OrbNet = Orbit->Networks->get_Item(NetIndex); OrbitModulePtr OrbModule = OrbNet->Modules->get_Item(ModuleIndex); AnsiString moduleID = AnsiString(OrbModule->ModuleID); double readingInCounts = OrbModule->ReadingInCounts; eOrbitErrors ErrorState = OrbModule->ModuleStatus->Error; if( ErrorState = = eOrbitErrors.OverRange || ErrorState = = eOrbitErrors.UnderRange) AnsiString ErrorString = AnsiString(OrbModule->ModuleStatus->ErrorString); cout << moduleID.c_str() << " Error: " << ErrorString.c_str() << endl; } else cout <<...

  • Page 50: Reading Modes

    10.6 READING MODES The following sub-sections describe the methods implementation for the reading modes provided by the Orbit Library. Each of these modes are designed for use in differing scenarios and situations; a comprehensive guide of when and where to use these modes can be found in the Measurement Modes section.

  • Page 51: Dynamic Modes 1

    10.6.2 Dynamic Modes 1 & 2 A Dynamic mode collection provides a fast and precise method to collect large numbers of synchronised readings for post processing once a collection is complete (see Dynamic Modes). All OrbitModules connected to an OrbitNetwork must be capable of Dynamic or Dynamic 2, represented by the OrbitModule fields DynamicCapable and Dynamic2Capable.
  • Page 52 C# (.NET) // Configure Dynamic // Enable Dynamic // Prepare Dynamic Orbit.StartAllDynamic(); // Give dynamic a chance to read System.Threading.Thread.Sleep(1000); Orbit.StopAllDynamic(); // Print number of readings Console.WriteLine(Orbit.Networks[NETINDEX].Dynamic.DynamicData.ReadingCount.ToString()); If CollectionSize has been configured to a non-zero positive number, then the collection will complete once the correct number of syncs has been reached or if StopAllDynamic() is called.

  • Page 53: Dynamic External Master Mode

    To check a collection's error state see the Dynamic.DynamicData.CollectionStatus property. If a collection completes without errors, the collected data is made available. This data is stored under Dynamic.DynamicData[ModuleIndex, ReadingIndex] for readings in units of measure and Dynamic.DynamicData.GetReadingInCounts(ModuleIndex, ReandingIndex) for counts. C# (.NET) // Configure Dynamic // Enable Dynamic...

  • Page 54: Buffered Mode

    10.6.3 Buffered Mode Buffered Mode section for more details about this mode. Buffered mode allows OrbitModules to be individually enabled in any order by modifying OrbitModule.Buffered.Enable to true. Once the OrbitNetwork is configured, Buffered mode enabled OrbitModules can be started at the same time with the OrbitNetwork.Buffered.Start() command. The enabled OrbitModules shall then start to take readings at their set intervals (see ModuleBufferedBase.OTUs in the OrbitLibrary Code...
  • Page 55 Console.WriteLine("\t" + index + "\t" Orbit.Networks[NETINDEX].Modules[moduleTwo].Buffered.BufferedData[index].Reading.ToString()); C++ (COM) OrbitNetworkPtr OrbNet = Orbit->Networks->get_Item( NETINDEX); OrbitModulesPtr OrbModules = OrbNet->Modules; OrbitModulePtr Module0 = OrbModules->get_Item(0); OrbitModulePtr Module1 = OrbModules->get_Item(1); Module0->Buffered->Mode = eBufferedMode.Sync; Module0->Buffered->ReadingInterval = 100000; Module0->Buffered->Enable = true; Module1->Buffered->Mode = eBufferedMode.Sample; Module1->Buffered->Enable = true; OrbNet->Buffered->Start();...

  • Page 56: Difference Mode

    10.6.4 Difference Mode If DifferenceModeCapable, an OrbitModule may be enabled into Difference mode by setting Orbit.Module.Difference.Enable to true. Enabled Difference mode OrbitModules can then be started into reading in Difference mode with a call to OrbitNetwork.Difference.Start(). Results are read with OrbitNetwork.Buffered.ReadDifference().

  • Page 57: Orbit Library Test

    11 ORBIT LIBRARY TEST 11.1 INTRODUCTION The Orbit Library Test program has been developed as a functional example to help ease users into working with the Orbit Library. Included is clearly commented source code written to provide reference, as well as simple, clean examples of interfacing to an Orbit3 Measurement System.
  • Page 58  Orbit Module Interfacing ● Module Information ● Module Capabilities Listing ● Traditional Reading  Units of Measure  Counts ● Module Type Specific Configuration  DP  LT  LTH  AIM  DIM  DIOM  DIOM2  EIM ...

  • Page 59: User Guide

    OrbitLibraryTest\ folder in the Orbit3 Support Pack for Windows installation directory: i.e. C:\Program Files\Solartron Metrology\Orbit3 Support Pack for Windows Ensure there are no other applications running which are connected to Orbit and run OrbitLibraryTest.exe to start the application.

  • Page 60: Usage

    11.3.2 Usage The screen shots displayed below illustrate and explain the different areas and functions of user interface elements. 11.3.2.1Server Tab The status bar will be updated when the Library Test is performing a task. 502989 - Orbit3 Software manual Issue 32 Page 60 of 117...

  • Page 61: Network Tab

    Once connected to Orbit: 11.3.2.2Network Tab 502989 - Orbit3 Software manual Issue 32 Page 61 of 117...

  • Page 62: Module Tab

    11.3.2.3Module Tab The following displays the module tab with only the generic controls visible. 502989 - Orbit3 Software manual Issue 32 Page 62 of 117...
  • Page 63 Differing module types have specialist configuration options. These options are only visible when a module of the correct type is selected. 11.3.2.3.1 Resolution and Averaging Configuration Only available for DPs, AIMs and LT/LTH laser products; allows configuration of a module's resolution and averaging. 11.3.2.3.2 Pre-set Configuration 11.3.2.3.3 EIM Configuration 502989 - Orbit3 Software manual...
  • Page 64 11.3.2.3.4 DIM Configuration 11.3.2.3.5 LE Configuration 11.3.2.3.6 LT Configuration Only available for the LT: provides the Laser Beam On/Off control. 11.3.2.3.7 LTH Configuration Only available for the LTH: Only available for the LTH: Only available for the LTH: Only available for the LTH: Only available for the LTH: Only available for the LTH: Only available for the LTH:...
  • Page 65 11.3.2.3.8 Confocal Configuration Only available for confocal. Configures the Integration, Bright, Averaging and Read Mode settings. Displays Channel B reading. Channel A reading is returned via the main Reading panel. 11.3.2.3.9 DIOM Configuration Only available for DIOM products: allows configuration of a module's Input and Output pins and Input pin debounce time.
  • Page 66 11.3.2.3.10 DIOM2 Configuration Only available for DIOM2 products: allows configuration of a module's Input and Output pins and Input pin debounce time. 502989 - Orbit3 Software manual Issue 32 Page 66 of 117...

  • Page 67: Read Burst Mode Tab

    11.3.2.4Read Burst Mode Tab Only displayed when a Read Burst capable module and network is selected. 502989 - Orbit3 Software manual Issue 32 Page 67 of 117...

  • Page 68: Dynamic Mode Tab

    11.3.2.5Dynamic Mode Tab Only displayed when a Dynamic or a Dynamic 2 capable module and network configuration is selected. 502989 - Orbit3 Software manual Issue 32 Page 68 of 117...

  • Page 69: Difference Mode Tab

    11.3.2.6Difference Mode Tab Only displayed when a Difference mode capable module is selected. 502989 - Orbit3 Software manual Issue 32 Page 69 of 117...

  • Page 70: Buffered Mode Tab

    11.3.2.7Buffered Mode Tab Only displayed when a Buffered mode capable module is selected. 502989 - Orbit3 Software manual Issue 32 Page 70 of 117...

  • Page 71: Ref Mark Mode Tab

    11.3.2.8Ref Mark Mode Tab Only displayed when a Ref Mark mode capable module is selected. 502989 - Orbit3 Software manual Issue 32 Page 71 of 117...

  • Page 72: Results Window

    11.3.2.9Results Window 502989 - Orbit3 Software manual Issue 32 Page 72 of 117...

  • Page 73: Source Code

    11.4 SOURCE CODE This section contains the technical details of the Library Test. This will include a partial walk through of the source code and steps towards familiarisation and navigation. 11.4.1 Development Tools The Library Test is written in C# for the Microsoft .NET 3.5 Framework and has been tested on 32bit and 64bit variants of XP, Vista and Windows 7.
  • Page 74 Note; Visual Studio may try and convert the project file depending on the version of Visual Studio the project was created with to the current version being used. Follow the conversion wizard's instructions and the project should open correctly. 502989 - Orbit3 Software manual Issue 32 Page 74 of 117...

  • Page 75: Compiling

    11.4.2.1Compiling In its initial state, the library test needs compiling before it can be run from the source code. This should be as simple as opening the 'solution' file in visual studio and clicking 'Build'. 11.4.2.2Running The application can be run from the same menu, or can be run from Windows Explorer from the bin/ directory in the Library Test's project directory.

  • Page 76: Navigating The Source Code

    11.4.3 Navigating the Source Code It is recommended that the source code is in a compiled state before opening any of the designer files (GUI files; forms user controls); in order to render certain parts, the designer requires them to be compiled. 502989 - Orbit3 Software manual Issue 32 Page 76 of 117...
  • Page 77 Once the Library Test is compiled and can run, the project is in a good position to be explored. The Library Test consists of a Windows Form form control containing a menu strip bar, a status bar and a tab container control. There is a tab for the Orbit server, network and module, as well a tab for each mode, Read Burst, Dynamic, Buffered, Difference and Ref Action.
  • Page 78 Next navigate the tab container and identify the user control which contains the area of interest. Note down the type on the control and select the UserControl type from the solution explorer. The user control should now be loaded into the windows forms designer. Locate the button that interests you and double click it.
  • Page 79 The source for the user control should open in the C# text editor, and the text cursor will be on the line of the button event handler. The code within the function provides an example on how to call that particular Orbit command. 502989 - Orbit3 Software manual Issue 32 Page 79 of 117...

  • Page 80: Module Specific Operation

    12 MODULE SPECIFIC OPERATION There are many Orbit Library commands that are specific to particular Orbit Modules. Also, newer Orbit features may not be available on some of the older Modules. See Orbit Compatibility Roadmap - Modules for details. 12.1 DIGITAL PROBE (DP) 12.1.1 Introduction All digital probe products are treated the same by the Orbit Library.

  • Page 81: Programmable Electrical Measurement Bandwidth

    12.1.3 Programmable Electrical Measurement Bandwidth This provides digital filtering of the Module readings. The update rate is reduced as the averaging is increased. The Measurement bandwidth of the Module is programmable by setting the Number of Averages of the Measurement cycle as below (change using the Module's Averaging property).

  • Page 82: Analogue Input Module (Aim)

    12.2 ANALOGUE INPUT MODULE (AIM) The AIM has similar functionality to the Digital Probe Module, therefore it is compatible with nearly all Orbit Library members, including Averaging and Resolution. For module readings, we recommend the ReadingInUnits property. This greatly simplifies taking scaled readings from the probe. 502989 - Orbit3 Software manual Issue 32 Page 82 of 117...

  • Page 83: Air Gauge Module (Agm)

    12.3 AIR GAUGE MODULE (AGM) 12.3.1 Introduction The AGM module provides air gauging functionality to the Orbit Network. It has similar functionality to a Digital Probe. After mastering it is read in the same way as a Digital Probe and therefore supports nearly all Orbit Library Members. For applications that use the Orbit Library, readings are converted to mastered readings automatically.
  • Page 84 Code Description No error 9000 Failed to load the Orbit Library 9001 Failed to connect to Orbit 9002 No Orbit networks found 9003 Failed to find the network specified on the command line 9004 Failed to find the module specified on the command line 9005 Mastering cancelled by the user.

  • Page 85: Implementing Mastering

    12.3.2.3 Implementing Mastering This section is only required if you need to implement your own non Orbit Library solution. class makes the properties and methods below available for OrbitModuleAGM mastering: Properties: MasterMinReadingInUOM The read value at the minimum set point e.g. 35mm.
  • Page 86 9. Use the formula below to evaluate the pressure offset to allow for the end- bands (explained below). 0.03 =( P −P )∗( Offset MasterMaxReadingInUOM −MasterMinReadingInUom 10. Assign to the property the pressure value sampled. MasterMinPressure 11. Assign to the property the pressure value sampled.

  • Page 87: Agm Module Additional Properties And Methods

    12.3.3 AGM Module Additional Properties and Methods In addition to the mastering properties and settings above, the OrbitModuleAGM class provides the properties and methods below to configure AGM specific settings. Properties: DisplayUnitsOfMeasure The units of measure of the AGM display (mm, inch or mils).

  • Page 88: Linear Encoder (Le)

    12.4 LINEAR ENCODER (LE) 12.4.1 Introduction The Linear Encoder is an incremental, high accuracy measurement module. This module does not support dynamic or buffered modes. Readings are returned via the ReadingInUnits property. 12.4.2 Linear Encoder & Reference Mark All Linear Encoders are incremental in reading; they lose their datum on power down. A reference mark is provided in order to provide an absolute datum.

  • Page 89: Encoder Input Module (Eim)

    12.5 ENCODER INPUT MODULE (EIM) 12.5.1 Introduction The Encoder Input Module (EIM) is an Orbit Module which can interface to incremental and rotary encoders with square wave outputs, allowing these sensors to be interfaced into the Orbit Measurement System. Using rotary encoders via the EIM in conjunction with linear measurement sensors allows the Orbit Measurement System to perform part profiling.
  • Page 90 502989 - Orbit3 Software manual Issue 32 Page 90 of 117...

  • Page 91: Digital Input Output Module (Diom)

    12.6 DIGITAL INPUT OUTPUT MODULE (DIOM) 12.6.1 Introduction The Digital Input / Output Module (DIOM) enables the ‘Orbit Network’ to interface with the outside world. The module provides 8 general purpose input / output lines. Each line can be individually configured as Input or Output. The OrbitLibrary has (since V1.2.0.6 - 2016) specific properties for the DIOM Pins to ease usage.

  • Page 92: Set Outputs

    12.6.6 Set Outputs The DIOM pin needs to be configured as an output for a meaningful result to be obtained. Use the Pin.OutputPinState property to read, e.g. DIOMmoduleInstance.Pins[4]. OutputPinState = eDiomIoPinState.low Sets the state of Pin 4 to low. Note that a DIOM pin in output mode set high is equivalent to a DIOM pin set in Input state.

  • Page 93: Diom Operation Example

    12.6.8 DIOM operation example In the example below, Port 1 (bit 1) is driving a load and Port 0 (bit 0) is an input to a switch. No other port is used in this example. All example input states are read back correctly except the last, where Port 1 (bit 1) output driver is switched ON, causing a false input state to be read by the Port 1 input buffer.
  • Page 94 The 8 least significant bits of the 32-bit number are used to set the output pins. A logic Low (0) will turn the output driver ON; The output pin will be set Low (0 V). A logic High (1) bit will turn the output driver OFF; the pin will be pulled up to Orbit +5 V via 4K7 and series diode or external load if connected.

  • Page 95: Digital Input Output Module V2 (Diom2)

    12.7 DIGITAL INPUT OUTPUT MODULE V2 (DIOM2) 12.7.1 Introduction The Digital Input / Output Module V2 (DIOM2) is an enhanced version of the DIOM. Rather than have configurable I/O, it has fixed inputs and outputs and has improved functionality over the DIOM. The module provides: 4 general purpose output lines •...

  • Page 96: Inputs

    0 (active low) 1 (active high) 1 (active high) Examples an output polarity mask set to 0 would set all outputs to be active low (i.e. if the pin • is activated low, the output pin state is high) an output polarity mask set to 0x0f (00001111b) would set all outputs to be active •...

  • Page 97: Diom2 Pin Members

    Pins (a collection of OrbitModuleDIOMPin classes – one for each pin – 10 in total) • ◦ Pins are assigned as: Pins[9] Pins[8] Pins[7] Pins[6] Pins[5] Pins[4] Pins[3] Pins[2] Pins[1] Pins[0] Input6 Input5 Input4 Input3 Input2 Input1 Output4 Output3 Output2 Output1 ◦...

  • Page 98: Improving Reading Integrity

    12.7.9 Improving Reading Integrity When reading external inputs, it is wise to issue multiple reads to help reduce the effects of: External electrical interference • Switch bounce • Noisy supplies • Mechanical vibration • Otherwise, a single read may miss the event or may even just see noise. The DIOM2 has a built in debounce functionality designed to filter out spurious readings.

  • Page 99: Digimatic Interface Module (Dim)

    12.8 DIGIMATIC INTERFACE MODULE (DIM) 12.8.1 Introduction The Digimatic Interface Module is designed to connect to any Digital Gauge with a Digimatic code output. The connection to the gauge is via a 10 way male connector, which will connect to any Mitutoyo Digimatic compatible gauge plug. The reading mode can be continuous, triggered via the gauge data switch or triggered from software.

  • Page 100: Laser Triangulation Sensors (Lt & Lth)

    12.9 LASER TRIANGULATION SENSORS (LT & LTH) The Laser Triangulation Sensors provide non contacting measuring to be integrated into the Orbit Network. There are two types available: LT – Entry level product. • See the separate user leaflet (503145), supplied with the product, for •...

  • Page 101: Confocal Module

    12.10 CONFOCAL MODULE The confocal system is based off reflected light and therefore has properties that can be configured to enable users to get the best reading possible from the device. 12.10.1 Optimising settings To optimally use the confocal system you want the signal bar to be approximately half to two thirds of the way up when in range on a target, its important to note that due to the nature of the technology signal strength will vary slightly with position and signal saturation will result in loss of accuracy.

  • Page 102: Read Second Channel In Units

    It should be noted that the bandwidth is affected by the read mode and the integration time and averaging , this should be considered when selecting the level of averaging. There are 9 possible averaging values that can be selected incrementing in powers of 2 from (average1 to average256) defined in eAveraging.

  • Page 103: Wireless Connection Module (Wcm)

    12.11 WIRELESS CONNECTION MODULE (WCM) The WCM enables Wireless handtool devices to be connected to the Orbit system. See the Orbit3 Module Manual for WCM installation, configuration and operational • details. The WCM Module class in the OrbitLibrary has various properties and methods, as summarised, next: Refer to the OrbitLibrary Code UML Diagram...
  • Page 104 Reading a device on the WCM will trigger a connection to that device from the • WCM (unless already connected). To read all channels for a device: • OrbitChannelReadings rdgs = OrbitModuleWCM.Devices[<DeviceIndex>].ReadAllChannels(ControlCode, UOM) To read specific channels of a device, use a Channel Mask •...
  • Page 105 For tagged readings: Tag number is the tag assigned to this reading • ◦ Note that this will be the same for all channels on this device. Note that if a standard Orbit read (e.g. ReadInCounts, ReadInUnits) is requested from the WCM module itself (which has no reading), zero is returned, rather than an error.

  • Page 106: Settings Class

    ◦ A reading exceeding this maximum value will return a “Reading Overflow” error. In this case, use the Single precision number (floating point) method. ◦ Example: 10mm stroke = 393.7 mils. In UOM of mils, the reading would overflow above the 5.45mm reading point. 4 byte Single precision number (floating point) –...
  • Page 107 //CAST settings class for WHT WCM_DeviceSettings_WHT Settings = (WCM_DeviceSettings_WHT)OrbitModuleWCM.Devices[<DeviceIndex>].Settings; //Enter Config mode, change setting(s) and Exit Config mode Settings.ConfigMode = true; [change other settings] Settings.ConfigMode = false; else if (OrbitModuleWCM.Devices[<DeviceIndex>].Type == eWCM_DeviceType.WHT_M) //CAST settings class for WHT-M WCM_DeviceSettings_WHTM Settings = (WCM_DeviceSettings_WHTM)OrbitModuleWCM.Devices[<DeviceIndex>].Settings;...

  • Page 108: Tagged Readings Example

    12.11.3 Tagged readings Example For this function, the devices must be configured to provide tagged readings when pressing a button – refer to WCM Device Configuration Settings in the Orbit Module manual. User software should first request current tagged reading from the WCM to obtain the current ‘Tag number’.

  • Page 109: Orbit Error Codes And Error Handling

    13 ORBIT ERROR CODES AND ERROR HANDLING 13.1 GENERAL When communicating with the Orbit Library, errors are returned via exceptions. Errors can be broken down into the following sections: Orbit Library Errors • The information passed to the Library is incorrect or not in the required format – or the requested function is not allowed in the current state.

  • Page 110: No Probe Error

    13.3.4 No Probe Error Dp only This error is generated if the probe has been disconnected from its PIE module. Probe disconnect detection. 13.4 MODULESTATUS This object is used to read the module's status and error conditions (e.g. under and over range for a DP / LT / LTH / AIM / AGM).

  • Page 111: Orbit Errors

    13.5 ORBIT ERRORS Value Value Error Description (Hex) (Decimal) NoError No Errors On the orbit Module Controller is current limiting! PSIM ORBIT_5V_CURRENT_LIMIT required or short on network ORBIT_5V_LOW Orbit Low Voltage - PSIM required Warning Orbit Supply voltage is too ORBIT_5V_HIGH high BLOCK_CHECKSUM_ERROR...
  • Page 112 (Legacy) Broadcast Address 0 Expected ADDR_NA 8453 (Legacy) Address Change not allowed (in ADDR_CH_NA 8454 difference/buffered or dynamic mode) WRONG_MODE 8455 Cal Mode Pin High (Legacy) No Calibration Table - Probe NO_CALTABLE 8456 uncalibrated Reading Missed - New Adc cycle MISSED_RDG 8457 started before previous reading read...
  • Page 113 SAMPLE_RUNNING 8529 Buffered Sample Running AVERAGE_NOT_VALID 8544 Average Not Valid AVE_CHANGE_NOT_ALLOWED 8545 Average Change Not Allowed RESOLUTION_NOT_VALID 8546 Resolution Not Valid RESO_CHANGE_NOT_ALLOWED 8547 Resolution change not allowed PROBE_SET_TO_HI_RES 8548 Probe set to High Resolution PROBE_SET_TO_LO_RES 8549 Probe Set to Low Resolution NOT_IN_NORMAL_MODE 8550 Not in Normal Mode...

  • Page 114: Appendix A - Orbit Compatibility Roadmap

    INCORRECT_COMMAND_FORMAT 8696 Incorrect command format COMMUNICATIONS_ERROR 8697 Communications Error Over And Under Range (Difference OverAndUnderRange 65537 Mode) Unknown 65538 Unknown error 14 APPENDIX A - ORBIT COMPATIBILITY ROADMAP The Orbit system has evolved over the years and it is now in its third generation. Some features will only be available with newer hardware and some features have been removed over time.

  • Page 115: Module Compatibility

    14.1.2 Module Compatibility The Orbit Library handles compatibilities of all versions of each Module type, from Orbit1 through to present day. The table below details which features are available with the various Modules and legacy products. Where Orbit Modules are denoted by a number, i.e. '1' denotes Orbit1 Modules •...

  • Page 116: Module Release History

    14.1.3 Module Release History This section details when particular Modules were introduced. Orbit1 DP, LE, DIOM Orbit2 DP, LE, DIOM, AIM, EIM, DIM Orbit3 DP, LT, LTH, LE, DIOM, AIM, AGM, EIM, DIM, DIOM2, WCM 14.2 CONTROLLERS & SOFTWARE The following Orbit Controllers are all compatible with the Orbit Library. USBIM MK2 RS232IM RS485IM...

  • Page 117: Revision History

    15 REVISION HISTORY REVISION DATE COMMENTS 16/06/11 Initial Issue 30/09/11 References to .NET updated 14/11/12 Linear Encoder (LE) added 20/05/13 Orbit high performance Laser Triangulation (LTH) added 23/10/13 Added setting of default Averaging & Resolution 04/11/13 LT & LTH Laser beam on/off added 22/11/13 Wireless Interface Module (WIM) added 09/03/15...

Table of Contents