96107E Data Logging and Remote Control Software for the XG Series XG VisionTerminal User's Manual Read this manual before using this system. Always keep this manual in a safe place for future reference.
Introduction Introduction This manual explains how to install, handle, and operate the data logging and remote control software for the machine vision system XG Series (XG-8000/XG-7000: herein referred to as the [XG Series], XG VisionTerminal [herein referred to as XG Vision Terminal]. It also covers precautions regarding use of the software. Read this manual thoroughly to understand the XG VisionTerminal functions in order to maximize performance of the system.
Introduction Trademarks • Microsoft, Windows, Windows Vista ,and Excel are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. • "SD Memory Card" is a registered trademark of the SD Association. • Other company names and product names noted in this document are registered trademarks or trademarks of their respective companies. The ™ mark and ® mark have been omitted in this manual.
Introduction General Cautions • Before using the XG VisionTerminal to communicate with the XG Series controller, confirm that all system functions of the XG controller are working properly. • Before starting or operating the system, check to make sure all system functions are working correctly. • If the system is operated beyond its published specifications or if the system is modified, its functions and performance cannot be guaranteed.
Software License Agreement Software License Agreement NOTICE TO USER: PLEASE READ THIS SOFTWARE LICENSE AGREEMENT ("THIS AGREEMENT") CAREFULLY. BY USING ALL OR ANY PORTION OF THE XG VisionTerminal ("THIS SOFTWARE"), YOU ARE AGREEING TO BE BOUND BY ALL THE TERMS AND CONDITONS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS OF THIS AGREEMENT, DO NOT USE THIS SOFTWARE.
Software License Agreement 5. Disclaimer. This Software is licensed to the User "AS IS" and without any warranty of any kind. In no event does KEYENCE or its suppliers accept or assume any liability for any damages, claims, costs or profit loss as a result of operating this Software. 6. Termination. 6.1 Under this Agreement the User's license will automatically terminate if this Software and any associated copies of this Software are destroyed or voluntarily returned to KEYENCE. 6.
Contents Contents Introduction .............................................................2 General Cautions .................................................. 4 Precautions ........................................................... 4 Software License Agreement ..................................5 Contents ..................................................................7 Chapter 4 XG VisionTerminal Application Menu XG VisionTerminal Application Menu .................. 4-1 File Menu ..................
Contents 8
Chapter 1 Introduction Confirming the Package Contents This package contains the following equipment and accessories. Check that all accessories are included before using this system. V-Works for XG (Integrated Management Software for (Model Number: XG-H7E or XG-H8NE) 1 x CD-ROM • This disc contains the installer, program files, and PDF instruction manual files for the XG VisionTerminal. Keep this disc in a safe place following installation.
Overview of the XG VisionTerminal Overview of the XG VisionTerminal The XG VisionTerminal is specifically designed for the machine vision system XG Series. Major functions Remote desktop Overview The XG VisionTerminal uses a remote desktop function that allows you to issue console commands from the PC and view the monitor output from the XG Series on your PC. The XG VisionTerminal allows you to view the monitor output from the XG Series on a PC.
System Configuration System Configuration Example of a standard system of XG-7000 Series setup with two cameras using the XG VisionTerminal.
System Operating Environment System Operating Environment The XG VisionTerminal requires a personal computer that meets the following conditions. Supported OS Microsoft Windows XP Home Edition/Professional SP 2 or later Microsoft Windows Vista Home Basic, Home Premium, Business, Ultimate, Enterprise Microsoft Windows 7 Home Premium, Professional, Ultimate, Enterprise • Supports the 32bit/64-bit version of Microsoft Windows 7 only. For all other operating systems, only the 32-bit version is supported.
Chapter 2 Preparations Installing the XG VisionTerminal Installation procedures will differ depending on whether the program is being installed from the CD-ROM or by downloading from the User Support page. Reference This example below explains the installation procedures for Windows XP. Install the XG VisionTerminal from the CD-ROM by using the following procedures.
Installing the XG VisionTerminal 3 Select language and click [OK]. 5 Follow the on-screen instructions to complete the installation. [Setup Wizard for XG VisionTerminal] appears. 6 When the [Installation completed] menu appears, click [Finish]. Reference The version number will differ depending on the model and period when purchased. 4 The XG VisionTerminal installation is completed. Click [Next]. The [User License Agreement] appears. • The shortcut icon for the [XG VisionTerminal Ver. ∗.
Installing the XG VisionTerminal Uninstalling the Software Uninstall the XG VisionTerminal using [Add/Remove Programs] in the Windows Control Panel. Downloading and Installing the Latest Version Note 1 Click the Start menu and select [Control Panel]. The [Control Panel] appears. Double-click the [Add/Remove Programs] icon. The [Add/Remove Programs] menu appears. 3 Select [XG VisionTerminal Ver. ∗.∗] and click [Remove]. 1 Uninstall any previous version of the XG VisionTerminal.
Installing the XG VisionTerminal 5 Click [Next]. The [User License Agreement] appears. 6 Follow the on-screen instructions to complete the installation. 7 When the [Installation completed] menu appears, click [Finish]. The XG VisionTerminal installation is completed. • The shortcut icon for the [XG VisionTerminal Ver. ∗.∗] appears on the desktop. • A shortcut will be added to the Windows Start menu under KEYENCE Applications → V-Works for XG Ver. ∗.∗ → XG VisionTerminal Ver. ∗.∗.
Starting and Exiting XG VisionTerminal Starting and Exiting XG VisionTerminal This section explains how to start and exit the XG VisionTerminal. Exiting XG VisionTerminal Click [File], and then [Exit]. Starting XG VisionTerminal Or, click the close button at the upper right of the window. Click the shortcut in the Windows Start menu under The XG VisionTerminal exits. Preparations All Programs → KEYENCE Applications → V-Works for XG Ver. ∗.∗ → XG VisionTerminal Ver. ∗.∗.
Understanding the Respective Windows Understanding the Respective Windows (5) Remote desktop Basic Window The basic window for the XG VisionTerminal is outlined below. (1)(2) This view shows monitor output from the connected XG Series controller. See "Controlling the XG Series Remotely (Remote Desktop)" (Page 3-2) for more details.
Understanding the Respective Windows Icons and names on the toolbar Toolbar The most frequently used functions and settings in the XG VisionTerminal can be accessed by clicking these icons on the toolbar. Icons and names on the toolbar Functions Connect All Connection to all registered XG Series controllers begins. See "Connecting to All Registered XG Series controllers (Connect All)" (Page 4-10) for more details. Disconnect All Disconnects all connected XG Series controllers.
Connecting to the XG Series Connecting to the XG Series After connecting the PC with XG VisionTerminal installed and a XG Series controller, the controller must be registered as the connection. Ethernet (1:1) Connection Connect the XG Series directly to the PC using an Ethernet cable (cross cable: OP-66843). Before Connecting Check the following settings. Settings on the PC Set the information required for the Ethernet connection (IP address, Subnet mask, Port number, etc.).
Connecting to the XG Series 3 Click [Search]. The XG Series connected to the PC appears in the list. LAN Connection Connect the XG Series and PC over an Ethernet-based LAN. Preparations HUB (Router) Note • Clicking [Search] will only display controllers that exist in Connecting to the XG Series the same subnet. Connect the Ethernet cable (commercial straight • The controller may not show up initially if there are multiple 4 controllers on the network.
Connecting to the XG Series 3 Click [Search]. The XG Series controllers that are connected on the LAN appear in the list. USB Connection Connect the XG Series directly to the PC using a USB cable. USB connection Note The XG VisionTerminal and XG VisionEditor cannot connect over the USB cable simultaneously. Note • Clicking [Search] will only display controllers that exist in the same subnet.
Connecting to the XG Series 1 Connect the XG Series to the PC using the optional USB cable (OP-66844). Registering the XG Series in the XG VisionTerminal [Found New Hardware Wizard] will appear on the PC screen. The XG Series must be registered as a connection so that the XG VisionTerminal can recognize it. Note Only one XG Series can be registered as a USB connection. From the [Connections] menu, click [Add Connection]. The [Add Connection] menu appears.
Connecting to the XG Series 2-12
Chapter 3 Typical Uses Typical Uses of XG VisionTerminal This Chapter explains the operations outlined below used to accomplish basic tasks in the XG VisionTerminal. • Controlling the XG Series remotely (remote desktop) (Page 3-2). • Logging data from the XG Series (Page 3-6). Reference To utilize the other features available in the XG VisionTerminal, see "XG VisionTerminal Application Menu" (Page 4-1).
Controlling the XG Series Remotely (Remote Desktop) Controlling the XG Series Remotely (Remote Desktop) View the monitor output from the XG Series controller in XG VisionTerminal. Note XGA image output is not supported in Ver. 4.∗.∗∗∗. 1. Registering a Controller Register the XG Series controller as a connection in the XG VisionTerminal to view the screen output. 1 From the [Connections] menu, click [Add Connection]. The [Add Connection] menu appears.
Controlling the XG Series Remotely (Remote Desktop) 2. Connecting to the Controller 3. Displaying the Remote Desktop This procedure connects the XG Series controllers that are registered as connections in the XG VisionTerminal. This procedure displays the monitor output from the connected XG Series controller. Note Click [Connect All] from the [Operation] menu. XGA image output is not supported in Ver. 4.∗.∗∗∗.
Controlling the XG Series Remotely (Remote Desktop) Reference • Displaying remote desktops for multiple controllers using 4. Controlling the Remote Desktop [Continuous] may result in slow screen updates for all connected XG Series controllers. In this case, select Sending remote console keystrokes [Asynchronous]. • The update interval for [Asynchronous] cannot be user specified to an arbitrary value because the interval is determined automatically based on the current connection status.
Controlling the XG Series Remotely (Remote Desktop) H button Operating with a mouse This button is used to enter multiple key combinations. Click the H button next to buttons 1 or 7 then click the other button in the key combination to simulate the key combination on the handheld controller. Mouse control can be used for most of the operations of the XG Series currently monitored in the remote desktop. The main operations are as follows.
Logging Data from the XG Series Logging Data from the XG Series The XG VisionTerminal can log (collect) inspection results, images, and archived data output from the XG Series during operation. 2 Specify the XG Series controller to register it as a connection. For a USB connection Note Click [USB].
Logging Data from the XG Series 2. Connecting to the Controller This procedure connects the XG Series controllers that are registered as connections in the XG VisionTerminal. Log file destination Log files are output to [Documents\KEYENCE\XG VisionTerminal\(IP address or [USB]] (by default) for the user currently logged in.
Logging Data from the XG Series 4. Viewing the Log This procedure opens the log summary which displays the latest data as it is being logged. Reference • Up to 32 log views can be displayed at one time. • The log summary only displays the output results. 1 From the [View] menu, click the [(XG Series controller to operate)] and then [Show log view]. The [Log Summary] appears. 2 Select the data output step for the log you wish to view from the [Unit Name] box.
Chapter 4 XG VisionTerminal Application Menu XG VisionTerminal Application Menu Commands in the XG VisionTerminal are organized under the following seven menus. • File (Page 4-2) • View (Page 4-4) • Connections (Page 4-9) • Operation (Page 4-10) • Window (Page 4-11) • Settings (Page 4-12) • Help (Page 4-16) Note displayed.
File Menu File Menu This section explains the commands in the [File] menu. Creating a New Settings File (New) This command creates a new settings file for the XG VisionTerminal. 1 Opening a Settings File (Open) This command opens an existing settings file. 1 From the [File] menu, click [Open]. The [Open file] menu appears. If the currently open file has unsaved changes From the [File] menu, click [New]. A confirmation screen appears.
File Menu Saving the Settings File (Save as) This command saves the settings file currently open to a file with a different name. 1 From the [File] menu, click [Save as]. The [Save as] menu appears. 2 Enter the file name, then click [Save]. The file is saved as a [Settings file] with the extension XG VisionTerminal Application Menu ".xgn". Exiting the XG VisionTerminal (Exit) This command exits the XG VisionTerminal. From the [File] menu, click [Exit]. The XG VisionTerminal exits.
View Menu View Menu This section explains the commands in the [View] menu. Show/Hide the Connections view (Connections) The connections view is displayed when a check mark appears next to this command. Operating the Remote Desktop (Show Handheld Controller View) This command shows the handheld controller view which is used to operate the XG Series controller currently monitored in the remote desktop. With the check mark visible, open the [View] menu and click [Connections].
View Menu Using the handheld controller view Button numbers for each input device Target Button numbers on the console Select the connected XG Series to operate. Each button on the console corresponds to the numbers shown below. Arrow buttons (7) Clicking the arrow buttons navigates through the screen in the same way the 8 way button on the handheld controller does.
View Menu Temporarily Disabling Remote Desktop Operations (Locking Handheld Controller) This command temporarily disables input from the remote desktop using the handheld controller view to prevent unintentional operation. From the [View] menu, click [Lock Handheld Controller].
View Menu Monitoring the XG Series remotely (View remote desktop) Saving the remote desktop screen to a file (Screen Capture) This procedure displays the screen output from the connected XG Series controller. This procedure saves the contents of the currently displayed remote desktop screen as an image file. Note XGA image output is not supported in Ver. 4.∗.∗∗∗. From the [View] menu, select the controller connection and then click on [Screen Capture].
View Menu Viewing the properties of an XG Series connection (Properties) This command displays the properties menu of an XG Series connection. 1 From the [View] menu, select the desired connection and then click [Properties]. The [Properties] menu for the specified XG Series connection appears. Reference • Clicking [Reference] opens the log file destination folder.
Connections Menu Connections Menu This section explains the commands on the [Connections] menu. 3 Click [OK]. The new connection is added and appears in the connection view. Registering a New Connection (Add Connection) 1 From the [Connections] menu, click [Add Connection]. The [Add Connection] menu appears. Note Always disconnect the connection before deleting it.
Operation Menu Operation Menu This section explains the commands on the [Operation] menu. Starting Logging (Start Logging) This procedure starts logging data from the XG Series connected and specified as a logging target. Connecting to All Registered XG Series controllers (Connect All) Note To store images and archived data output from the XG-8000 This procedure connects the XG Series controllers that are registered as connections in the XG VisionTerminal. Series as logs, Ver. 5.
Window Menu Window Menu This section explains the commands in the [Window] menu. Switching View Layout in the XG VisionTerminal Window (Select Layout). The XG VisionTerminal can store up to 5 view layouts (window locations and layout), from No. 1 to No. 5. The view layout can be changed by specifying the view layout number. Bringing a View to the front (View Name) This command brings the desired view to the front when multiple log views and remote desktops are displayed in the XG VisionTerminal window.
Settings Menu Settings Menu This section explains the commands on the [Settings] menu. Acquiring a File From a Connected XG Series Controller (Acquire File) 3 In the files list, click the file to download and select it. 4 In the [Transfer To] box, specify the destination path to store the downloaded files on the PC.
Settings Menu Handheld controller button assignments Changing the XG VisionTerminal Global Settings (Options) The commands assigned to the buttons in the handheld controller view are configurable. For more details, see "Changing the handheld controller button This command changes the XG VisionTerminal operating environment settings. 1 From the [Settings] menu, click [Option]. assignments" (Page 4-13). 3 After completing the changes, click [OK]. The [Option] menu appears.
Settings Menu Switches the height display Observing 3D images (3D viewer) By using images acquired from the 3D camera or LJ-V, the 3D images of the objects for the inspection are displayed (supported by XG VisionTerminal Ver.5.3 or later versions). Color method (Rainbow1 (initial set Palette value)/Rainbow2/Cyan/Magenta/ Yellow).
Settings Menu 4 Change the display method by using a mouse. Adjusting the distribution of the height image and the Grayscale image. Move the "Height <-->Grayscale" slider. When the slider is moved to the left end, only the height image is displayed. When the slider is moved to the right end, only the Grayscale image is displayed. Return the display location of the 3D image. Click "Reset Position" or double-click the right button of the mouse.
Help Menu Help Menu This section explains the commands in the [Help] menu. Displaying the Help File (Help) This command displays the PDF version of this manual. From the [Help] menu, click [Help]. This manual appears. Displaying the Version Number of the XG VisionTerminal (Version Info) This command displays the version number of the XG VisionTerminal. Note Always provide the version number of the XG VisionTerminal when contacting Keyence for technical support.
Chapter 5 Appendix Appendix 5-1
Error Messages Error Messages Message Cause Remedy Connection to the controller (connection) failed. The controller at the connection is disconnected from the network physically or otherwise. (Only applies to Ethernet connections.) • Check that the LAN cable is connected correctly between the controller, PC and the hub. • Make sure power to the hub is turned on. The IP address is set incorrectly. (Only applies to Ethernet connections.) • Check the IP address settings for the controller.
Error Messages Message Cause Remedy A communication error occurred. Archive logging from the (connection) failed. The controller at the connection is disconnected from the network physically or otherwise. (Only applies to Ethernet connections.) • Check that the LAN cable is connected correctly between the controller, PC and the hub. • Make sure power to the hub is turned on. The IP address is set incorrectly. (Only applies to Ethernet connections.) • Check the IP address settings for the controller.
Error Messages Message Cause Remedy A communication error occurred. File list acquisition from the (connection) failed. The controller at the connection is disconnected from the network physically or otherwise. (Only applies to Ethernet connections.) • Check that the LAN cable is connected correctly between the controller, PC and the hub. • Make sure power to the hub is turned on. • Execute the [Connect all] command (Page 4-10). The IP address is set incorrectly.
Error Messages Message Cause Failed to write results data. Could The drive at the destination could not start logging from the controller not be found. (connection). Remedy • Make sure the drive specified in the file destination base path (Page 4-13) exists. • Specify a drive that currently exists in the downloaded file basebath (Page 4-13). The number of output items in the • Make sure the drive specified in the file destination data output unit exceeds the output base path (Page 4-13) exists. buffer.
Error Messages Message Cause The settings file contains corrupt or invalid data. Starting with a new file. The settings file is corrupt. Create a new settings file. Tried to open an incompatible settings file. Open a file compatible with the XG VisionTerminal. Failed to save the settings file. Remedy - Contact your local KEYENCE office. Failed to save the captured image Not enough disk space available at Make space available by deleting unneeded files on file. the destination. the PC.
Error Messages Appendix 5-7
Revision History Revision History Printing date Edition Revision January 2009 Official release June 2009 2nd edition Changed version indication to Ver. 2.1. February 2010 3rd edition Edited for Ver. 3.0.0000. September 2010 4th edition September 2011 5th edition March 2012 6th edition Edition for Ver. 4.1/5.0 Edition for Ver. 4.2/5.1 October 2012 7th edition Edition for Ver. 4.2.0020/5.1.0020 November 2013 8th edition Edition for Ver. 5.3.
WARRANTIES AND DISCLAIMERS (1) KEYENCE warrants the Products to be free of defects in materials and workmanship for a period of one (1) year from the date of shipment. If any models or samples were shown to Buyer, such models or samples were used merely to illustrate the general type and quality of the Products and not to represent that the Products would necessarily conform to said models or samples.
Revision History Copyright (c) 2010 KEYENCE CORPORATION. All rights reserved.
