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 trademarks of the respective owners. Nikon Metrology N.V. or any of its group companies (Nikon Metrology) make no claim to these trademarks. The use of these Nikon Metrology products, services and materials is subject to the Nikon Metrology General Sales Terms and Conditions. Handheld API 3.7 Contents 1 Scope..........................................................................................................................................................4 2 Scanner / Localizer configurations.............................................................................................................5 3 Scanning operational considerations .........................................................................................................6 4 Hardware description..................................................................................................................................7 4.1 The MMDx Scanner....................................................................................................................7 4.2 The MMCx Scanner....................................................................................................................9 4.3 The LC60Dx Scanner................................................................................................................10 5 Hardware configuration............................................................................................................................12 5.1 Localizer configuration..............................................................................................................13 5.1.1 K-Series .....................................................................................................................13 5.1.2 MCA II (Romer Cimcore Infinite 2.0) ......................................................................14 5.1.3 MCAx (Romer-Cimcore Absolute)............................................................................15 5.1.4 Faro.............................................................................................................................15 5.2 Scanner configuration................................................................................................................16 5.2.1 MMDx configuration..................................................................................................17 5.2.2 MMCx configuration..................................................................................................20 5.2.3 LC60Dx configuration................................................................................................20 5.3 Qualification..............................................................................................................................20 5.3.1 Qualification procedure..............................................................................................21 6 Upgrading scanner firmware....................................................................................................................27 Full details on the scanners can be found in the corresponding documentation provided. It is the subject of this manual.Nikon Metrology 1 Scope This manual concerns the hardware and configuration involved in the hand-held scanners supported by Nikon Metrology. All the instructions on the use of the Handheld API to configure the scanner with the localizer and to perform a qualification procedure are described in the chapter Hardware configuration on page 12. Full details on the interface kit can be found in the corresponding documentation provided. The figure below shows the various components of a hand-held scanning system. In each case information regarding the measurement range and the stripe width is provided. Driver : the driver software allows the scanner / localizer combination to communicate with the scanning software. Interface kit : this is a device that connects a particular scanner with a particular localizer. 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. Full details on the localizers can be found in the corresponding documentation provided. Localizer : the localizers that can be used in combination with the supported scanners are listed in Scanner / Localizer configurations on page 5. Scanning software : full details on the operation of the scanning software can be found in the corresponding software manual. page-4 . 0 Romer-Cimcore Absolute 7 axis Notes 6 axis arms are not supported.28. Full details on each of the scanners and the localizers can be found in their corresponding documentation.47110 .30.27.Handheld API 3. LC60D: Firmware version 2.0. Table 1: Scanner .6. MCAx and Romer-Cimcore Absolute 7 axis : RDS 3. Information on measurement parameters and set up instructions are given in Hardware description on page 7.3 K-Series : K-CMM v7. Fusion) Cimcore 7 axis Infinite 1.7 2 Scanner / Localizer configurations The supported Scanners and Localizers and their compatibility are listed in the table below. See the procedure for updating the firmware on page 27. K-Interface 3.1.0 Cimcore 7 axis Infinite 2.46970 page-5 .3. Required Firmware MMDx and MMCx : Firmware version 2.5RC1 : Firmware Version 6.5. Platinum.1.2218 or higher.1 : Firmware 016 MCA II and Romer . Faro : Faro USB driver version 5.1.0.Localizer compatibility Localizer MMDx MMCx LC60Dx MCAx 7 axis MCA II 7 axis K-Series (K600 and K610) Faro 7 axis (Titanium.0 : WinRDS 7.0.Cimcore 7 axis Infinite 2.226 or higher. The Nikon Metrology scanner is a precision optical measuring instrument. Doing so will invalidate the warranty. Do not look directly into the beam or view with an optical instrument . Do not touch the optical windows on the front of the scanner. and should be treated with care. Do not expose the scanner to extremes of temperatures.laser light is emitted from the indicated aperture. there are certain precautions that should be taken when using it: • • • • • • page-6 Do not drop the scanner. . Do not attempt to dismantle the scanner. Do not allow the scanner to be covered in any liquid.Nikon Metrology 3 Scanning operational considerations Care should always be taken when using hand-held scanners and users should be aware of the safety manual shipped with the product. nevertheless. The scanner has been designed to withstand a typical shop-floor environment. (Full details on all the characteristics of the scanners can be found in the corresponding hardware documentation.Localizer compatibility on page 5.7 4 Hardware description This following information is provided for each of the supported scanners: • Measurement parameters including the measurement range and the stripe width.1 The MMDx Scanner Full details about the MMDx scanner characteristics can be found in the hardware documentation. The Localizers that can be used with the MMDx scanner are listed in Table 1: Scanner .) • The procedure to set up the scanner. Specifications The table below lists the scanner measuring characteristics for each of the scanners in the MMDx range.Handheld API 3. 4. These characteristics are shown in Figure 2: MMDx specifications on page 7. Table 2: MMDx Specifications Specification MMDx50 MMDx100 MMDx200 Start measuring range (mm) 95 100 110 Measuring range (mm) 50 100 150 Stripe width (mm) 50 100 200 Figure 2: MMDx specifications page-7 . the localizer and connect with the scanning software. The scanner will then reboot into normal mode and after 60seconds the green lights should be on again and the scanner is ready for scanning. Type the following IP address into an Internet Explorer window: 192. While booting both LEDs are red. . The Power LED will be on continuously when the connection is established. 3. No Connection between the Scanner and the PC: This could be due to the following : page-8 . 2.If this operation fails. 4. the upper LED (power) is green and the lower LED (laser) blinks green. Mount the scanner on the localizer according to the instruction provided with the interface kit. To check this: 1.168.168.1. Set up the localizer. the scanner will be able to communicate with the PC. according to the instructions given in the manual provided. then the scanner has not booted. Make sure the scanner is connected to the PC. Click on this [Reboot to applic] button. This may be caused by the scanner being stuck in the so-called “upgrade firmware” mode. The scanner web interface page will appear. When booting is complete. switch off the scanner and contact Nikon Metrology support. Trouble shooting LEDs on the back of the scanner remain red: If the upper LED is not green and the lower LED does not blink green.1. Connect the scanner cable to the Ethernet port of the PC. There are two LEDs on the rear of the scanner. [Reboot to applic] NOT available Switch off the scanner and contact Nikon Metrology support.Nikon Metrology Hardware set-up 1.70 (for MMDx and MMCx scanners) 192. 5. 3. Power up the localizer before starting the ModelMaker hardware set-up. Power up the scanner. 2. Note that the scanner will automatically start up in this “upgrade firmware” mode after failing 3 times to boot in the normal mode. When the booting is complete. . The [Reboot to applic] button should be available [Reboot to applic] available This is a confirmation that the scanner is in upgrade firmware mode (and can therefore not be used for normal scanning).71 (for an LC60Dx scanner). Localizer compatibility on page 5.168.Handheld API 3. Choose the option Use the following IP address and set the IP address to be 192. Firewall Check that the connection can not be made because it is being blocked by a Firewall. make sure that the option Obtain an IP address automatically is set OFF. In the Internet Protocol (TCP/IP) Properties dialog. 3.60 The last set of digits can be any number between 1 and 255 except 70 or 71. 4. These characteristics are shown in Figure 3: MMCx specifications on page 10. Table 3: MMCx Specifications Specification MMCx80 MMCx160 Start measuring range (mm) 100 110 Measuring range (mm) 100 150 Stripe width (mm) 80 160 page-9 . It is recommended that you use 60. 2. The localizers that can be used with the MMCx scanner are listed in Table 1: Scanner . Specifications The table below lists the scanner measuring characteristics for each of the scanners in the MMCx range.2 The MMCx Scanner Full details about the MMCx scanner characteristics can be found in the hardware documentation.1. Incorrect IP address for the scanner The Scanner needs a fixed IP address. accessible from the PC network connection parameters on the Control Panel.7 1. Cabling Check all the cabling between the scanner and the PC and on the power supply. connect the scanner to Ethernet port of the PC. The localizers that can be used with the LC60Dx scanner are listed in the Table 1: Scanner Localizer compatibility on page 5.Nikon Metrology Figure 3: MMCx specifications Hardware set-up 1. These characteristics are shown in Figure 4: LC60Dx specifications on page 11. Table 4: LC60Dx Specifications page-10 Specification LC60Dx Start measuring range (mm) 95 Measuring range (mm) 60 Stripe width (mm) 60 . 4. Mount the scanner on the localizer according to the instruction provided with the interface kit. For additional information see Trouble shooting on page 8.3 The LC60Dx Scanner Full details about the LC60Dx scanner characteristics can be found in the hardware documentation. Power up the localizer before starting the ModelMaker hardware set-up. 4. 2. 5. When booting is complete. Power up the scanner. Set up the localizer. 3. according to the instructions given in the manual provided. Specifications The table below lists the scanner measuring characteristics for the LC60Dx scanner. according to the instructions given in the manual provided. Connect the scanner cable to the Ethernet port of the PC.7 Figure 4: LC60Dx specifications Hardware set-up 1. the left LED (power) is green and the right LED (laser) blinks green. When the booting is complete. 3. Mount the scanner on the localizer according to the instruction provided with the interface kit. 5. 2. Set up the localizer. There are two LEDs on the rear of the scanner. the scanner can be connected to the Ethernet port of the PC. While booting both LEDs are red. Power up the scanner.Handheld API 3. When booting is complete. page-11 . Power up the localizer. For additional help see Trouble shooting on page 8. 4. • MMCx configuration on page 20. (See Table 1: Scanner .Localizer compatibility on page 5 for information on the compatibility between localizers and scanners. • Localizer The configuration for the following localizers are described: • • • • K-Series on page 13. (See Table 1: Scanner . your localizer and to perform a Qualification procedure.0) on page 14. Follow the steps to configure the hardware . MCA II (Romer Cimcore Infinite 2. The Hardware Configuration dialog contains three buttons on the left side : Localizer. Accessing the Handheld API The Handheld API can be accessed from your scanning software.referring to the software manual if necessary.) • Scanner The configurations for the following Scanners are described: • MMDx configuration on page 17. MCAx (Romer-Cimcore Absolute) on page 15.Nikon Metrology 5 Hardware configuration This section describes how to use the Handheld API Version 3.) page-12 . • LC60Dx configuration on page 20.7 to configure your scanner.Localizer compatibility on page 5 for information on the compatibility between localizers and scanners. Eventually you should open the Hardware Configuration dialog as shown below. Faro on page 15. Clicking on each of these enables you to configure your hand held scanning set up. Scanner and Qualification. This information should be used when requesting support. SpaceProbe tip diameter : the diameter of the tactile probe tip.1. The software reads the tip number of the current probe and automatically loads the corresponding calibration file for that tip. Number of LEDs : the total number of active LEDs on the whole system. as well as any additional "external" LEDS that you may have glued to the system.7 • Qualification The Qualification procedure on page 20 describes the complete qualification process for all scanner / localizer combinations. and the K-CMM Version. Driver Information: displays information about the Driver Description. 5. the Driver version. Device information: displays the following information on the K-Scan system: Camera serial number : the serial number of the camera.Handheld API 3. SpaceProbe serial number : the serial number of the SpaceProbe.1 Localizer configuration The Localizer configuration function provides you with tools to view diagnostic information and configure the localizer. K-Scan serial number : the serial number of the K-Scan probe. This includes the LEDs on both the Space Probe and the K-Scan probe. page-13 . Maximum scan rate : the maximum scan rate. This number is stored in a chip inside the probe adapter and is also stamped on the outside of the adaptor.1 K-Series Diagnostics The Diagnostics tool provides information about the currently selected localizer. 5. SpaceProbe tip number : the number of the currently mounted tip. It activates the probe that has been manually selected.2 MCA II (Romer Cimcore Infinite 2. Serial Number : the localizer serial number. This is possible if the identification number is programmed in a chip inside the probe.1. [Calibrate] : starts a calibration procedure. Active probe info: displays the following information on the currently active probe: Number : the identification number of the currently connected probe.0) Diagnostics The Diagnostics tool provides information about the currently selected localizer. USB Firmware : the USB firmware version number. [Activate] : this option is used if the Autodetect option is off. This information should be used when requesting support. Type : the type of probe. page-14 . Runcode : the runcode version number. Diameter : the calibration method used. uncheck this option and set the probe number to the required value manually. Driver info : displays version information about : Driver Version WinRDS Version RXXC Version XDAT Version Arm info : displays the following information on the currently active localizer arm: Arm Type : the localizer arm type. Autodetect : when the Autodetect function is checked. probe calibration data will loaded automatically if the identification number of the connected probe can be detected. This is most commonly a ball. [Profile Settings] : refer to the MCAII hardware manual for more details. Refer to the MCAII hardware manual for more details. [Special Functions] : refer to the MCAII hardware manual for more details. If the identification number can not be detected.Nikon Metrology 5. 3 MCAx (Romer-Cimcore Absolute) Diagnostics The Diagnostics tool provides information about the currently selected localizer. [Calibrate] : starts a calibration procedure. Tip Diameter : the diameter of the probe tip Calibration Date : the date on which the probe was last calibrated. This is most commonly a ball.when a new probe has been activated for example. Calibration date : the time and date when the localizer arm was calibrated.7 5. Firmware : the firmware version number.4 Faro Diagnostics The Diagnostics tool provides information about the currently selected localizer. 5. [Refresh] : this button can be used to refresh the diagnostics information after changes . page-15 . Calibration Result : this is a status code for the calibration of the probe. This information should be used when requesting support.1. It is not an indication of the accuracy of the calibration. This information should be used when requesting support.Handheld API 3. Probe info: displays the following information on the currently active probe: Probe Name : the name of the currently connected probe.1. Refer to the MCAx hardware manual for more details. Probe Type : the type of probe. Driver info : displays version information about : Driver Version RDS Version Arm info : displays the following information on the currently active localizer arm: Arm Type : the localizer arm type. Max.. Use scan mode during probe calibration : this allows you to use the scan mode during probe calibration. Version : version of the driver FARO 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 type Serial No : the localizer serial number Joints : number of Joints Calibration 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. error : the maximum error of the calibration.. Calibration Date : the date when the probe was calibrated (mm/dd/yyyy). [Select probe. Radius : radius of the probe. Two sigma : the two sigma value of the calibration.Nikon Metrology Driver info : displays information about : Description : description of the driver. Name : the name of the probe.2 Scanner configuration The Scanner function provides tools used to configure the scanner. [FARO diagnostics] : clicking on this button will start the diagnostics of your FARO localizer.] : clicking on this button will start the FARO probe dialog box. 5. Consult your FARO localizer documentation for more information. page-16 . Consult your FARO localizer documentation for more information. Laser tool The Laser tool enables you to configure the laser settings for the scanner. by entering the required level using the slider or the input field. The 2D Preview assists in determining a suitable power level. then the intensity is too high and too many points will be in saturation. This function only works if the Automatic option is not set. To delete a profile: select it from the drop-down list and click [Delete]. To retrieve a saved profile : simply select it from the drop-down list. i. in which case you can check this option off. then you can increase the exposure time by entering the required level using the slider or the input field. page-17 . By default you should always use the lowest exposure time possible. as well as the material and the colour of the object. However if setting the Laser Power level to a maximum does not produce sufficient number of points. Uncheck this option only if you need to set the laser power levels manually. then may give rise to erroneous results. The bar at the side should be as shown in the screenshot above. Laser Profiles: These fields enable you to save. By default the Automatic setting is enabled and it is recommended that you retain this.e. so that no points are filtered out. The Automatic option adjusts the laser power for each point.7 5. Depending on the nature of the object being scanned. 2D Preview: This provides a preview of the points that the scanner is currently seeing. The following fields are displayed.Handheld API 3. If the bar is red.1 MMDx configuration The Scanner configuration function consists of (3) tools: Laser. If the level of the bar is low. retrieve or delete a laser profile (configuration). Exposure : This allows you to set the exposure time. especially when rapid movements of the scanner are involved. Reflection Filter : By default a filter is used during the scanning operation to remove the effects of reflected light. coloured green with a high level. Field of View and Diagnostics. the laser power level is too low. Note: Increasing the exposure time can reduce the accuracy. To save a laser profile: click on the [Save as] button and enter a name to identify the profile. Laser Power : This slider enables you to view or set the laser power level. [Detect] : This button is used to detect the optimum values of Laser Power and Exposure for the object to be scanned.2. This is based on the number of points required. Nikon Metrology Field of View tool This tool allows you to adjust the scanner field of view. It is useful if you only wish to scan a part of an object. set using the 'Y' and 'Z' sliders. 'Z' slider : The 'Z' slider allows you to control the active area of the scanner in depth (Z direction). page-18 . 'Y' slider : The 'Y' slider allows you to control the number of points along the stripe (Y direction). not the accuracy. In the screen shot above. The Field of View panel displays the current scan rate of the incoming stripe data (frames per second) which is calculated from the exposure time and the dimensions of the field of view. The number of points per stripe is automatically calculated depending on the options in this section. The size of the field of view depends on the scanner model and current scanner calibration. Reducing the field of view improves the speed of scanning. where the Y slider is at a maximum (representing 1000 points) the scan rate is 51 frames ber second. The screen shot below shows the results of reducing the Y slider range to 50% which results in the Scan rate being doubled. page-19 . Diagnostics tool The Diagnostics panel provides information about the current scanner.Handheld API 3.7 The screenshot below shows the effect of reducing both the Y and the Z sliders to 50%. This information should be used when requesting support. Nikon Metrology General: displays information about Type : of scanner.2 MMCx configuration The Laser tool is as described for the MMDx scanner on page 17.3 LC60Dx configuration The Laser tool is as described for the MMDx scanner on page 17. 5.2. Serial Number : of the scanner Manufacturing Date : of the scanner (mm/dd/yyyy) Firmware : displays version information about FPGA : FGPA version Driver : driver version Server : scanner server version 5.2. 5. The Diagnostics tool is as described for the MMDx scanner on page 19. It is highly recommended that you carry out a qualification procedure each time a particular scanner is attached to the localizer or once a week otherwise. The Qualification process is based on scanning a qualification plate with a known calibrated width between the two white sides of the plate. The Diagnostics tool is as described for the MMDx scanner on page 19. probe and localizer) will provide accurate results.3 Qualification The Qualification procedure is a means of ensuring that your hand held laser setup (including the scanner. page-20 . The Qualification procedure is part of the Hardware Configuration functionality that can be accessed from your scanning software. the wizard automatically takes you to the next step.. At each stage instructions are given about the measurements to be performed and once they are complete. 3. Start up your scanning software. Scanner: the scanner used during the last qualification. The Qualification panel displays the following : Localizer: the localizer used during the last qualification. Click [Apply]. The user is guided through the Qualification procedure by means of a wizard. you must : 1. Before starting this procedure it is assumed that you have carried out all the require preliminary steps on page 20. Click on the Laser tool.Handheld API 3. Enter the calibrated width between two white surfaces of the plate to be used for the qualification. 5.1 Qualification procedure This procedure describes all the stages involved in performing a Qualification of a scanner / localizer setup. Date: the date of the last qualification Standard Deviation: standard deviation achieved during the last qualification. Click on the Qualification button.3. 5. 8. The width is displayed on the label on the white plate. 2. 4.. The Qualification wizards will issue a warning when: page-21 . Click on the Scanner button. 9. Adjust the exposure time to the lowest possible value and check that the Automatic Laser Power option is on. 7.] button to the wizard that will guide you through the qualification procedure on page 21. Click on the [Start Qualification. Set up the localizer and connect this to the scanner as described in the hardware description section on page 7.7 Before starting a qualification. 10. Follow the steps required in the software to access the Hardware Configuration dialog. 6. When the measurement is complete. 2. the wizard will automatically continue to the next screen. When the measurement is complete. page-22 . Follow the instructions on the screen. • the scanner is not oriented as required. follow the instructions on the screen. 1. Follow the instructions on the screen. When the setup is ready for you to begin. the wizard will automatically continue to the next screen. 3.Nikon Metrology • the scanner is moving either too fast or too slow. the wizard will automatically continue to the next screen.7 4. When the measurement is complete. 5. page-23 . When the measurement is complete.Handheld API 3. Follow the instructions on the screen. Follow the instructions on the screen. the wizard will automatically continue to the next screen. 7. the wizard will automatically continue to the next screen. When the measurement is complete. Follow the instructions on the screen. the wizard will automatically continue to the next screen. the wizard will automatically continue to the next screen. page-24 . When the measurement is complete. 8. Follow the instructions on the screen. Follow the instructions on the screen.Nikon Metrology 6. When the measurement is complete. 7 9. the wizard will automatically continue to the next screen. page-25 . When the measurement is complete.Handheld API 3. Follow the instructions on the screen. Follow the instructions on the screen. When the measurement is complete. the wizard will automatically continue to the next screen. 10. If the results are still unacceptable after repeating the procedure carefully. Note: If the mount connecting the scanner to the localizer is removed or adjusted. A very high condition number is not good. Loading and saving scanner qualification data The qualification information is stored on your PC immediately after a qualification has taken place. this may indicate a problem with the device and you should contact support at Nikon Metrology. a new qualification should be carried out. This may be due to poor results during one of the stages in the Qualification procedure.Nikon Metrology 11. You can choose to accept the results if the deviation is acceptable. page-26 . since it implies that the deviation is unreliable. The results are displayed on the screen. When you change the scanner or localizer. the software will automatically load the most recent qualification available for that scanner and localizer based on their serial numbers. The Qualification procedure is complete. 7 6 Upgrading scanner firmware This procedure explains how to upgrade the scanner firmware via the web interface Application.168. Requirements To 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 firmware Note: The screenshots shown in this procedure are illustrative only and may vary according to the type of scanner being upgraded. The web interface of the scanner will appear.Handheld API 3. The information in this document applies to MMDx. This is displayed as the "Build version" as shown in the figure below. The new firmware version must have a higher number.70 for an MMDx or MMCx scanner.71 for an LC60D(x) scanner. 192.1. 2. Open an Internet Explorer window and type in the IP address of the scanner: 192. MMCx and LC60D scanners. 1. Check the current version of the firmware. page-27 .168.1. Nikon Metrology 3. 4. For an MMDx or an MMCx scanner: click on the [Upgrade] button.] button and browse to the location of the new firmware image. page-28 . The scanner will now boot into a special Upgrade mode. This will take about 60 seconds... Click on the [Browse. For an LC60Dx scanner : go to step 4. When the upload is complete. page-29 . 6. click "reboot" to reboot the scanner with the new firmware. 7. The new firmware will be uploaded and the progress shown.7 5.Handheld API 3. The scanner will now reboot into normal operating mode. This will take about 60 seconds. Select the new firmware and click on "Submit". page-30 .Nikon Metrology 8. The scanner is now ready for operation with the new firmware.
Report "Nikon Metrology API v3.7 - Reference Manual"