File Transfer Protocol (FTP)

In-Sight vision systems have an integrated FTP client/server that allows them to share files with other vision systems on the network using the FTP protocol. The Save & Open dialogs act as FTP clients and can establish connections with FTP servers on the network to transfer job, image, and firmware update files. For more information, see Save & Open Dialogs.

Vision system settings are stored in the proc.set file. This file contains configuration details for serial ports, discrete input/output, the user list, startup parameters (user & job), and date/time settings. An FTP connection to a vision system may also be initiated from a non-In-Sight host on the network (in which case, the vision system acts as the FTP server.) This is the only method for saving the vision system proc.set file (.SET). This settings file may then be loaded onto other vision systems to replicate a configuration.

Custom applications that automate both the logon process and the issuance of FTP commands to a vision system can be written to run on the remote host.

Note:
  • Only one FTP server can be running on a PC. To ensure proper FTP communications with vision systems, close any third-party FTP servers that might be running on the local PC.
  • The vision system's performance may be degraded if attempting to save or load files while the vision system is Online.
  • File transfers over FTP on an In-Sight 5600 vision system may be slower than on other vision systems.

In-Sight vision systems support standard FTP commands. The following table lists frequently used commands:

FTP Command Description
open [Address] Establishes an FTP connection between a remote host and a vision system.
help Displays a list of available FTP commands.
help [Command] Displays information about an individual FTP command.
dir Displays a list of files that are currently stored on a vision system.

prompt

Toggles Y/N prompting when multiple commands are used. The default setting for prompt is on.

get [File Name]

Downloads a file from an In-Sight system and saves it to the default directory of the FTP client on the remote host.1

Note:
  • If retrieving Sensor filmstrip images stored to the vision system, the filmstrip image file name must be in the following format: get image_rqN.bmp where N is the 0-19 index of a specific filmstrip image. For example, get image_rq3.bmp retrieves the fourth filmstrip image.
  • The following Native Mode commands can be used to perform additional Sensor filmstrip actions.
    • Get /resultQueue/frozen to return the frozen/unfrozen state of the Sensor filmstrip. For more information, see Get /resultQueue/frozen.
    • Put /resultQueue/frozen true to freeze the Sensor filmstrip. For more information, see Put /resultQueue/frozen.
    • Put /resultQueue/frozen false to unfreeze the Sensor filmstrip. For more information, see Put /resultQueue/frozen.
    • Post /resultQueue/clear to clear the Sensor filmstrip. For more information, see Post /resultQueue/clear.
    • Post /resultQueue/toString that returns a string with a 1 (pass) or 0 (fail) for each Sensor filmstrip image. The length of the string is the equal to the number of queued results. For more information, see Post /resultQueue/toString.
mget [File Names] Downloads multiple files from a vision system and saves them to the default directory of the FTP client on the remote host.1,2
put [File Name] Uploads a file to a vision system from the default directory of the FTP client on the remote host.1
mput [File Names] Uploads multiple files to an In-Sight system from the default directory of the FTP client on the remote host.1,2
del Deletes a specified file from the vision system.
mdel Deletes multiple files from the vision system.3
disconnect

Breaks the FTP connection between the remote host and the vision system, and returns user to the FTP command prompt.

Note: a vision system may have a maximum of two FTP connections at any one time.
quit Breaks the FTP connection between the remote host and the vision system, and returns user to the DOS command prompt.
1 FTP will replace an existing copy of the file being transferred without any prompting or warning.

2 Use the "*" wildcard character (i.e., *.job) to specify multiple files. You will be prompted to respond Y or N for each file to be transferred.

3 Use the "*" wildcard character (i.e., *.job) to specify multiple files. You will be prompted to respond Y or N for each file to be deleted.

Example 1: Establishing a FTP Connection Between a Vision System and a Remote Host

  1. Identify the IP address of the vision system.

    Note: The About In-Sight Explorer dialog displays IP addresses for all devices in the In-Sight network. For more information, see About In-Sight Explorer Dialog.
  2. Open the FTP application on the remote host. In Microsoft Windows, you can open a DOS Command Prompt window and type: FTP
  3. At the FTP command prompt, type open Address, where Address is the IP address obtained in Step 1. If the connection is successful, a message similar to the following will appear: 220 In-Sight (R) 5100 Release 3.40.00 (2240) ready (is5100_010203).
  4. At the User prompt, enter a User Name that exists in the vision system's user list. If the User Name is accepted, the following message will appear: 331 User Name OK, need password. For more information, see User Access Settings Dialog.
  5. At the Password prompt, enter the corresponding password for the user name. If the password is accepted, the following message will appear: 230 User UserName logged in.

Example 2: Saving & Loading Vision System Settings Using FTP

Vision system settings are stored in the proc.set file. This file contains configuration details for serial ports, discrete input/output, the user list, startup parameters (user & job), and date/time settings.

Note: Copying the proc.set file to a vision system while it is Online is not allowed.

To save the proc.set file from a vision system to the FTP client:

  1. Establish an FTP connection to a vision system as described in Example 1.
  2. After log on, issue the following command: get proc.set. To verify that the file transfer was successful, look for the proc.set file in the default local directory on the FTP client.

    Note: Issuing the LCD command at the FTP prompt will show the default local directory.

To load the settings file from an FTP client onto a vision system:

  1. Establish an FTP connection to a vision system as described in Example 1.
  2. After log on, issue the following command: put proc.set.

    CAUTION:  This command will overwrite the current settings file on the target vision system without any prompting or warning. Once the file has loaded successfully, restart the target vision system. Any settings in a file that do not apply to the target vision system will be discarded on the target system.