Exporting Images via FTP

You can configure your In-Sight vision system to export images to an FTP server on the network. This allows you to store acquired images (based on a tool or job's pass/failure condition) to another device for archival purposes. These images can then be reviewed, helping you to diagnose problems that may have been encountered during the production process.

To configure an FTP connection:

  1. From the Communications group box, select FTP.
  2. Select the Image tab.

  3. Press the Add button to add an entry and configure the image export parameters.

    Note: More than one image export operation can be added to a job.
  4. Select the Settings tab and configure the FTP server settings.
  5. Place the In-Sight vision system Online. The vision system must be Online to execute; otherwise, no images will be exported.
  6. Trigger the vision system to acquire images. For each acquired image, an image file (BMP or JPG, depending on the File Format parameter) is exported and stored on the host specified in the Host Name parameter.
Note:
  • When Transfer Condition is set to None (default), an image file will be exported every time a new image is acquired. When Transfer Condition is set to other than None, an image file will be exported every time the specified event occurs. For example, when Transfer Condition is set to Job.Fail, an image file is exported and stored on the FTP server every time the job fails.
  •  When using the In-Sight emulator as an FTP server, by default, files are written to the Emulator folder ([ProgramData]\Cognex\In-Sight\Emulators\x.x.x). In addition to this directory, files can be written to a user-defined location (Authorized FTP directory). For more information on the Authorized FTP directory, see Emulation Panel.

Image Tab

Provides parameters for defining the exported image, its format, when the image is exported and where the image is exported.

ClosedEnabled check box

Defines whether or not the image export operation is operational (by default, it is checked), and whether or not it will be exposed as an EasyView item (for example, WriteImageFTP_1.Tool_Enabled), which can be displayed on the VisionView Operator Interface Panel and is editable by the operator.

Note: To enable, check the Enable checkbox in the table. This is the only parameter you can configure in the table.
ClosedName

Defines the name of your image export operation, which can be utilized in configuring the results (Inputs/Outputs and Communication); the default name is "WriteImageFtp_1" (if it is the first image export operation added to the job, otherwise it will be incremented, e.g. “WriteImageFtp_2”, “WriteImageFtp_3”, etc.). Customize the operation by giving it a name that is associated with its Transfer Condition, for instance.

ClosedTransfer Condition

Defines when the data should be sent to the FTP server, such as when a particular tool passes or fails, or an input is received. By default, None is selected, which ensures that the data will be exported every time an image is acquired, when the Enabled checkbox is checked. If the Enabled checkbox is disabled, or the tool referenced is disabled, the export operation will not execute.

ClosedDevice

Defines the FTP server, configured in the Settings Tab, that will receive the exported data. By default, Device 1 is selected.

ClosedFile Format

Defines the file format of the exported image: BMP (Windows bitmap format) or JPG (standard encoded JPEG format). By default, BMP is selected.

ClosedImage Size

Defines the resolution of the exported image: Full, Half or Quarter. By default, Full is selected.

ClosedInclude Graphics

Defines whether or not an SVG file will be created that contains overlay graphic data for supported Location and Inspection Tools. To view the SVG file and image file, open the SVG file with a Web browser that supports the SVG file type (e.g. Microsoft Internet Explorer 9.0). The SVG file contains an internal link to the acquired image associated with it, and when the browser opens the SVG file, it follows the link to open and display the acquired image along with the overlay graphics.

Note:
  • To enable, check the Include Graphics checkbox in the group box in the right-hand side. The Include Graphics checkbox in the table is read-only.
  • When enabled, the SVG file will use the name specified in the File Name parameter.
  • When the Host Name parameter in the Settings tab is set to an In-Sight emulator, the svg files are saved to the emulator directory ([ProgramData]\Cognex\In-Sight\Emulators\x.x.x) and displayed in the In-Sight Files pane. For more information, see In-Sight Files.
  • If a Location and/or Inspection Tool has been configured to hide its overlay graphics by modifying the Tool Options in the Result Display Options dialog, the SVG graphics will not be output. By default, all tools display their overlay graphics.
  • Due to the graphics being rendered by a third-party application, such as a Web browser, the overlay graphic data will not be an exact pixel-for-pixel match.
  • In-Sight firmware does not guarantee the transmission of every SVG and image file pair. If the In-Sight vision system is overloaded, it may skip the transmission of one or both the SVG and/or image file to ensure that inspections and/or image acquisitions are not missed.
ClosedFile Name Preview

Previews the name of the image file that is exported; by default, Image999 is displayed. The file name can be customized by configuring the following parameters: Default File Name, Add Link, Add Timestamp and Add Counter.

Note:
  • Define at least one parameter for the image file. If the Default File Name field is blank and the Add Link, Add Timestamp and Add Counter checkboxes are unchecked, the file export operation will fail.
  • The order of the parameters cannot be changed.
  • When the Add Counter parameter is enabled, the Maximum Value of the counter is always displayed in the File Name Preview.
ClosedDefault File Name

Defines the name of the image file that is exported; the default name is "Image." Long file names are supported.

ClosedAdd Link

Defines whether or not the selected tool will be linked and added to the name of the file that is exported. By default, this checkbox is disabled.

Note:
  • The export operation will fail if the selected tool is linked to a string that contains any of the following invalid characters: <, >, :, ", /, \, |, ? or *.
  • The Add Link checkbox is grayed out when EasyBuilder cannot find any tool that can be linked.
  • If the linked tool is removed from the job, the Add Link checkbox will be automatically disabled.
  • When the Add Link checkbox is enabled, do not select Undefined from the drop-down list; it may produce undefined results.
ClosedAdd Timestamp

Defines whether or not a timestamp will be added to the name of the image file that is exported. By default, this checkbox is disabled. When enabled, one of the following pre-configured timestamp formats can be selected from the drop-down list: MMDDYY, YYYYMMDD_HHMMSS, DDMMYY_HHMMSS, MM-DD-YYYY_HH.MM.SS, HHMMSS, YYMMDD_HHMMSS or YYDDMM_HHMMSS.

Note: You can configure the In-Sight vision system's date/time settings in the Date/Time Setting dialog. For more information, see Date/Time Settings Dialog.
ClosedAdd Counter

Defines whether or not a counter will be added to the name of the image file that is exported (default = enabled). When enabled, the counter's Maximum Value can be specified (0 to 9999999; default = 999). A counter will increment itself as each image file is exported. The counter automatically resets itself when it equals the Maximum Value; existing image files will be overwritten by new files of the same name.

ClosedAdd button

Adds a new export operation to the list.

ClosedRemove button

Removes an export operation from the list. Only one export operation may be removed at a time.

ClosedReset All Counters button

Resets the value added to the name of the image file for each image export operation in the list to 000.

Settings Tab

The Settings Tab provides parameters for defining two target devices. The target device can be an In-Sight emulator, or any other host acting as an FTP server on the network.

ClosedHost Name

Defines the host name (or IP address) for the target device's FTP server.

Note:
  • If an invalid Host Name is specified, the connection may take up to 30 seconds to timeout.

  • When specifying the Host Name or User Name, do not use spaces before or after the name. If the name specified in the Host Name or User Name setting contains a space before or after the name, the image export operation will fail to write the image to the specified server.

  • If you have another PC with an FTP server installed, you can choose that as your storage location. Note that In-Sight Explorer software is considered an FTP server. If you are using a third party FTP server, In-Sight Explorer should be closed. If no other FTP server is running, In-Sight Explorer must be running. If you are using a third party FTP server, the PC's IP address must be used in the Host Name parameter.
  • The port number of the FTP server connection can be changed by appending the Host Name (or IP address) with a colon (:) and the new port number. For example, if the current Host Name was PRODUCTION1, to change the default port number (21) to port 34, the Host Name parameter is changed to: PRODUCTION1:34.
ClosedUser Name

Defines the valid user name for the target device's FTP server (must not exceed 255 characters). This name does not have to exist on the In-Sight vision system that is exporting the image file or data.

ClosedPassword

Defines the valid password for the target device's FTP server. The password is case-sensitive, and its length cannot exceed 20 characters.

Note:
  • For security purposes, the password you enter is masked with "*" in the field.
  • The password will be saved in the job file in encrypted form.
ClosedConnection Type

Defines the type of image export connection: Standard FTP (default selection), Secure FTP or Mitsubishi GOT. Secure FTP provides a secure transmission protocol, for use with SFTP applications, and Mitsubishi GOT provides support for displaying images on a Mitsubishi GOT terminal.

Note: When the Connection Type parameter is set to Mitsubishi GOT, ensure that the File Format parameter in the Images tab is set to JPG for the best display results.
ClosedFTP Settings button

Launches the FTP Settings dialog. For more information, see FTP Settings Dialog.

Note: Typically you do not need to modify the default settings on dedicated, local In-Sight networks where all FTP connections will occur between In-Sight vision systems. However, if FTP connections are needed between In-Sight vision systems and other network servers, or between vision systems on different networks, you may need to change the default FTP settings.
ClosedLast Network Error

Displays the cause of an error when one is encountered during an export operation. An event specified in File Tab - Transfer Condition must have occurred, e.g. triggering an image, or you must place the In-Sight vision system online for this field to be updated.

Copyright © 2008 - 2019  |  Cognex Corporation  |  All Rights Reserved.

EasyBuilder Help  |  2019 August 24  |  Revision: 5.7.4.3