Nikon Metrology API v3.7 - Reference Manual

Nikon Metrology Handheld API Reference Manual Version 3.7

Copyright Nikon Metrology

All rights reserved

This publication or parts thereof may not be reproduced in any form, by any method, for any purpose.

Metris and the Metris logo are registered trademarks of Nikon Metrology N.V.

Products that are referred to in this document may be either trademarks and/or registered trademarksof the respective owners.

Nikon Metrology N.V. or any of its group companies (Nikon Metrology) make no claim to thesetrademarks.

The use of these Nikon Metrology products, services and materials is subject to the Nikon MetrologyGeneral Sales Terms and Conditions.

Contents1 Scope..........................................................................................................................................................42 Scanner / Localizer configurations.............................................................................................................53 Scanning operational considerations .........................................................................................................64 Hardware description..................................................................................................................................7

4.1 The MMDx Scanner....................................................................................................................74.2 The MMCx Scanner....................................................................................................................94.3 The LC60Dx Scanner................................................................................................................10

5 Hardware configuration............................................................................................................................125.1 Localizer configuration..............................................................................................................13

5.1.1 K-Series .....................................................................................................................135.1.2 MCA II (Romer Cimcore Infinite 2.0) ......................................................................145.1.3 MCAx (Romer-Cimcore Absolute)............................................................................155.1.4 Faro.............................................................................................................................15

5.2 Scanner configuration................................................................................................................165.2.1 MMDx configuration..................................................................................................175.2.2 MMCx configuration..................................................................................................205.2.3 LC60Dx configuration................................................................................................20

5.3 Qualification..............................................................................................................................205.3.1 Qualification procedure..............................................................................................21

6 Upgrading scanner firmware....................................................................................................................27

Handheld API 3.7

1 Scope

Thismanual concerns the hardware and configuration involved in the hand-held scanners supportedby Nikon Metrology. The figure below shows the various components of a hand-held scanningsystem.

Figure 1: Schematic representation of the components of a hand-held scanning system

Scanner: the scanners supported are described in Hardware description on page 7. In eachcase information regarding the measurement range and the stripe width is provided. Full detailson the scanners can be found in the corresponding documentation provided.

Interface kit : this is a device that connects a particular scanner with a particular localizer. Fulldetails on the interface kit can be found in the corresponding documentation provided.

Localizer : the localizers that can be used in combination with the supported scanners are listedin Scanner / Localizer configurations on page 5. Full details on the localizers can be found inthe corresponding documentation provided.

Driver : the driver software allows the scanner / localizer combination to communicate with thescanning software. It is the subject of this manual. All the instructions on the use of the HandheldAPI to configure the scanner with the localizer and to perform a qualification procedure aredescribed in the chapter Hardware configuration on page 12.

Scanning software : full details on the operation of the scanning software can be found in thecorresponding software manual.

page-4

Nikon Metrology

2 Scanner / Localizer configurations

The supported Scanners and Localizers and their compatibility are listed in the table below.Table 1: Scanner - Localizer compatibility

LC60DxMMCxMMDxLocalizer

MCAx 7 axis

MCA II 7 axis

K-Series (K600 and K610)

Faro 7 axis (Titanium, Platinum, Fusion)

Cimcore 7 axis Infinite 1.0

Cimcore 7 axis Infinite 2.0

Romer-Cimcore Absolute 7 axis

Notes6 axis arms are not supported.Full details on each of the scanners and the localizers can be found in their correspondingdocumentation. Information on measurement parameters and set up instructions are given inHardware description on page 7.

Required FirmwareMMDx and MMCx : Firmware version 2.0.28.226 or higher.LC60D: Firmware version 2.0.30.2218 or higher.See the procedure for updating the firmware on page 27.MCAx and Romer-Cimcore Absolute 7 axis : RDS 3.3.1 : Firmware 016MCA II and Romer - Cimcore 7 axis Infinite 2.0 :WinRDS 7.1.5RC1 : Firmware Version 6.Faro : Faro USB driver version 5.6.5.3K-Series : K-CMM v7.0.1.47110 ; K-Interface 3.1.27.46970

page-5

Handheld API 3.7

3 Scanning operational considerations

Care should always be taken when using hand-held scanners and users should be aware of thesafety manual shipped with the product.

The Nikon Metrology scanner is a precision optical measuring instrument, and should be treatedwith care. The scanner has been designed to withstand a typical shop-floor environment,nevertheless, there are certain precautions that should be taken when using it:

• Do not drop the scanner.• Do not touch the optical windows on the front of the scanner.• Do not attempt to dismantle the scanner. Doing so will invalidate the warranty.• Do not allow the scanner to be covered in any liquid.• Do not expose the scanner to extremes of temperatures.• Do not look directly into the beam or view with an optical instrument - laser light is emitted

from the indicated aperture.

page-6

Nikon Metrology

4 Hardware description

This following information is provided for each of the supported scanners:

• Measurement parameters including the measurement range and the stripe width. (Full detailson all the characteristics of the scanners can be found in the corresponding hardwaredocumentation.)

• The procedure to set up the scanner, the localizer and connect with the scanning software.

4.1 The MMDx Scanner

Full details about theMMDx scanner characteristics can be found in the hardware documentation.

The Localizers that can be used with theMMDx scanner are listed in Table 1: Scanner - Localizercompatibility on page 5.

SpecificationsThe table below lists the scanner measuring characteristics for each of the scanners in theMMDxrange. These characteristics are shown in Figure 2: MMDx specifications on page 7.

Table 2: MMDx Specifications

MMDx200MMDx100MMDx50Specification

11010095Start measuring range (mm)

15010050Measuring range (mm)

20010050Stripe width (mm)

Figure 2: MMDx specifications

page-7

Handheld API 3.7

Hardware set-up1. Set up the localizer, according to the instructions given in the manual provided.2. Mount the scanner on the localizer according to the instruction provided with the interface

kit.3. Power up the localizer before starting the ModelMaker hardware set-up.4. Power up the scanner.

There are two LEDs on the rear of the scanner. While booting both LEDs are red. When thebooting is complete, the upper LED (power) is green and the lower LED (laser) blinks green.

When booting is complete, the scanner will be able to communicate with the PC.5. Connect the scanner cable to the Ethernet port of the PC.

The Power LED will be on continuously when the connection is established.

Trouble shootingLEDs on the back of the scanner remain red: If the upper LED is not green and the lowerLED does not blink green, then the scanner has not booted.This may be caused by the scanner being stuck in the so-called “upgrade firmware” mode. Tocheck this:1. Make sure the scanner is connected to the PC.2. Type the following IP address into an Internet Explorer window:

192.168.1.70 (for MMDx and MMCx scanners)192.168.1.71 (for an LC60Dx scanner).

The scanner web interface page will appear.3. The [Reboot to applic] button should be available

This is a confirmation that the scanner is in upgrade firmware mode(and can therefore not be used for normal scanning). Note that the

[Reboot to applic]available

scanner will automatically start up in this “upgrade firmware” modeafter failing 3 times to boot in the normal mode.Click on this [Reboot to applic] button.

- The scanner will then reboot into normal mode and after60seconds the green lights should be on again and the scanner isready for scanning.- If this operation fails, switch off the scanner and contact NikonMetrology support.

Switch off the scanner and contact Nikon Metrology support.[Reboot to applic]NOT available

No Connection between the Scanner and the PC: This could be due to the following :

page-8

Nikon Metrology

1. CablingCheck all the cabling between the scanner and the PC and on the power supply.

2. FirewallCheck that the connection can not be made because it is being blocked by a Firewall.

3. Incorrect IP address for the scannerThe Scanner needs a fixed IP address. In the Internet Protocol (TCP/IP) Properties dialog,accessible from the PC network connection parameters on the Control Panel, make sure thatthe option Obtain an IP address automatically is set OFF.

Choose the option Use the following IP address and set the IP address to be 192.168.1.60The last set of digits can be any number between 1 and 255 except 70 or 71. It is recommendedthat you use 60.

4.2 The MMCx Scanner

Full details about theMMCx scanner characteristics can be found in the hardware documentation.

The localizers that can be used with the MMCx scanner are listed in Table 1: Scanner - Localizercompatibility on page 5.

SpecificationsThe table below lists the scanner measuring characteristics for each of the scanners in theMMCxrange. These characteristics are shown in Figure 3: MMCx specifications on page 10.

Table 3: MMCx Specifications

MMCx160MMCx80Specification



16080Stripe width (mm)

page-9

Handheld API 3.7

Figure 3: MMCx specifications


kit.3. Power up the localizer before starting the ModelMaker hardware set-up.4. Power up the scanner.5. When booting is complete, connect the scanner to Ethernet port of the PC.For additional information see Trouble shooting on page 8.

4.3 The LC60Dx Scanner

Full details about the LC60Dx scanner characteristics can be found in the hardware documentation.

The localizers that can be used with the LC60Dx scanner are listed in the Table 1: Scanner -Localizer compatibility on page 5.

SpecificationsThe table below lists the scanner measuring characteristics for the LC60Dx scanner. Thesecharacteristics are shown in Figure 4: LC60Dx specifications on page 11.

Table 4: LC60Dx Specifications

LC60DxSpecification



60Stripe width (mm)

page-10

Nikon Metrology

Figure 4: LC60Dx specifications


kit.3. Connect the scanner cable to the Ethernet port of the PC.4. Power up the localizer.5. Power up the scanner.

There are two LEDs on the rear of the scanner. While booting both LEDs are red. When thebooting is complete, the left LED (power) is green and the right LED (laser) blinks green.When booting is complete, the scanner can be connected to the Ethernet port of the PC.

For additional help see Trouble shooting on page 8.

page-11

Handheld API 3.7

5 Hardware configuration

This section describes how to use the Handheld API Version 3.7 to configure your scanner, yourlocalizer and to perform a Qualification procedure.

Accessing the Handheld API

The Handheld API can be accessed from your scanning software. Follow the steps to configurethe hardware - referring to the software manual if necessary.

Eventually you should open the Hardware Configuration dialog as shown below.

TheHardware Configuration dialog contains three buttons on the left side : Localizer, Scannerand Qualification. Clicking on each of these enables you to configure your hand held scanningset up.

• Localizer

The configuration for the following localizers are described:

• K-Series on page 13.• MCA II (Romer Cimcore Infinite 2.0) on page 14.• MCAx (Romer-Cimcore Absolute) on page 15.• Faro on page 15.

(See Table 1: Scanner - Localizer compatibility on page 5 for information on the compatibilitybetween localizers and scanners.)

• Scanner

The configurations for the following Scanners are described:

• MMDx configuration on page 17.• MMCx configuration on page 20.• LC60Dx configuration on page 20.

(See Table 1: Scanner - Localizer compatibility on page 5 for information on the compatibilitybetween localizers and scanners.)

page-12

Nikon Metrology

• Qualification

The Qualification procedure on page 20 describes the complete qualification process for allscanner / localizer combinations.

5.1 Localizer configuration

The Localizer configuration function provides you with tools to view diagnostic information andconfigure the localizer.

5.1.1 K-Series

DiagnosticsThe Diagnostics tool provides information about the currently selected localizer. This informationshould be used when requesting support.

Driver Information: displays information about the Driver Description, the Driver version, andthe K-CMM Version.Device information: displays the following information on the K-Scan system:

Camera serial number : the serial number of the camera.K-Scan serial number : the serial number of the K-Scan probe.Maximum scan rate : the maximum scan rate.SpaceProbe serial number : the serial number of the SpaceProbe.SpaceProbe tip number : the number of the currently mounted tip. This number is stored in achip inside the probe adapter and is also stamped on the outside of the adaptor. The softwarereads the tip number of the current probe and automatically loads the corresponding calibrationfile for that tip.SpaceProbe tip diameter : the diameter of the tactile probe tip.Number of LEDs : the total number of active LEDs on the whole system. This includes theLEDs on both the Space Probe and the K-Scan probe, as well as any additional "external"LEDS that you may have glued to the system.

page-13

Handheld API 3.7

5.1.2 MCA II (Romer Cimcore Infinite 2.0)


Driver info : displays version information about :

Driver VersionWinRDS VersionRXXC VersionXDAT Version

Arm info : displays the following information on the currently active localizer arm:

Arm Type : the localizer arm type.Serial Number : the localizer serial number.Runcode : the runcode version number.USB Firmware : the USB firmware version number.

Active probe info: displays the following information on the currently active probe:

Number : the identification number of the currently connected probe.Autodetect : when the Autodetect function is checked, probe calibration data will loadedautomatically if the identification number of the connected probe can be detected. This ispossible if the identification number is programmed in a chip inside the probe. If theidentification number can not be detected, uncheck this option and set the probe number tothe required value manually.Type : the type of probe. This is most commonly a ball.Diameter : the calibration method used.[Activate] : this option is used if the Autodetect option is off. It activates the probe that hasbeen manually selected.[Calibrate] : starts a calibration procedure. Refer to the MCAII hardware manual for moredetails.

[Profile Settings] : refer to the MCAII hardware manual for more details.[Special Functions] : refer to the MCAII hardware manual for more details.

page-14

Nikon Metrology

5.1.3 MCAx (Romer-Cimcore Absolute)


Driver info : displays version information about :

Driver VersionRDS Version

Arm info : displays the following information on the currently active localizer arm:

Arm Type : the localizer arm type.Calibration date : the time and date when the localizer arm was calibrated.Firmware : the firmware version number.

Probe info: displays the following information on the currently active probe:

Probe Name : the name of the currently connected probe.Probe Type : the type of probe. This is most commonly a ball.Tip Diameter : the diameter of the probe tipCalibration Date : the date on which the probe was last calibrated.Calibration Result : this is a status code for the calibration of the probe. It is not an indicationof the accuracy of the calibration.[Calibrate] : starts a calibration procedure. Refer to the MCAx hardware manual for moredetails.[Refresh] : this button can be used to refresh the diagnostics information after changes - whena new probe has been activated for example.

5.1.4 Faro


page-15

Handheld API 3.7

Driver info : displays information about :

Description : description of the driver,Version : version of the driverFARO USB Driver Version : the version of the FARO USB Driver

Active arm info : displays the following information on the localizer arm that is currently used:

Type : localizer typeSerial No : the localizer serial numberJoints : number of JointsCalibration Date : the date when the arm was calibrated (mm/dd/yyyy)Certification Date : the date when the arm was certified (mm/dd/yyyy)

Active probe info : displays the following information on the currently active probe:

Type : the type of probe.Name : the name of the probe.Radius : radius of the probe.Calibration Date : the date when the probe was calibrated (mm/dd/yyyy).Two sigma : the two sigma value of the calibration.Max. error : the maximum error of the calibration.

[FARO diagnostics] : clicking on this button will start the diagnostics of your FARO localizer.Consult your FARO localizer documentation for more information.[Select probe...] : clicking on this button will start the FARO probe dialog box. Consult yourFARO localizer documentation for more information.Use scan mode during probe calibration : this allows you to use the scan mode during probecalibration.

5.2 Scanner configuration

The Scanner function provides tools used to configure the scanner.

page-16

Nikon Metrology

5.2.1 MMDx configuration

The Scanner configuration function consists of (3) tools: Laser, Field of View and Diagnostics.

Laser toolThe Laser tool enables you to configure the laser settings for the scanner. The following fieldsare displayed.

Laser Power : This slider enables you to view or set the laser power level. By default theAutomatic setting is enabled and it is recommended that you retain this. The Automatic optionadjusts the laser power for each point. Uncheck this option only if you need to set the laser powerlevels manually, by entering the required level using the slider or the input field. The 2D Previewassists in determining a suitable power level.Exposure : This allows you to set the exposure time. By default you should always use the lowestexposure time possible. However if setting the Laser Power level to a maximum does not producesufficient number of points, then you can increase the exposure time by entering the requiredlevel using the slider or the input field.

Note: Increasing the exposure time can reduce the accuracy, especially when rapidmovementsof the scanner are involved.

[Detect] : This button is used to detect the optimum values of Laser Power and Exposure for theobject to be scanned. This is based on the number of points required, as well as the material andthe colour of the object. This function only works if the Automatic option is not set.Reflection Filter : By default a filter is used during the scanning operation to remove the effectsof reflected light. Depending on the nature of the object being scanned, then may give rise toerroneous results, in which case you can check this option off, so that no points are filtered out.2D Preview: This provides a preview of the points that the scanner is currently seeing. The barat the side should be as shown in the screenshot above, i.e. coloured green with a high level. Ifthe bar is red, then the intensity is too high and too many points will be in saturation. If the levelof the bar is low, the laser power level is too low.Laser Profiles: These fields enable you to save, retrieve or delete a laser profile (configuration).

To save a laser profile: click on the [Save as] button and enter a name to identify the profile.To retrieve a saved profile : simply select it from the drop-down list.To delete a profile: select it from the drop-down list and click [Delete].

page-17

Handheld API 3.7

Field of View toolThis tool allows you to adjust the scanner field of view. The size of the field of view depends onthe scanner model and current scanner calibration. Reducing the field of view improves the speedof scanning, not the accuracy. It is useful if you only wish to scan a part of an object.

The Field of View panel displays the current scan rate of the incoming stripe data (frames persecond) which is calculated from the exposure time and the dimensions of the field of view, setusing the 'Y' and 'Z' sliders. In the screen shot above, where the Y slider is at a maximum(representing 1000 points) the scan rate is 51 frames ber second.'Y' slider : The 'Y' slider allows you to control the number of points along the stripe (Y direction).The number of points per stripe is automatically calculated depending on the options in thissection. The screen shot below shows the results of reducing the Y slider range to 50% whichresults in the Scan rate being doubled.

'Z' slider : The 'Z' slider allows you to control the active area of the scanner in depth (Z direction).

page-18

Nikon Metrology

The screenshot below shows the effect of reducing both the Y and the Z sliders to 50%.

Diagnostics toolThe Diagnostics panel provides information about the current scanner. This information shouldbe used when requesting support.

page-19

Handheld API 3.7

General: displays information about

Type : of scanner,Serial Number : of the scannerManufacturing Date : of the scanner (mm/dd/yyyy)

Firmware : displays version information about

FPGA : FGPA versionDriver : driver versionServer : scanner server version

5.2.2 MMCx configuration

The Laser tool is as described for theMMDx scanner on page 17.

The Diagnostics tool is as described for theMMDx scanner on page 19.

5.2.3 LC60Dx configuration

The Laser tool is as described for theMMDx scanner on page 17.

The Diagnostics tool is as described for theMMDx scanner on page 19.

5.3 Qualification

The Qualification procedure is a means of ensuring that your hand held laser setup (includingthe scanner, probe and localizer) will provide accurate results. It is highly recommended that youcarry out a qualification procedure each time a particular scanner is attached to the localizer oronce a week otherwise.

The Qualification process is based on scanning a qualification plate with a known calibratedwidth between the two white sides of the plate.

The Qualification procedure is part of the Hardware Configuration functionality that can beaccessed from your scanning software.

page-20

Nikon Metrology

Before starting a qualification, you must :

1. Set up the localizer and connect this to the scanner as described in the hardware descriptionsection on page 7.

2. Start up your scanning software.3. Follow the steps required in the software to access the Hardware Configuration dialog.4. Click on the Scanner button.5. Click on the Laser tool.6. Adjust the exposure time to the lowest possible value and check that the Automatic Laser

Power option is on.7. Click [Apply].8. Click on the Qualification button.

The Qualification panel displays the following :

Localizer: the localizer used during the last qualification,Scanner: the scanner used during the last qualification,Date: the date of the last qualificationStandard Deviation: standard deviation achieved during the last qualification.

9. Enter the calibrated width between two white surfaces of the plate to be used for thequalification. The width is displayed on the label on the white plate.

10. Click on the [Start Qualification...] button to the wizard that will guide you through thequalification procedure on page 21.

5.3.1 Qualification procedure

This procedure describes all the stages involved in performing a Qualification of a scanner /localizer setup. Before starting this procedure it is assumed that you have carried out all therequire preliminary steps on page 20.

The user is guided through the Qualification procedure by means of a wizard. At each stageinstructions are given about the measurements to be performed and once they are complete, thewizard automatically takes you to the next step. The Qualification wizards will issue a warningwhen:

page-21

Handheld API 3.7

• the scanner is moving either too fast or too slow,• the scanner is not oriented as required.

1. When the setup is ready for you to begin, follow the instructions on the screen.

2. Follow the instructions on the screen. When the measurement is complete, the wizard willautomatically continue to the next screen.


page-22

Nikon Metrology



page-23

Handheld API 3.7




page-24

Nikon Metrology



page-25

Handheld API 3.7

11. The Qualification procedure is complete. The results are displayed on the screen.

You can choose to accept the results if the deviation is acceptable. A very high conditionnumber is not good, since it implies that the deviation is unreliable. This may be due to poorresults during one of the stages in the Qualification procedure. If the results are stillunacceptable after repeating the procedure carefully, this may indicate a problem with thedevice and you should contact support at Nikon Metrology.

Loading and saving scanner qualification dataThe qualification information is stored on your PC immediately after a qualification has takenplace.When you change the scanner or localizer, the software will automatically load the most recentqualification available for that scanner and localizer based on their serial numbers.

Note: If the mount connecting the scanner to the localizer is removed or adjusted, a newqualification should be carried out.

page-26

Nikon Metrology

6 Upgrading scanner firmware

This procedure explains how to upgrade the scanner firmware via the web interface Application.The information in this document applies to MMDx, MMCx and LC60D scanners.

RequirementsTo order to carry out this procedure the following are required:• A scanner• Power supply for the scanner• PC with Ethernet connection to the scanner• New firmware version

Procedure to upgrade the Scanner firmwareNote: The screenshots shown in this procedure are illustrative only and may vary accordingto the type of scanner being upgraded.

1. Open an Internet Explorer window and type in the IP address of the scanner:

192.168.1.70 for an MMDx or MMCx scanner.192.168.1.71 for an LC60D(x) scanner.

The web interface of the scanner will appear.2. Check the current version of the firmware. This is displayed as the "Build version" as shown

in the figure below.The new firmware version must have a higher number.

page-27

Handheld API 3.7

3. For an LC60Dx scanner : go to step 4.For an MMDx or an MMCx scanner: click on the [Upgrade] button. The scanner will nowboot into a special Upgrade mode. This will take about 60 seconds.

4. Click on the [Browse...] button and browse to the location of the new firmware image.

page-28

Nikon Metrology

5. Select the new firmware and click on "Submit". The new firmware will be uploaded and theprogress shown.

6. When the upload is complete, click "reboot" to reboot the scanner with the new firmware.

7. The scanner will now reboot into normal operating mode. This will take about 60 seconds.

page-29

Handheld API 3.7

8. The scanner is now ready for operation with the new firmware.

page-30

Nikon Metrology

Nikon Metrology API v3.7 - Reference Manual

Documents

Transcript of Nikon Metrology API v3.7 - Reference Manual