Native Mode Commands

Native Mode Communications Page 1 of 137
Native Mode Communications
In-Sight Communications Reference
About the Native Mode Protocol
Basic Native Mode Syntax
Extended Native Mode Syntax
Communicating with In-Sight Sensors via Serial Port Using Native Mode Commands
Communicating with In-Sight Sensors via Telnet Using Native Mode Commands
List of Native Mode Commands
About the Native Mode Protocol

The In-Sight Native Mode protocol is an ASCII protocol that allows an In-Sight sensor to be controlled from any of the following:
Custom application programs running on a PC

Remote hosts that support standard serial communications
Telnet over an Ethernet network
The Native Mode protocol is divided into two sets of commands: Basic and Extended. Basic Native Mode commands are two characters long, plus
parameters (if any) and a terminator character; extended Native Mode commands include additional functions or commands. The commands are not
case sensitive. The terminator is CR + LF (ASCII characters 13 + 10) when sending Native Mode commands using a telnet connection. When using
Native Mode commands over a serial port, an alternate terminator character may be specified in the Native Mode Details; the default terminator is
CR (ASCII character 13).
When a Native Mode command is remotely issued to an In-Sight sensor, the In-Sight sensor processes the command and then returns a response,
consisting of an ASCII string followed by the terminator character. Commands that set values return 1 for "success", 0 for "unrecognized
command", or a negative number for "failure". Commands that get values return various values, depending on the command.
Notes:
A subset of Native Mode commands can be sent from any PLC (that allows a generic CIP message) over an EtherNet/IP connection using
Explicit Messaging.
The In-Sight 2000 series vision sensor has the following limitations:
Following basic native mode commands are not supported on the In-Sight 2000 series vision sensor: Read Image (RI), Write Image
(WI), Get Value (GV), Set Integer (SI), Set Float (SF), Set Region (SR), Set String (SS), Set Event (SE), Set Event and Wait (SW) and
Send Message (SM).
Extended Native mode commands are not supported on the In-Sight 2000 series vision sensor, except where noted.
The In-Sight 2000-110/120/120C vision sensor is only capable of returning Pass/Fail data. When attempting to retrieve numeric data, an
invalid permission (-6) error will be returned.
Basic Native Mode Syntax

The general syntax of a Basic Native Mode command is as follows:
[command][parameter][terminator]
where [command] consists of two characters. Some Native Mode commands take an optional [parameter].
The Basic Native Mode command is completed with a [terminator] character. The terminator is CR + LF (ASCII characters 13 + 10) when sending
Native Mode commands using a telnet connection. When using Native Mode commands over a serial port, an alternate terminator character may be
specified in the Native Mode Details; the default terminator is CR (ASCII character 13).
Basic Native Mode commands are not case-sensitive. No spaces exist between parameters.
Notes:
file:///C:/Users/laptop/AppData/Local/Temp/~hhC229.htm 24/5/2017
Native Mode commands that are executed on a Job (such as Write Job and Delete Job) are included primarily for backwards compatibility.
The checksum that is used by Native Mode file transfer commands is a standard 16-bit Cyclical Redundancy Check.
Extended Native Mode Syntax

The general syntax of an Extended Native Mode command is as follows:
[command1] [command2] [input parameters][terminator]
where [command1] is any one of the three Extended Native Mode commands (Get, Put, EV). [command2] represents the secondary command,
indicating which data to send, receive, or execute, based upon [command1]. [input parameters] supply optional supplementary information to the
command.
The Extended Native Mode command is completed with a [terminator] character. The terminator is CR + LF (ASCII characters 13 + 10) when
sending Native Mode commands using a telnet connection. When using Native Mode commands over a serial port, an alternate terminator character
may be specified in the Native Mode Details; the default terminator is CR (ASCII character 13).
Extended Native Mode commands are not case-sensitive. Note that spaces exist between certain input parameters.
Communicating with In-Sight Sensors via Serial Port Using Native Mode commands
1. On the Sensor menu, click Serial Port Settings.
2. In the Serial Port Settings dialog, choose Native From the Mode drop-down list.
3. Configure the remote serial device to use the same port settings as the In-Sight sensor.
Note: When using Native Mode commands over a serial port, a different terminator character may be specified in the Native Mode Details, which is
accessed from the Serial Port dialog.
Communicating with In-Sight Sensors via Telnet Using Native Mode Commands
Telnet is a built-in Microsoft Windows client that can be used to remotely communicate with the sensor using In-Sight Native Mode commands.
1. Open the telnet client application on the remote host.

2. In the telnet application, connect to the In-Sight sensor by either its Host Name or IP address. If the connection is successful, a "Welcome to
In-Sight(tm)" message appears, along with the hardware sensor type (for example: 5100, 5400C) and the session number.
3. Enter a valid user name and password for the In-Sight sensor. The user name and password entered must exist in the User List for that sensor.
If the log on is successful, the message "User Logged In" will appear.
You can test the telnet connection by typing the Native Mode Get Value command, "gva000", at the telnet prompt. If successful, the command
returns a 1, followed by the value in cell A0 in the spreadsheet of the In-Sight sensor, #Image:
Custom applications can be written (to run on a remote host) to automate the telnet logon process, as well as to send and receive Native Mode data.
Notes:
By default, when connected via telnet, there is no default timeout. To set a timeout value, use the Put Timeout command.
Under typical use, password echo is disabled in the telnet client application for security purposes.
When using telnet to log on to an In-Sight sensor from a Unix-based platform, the telnet command line must be in the following format:
> telnet <host> <port>

where <host> is either the In-Sight sensor's Host Name or IP Address, and <port> is the remote telnet port (usually 23). Supplying the
port number disables the Unix username/password authentication and forces the Unix system to prompt you for a user name and password.
Native Mode Commands
In-Sight Communications Reference
Basic Native Mode Commands
Extended Native Mode Commands
Basic Native Mode Commands

File & Job Commands
Load File: (LF) Loads the specified job from flash memory on the In-Sight vision system, making it the active job.
Store File: (TF) Saves the current job in flash memory on the vision system.
Read File: (RF) Reads a job from the flash memory on the vision system.
Write File: (WF) Sends a job to the flash memory on the vision system.
Delete File: (DF) Deletes the specified job or cell data file (.cxd) from flash memory on the vision system.
Get File: (GF) Returns the filename of the active job on the vision system.
Set Job: (SJ) Loads a job from one of the job slots in flash memory on the vision system, making it the active job.
Store Job: (TJ) Saves the current job into the specified slot in flash memory on the vision system.
Read Job: (RJ) Reads a job from the specified In-Sight job slot.
Write Job: (WJ) Sends a job to the specified job slot in flash memory on the vision system.
Delete Job: (DJ) Deletes the job from the specified slot in flash memory on the vision system.
Get Job: (GJ) Gets the currently loaded job's ID number.
Image Commands
Read BMP: (RB) Sends the current image, in ASCII hexadecimal format, from a vision system to an external device.
Read Image: (RI) Sends the current image, in ASCII hexadecimal format, from a vision system to an external device.
Write BMP: (WB) Sends image data from an external device to the vision system.
Write Image: (WI) Sends image data from an external device to the vision system.
Settings & Cell Value Commands
Get Value: (GV) Returns the value in a specified cell or symbolic tag.
Set Integer: (SI) Sets an integer value in a specified cell or symbolic tag.
Set Float: (SF) Sets a floating point value in a specified cell or symbolic tag.
Set Region: (SR) Sets the values of an EditRegion cell or symbolic tag.
Set String: (SS) Sets a string value in a specified cell or symbolic tag.
Get Info: (GI) Returns system information about the In-Sight vision system.
Read Settings: (RS) Reads the system settings data from a vision system.
Write Settings: (WS) Sends the system settings data from an external device to the vision system.
Store Settings: (TS) Stores the vision system settings to the proc.set file.
Set IP Address Lock: (SL) Prevents unauthorized changes to a vision system's IP address.
Get IP Address Lock: (GL) Returns the security status of the IP address on a vision system.
Execution & Online Commands
Set Online: (SO) Sets the vision system into Online or Offline mode.
Get Online: (GO) Returns the Online state of the vision system.
Set Event: (SE) Triggers a specified event.
Set Event and Wait: (SW) Triggers a specified event and waits until the command is completed to return a response.
Reset System: (RT) Resets the vision system (similar to physically power cycling the vision system).
Send Message: (SM) Sends a string to the spreadsheet over a Native Mode connection, and optionally, triggers a spreadsheet Event.
Extended Native Mode Commands

Get: Used to receive information from the In-Sight vision system and its spreadsheet.
Put: Used to send information to a vision system and its spreadsheet.
Evaluate
Evaluate: (EV) Executes In-Sight functions as well as inserts formulas into the In-Sight spreadsheet; used to retrieve information and make changes
to In-Sight vision systems.
Note: All In-Sight functions may be used with the EV command; the commands listed below are some of the most common functions to be
executed using the EV command.
GetCellName: Returns the cell location of a specified symbolic tag name, or the symbolic tag name of a specified cell.
GetCellValue: Returns the contents of a specified symbolic tag or spreadsheet cell in XML format.
GetDeEnergizeOutputs: Returns the De-Energize Outputs While Offline setting configured in the Discrete I/O Settings dialog.
GetDiagnosticLog: Returns a log of information used to diagnose errors on the In-Sight vision system.
GetDiscreteInput: Returns information that is configured in the Discrete I/O Settings dialog.
GetDiscreteOutput: Returns information that is configured in the Discrete I/O Settings dialog.
GetDiscreteOutputDelay: Returns delay settings that are configured in the Discrete I/O Settings dialog.
GetEasyBuilderTag: Returns the EasyBuilder Tag for the specified symbolic tag name or cell location.
GetEIPSingleAttribute: Returns In-Sight EtherNet/IP Class and Instance Attributes.
GetFTPSettings: Returns information that is configured in the FTP Settings dialog.
GetHostTable: Returns information contained in the In-Sight Host Table dialog.
GetMSBuffer: Returns the Machine Status data stored in one of 8 indexed buffers (zero-based) within the Machine Status stack.
GetNetwork: Returns information that is configured in the Network Settings dialog.
GetSerialPort: Returns information that is configured in the Serial Port Settings dialog.
GetStartup: Returns information that is configured in the Startup dialog.
GetSystemConfig: Various commands that return system information.
GetUserList: Returns information that is configured in the User List dialog.
SetCellName: Sets the symbolic tag name of a specified cell.
SetCellValue: Sets the value of specific cell appended with an EasyBuilder Tag.
SetDeEnergizeOutputs: Configures the De-Energize Outputs While Offline setting found in the Discrete I/O Settings dialog.
SetDiscreteInput: Configures settings that are found in the Discrete I/O Settings dialog.
SetDiscreteOutput: Configures settings in the Discrete I/O Settings dialog and the Output Details dialog.
SetDiscreteOutputDelay: Configures delay settings that are found in the Output Details dialog.
SetEditRegion: Configures settings for a cell that contains an EditRegion function.
SetEIPSingleAttribute: Configures In-Sight EtherNet/IP Class and Instance Attributes.
SetFavorHostTable: Enables or disables the Favor Host Table over DNS option found in the In-Sight Host Table.
SetFTPSettings: Configures settings that are found in the FTP Settings dialog.
SetHostTable: Configures settings that are found in the In-Sight Host Table dialog.
SetNetwork: Configures settings that are found in the Network Settings dialog.
SetSerialPort: Configures settings that are found in the Serial Port Settings dialog.
SetStartup: Configures settings that are found in the Startup dialog.
SetSystemConfig: Various commands that configure system parameters.
Load File
Basic Native Mode Commands In-Sight Communications Reference
Loads the specified job from flash memory on the In-Sight vision system, RAM Disk or SD Card, making it the active job.
Syntax: LF[Filename]
Notes:
The In-Sight vision system must be Offline.
To load a job file stored in the RAMDisk folder, the syntax is: LFRAMDisk/[Filename]. For example, to load the file "Product.job" stored
in the vision system's RAMDisk folder, issue the following command: "LFRAMDisk/Product.job".
To load a job file stored in the SD Card folder, the syntax is LFSDCARD/[Filename]. For example, to read the file "Product.job" stored in
the vision system's SD Card folder, issue the following command: "LFSDCARD/Product.job".
The Job Server Settings dialog can be used to configure an FTP server that will host In-Sight job files for the In-Sight vision system,
which allows another device, such as a PLC or robot controller via the LF and TF Native Mode commands, to change jobs without
specifying a location.
Load File Inputs
Input Description
Filename The name of the job. The command will execute with or without the .JOB extension.
Load File Outputs
Returns 1 The command was executed successfully.
0 Unrecognized command.
-1 The filename is missing.
-2 The job failed to load, the vision system is Online, or the file was not found.
-4 The job to be loaded was not found, or the vision system is out of memory.
-6 User does not have Full Access to execute the command.
Load File Example

To load "Product" as the active job on the In-Sight vision system, issue the following command: LFProduct.job
The In-Sight sensor responds with 1, indicating that the job was successfully loaded and made active.
Related Topics
Store File
Read File
Write File
Delete File
Get File
Store File
Saves the current job in flash memory on the In-Sight vision system, RAM Disk or SD Card.
Syntax: TF[Filename]
Notes:
If the Allow Online Job Save checkbox is enabled, users with Full or Protected access are allowed to save jobs while Online. If the Allow
Online Job Save checkbox is not enabled, the vision system must be Offline to save jobs.
To save the current job file, with the specified filename, to the vision system's RAMDisk folder, the syntax is: TFRAMDisk/[Filename].
For example, to save the file "Test.job" to the vision system's RAMDisk folder, issue the following command: "TFRAMDisk/Test.job".
To save the current job file, with the specified file name, to the vision system's SD Card folder, the syntax is TFSDCARD/[Filename]. For
example, to save the file "Test.job" stored to the vision system's SD Card folder, issue the following command: "TFSDCARD/Test.job".
The Job Server Settings dialog is used to configure an FTP server that will host In-Sight job files for the In-Sight vision system, which
allows another device, such as a PLC or robot controller via the LF and TF Native Mode commands, to change jobs without specifying a
location.
Store File Inputs
Input Description
Filename The name of the job. The file extension must be .JOB.
Store File Outputs
Returns A status code, followed by a line terminator. The status codes are:
1 The command was executed successfully.
-2 The job failed to save, the vision system is Online or the file was not found, therefore the command could not be
executed.
Store File Example
To name the current job "Test" and save it in flash memory on the In-Sight vision system, issue the following command: TFTest.job
The In-Sight vision system responds with 1, indicating that the current job was successfully saved.
Related Topics
Load File
Read File
Write File
Delete File
Get File
Read File
Reads a job from the specified In-Sight flash memory, RAM Disk or SD Card.
Syntax: RF[Filename]
Notes:
To read a job file stored in the RAMDisk folder, the syntax is: RFRAMDisk/[Filename]. For example, to read the file "Model.job" stored in
the vision system's RAMDisk folder, issue the following command: "RFRAMDisk/Model.job".
To read a job file stored in the SD Card folder, the syntax is RFSDCARD/[Filename]. For example, to read the file "Model.job" stored in the
vision system's SD Card folder, issue the following command: "RFSDCARD/Model.job".
Read File Inputs
Input Description
Read File Outputs
Returns A status code, followed by a line terminator, followed by lines of job data.
The status codes are:
-1 The job filename is missing.
-2 There is no job saved with the given name or the job data is invalid, therefore the command could not be
executed.
The lines of job data are:
Name The first line contains the job name.
Size The second line contains an integer value for the size (in bytes) of the job.
Data The actual job data is encoded as ASCII hexadecimal values formatted to 80 characters per line. Each line
ends with a terminating character.
CheckSum The last line contains four ASCII hexadecimal bytes that are a checksum of the job data.
Read File Example

To receive information about the job "Model.job", which is saved on the In-Sight vision system, issue the following command: RFModel.job
After issuing the Read File command, the first line outputted to the telnet window is the status code (1), followed by the job name (Model.job) and
size (826) in bytes, then the job data (in ASCII hexadecimal format). Finally, the four-byte ASCII hexadecimal checksum is displayed on the last
line (8767).
Note: The size reported by the RF command will be twice the number of bytes of the actual .JOB file size stored on the In-Sight vision system, due
to the ASCII hexadecimal encoding of the data.
Related Topics
Load File
Store File
Write File
Delete File
Get File
Write File
Sends a job to the flash memory on the In-Sight vision system, RAM Disk or SD Card.
Syntax: WF
[Filename]
[Size]
[Data]
[Checksum]
Notes:
To send a job file stored in the vision system's RAMDisk folder, the filename must include the RAMDisk folder path. For example,
"RAMDisk/NewModel.job".
To send a job file stored in the vision system's SD Card folder, the filename must include the SD Card folder path. For example,
"SDCARD/NewModel.job".
Write File Inputs
The command is sent on a separate line, followed by the lines of job data, which should be an exact copy of the data received from a Read File
command. The lines of job data are:
Input Description
Data The actual job data is encoded as ASCII hexadecimal values formatted to 80 characters per line. Each line ends with a
terminating character.
Write File Outputs
-2 The job could not be written, or the job data is invalid.
-3 The checksum failed. The checksum does not match the job data.
-4 The In-Sight vision system is out of memory.
Write File Example
To write job data to the job "NewModel.job", issue the following command: WF. After issuing the Write File command, the first input is the job
name (NewModel.job), followed by the size (826) in bytes. Next, each ASCII hexadecimal byte of the job file is input. Finally, the four ASCII
hexadecimal checksum bytes are input on the last line (8767).
The In-Sight vision system responds with 1, indicating that the job was successfully sent to the vision system's flash memory.
Notes:
If the job file already exists on the vision system, the existing job data is overwritten.
If the job file does not already exist on the vision system, a new job file is created with the specified name.
Related Topics
Load File
Store File
Read File
Delete File
Get File
Delete File
Deletes the specified job or cell data (.CXD) file from flash memory on the In-Sight vision system, RAM Disk or SD Card.
Syntax: DF[Filename]
Notes:
To delete a job or .CXD file stored in the vision system's RAMDisk folder, the syntax is: DFRAMDisk/[Filename]. For example, to delete
the file "Test.job" stored in the vision system's RAMDisk folder, issue the following command: "DFRAMDisk/Test.job".
To delete a job or .CXD file stored in the vision system's SD Card folder, the syntax is: DFSDCARD/[Filename]. For example, to delete
the file "Test.job" stored in the vision system's SD Card folder, issue the following command: "DFSDCARD/Test.job".
Delete File Inputs
Input Description
Filename The name of the job or .CXD file. The file extension must be .JOB or .CXD.
Delete File Outputs
-2 The file could not be deleted, the vision system is Online, a file does not exist with the given name, or the job
data is invalid, therefore the command could not be executed.
Delete File Examples

Example: Delete a Job File
Example: Delete a .CXD File
Example: Delete a Job File
To delete the job "Test.job" from the In-Sight vision system, issue the following command: DFTest.job
The In-Sight vision system responds on the following line with the status code of 1, indicating that the job was successfully deleted.
Example: Delete a .CXD File
To delete the .CXD file "FindPatterns.cxd" from the In-Sight vision system's RAM Disk folder, issue the following command:
DFRAMDisk/FindPatterns.cxd
The In-Sight vision system responds on the following line with the status code of 1, indicating that the .CXD file was successfully deleted.
Related Topics
Load File
Store File
Read File
Write File
Get File
Get File
Returns the filename of the active job on the In-Sight vision system, RAM Disk or SD Card.
Syntax: GF
Notes:
The active job must be saved before this command can be executed successfully.
If the active job is saved to the vision system's RAMDisk folder, the Get File output includes the RAMDisk folder path. For example, if
the active job, "Test.job", is saved in the vision system's RAMDisk folder, the Get File command returns "RAMDisk/Test.job".
If the active job is saved to the vision system's SD Card folder, the Get File output includes the SD Card folder path. For example, if the
active job, "Test.job", is saved in the vision system's SD Card folder, the Get File command returns "SDCARD/Test.job".
Get File Inputs
None.
Get File Outputs
Returns A status code, followed by the name of the file. The status codes are:
-2 The active job has not been saved, therefore the command could not be executed.
Get File Example
Assume that the active, saved job on an In-Sight vision system is named "Test.job". To return the filename of the active job, issue the following
command: GF
The In-Sight vision system responds with 1, indicating that the command executed successfully. On the following line, the active job filename
(Test.job) is displayed.
Notes:
If the active job was loaded from a remote In-Sight vision system, the filename will be displayed in the following format:
FTP://HostName/filename.
If the active job was drag-and-dropped from the PC (and not saved to the sensor), the filename is displayed in the following format: .job.
Related Topics
Load File
Store File
Read File
Write File
Delete File
Set Job
Loads a job from one of the job slots in flash memory on the In-Sight sensor, making it the active job.
Syntax: SJ[ID]
Notes:
The In-Sight sensor must be Offline.
To use the job ID number feature, the job to be loaded must be saved with a numerical prefix of 0 to 999. For backwards compatibility on
non-network capable In-Sight sensors, the prefix must be in the range of 0 to 19.
Set Job Inputs
Input Description
ID The ID number of the job to load (0 to 999).
Set Job Outputs
-1 The ID is less than 0, or is not an integer.
-2 The job failed to load, the sensor is Online or the file was not found, therefore the command could not be executed.
-4 The In-Sight sensor is out of memory.
Set Job Example

To load "85Test.job" as the active job on the In-Sight sensor, issue the following command: SJ85.
The In-Sight sensor responds with 1, indicating that the job was successfully loaded and made active.
Related Topics
Store Job
Read Job
Write Job
Delete Job
Get Job
Store Job
Saves the current job into the specified slot in flash memory on the In-Sight sensor.
Syntax: TJ[ID][Name]
Notes:
If the Allow Online Job Save checkbox is enabled, users with Full or Protected access are allowed to save jobs while Online. If the Allow
Online Job Save checkbox is not enabled, the vision system must be Offline to save jobs.
To use the job ID number feature, the job to be saved must be saved with a numerical prefix of 0 to 999. For backwards compatibility on
Store Job Inputs
Input Description
ID The job ID number (0 to 999).
Name The name of the job. The command will execute with or without the .JOB file extension.
Store Job Outputs
-1 The job ID number is invalid or it is not an integer.
-2 The sensor is Online, therefore the command could not be executed.
Store Job Example
To name the current job "Test" and save it into slot 0 on the In-Sight sensor, issue the following command: TJ00Test.job
The In-Sight sensor responds with 1, indicating that the current job was successfully saved.
Related Topics
Set Job
Read Job
Write Job
Delete Job
Get Job
Read Job
Reads a job from the specified In-Sight job slot.
Syntax: RJ[ID]
Note: For backwards compatibility on non-network capable sensors, the job ID number must be in the range of 0 to 19.
Read Job Inputs
Input Description
Read Job Outputs
Returns A status code, followed by a line terminator, followed by lines of job data.
The status codes are:
-1 The job ID number is outside the allowable range (0 to 999).
-2 The job could not be read, or the job slot is empty, therefore the command could not be executed.
Data The actual job data is encoded as ASCII hexadecimal values formatted to 80 characters per line. Each line
Read Job Example

To receive information about the job named "85Test.job", which is saved on the In-Sight sensor, issue the following command: RJ85
After issuing the Read Job command, the first line outputted to the telnet window is the status code (1), followed by the job name (85Test.job) and
size (826) in bytes, then the job data (in ASCII hexadecimal format). Finally, the four-byte ASCII hexadecimal checksum is displayed on the last
line (5384).
Note: The size reported by the RJ command will be twice the number of bytes of the actual .JOB file size stored on the In-Sight sensor, due to the
ASCII hexadecimal encoding of the data.
Related Topics
Set Job
Store Job
Write Job
Delete Job
Get Job
Write Job
Sends a job to the specified In-Sight job slot in flash memory on the In-Sight sensor.
Syntax: WJ[ID]
[Filename]
[Size]
[Data]
[Checksum]
Notes:
For backwards compatibility on non-network capable sensors, the job ID number must be in the range of 0 to 19.
Write Job Inputs
The command and ID are sent on a separate line, followed by the lines of job data, which should be an exact copy of the data received from a Read
Job command.
Input Description
Input Description
Size The second line contains an integer value for the size, in bytes, of the job.
Data The actual job data is encoded as ASCII hexadecimal values formatted to 80 characters per line. Each line ends with a
Write Job Outputs
-2 The job could not be written, or the job data is invalid.
-3 The checksum failed. The checksum does not match the job data.
Write Job Example
To write job data to the job named "86Test.job", issue the following command: WJ86
After issuing the command, input the job name (Test.job), followed by the size (826) in bytes. Next, each ASCII hexadecimal byte of the job file is
input. Finally, the four ASCII hexadecimal checksum bytes are input on the last line (5384).
The In-Sight sensor responds with 1, indicating that the job was successfully sent to the sensor's flash memory.
Notes:
If the job file already exists on the sensor, the existing job data is overwritten.
If the job file does not already exist on the sensor, a new job file is created with the specified name.
The size will be twice the number of bytes of the actual .JOB file size stored on the In-Sight sensor, due to the ASCII hexadecimal
encoding of the data.
Related Topics
Set Job
Store Job
Read Job
Delete Job
Get Job
Delete Job
Deletes the job from the specified slot in flash memory on the In-Sight sensor.
Syntax: DJ[ID]
Notes:
For backwards compatibility on non-network capable sensors, the job ID number must be in the range of 0 to 19.
Delete Job Inputs
Input Description
Delete Job Outputs
-2 The job could not be deleted, the sensor is Online, or the job slot is empty, therefore the command could not
be executed.
Delete Job Example

To delete the job "Test.job" from slot 0 on the In-Sight sensor, issue the following command: DJ00Test.job
The In-Sight sensor responds on the following line with the status code of 1, indicating that the job was deleted successfully.
Related Topics
Store Job
Set Job
Read Job
Write Job
Get Job
Get Job
Returns the ID of the active job on the In-Sight sensor.
Syntax: GJ
Notes:
To use the job ID number feature, the job to be loaded must be saved with a numerical prefix of 0 to 999. For backwards compatibility on
The active job must be saved with a numerical prefix before this command can be executed successfully. If the job has been dragged and
dropped, the file name must have a numerical prefix before this command can be executed successfully.
When a Get Job command is issued using Motoman communications, the status data is returned but the result data is not returned. Use the
Get File command instead of the Get Job command, or place the job ID number in another cell in the spreadsheet and use the Get Value
command.
Get Job Inputs
None.
Get Job Outputs
Returns A status code, followed by the integer ID of the active job. The status codes are:
-2 The active job has not been saved or does not have a numerical prefix, therefore the command could not be
executed.
Get Job Example

To return the ID for the active job, issue the following command: GJ
The In-Sight sensor responds with 1 to indicate that the command was executed successfully. The active job's name is "85.JOB".
Related Topics
Store Job
Set Job
Read Job
Write Job
Delete Job
Read BMP
Sends the current image, in ASCII hexadecimal format (formatted to 80 characters per line), from an In-Sight sensor out to a remote device. When
converted to binary, the resulting data is in standard BMP image format.
Syntax: RB
Note: Executing the Read BMP command is the equivalent of executing the Read Image command.
Read BMP Inputs
None.
Read BMP Outputs
Returns A status code, followed by a line terminator, followed by lines of image data. The status codes are:
The lines of image data are:
Size The second line contains an integer value for the size, in bytes, of the image.
Image The actual image data is encoded as ASCII hexadecimal values formatted to 80 characters per line. Each line
CheckSum The last line contains four ASCII hexadecimal bytes that are a checksum of the image data.
Read BMP Example
To read the current image (in ASCII hexadecimal format) from an In-Sight sensor, issue the following command: RB
The In-Sight sensor initially responds with 1, indicating the command was successfully executed. The next line contains the size (3436) in bytes,
followed by the image data (in ASCII hexadecimal format.)
Note: Most of the actual image data has been omitted from the preceding graphic for clarity.
Finally, the four-byte ASCII hexadecimal checksum (E213) is returned.
Related Topics
Write BMP
Read Image
Sends the current image, in ASCII hexadecimal format (formatted to 80 characters per line), from an In-Sight sensor out to a remote device. When
converted to binary, the resulting data is in standard BMP image format.
Syntax: RI
Note: Executing the Read Image command is the equivalent of executing the Read BMP command.
Read Image Inputs
None.
Read Image Outputs
Returns A status code, followed by a line terminator, followed by lines of image data. The status codes are:
The lines of image data are:
Size The second line contains an integer value for the size, in bytes, of the image.
Image The actual image data is encoded as ASCII hexadecimal values formatted to 80 characters per line. Each line
Read Image Example

To read the current image (in ASCII hexadecimal format) from an In-Sight sensor, issue the following command: RI
The In-Sight sensor initially responds with 1, indicating the command was successfully executed. The next line contains the data size (3436) in
bytes, followed by the image data (in ASCII hexadecimal format.)
Finally, the four-byte ASCII hexadecimal checksum (E213) is returned.
Related Topics
Write Image
Write BMP
Sends image data from a remote device to an In-Sight sensor.
Syntax: WB
[Size]
[Image]
[Checksum]
Notes:
Executing the Write BMP command is the equivalent of executing the Write Image command.
Write BMP Inputs
The command is sent on a separate line, followed by the lines of image data, which should be an exact copy of the data sent using a Read BMP
command. The lines of image data are:
Input Description
Size An integer value for the size (in bytes) of the image file.
Image The actual image data is encoded as ASCII hexadecimal values formatted to 80 characters per line. Each line ends with a
Write BMP Outputs
-2 The image could not be written, or the image data is invalid.
-3 The checksum failed. The checksum does not match the image data.
Write BMP Example
To send the system settings to the sensor, issue the following command: WB. After issuing the Write BMP command, the first input is the size
(3436) in bytes. Next, each ASCII hexadecimal byte of the image data is input. Finally, the four ASCII hexadecimal checksum bytes are input on
the last line (E213).
The In-Sight sensor responds with 1, indicating that the image data was successfully sent to the sensor.
Related Topics
Read BMP
Write Image
Sends image data from a remote device to an In-Sight sensor.
Syntax: WI
[Size]
[Image]
[Checksum]
Notes:
Executing the Write Image command is the equivalent of executing the Write BMP command.
Write Image Inputs
The command is sent on a separate line, followed by the lines of image data, which should be an exact copy of the data sent using a Read Image
command. The lines of image data are:
Input Description
Size An integer value for the size, in bytes, of the image file.
Image The actual image data is encoded as ASCII hexadecimal values formatted to 80 characters per line. Each line ends with a
Write Image Outputs
-2 The image could not be written, or the image data is invalid.
-3 The checksum failed. The checksum does not match the image data.
Write Image Example
To send the system settings to the sensor, issue the following command: WI
After issuing the Write Image command, the first input is the size (3436) in bytes. Next, each ASCII hexadecimal byte of the image data is input.
Finally, the four ASCII hexadecimal checksum bytes are input on the last line (E213).
The In-Sight sensor responds with 1, indicating that the image data was successfully sent to the sensor.
Related Topics
Read Image
Get Value
EasyBuilder View
Spreadsheet View
EasyBuilder View
Returns the contents of a specified symbolic tag, such as an EasyBuilder Location or Inspection Tool result or job data.
Syntax: GV["Symbolic Tag"]
Get Value Inputs
Input Description
"Symbolic Tag" The name of the symbolic tag [such as a Location or Inspection Tool result or job data ("Job.Robot.FormatString.", for
example)].
Get Value Outputs
Returns A status code, followed by a line terminator, followed by the value contained in the specified symbolic tag. The status codes
are:
-1 The "Symbolic Tag" is invalid.
-2 The command could not be executed.
Note: A symbolic tag containing any numeric value will return a float value formatted to 3 decimal places when requested by the Get Value
command, regardless of whether the tool result or job data contains an integer or a floating-point value. If the symbolic tag contains a non-printing
character, such as a Structure, a pound character (#) will replace the non-printing character. If the tool result or job data is empty, a null string will
be sent.
Get Value Example
You can return the data contained in a symbolic tag, such as an EasyBuilder Location or Inspection Tool result or job data, by sending a Get Value
command.
1. Assume that your job is configured to communicate with a Mitsubishi robot controller:
2. You need to retrieve the data string from the In-Sight vision system, using the Get Value Native Mode command. Issue the command
GVJob.Robot.FormatString, as shown in the following telnet client window:
3. The In-Sight vision system responds with 1, indicating that the command was successfully executed, and the data in the formatted string.
Spreadsheet View
Returns the value contained in the specified cell.
Syntax: GV[Column][Row]
Get Value Inputs
Input Description
Column The column letter of the cell value to get (A to Z).
Row The row number of the cell value to get. The row number must consist of three digits (000 to 399).
Get Value Outputs
Returns A status code, followed by a line terminator, followed by the value contained in the specified cell. The status codes are:
-1 The cell ID is invalid.
Note: An In-Sight cell containing any numeric value will return a float value formatted to 3 decimal places when requested by the Get Value
command, regardless of whether the cell contains an integer or a floating-point value. If the cell contains a non-printing character, such as a
Structure, a pound character (#) will replace the non-printing character. If the cell is empty, a null string will be sent.
Get Value Example
1. Assume that cells A1, B0 and B1 are populated as follows:
A1 = 4.000
B0 = EditInt(0,10)
B1 = EditFloat(0,10)
A1 currently contains the value 4; B0 contains the value 5; and B1 contains the value 3.230. The spreadsheet looks like this:
Issuing various GV commands produces the following results:
Set Integer
EasyBuilder View
Spreadsheet View
EasyBuilder View
Sets the integer value of a symbolic tag, such as a parameter contained in an EasyBuilder Location or Inspection Tool, or job data, to the specified
integer value. The parameter or job data must be an Integer Data Type.
Syntax: SI["Name"][Space][Int]
Set Integer Inputs
Input Description
"Name" The name of the Location or Inspection Tool parameter ("Pattern_1.Model_Type", for example) or EasyBuilder job data
("Job.External_Reset_Counters", for example) to be set.
Space A blank space to separate the "name" from the integer value.
Int The integer value to set.
Set Integer Outputs
-1 The EasyBuilder "Name" is invalid, or was not an Integer Data Type.
-2 The command could not be executed, or the specified integer value is outside of the control's valid range. For
example, the specified name may not contain a control of the valid Data Type.
Set Integer Examples
Example 1: Change the Value of a Parameter Containing an Integer Value
Example 2: Uncheck or Check a Parameter Containing a Checkbox
Example 3: Change the Selection within a Drop-Down List
Example 1: Change the Value of a Parameter Containing an Integer Value
You can set the integer value of a Location or Inspection Tool parameter, or job data, by sending a Set Integer command containing the new integer
value.
1. Assume that your job contains a Pattern Location Tool, and the tool's current Timeout parameter setting is the default, 5000 milliseconds:
2. However, you would like to change that parameter's setting via the Set Integer Native Mode command. Issue the command
SIPattern_1.Timeout 500 as shown in the following telnet client window:
3. The In-Sight vision system responds with 1, indicating that the command was successfully executed. The tool's Timeout parameter has been
successfully changed from 5000 to 500:
Example 2: Uncheck or Check a Parameter Containing a Checkbox
You can enable or disable a tool's checkbox parameter by using the Set Integer command to send a value of 1 (enable) or 0 (disable)
1. Assume that your job contains a Pattern Location Tool, and the tool's current Scale Tolerance parameter setting is the default, disabled
(unchecked):
2. However, you would like to change that parameter's setting programmatically, to either enabled or disabled, based on a particular part. Issue
the command SIPattern_1.Scale_Tolerance 1, as shown in the following telnet client window:
3. The In-Sight vision system responds with 1, indicating that the command was successfully executed. The tool's Scale Tolerance parameter has
been successfully changed from disabled (unchecked) to enabled (checked):
Example 3: Change the Selection within a Drop-Down List
You can change the selection of a tool's drop-down menu list parameter by using the Set Integer command to send an integer indicating the desired
selection. The items within the drop-down menu correspond to a ListBox control, which has an integer value (zero-based) assigned to it. You can
"choose" a different value from the list by using the Set Integer Native Mode command to assign a different value to the parameter that contains the
drop-down menu.
1. Assume that your job contains a Blobs Counting Tool, and the tool's current Blob Color parameter setting is the default, Either/2:
2. However, you would like to change that parameter's setting programmatically, to either Black/0 or White/1, based on a particular product part.
Issue the command SIBlobs_1.Blob_Color 1, as shown in the following telnet client window:
3. The In-Sight vision system responds with 1, indicating that the command was successfully executed. The tool's Blob Color parameter has
been successfully changed from Either/2 to White/1:
Spreadsheet View
Sets the control contained in a cell to the specified integer value. The control must be of the types EditInt, Checkbox, or ListBox.
Syntax: SI[Column][Row][Int]
Set Integer Inputs
Input Description
Column The column letter of the cell value to set (A to Z).
Row The row number of the cell value to set. The row number must contain a three-digit number (000 to 399).
Int The integer value to set.
Set Integer Outputs
-1 The cell ID is invalid, or was not an integer.
-2 The command could not be executed, or the specified integer value is outside of the control's valid range. For
example, the specified cell may not contain a control of the valid type.
Set Integer Examples
Example 1: Change the Value of an EditInt Control
Example 2: Toggle the State of a CheckBox Control
Example 3: Change the Selection within a ListBox Control
Example 1: Change the Value of an EditInt Control
The command to set an EditInt control in cell A2 to the integer value 8 is: SIA0028
1. Assume cell A2 is populated as follows:
A2 = EditInt(0,10)
A2 currently contains the value 3. The spreadsheet looks like this:
2. We would like to change the value in A2 to 8 using the Set Integer Native Mode command; issue the command SIA0028 as shown in the
following telnet client window:
The In-Sight sensor responds with 1, indicating that the command was successfully executed. The EditInt control has been successfully
changed from 3 to 8 within the spreadsheet:
Example 2: Toggle the State of a CheckBox Control
You can enable or disable a CheckBox control using the Set Integer command by sending a value of 1 (enable) or 0 (disable) to the cell that contains
the check box.
1. Assume cells B2, D2 and E2 are populated as follows:
B2 = CheckBox("Draw circle")
D2 = 'Check box integer value =
E2 = $B$2
The check box is currently cleared, as shown:
Note: Cell E2 is simply reporting the integer value of the CheckBox control.
2. To select this check box using the Set Integer Native Mode command, issue the command SIB0021, as shown in the following telnet client
window:
The In-Sight sensor responds with 1, indicating that the command was successfully executed. The check box is now selected:
Cell E2 changed from 0 to 1 to reflect the new integer value of the CheckBox control.
Example 3: Change the Selection within a ListBox Control
Each item within a ListBox control has an integer value (zero-based) assigned to it. You can "choose" a different value from the list by using the Set
Integer Native Mode command to assign a different value to the cell that contains the ListBox control.
1. Assume cells B2, C2 and D2 are populated as follows:
B2 = ListBox("Red", "Orange", "Yellow", "Green", "Blue", "Indigo", "Violet")
C2 = ' Integer List Value =
D2 = $B$2
The ListBox control is currently set to Yellow; this corresponds with an integer value of 2, as shown in the following spreadsheet:
Note: Cell D2 is simply reporting the integer value of cell B2.
2. To change the current list selection to Blue using the Set Integer Native Mode command, issue the command SIB0024, as shown in the
following telnet client window:
The In-Sight sensor responds with 1, indicating that the command was successfully executed. The list selection has been changed from
Yellow to Blue within the spreadsheet:
Cell D2 changed from 2 to 4 to reflect the new integer value of the ListBox control.
Set Float
EasyBuilder View
Spreadsheet View
EasyBuilder View
Sets the floating-point value of a symbolic tag, such as an EasyBuilder Location or Inspection Tool parameter, or job data, to the specified floating-
point value. The symbolic tag must be a Floating Point Data Type.
Syntax: SF["Symbolic Tag"][Space][Float]
Set Float Inputs
Input Description
The name of the symbolic tag [such as a Location or Inspection Tool parameter ("Pattern_1.Horizontal_Offset", for example)
"Symbolic Tag" or EasyBuilder job data ("Acquistion.Exposure_Time", for example)] to be set.
Space A blank space to separate the "symbolic tag" from the floating-point value.
Float The floating-point value to set, including the decimal point (.) character.
Set Float Outputs
-1 The "Symbolic Tag" is invalid, or the specified value does not contain a floating-point number.
-2 The command could not be executed, or the specified floating point value is outside of the control's valid
range. For example, the specified name may not contain a control of the valid Data Type.
Set Float Example
You can set the floating-point value of a Location or Inspection Tool parameter, or job data, by sending a Set Float command containing the new
floating-point value.
1. Assume that your job contains a Pattern Location Tool, and the tool's current Horizontal Offset parameter setting is the default, 0.000:
2. However, you would like to change that parameter's setting via the Set Float Native Mode command. Issue the command
SFPattern_1.Horizontal_Offset 100.302 as shown in the following telnet client window:
3. The In-Sight vision system responds with 1, indicating that the command was successfully executed. The tool's Horizontal Offset parameter
has been successfully changed from 0.000 to 100.302:
Spreadsheet View
Sets an edit box control contained in a cell to a specified floating-point value. The edit box control must be of the EditFloat type.
Syntax: SF[Column][Row][Float]
Set Float Inputs
Input Description
Row The row number of the cell value to set. The row number must consist of three digits (000 to 399).
Float The floating-point value to set, including the decimal point (.) character.
Set Float Outputs
-1 The cell ID is invalid, or the specified value does not contain a floating-point number.
-2 The command could not be executed. For example, the specified cell may not contain an edit box control, or
the edit box control was not created by the EditFloat function.
Set Float Example
The command to set an edit box contained in cell A2 to the floating point value 7.2 is: SFA0027.2
A2 = EditFloat(0,10)
A2 currently contains a value of 3.5. The spreadsheet looks like this:
2. To change this value to 7.2 using the Set Float Native Mode command; issue the command SFA0027.2 as shown in the following telnet client
window:
The In-Sight sensor responds with 1, indicating that the command was successfully executed. The EditFloat control has been successfully
changed from 3.5 to 7.2:
Set Region
EasyBuilder View
Spreadsheet View
EasyBuilder View
Sets a region contained in a symbolic tag, such as an EasyBuilder Location or Inspection Tool'sregion. The tool's region must contain an edit region
control from an EditRegion function.
Syntax: SR["Symbolic Tag"][Space][Row][Space][Col][Space][High][Space][Wide][Space][Angle]

[Space][Curve]
Set Region Inputs
Input Description
"Symbolic Tag" The name of the Location or Inspection Tool ("Edge_1.Region", for example).
Space A blank space to separate the "name" from the floating-point value.
Row The x-offset of the origin, in fixture coordinates.
Space A blank space to separate the value from the next value.
Col The y-offset of the origin, in fixture coordinates.
High The dimension along the region's x-axis.
Wide The dimension along the region's y-axis.
Angle The orientation, in fixture coordinates.
Curve The angular deviation between the region's x-axis and the opposing boundary line.
Set Region Outputs
-2 The command could not be executed because the "Symbolic Tag" does not contain an edit region control, or
the edit region control was not created by the EditRegion function.
Set Region Example
You can set the Region of an EasyBuilder Location or Inspection Tool by sending a Set Region command containing the new region's position,
dimensions, orientation and shape.
1. Assume that your job contains an Edge Location Tool, and the tool's region is currently in another position, with different dimensions,
orientation and shape.
2. However, you would like to move and re-orient the tool's region settings via the Set Region Native Mode command. Issue the command
SREdge_1.Region 192.000 119.000 167.000 20 0.5 0 as shown in the following telnet client window:
3. The In-Sight vision system responds with 1, indicating that the command was successfully executed.
Spreadsheet View
Sets an edit region control contained in a cell; the edit region control must be an EditRegion function.
Syntax: SR[Column][Row][Row][Space][Col][Space][High][Space][Wide][Space][Angle][Space]
[Curve]
Set Region Inputs
Input Description
Row The row number of the cell value to set. The row number must consist of three digits (000 to 399)
Row The x-offset of the origin, in fixture coordinates.
Col The y-offset of the origin, in fixture coordinates.
Angle The orientation, in fixture coordinates.
Curve The angular deviation between the region's x-axis and the opposing boundary line.
Set Region Outputs
-2
The command could not be executed because the specified cell does not contain an edit region control, or the
edit region control was not created by the EditRegion function.
Set Region Example
The command to set an edit region contained in cell A2 to a new location and dimensions.
A2 = EditRegion($A$0,0,0,0,1,1,1,1,"Region",0)
The spreadsheet looks like this:
2. To change the region's location and dimensions using the Set Region Native Mode command; issue the command SRA002437.0 581.2 333.12
441 2 2.3 as shown in the following telnet client window:
The In-Sight sensor responds with 1, indicating that the command was successfully executed:
Set String
EasyBuilder View
Spreadsheet View
EasyBuilder View
Sets the string of a symbolic tag, such as a parameter of an EasyBuilder Inspection Tool, to the specified string. The parameter must be a String
Data Type.
Syntax: SS["Symbolic Tag"][Space][String]
Set String Inputs
Input Description
"Symbolic Tag" The symbolic tag name of the Location or Inspection Tool result ("Text_1.Match_String", for example).
Space A blank space to separate the "name" from the string to set.
String The string to set.
Set String Outputs
-2 The input string is longer than the specified maximum string length in the EditString function or the cell does not
contain an EditString function.
Set String Example
You can set the string of a Read Text or Read ID Code Inspection Tool by sending a Set String command containing the new string.
1. Assume that your job contains a Read Text Identification Tool, and the tool's current Match String parameter setting is the default, ABC:
2. However, you would like to change that parameter's setting via the Set String Native Mode command. Issue the command
SIText_1.Match_String 604 as shown in the following telnet client window:
3. The In-Sight vision system responds with 1, indicating that the command was successfully executed. The tool's Match String parameter has
been successfully changed from ABC to 604:
Spreadsheet View
Sets an edit box control contained in a cell to a specified string. The edit box must be of the type EditString.
Syntax: SS[Column][Row][String]
Set String Inputs
Input Description
Row The row number of the cell value to set. The row number must contain a three-digit number (000 to 399).
String The string to set.
Set String Outputs
-1 The cell ID or is invalid.
-2 The input string is longer than the specified maximum string length in the EditString function or the cell does not
contain an EditString function.
Set String Example
1. Assume cell B2 is populated as follows:
B2 = EditString(20)
The EditString control currently contains the text Before SS. The spreadsheet looks like this:
2. To change this text to After SS using the Set String Native Mode command, issue the command SSB002After SS, as shown in the following
telnet client window:
The In-Sight sensor responds with 1, indicating that the command was successfully executed. The EditString control has been successfully
changed from Before SS to After SS:
Get Info
Returns the system information for the In-Sight vision system.
Syntax: GI
Get Info Inputs
None.
Get Info Outputs
Returns A status code, followed by the system information. The status codes are:
System information includes:
Serial Number The serial number of the In-Sight vision system.
Application Version The current firmware version on the In-Sight vision system.
Monitor Version The Monitor version of the In-Sight vision system.
MAC Address The MAC address of the In-Sight vision system.
Date of Build The date of build of the firmware on the In-Sight vision system.
Get Info Example
To display system information about an In-Sight vision system, issue the following command: GI
The vision system initially responds with 1, indicating the command successfully executed. On the following lines, the system information is
reported.
Read Settings
Reads the system settings data from an In-Sight sensor. The system settings data consist of the contents of the proc.set file, encoded in ASCII
hexadecimal format.
Syntax: RS
Read Settings Inputs
None.
Read Settings Outputs
Returns A status code, followed by a line terminator, followed by lines of settings data. The status codes are:
-2 The settings could not be read.
The lines of settings data are:
Size The first line contains an integer value for the size (in bytes) of the settings data.
Settings The data for the settings is encoded as ASCII hexadecimal values formatted to 80 characters per line. Each line
ends with the terminating character.
CheckSum The last line contains four ASCII hexadecimal bytes that are a checksum of the system settings data.
Read Settings Example
To read system settings data from an In-Sight sensor, issue the following command: RS
The In-Sight sensor initially responds with 1, indicating the command successfully executed. The following line (4246) represents the amount of
data (in bytes) to be transmitted. Finally, the system settings data are sent, followed by a checksum (9A67) of the data.
Notes:
Most of the actual image data has been omitted from the preceding graphic for clarity.
The size reported by the RS command will be twice the number of bytes of the proc.set file, due to ASCII hexadecimal encoding of the
data.
Related Topics
Write Settings
Store Settings
Write Settings
Sends the system settings data from a remote device to the In-Sight sensor.
Syntax: WS
[Size]
[Settings]
[Checksum]
Note: The In-Sight sensor must be Offline.
Write Settings Inputs
The command is sent on a separate line, followed by the lines of settings data, which should be an exact copy of the data received from a Read
Settings command.
The lines of settings data are:
Input Description
Size The first line contains an integer value for the size (in bytes) of the settings.
Settings The data for the settings is encoded as ASCII hexadecimal values formatted to 80 characters per line. Each line ends with the
CheckSum The last line contains four ASCII hexadecimal bytes that are a checksum of the system settings data.
Write Settings Outputs
-2 The settings could not be saved.
-3 The checksum failed. The checksum does not match the settings data.
Write Settings Example

To send the system settings to the sensor, issue the following command: WS
After issuing the Write Settings command, the first input is the size (4246) in bytes. Next, each ASCII hexadecimal byte of the system settings is
input. Finally, the four ASCII hexadecimal checksum bytes are input on the last line (9A67).
The In-Sight sensor responds with a status code of 1, indicating that the command was executed successfully.
Notes:
Most of the actual image data has been omitted from the preceding graphic for clarity.
The size will be twice the number of bytes of the proc.set file, due to ASCII hexadecimal encoding of the data.
Related Topics
Read Settings
Store Settings
Store Settings
Stores the In-Sight sensor settings to the proc.set file.
Syntax: TS
Store Settings Inputs
None.
Store Settings Outputs
Returns A status code. The status codes are:
-2 The sensor is Online, therefore the command could not be executed.
Store Settings Example
To store the sensor settings to the proc.set file, issue the following command: TS
The In-Sight sensor responds with a status code of 1, indicating that the command was executed successfully.
Related Topics
Read Settings
Write Settings
Set IP Address Lock
Prevents unauthorized changes to an In-Sight sensor's IP address.
Syntax: SL[Int]
Set IP Address Lock Inputs
Input Description
Int 0 Unlock the IP address
1 Lock the IP Address
Set IP Address Lock Outputs
-1 The value given for Int is either out of range or is not a valid integer.
Set IP Address Lock Example
To lock the sensor's IP address, issue the following command: SL1
The In-Sight sensor responds with a status code of 1, indicating that the IP address was successfully locked.
Related Topics
Get IP Address Lock
Get IP Address Lock
Returns the security status of the IP address on an In-Sight sensor. The ability to prevent unauthorized changes to the IP address is established by the
Set IP Address Lock command.
Syntax: GL
Get IP Address Lock Inputs
None.
Get IP Address Lock Outputs
Returns 0 The IP address is not locked.
1 The IP address is locked.
Get IP Address Lock Example

To return the security status of the IP address on the sensor, issue the following command: GL
The In-Sight sensor responds with 0, indicating that the IP address is not locked.
Related Topics
Set IP Address Lock
Set Online
Sets the In-Sight sensor into Online or Offline mode.
Syntax: SO[Int]
Notes:
This command cannot place the In-Sight sensor into Online mode if the sensor has been set Offline either manually in the In-Sight Explorer
user interface or by a Discrete Input signal.
The In-Sight Explorer application will send Set Online commands to In-Sight sensors to perform administrative functions such as Backup and
Restore.
Set Online Inputs
Input Description
Int 0 Sets the In-Sight sensor Offline.
1 Sets the In-Sight sensor Online.
Set Online Outputs
-1 The value given for Int is either out of range, or is not a valid integer.
-5 The communications flag was successful but the sensor did not go Online because the sensor is set Offline manually
through the In-Sight Explorer user interface or by a Discrete I/O signal.
Set Online Examples
Example 1: Set the In-Sight Sensor into Online Mode
Example 2: Set the In-Sight Sensor into Offline Mode
Example 1: Set the In-Sight Sensor into Online Mode
To set an In-Sight sensor into Online mode, issue the following command: SO1
The In-Sight sensor responds with a status code of 1, indicating that the sensor was successfully placed Online.
Example 2: Set the In-Sight Sensor into Offline Mode
To set an In-Sight sensor into Offline mode, issue the following command: SO0
The In-Sight sensor responds with a status code of 1, indicating that the sensor was successfully taken Offline.
Get Online
Returns the Online state of the In-Sight sensor.
Syntax: GO
Get Online Inputs
None.
Get Online Outputs
Returns 0 The In-Sight sensor is currently Offline.
1 The In-Sight sensor is currently Online.
Get Online Example

To determine the Online state of an In-Sight sensor, issue the following command: GO
The In-Sight sensor responds with 0, indicating that the sensor is currently Offline.
Set Event
Triggers a specified event in the spreadsheet through a Native Mode command.
SetEvent Inputs
SetEvent Outputs
SetEvent Example
Notes:
If the In-Sight vision system will be configured to accept an acquisition trigger from a PLC/Motion Controller via a Native Mode command,
Cognex recommends that the SetEvent and Wait function be utilized, with the Event code set to 8 (SW8). This will ensure that vision system
waits for both the acquisition and inspection to be completed before sending a "complete" response back to the PLC/Motion Controller, and
that previous inspection results are not being sent to the PLC/Motion Controller. The "complete" response from the vision system can also
then be used to create conditional PLC logic that sends a read request for the inspection results. If the SetEvent function will be used by a
PLC/Motion Controller to trigger an acquisition, it should only be used in circumstances where the inspection results are not also being read.
Otherwise, the acquisition and inspection will not be synchronized, with the vision system returning a response as soon as the image is
acquired and before the inspection has been completed.
In job deployment environments in which In-Sight Explorer or the VisionView application are monitoring inspections, if the job depends
upon a Soft Event (configured as a Timer function, for example) to trigger a spreadsheet event, it may cause the inspection of an image to be
delayed if it is triggered shortly before the acquisition cycle completes. If the job file is large (i.e. it contains many Vision Tools, such as
Pattern Match, Flaw Detection and/or InspectEdge tools, in addition to additional job logic), the update required by In-Sight Explorer or
VisionView may prevent an image from being inspected until the display update is queued. For applications which require exact timing (e.g.
measured in the 10s of milliseconds) , this update may result in a delay in determining a pass/fail results, and thus the transmission of that
result to the next station (e.g. a PLC or motion controller) in the inspection process. Therefore, in these types of application environments,
Cognex recommends that Soft Events not be utilized to avoid the possibility of delayed inspections.
Set Event Inputs
Syntax: SE[Int]
Input Description
Int The Event code to set.
(0 to 7) Specifies a soft trigger (Soft 0, Soft 1, ... Soft 7).
8 Acquire an image and update the spreadsheet. This option requires the AcquireImage function's Trigger
parameter to be set to External, Manual or Network.
Set Event Outputs
-1 The number is either out of range (0 to 8) or not an integer.
Set Event Example
The SetEvent function may be used to trigger events in the spreadsheet through Native Mode commands.
The command to trigger Event 0 (Soft 0) is: SE0
1. Assume cells A2 and A3 are populated as follows:
A2 = Event(80,0)
A3 = Count($A$2,9999,0,0)
2. Using the telnet client, issue 4 consecutive Set Event commands:
The counter in cell A3 is incremented by 1 for each time SE0 is sent:
Set Event and Wait
Triggers a specified event and waits until the command is completed to return a response.
Notes:
The In-Sight vision system must be Online.

If the In-Sight vision system will be configured to accept an acquisition trigger from a PLC/Motion Controller via a Native Mode command,
Cognex recommends that the SetEvent and Wait function be utilized, with the Event code set to 8 (SW8). This will ensure that vision system
waits for both the acquisition and inspection to be completed before sending a "complete" response back to the PLC/Motion Controller, and
that previous inspection results are not being sent to the PLC/Motion Controller. The "complete" response from the vision system can also
then be used to create conditional PLC logic that sends a read request for the inspection results.
Set Event and Wait Inputs
Syntax: SW[Int]
Input Description
(0 to 7) Specifies a soft trigger (Soft 0, Soft 1, ... Soft 7).
8 Acquire an image and update the spreadsheet. This option requires the AcquireImage function's Trigger
parameter to be set to External, Manual or Network.
Set Event and Wait Outputs
-2 The command could not be executed, or the sensor is Offline.
Set Event and Wait Example
The command to trigger Event 0 (Soft 0) is SW0. A response is not sent until the command has been completed.
A2 = Event(80,0)
A3 = Count($A$2,9999,0,0)
2. Place the sensor Online. Using the telnet client, issue 4 consecutive Set Event & Wait commands:
The counter in cell A3 is incremented by 1 for each time SW0 is sent:
Reset System
Resets the In-Sight sensor. This command is similar to physically cycling power on the sensor.
Syntax: RT
Reset System Inputs
None.
Reset System Outputs
Returns A status code, followed by a line terminator, followed by lines of settings data. The only status code returned is:
Reset System Example

To reset the In-Sight sensor, issue the following command: RT
The In-Sight sensor is successfully reset and no status code is returned.
Send Message
Sends a string to an In-Sight spreadsheet over a Native Mode connection, and optionally, triggers a spreadsheet Event.
Syntax: SM"String"[Int]
Send Message Inputs
Input Description
"String" The string to set.
Note: The string must be enclosed with quotation marks.
Note: This is an optional parameter.
(0 to 7) Specifies a soft trigger (Soft 0, Soft 1, ... , Soft 7).
8 Acquire an image and update the spreadsheet. This option requires that the AcquireImage
function's Trigger parameter be set to External or Manual.
Send Message Outputs
-2 The command could not be executed, or the sensor is Offline.
Send Message Examples

Example: Send a Text String
Example: Send a String and Trigger a Spreadsheet Event
Example: Send a Text String
A2 = Event(80,0)
A3 = ReadMessage(A2)
2. Place the sensor Online. Using the telnet client, issue the Send Message command, followed by the Set Event command. The command to
send the string "Test" is SM"Test". The command to trigger Event 0 (Soft 0) is: SE0.
The ReadMessage function in cell A3 displays "Test".
Example: Send a String and Trigger a Spreadsheet Event
A2 = Event(80,0)
A3 = ReadMessage(A2)
2. Place the sensor Online. Using the telnet client, issue the Send Message command to the In-Sight sensor. The command to send the string
"Test" and trigger Event 0 (Soft 0) is: SM"Test"0.
3. Take the sensor Offline. The ReadMessage function in cell A3 displays "Test".
Get
Extended Native Mode Commands - Get In-Sight Communications Reference
Three commands are used in conjunction with the Get extended Native Mode command to receive information from the In-Sight vision system and
its spreadsheet:
Get Connections
Get Expr [Column][Row]
Get Filelist
Syntax: Get [command]
Note: A space is needed between Get and the command, as well as between the command and any input parameters.
Get Connections
Returns current connection information for the In-Sight vision system.
Syntax: Get Connections
Get Connections Inputs
None.
Get Connections Outputs
-1 The input is invalid or has exceeded 15 bytes in length.
-6 A parameter was invalid or exceeded 15 bytes in length.
The number of users currently logged onto the vision system.

The names of the users that are currently logged on to the vision system.
A hexadecimal representation of each user's FTP Read/Write permissions, Access level and Java applet connections.
The FTP Read/Write permissions, Access levels and Java applet connections are:
0x01 Read
0x02 Write
0x08 Users with a Protected access level are restricted from switching the vision system between its Online and
modes of operation.
0x10 Full
0x20 Protected
0x40 Locked
0x80 Java applet connection
The Host Name and IP address (as a hexadecimal number) of each user's vision system.
Get Connections Example
To retrieve the vision system's connection settings, issue the following command: Get Connections
The In-Sight vision system initially responds with the status code (1), followed by the number of users currently logged in to the In-Sight vision
system (2). Next, the connection information is presented for each user. The first user, admin, has a hexadecimal access representation of 0x13; this
representation is obtained by summing the FTP Read/Write permissions and Access level that applies to the user (see preceding table). In this case,
admin has Full access (0x10) + FTP Read permission (0x01) + FTP Write permission (0x02) = 0x13. The user admin is currently connected from
the vision system named FACTORYFLOOR-1. The IP address of FACTORYFLOOR-1 is 192.168.0.1; represented in hexadecimal, this address
becomes C0A80001.
Connection information for the second user (monitor) is presented similarly on the following line.
Get Expr
Returns the parameters or value stored in the cell specified by the column and row address, as well as the state of that cell.
Syntax: Get Expr [Column][Row]
Note: If the specified cell is empty, the two output lines after the status code will be blank.
Get Expr Inputs
Input Description
Get Expr Outputs
-1 The cell ID is invalid or has exceeded 15 bytes in length.
The parameters or values that are stored in the specified cell.
The state of the specified cell.
0 The cell is disabled.
1 The cell is enabled.
Get Expr Example
To retrieve the parameters returned by AcquireImage that is stored in cell A0, issue the following command: Get Expr A000
After issuing the command Get Expr A000, the In-Sight vision system responds with a status code (1), followed by the expression contained within
cell A0. Finally, the cell state (1) is displayed.
Get Filelist
Returns the number of files stored in memory, and the name of each file in memory on the In-Sight vision system.
Syntax: Get Filelist
Notes:
If a RAM Disk folder is enabled on the vision system, the "RAMDisk" folder name is included in the Get Filelist output.
It is not possible to get the file list from a RAM Disk folder using the Get Filelist Native Mode command. In order to obtain the file list of a
RAM Disk folder, use the FTP protocol instead. Note that the CD (change directory) FTP command is not supported.
Get Filelist Inputs
None.
Get Filelist Outputs
Returns A status code, followed by the number of files stored in memory, followed by the name of each file in memory. The status
codes are:
Get Filelist Example
To retrieve a count and list of files that are stored on the In-Sight vision system, issue the following command: Get Filelist
After issuing the command Get Filelist, the In-Sight vision system responds with a status code (1), followed by the number of files present in
memory (13). Finally, the individual name of each file is displayed.
Put
Extended Native Mode Commands - Put In-Sight Communications Reference
Syntax: Put [command] [input parameters]
About Put
The following commands are used in conjunction with the Put extended Native Mode command to send information to an In-Sight vision system
and its spreadsheet:
Put Live [Int]

Put Portnum [Int]
Put Timeout [Int]
Put Update
Put Watch [Column][Row][Int]
Put XML [Int]
Note: A space is needed between Put and the command, as well as between the command and the input parameters (if any.)
Put Live
Turns live acquisition mode on or off.
Syntax: Put Live [Int]
Note: The vision system must be Offline when using the Put Live command.
Put Live Inputs
Input Description
0 = Disable live acquisition mode.

Int
1 = Enable live acquisition mode.
Put Live Outputs
A status code. The status codes are:
1
The command was executed successfully.
Returns 0 Unrecognized command.
-1
The input is invalid or has exceeded 15 bytes in length.
-2
The command could not be executed, or the vision system is Online.
Put Live Example
To place the vision system into live acquisition mode, issue the following command: Put Live 1
The In-Sight vision system responded with a status code of 1, indicating that the vision system was successfully placed into live acquisition mode.
To take the vision system out of live acquisition mode, issue the command: Put Live 0
The In-Sight vision system responded with a status code of 1, indicating that the vision system was successfully taken out of live acquisition mode.
Put Portnum
Specifies the port that will be used by the In-Sight vision system for transferring data or images over the network.
Syntax: Put Portnum [Int]
Notes:
The Portnum command must be executed before another device can connect to the specified port.
If the port number is changed, the In-Sight OPC Server will be disabled.
The In-Sight 2000 series vision sensor does not support this extended native mode command, and returns -2 when issued.
Put Portnum Inputs
Input Description
Specifies the port number.
Int (1 to 65535)
Note: A valid port assignment is any unused number from 1 to 65535, except for ports used for In-Sight communications.
Put Portnum Outputs

Returns 0
Unrecognized command.
-1
-2 The command could not be executed, or the vision system is Online.
-6
User does not have Full Access to execute the command.
Put Portnum Example
To specify 3001 as the port to be used for transferring data or images across the network, issue the following command: Put Portnum 3001
The In-Sight vision system responded with a status code of 1, indicating that the port number was successfully changed to 3001.
Put Timeout
Specifies the amount of time (ms) that a port connection from a client may be left open without any activity. If the In-Sight vision system does not
receive any messages from the client for the specified amount of time, it will close the port.
Syntax: Put Timeout [Int]
Note: The timeout is reset to the default (0 ms) if the In-Sight vision system is rebooted.
Put Timeout Inputs
Input Description
Int 0* or -1 Does not timeout.
(1 to 9999999) Duration of time (ms) that a port connection may be left open without any activity.
* denotes default value
Put Timeout Outputs
1
Returns The command was executed successfully.
-6
Put Timeout Example
To specify a timeout of 30000 ms, issue the following command: Put Timeout(30000)
The In-Sight vision system responded with a status code of 1, indicating that the timeout was successfully changed to 30000.
Put Update
Updates the GUI (spreadsheet, cell graphics and image display).
Syntax: Put Update [Int]
Put Update Inputs
Input Description
Int 1 = Updates the GUI (spreadsheet, cell graphics and image display).
Put Update Outputs
1
The command was executed successfully.
-1
-2
The command could not be executed.
Put Update Example
To update the GUI, issue the following command: Put Update 1
The In-Sight vision system responded with a status code of 1, indicating that the command successfully executed.
Put Watch
Returns the value contained in the specified cell each time the cell is updated. The Put Watch command can be used to specify output cells and send
data using the DataChannel.
Syntax: Put Watch [Column][Row][Int]
Notes:
The Put Portunum command must be executed to specify a port to which the Put Watch command will send information.
The In-Sight 2000 series vision sensor does not support this extended native mode command, and returns -2 when issued.
Put Watch Inputs
Input Description
Column
The column letter of the cell value to set (A to Z).
0 = disable output of the cell value

Int 1 = enable output of the cell value only when it changes
2 = enable output of the cell value on every acquisition
Put Watch Outputs
A status code, followed by a line terminator, followed by the value contained in the specified cell. The status codes are:

-1
Put Watch Example
To receive information from cell A0, only when that cell is updated, issue the following command: Put Watch A000
The In-Sight vision system responded with a status code of 1, indicating that the command successfully executed.
Put XML
Specifies whether Native Mode command output results are formatted in XML.
Syntax: Put XML [Int]
Put XML Inputs
Input Description
0 = disable XML formatting (default)

Int
1 = enable legacy XML formatting
2 = enable strict XML formatting
Put XML Outputs
Returns
0
Unrecognized command.
Put XML Example
In the following examples, the standard output is compared with legacy XML-enabled output and strict XML-enabled output.
Put XML 0
To disable XML formatting for the output results, issue the following command: Put XML 0. The In-Sight vision system responds with 1,
indicating the XML has been successfully disabled. Next, issue the Get Filelist command.
Put XML 1
To enable legacy XML formatting for the output results, issue the following command: Put XML 1. The In-Sight vision system responds with 1,
using the appropriate XML formatting, indicating that legacy XML has been successfully enabled. Next, issue the Get Filelist command; the
response is in legacy XML format.
Put XML 2
To enable strict XML formatting for the output results, issue the following command: Put XML 2. The In-Sight vision system responds with 1,
using the appropriate XML formatting. Next, issue the Get Filelist command; the response is in strict XML format (for example, the FileName ID
value is enclosed in quotes).
Evaluate
Extended Native Mode Commands - Evaluate In-Sight Communications Reference
Executes In-Sight functions, as well as inserting formulas into the In-Sight spreadsheet. Evaluate executes commands for retrieving information
from, and making changes to, In-Sight vision systems.
Syntax: EV [command]
Notes:
In-Sight functions that return a data structure cannot be executed using the Evaluate command; however, these functions can be inserted into
the In-Sight Spreadsheet.
Changes made to the In-Sight system settings using the Evaluate command are temporary; rebooting the In-Sight vision system will lose any
changes. To save settings to the proc.set file, use the Store Settings command.
Evaluate Inputs
Command Any supported In-Sight function, or a legal string of functions, as well as general commands.
Note: Any inputs that are enclosed in quotation marks (such as "DHCPTimeout" for GetSystemConfig) must be enclosed by quotes when sent to the
In-Sight vision system.
Evaluate Outputs
-4 The In-Sight vision system is out of memory.
The number of characters (in bytes) contained within the output that follows.
The results of the expression in XML format (only shown if the status code is 1.)
Note: The results of the expression are dependent on the command that is executed.
Evaluate Examples
Example: Remotely Place an In-Sight Formula into a Spreadsheet Cell Using the Evaluate Command
Example: Retrieve Information from the In-Sight Vision System Using the Evaluate Command and In-Sight Functions
Example: Retrieve In-Sight Network Settings Using the Evaluate Command
Example: Change Specific In-Sight Settings Using the Evaluate Command
Example: Remotely Place an In-Sight Formula into a Spreadsheet Cell Using the Evaluate Command
The general syntax to remotely place an In-Sight formula into a spreadsheet cell using the Evaluate command is as follows:
Syntax: EV [Column][Row] [Cell state] [Formula]
Evaluate Inputs
Row The row number of the cell value to set (0 to 399).
Cell state The current state for the specified cell (0 = Disabled; 1 = Enabled).
Notes:
Cell state can also reference (absolute or relative) another cell. If the referenced cell is empty, the cell state will be 0.
If a Controls Function, containing a text label, is inserted into the spreadsheet with the cell state specified as disabled, the
GUI will only show the graphic associated with the control. The text label will remain hidden in the spreadsheet until the
cell state is modified within the spreadsheet.
Formula A combination of values, functions, arguments, and operators used to create a formula.
Example A: Remotely Inserting Basic Functions
1. Assume the spreadsheet is configured as follows:

A3 = 3
A4 = 4
A5 = 5
A6 = 6
Formulas can be inserted into the In-Sight spreadsheet using a remote connection.
2. While logged on to the In-Sight vision system through a telnet client, type the following command: EV A8 1 Sum(1,2,A3:A6)
The In-Sight responds with a status code (1) followed by the number of bytes (0) of XML data returned. This evaluate command inserts
the formula Sum(1,2,A3:A6) into Cell A8.
Note: The actual result returned by the Sum spreadsheet function, 21, is not returned by this Evaluate command as XML data; use the Get Value
command to retrieve this result instead.
Example B: Remotely Inserting Functions with Property Sheets
Functions that contain parameters selected from a property sheet can also be remotely inserted into the spreadsheet. From the telnet client, type the
following command: EV A2 1 ExtractBlobs($A$0,0,0,0,40,276,381,450,0,0,8,-1,0,0,2,1,100,100000,0)
As shown in the following image, the In-Sight vision system responds with a status code (1) and the size (0) of XML data returned.
The ExtractBlobs function has successfully been inserted into cell A2 of the spreadsheet:
Example: Retrieve Information from the In-Sight Vision System Using the Evaluate Command and In-Sight Functions
1. Assume that an In-Sight spreadsheet contains a data structure in cell A2 that was obtained from a ReadIDCode function; the decoded
string is returned in the adjacent cell, as follows:
A2 = ReadIDCode($A$0,0,0,0,156.798,216.083,178.964,179.119,0,128,0,1,3,0,0,0,0,15,0,2,1,0,0,6,0,0,0)
2. Using a telnet client, log on to the In-Sight vision system and type EV GetString(A2) as follows:
The In-Sight vision system returns a status code of 1, indicating that the command was executed successfully. The next line reports that
36 bytes of XML data were returned, while the final line consists of the results of the expression, formatted in XML.
Example: Retrieve In-Sight Network Settings Using the Evaluate Command
While logged on to an In-Sight vision system from a telnet client, type EV GetNetwork() to retrieve the system network settings. The telnet client
output is shown in the following image:
The In-Sight vision system responds with a status code of 1 to indicate that the command was executed successfully. The next line contains the size
(552 bytes) of the XML data to follow; the remaining lines consist of the actual XML data that was returned.
Example: Change Specific In-Sight Settings Using the Evaluate Command
This example sets the Idle Timeout, Read Timeout, Connection Retry, Local Port, Remote Port, and Passive Transfer FTP settings on an In-Sight
5100 vision system. While logged on to the In-Sight vision system from a telnet client, issue the following command: EV SetFTPSettings
(120,120,1,21,21,0)
The telnet client output is shown in the following image:
The In-Sight vision system responds with a status code of 1, indicating that the command successfully executed. Next, 18 represents the number of
XML output bytes to follow. Finally, the actual XML data is shown.
GetCellName
Returns the cell location of a specified symbolic tag name, or the symbolic tag name of a specified cell.
Syntax: EV GetCellName("Name")
GetCellName Inputs
Input Description
The name of the symbolic tag (such as Distance_1.Distance, for example) or the cell location (A4, for example). The name must be
"Name"
enclosed in quotation marks.
GetCellName Outputs
Returns A status code followed by the number of characters, and the name or cell reference of the cell. The status codes are:
GetCellName Example
Symbolic Tag Name
To get the symbolic tag name of cell B116, issue the following command: EV GetCellName("B116")
Issuing this command produces the following result:
The In-Sight sensor returns 1 to indicate that the command was executed successfully; the number of characters (in bytes) is followed by the
Symbolic Tag name.
Symbolic Tag Name Cell Location
To get the cell location of a symbolically tagged Distance Measurement Tool result, issue the following command: EV GetCellName
("Distance_1.Distance")
The In-Sight sensor returns 1 to indicate that the command was executed successfully. The number of characters (in bytes) is followed by the cell
location.
GetCellValue
Returns the contents of a specified symbolic tag, such as an EasyBuilder fixture output, EasyBuilder Location or Inspection Tool result or
Spreadsheet cell, in XML format.
Note: If a job is being built and configured in a language other than English and the Use English Symbolic Tags for EasyBuilder option is enabled
(checked) in the Options dialog, User Interface panel, any symbolic tags references that were created prior to enabling the option must be updated to
the English name version.
Syntax: EV GetCellValue("Symbolic Tag")
GetCellValue Inputs
Input Description
"Symbolic Tag"
Input Description
The name of the symbolic tag, such as a Location or Inspection Tool result ("Distance_1.Distance", for example) or the cell
reference (A4, for example). For the automatically generated EasyBuilder fixture output data, the name must be either
"Job.Robot.FormatString" or "Job.FormatString", depending upon the selected Device and Protocol selected in the
Communications Application Step. The name must be enclosed in quotation marks.
GetCellValue Outputs
Returns A status code followed by the number of characters, and the contents of the cell (an integer, floating point value, or text string). The status
codes are:
GetCellValue Example
EasyBuilder
To retrieve fixture data for vision guided robotics applications, or the result of a Location or Inspection Tool:
Fixture Example for Vision Guided Robotics Applications
There are two possible commands to issue, depending upon the selected Device and Protocol in the Communication step: EV GetCellValue
("Job.Robot.FormatString") and EV GetCellValue("Job.FormatString").
EV GetCellValue("Job.Robot.FormatString") should be used in the following situations:
The Device selection is Robot.

The Device selection is Other, and the Protocol selected is either Serial Kuka or Serial Motoman.
EV GetCellValue("Job.FormatString") should be used in the following situations:
The Device selection is Other, and the Protocol selected is Ethernet Native, Serial Native, Serial Text or TCP/IP.
EV GetCellValue("Job.Robot.FormatString")
The In-Sight sensor returns 1 to indicate that the command was executed successfully. The number of characters (in bytes) is followed by the value
in the cell (integer, floating point, or text string).
EV GetCellValue("Job.FormatString")
Location or Inspection Tool Result Example
The following example illustrates issuing a command to retrieve the result of a Distance Measurement Tool:
EV GetCellValue("Distance_1.Distance")
Spreadsheet
To retrieve the value in a specific Spreadsheet cell, issue the following command:
EV GetCellValue("A52")
GetDeEnergizeOutputs
Returns the De-Energize Outputs While Offline setting configured in the Discrete I/O Settings dialog.
Syntax: EV GetDeEnergizeOutputs()
GetDeEnergizeOutputs Inputs
None.
GetDeEnergizeOutputs Outputs
Returns A status code, followed by the number of characters (in bytes) for the results, then the results in XML format.
GetDeEnergizeOutputs Example
To retrieve the De-Energize Outputs While Offline setting, issue the following command: EV GetDeEnergizeOutputs()
The In-Sight sensor responds with a status code (1), followed by the number of characters, in bytes (18). Finally, the De-Energize Outputs While
Offline setting is returned.
GetDiagnosticLog
Returns a log of information used to diagnose errors on the In-Sight vision system.
Syntax: EV GetDiagnosticLog()
GetDiagnosticLog Inputs
None.
GetDiagnosticLog Outputs
GetDiagnosticLog Example
To retrieve the diagnostic log of the connection status between the In-Sight Micro 1100 vision system and the CIO-MICRO, CIO-MICRO-CC, or
CIO-WENET Ethernet I/O module, issue the following command: EV GetDiagnosticLog()
The In-Sight sensor responds with a status code (1), followed by the number of characters (446), in bytes. Finally, the diagnostic log is returned.
GetDiscreteInput
Returns information that is configured in the Discrete I/O Settings dialog.
Syntax: EV GetDiscreteInput()
GetDiscreteInput Inputs
None.
GetDiscreteInput Outputs
GetDiscreteInput Example
To retrieve the information configured in the Discrete I/O Settings dialog, issue the following command: EV GetDiscreteInput()
Note: Count, in the first XML tag, represents the number of discrete inputs. Each discrete input is assigned a Line ID (zero-based.)
The In-Sight sensor responds with a status code (1), followed by the number of characters, in bytes (43). Finally, the information configured in the
Discrete Input Settings dialog is returned.
GetDiscreteOutput
Returns information that is configured in the Discrete I/O Settings dialog.
Syntax: EV GetDiscreteOutput()
GetDiscreteOutput Inputs
None.
GetDiscreteOutput Outputs
GetDiscreteOutput Example
To retrieve the information configured in the Discrete I/O Settings dialog, issue the following command: EV GetDiscreteOutput()
Note: Count, in the first XML tag, represents the number of discrete outputs. Each discrete output is assigned a Line ID (zero-based.)
Discrete I/O Settings dialog is returned.
GetDiscreteOutputDelay
Returns delay settings that are configured in the Output Details dialog.
Syntax: EV GetDiscreteOutputDelay(LineID,[Model])
GetDiscreteOutputDelay Inputs
Input Description
LineID The output line number.
IOModule is an optional parameter that can be used to return the Discrete Output Delay for a specific I/O Module type.
0 = Direct I/O / CIO-1350

IOModule
1 = CIO-1450 and CIO-1460
2 = CIO-1400
3 = CIO-MICRO and CIO-MICRO-CC
GetDiscreteOutputDelay Outputs
Output Description
0 = None
Type 1 = Acquisition Delay
2 = Time After Trigger
Output Description
Delay If Type = 0, Delay is ignored and forced to 0.
If Type = 1, Delay returns the number of acquisition or tracking pulses (0 to 1000) that the output is delayed after a signal pulse is
received by an output Line. If this value is 0, then the In-Sight vision system updates the output line immediately on evaluating
the WriteDiscrete function. If this value is > 0, then the output Line is always pulsed.
If Type = 2, Delay returns the amount of time (0 to 10000 ms) before the output is fired.
GetDiscreteOutputDelay Example
To retrieve the delay settings for Line 3 for a CIO-MICRO I/O Module, issue the following command: EV GetDiscreteOutputDelay(3,3)
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (87). Finally, the Type (Time After
Trigger) and the Delay (250 ms) are returned.
GetEasyBuilderTag
Returns the EasyBuilder Tag for the specified symbolic tag name or cell location.
Syntax: EV GetEasyBuilderTag("Name")
GetEasyBuilderTag Inputs
Input Description
The name of the symbolic tag or the cell location. When the input is a symbolic tag, it must be enclosed in quotation marks. When the
"Name"
input is a cell location, quotation marks are optional.
GetEasyBuilderTag Outputs
Returns A status code followed by the EasyBulder Tag name. The status codes are:
GetEasyBuilderTag Example
Symbolic Tag Name
To return the EasyBuilder Tag associated with the Acquistion.Frames_Per_Second symbolic tag, issue the following command: EV
GetEasyBuilderTag("Acquisition.Frames_Per_Second")
The In-Sight sensor returns 1 to indicate that the command was executed successfully and the number of characters in bytes (34). Finally, the results
are returned in XML format.
Cell Location
To return the EasyBuilder Tag for cell F11, issue the following command: EV GetEasyBuilderTag(F11)
GetEIPSingleAttribute
Returns In-Sight EtherNet/IP Class and Instance Attributes.
Syntax: EV GetEIPSingleAttribute(Image Event,Class,Instance,Attribute)
Note: The GetEIPSingleAttribute Native Mode command is only supported on sensors with firmware version 3.1.0 - 3.2.5. For sensors with
firmware version 3.3.0 and higher, if the implicit connection times out, the sensor automatically deletes the implicit connection and session.
GetEIPSingleAttribute Inputs
Input Description
Image Event References cell A0 in the spreadsheet. When an Image Event is triggered, the spreadsheet cell updates.
Class The decimal identifier assigned to the Control and Information Protocol Class.
Instance The decimal value of the Instance being referenced.
Attribute The decimal identifier of the Attribute.
GetEIPSingleAttribute Outputs
Returns A status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes
are:
The results are:
Value 0 Transition to Timed Out
1 Auto Delete
GetEIPSingleAttribute Example
To return the In-Sight EtherNet/IP Class and Instance Attributes, issue the following command: EV GetEIPSingleAttribute(A0,5,0,12)
The In-Sight sensor responds with a status code (1), followed by the number of characters, in bytes (18). Finally, the value (1) is returned.
GetExternalLightMode
Returns the type of external strobe device connected to the In-Sight 7000 series vision system.
Syntax: EV GetExternalLightMode()
GetExternalLightMode Inputs
None.
GetExternalLightMode Outputs
Status Code A status code, followed by the number of characters (in bytes) for the results, then the results in XML format.
OutputMode
0 Disabled
1 PNP (Sourcing)
2 NPN (Sinking)
GetExternalLightMode Example
To return the type of external strobe device connected to the vision system, issue the following command: EV GetExternalLightMode()
The In-Sight sensor responds with a status code (1), followed by the number of characters (18), in bytes. Finally, the OutputMode is returned (2),
indicating that the vision system is connected to an NPN (Sinking) external strobe device.
GetFTPSettings
Returns information that is configured in the FTP Settings dialog.
Syntax: EV GetFTPSettings()
GetFTPSettings Inputs
None.
GetFTPSettings Outputs
GetFTPSettings Example
To retrieve the information configured in the FTP Settings dialog, issue the following command: EV GetFTPSettings()
FTP Settings dialog is returned.
GetHostTable
Returns information contained in the In-Sight Host Table dialog.
Syntax: EV GetHostTable()
GetHostTable Inputs
None.
GetHostTable Outputs
GetHostTable Example
To retrieve the information contained in the In-Sight Host Table dialog, issue the following command: EV GetHostTable()
Note: Count, in the first XML tag, represents the number of hosts in the Host Table.
In-Sight Host Table dialog is returned.
GetMSBuffer
Returns the Machine Status data stored in one of 8 indexed buffers (zero-based) within the Machine Status stack. If Index is 0, the current Machine
Status is returned.
Syntax: EV GetMSBuffer(Index)
Note: The In-Sight 2000 series vision sensor does not support this extended native mode command, and returns -2 when issued.
GetMSBuffer Inputs
Input Description
Index Identifies which buffer to return (0 to 7).
GetMSBuffer Outputs
GetMSBuffer Example
To retrieve the Machine Status data stored in buffer 0 within the Machine Status stack, issue the following command: EV GetMSBuffer(0)
The In-Sight sensor responds with a status code (1), followed by the number of characters, in bytes (582). Finally, the Machine Status data is
returned.
Notes:
The date and time specified for <BootTime> will only be current after the power has been cycled on an In-Sight device if the Use SNTP
Services checkbox is selected and an SNTP server is located.
The GetMSBuffer command can be used without the EV prefix by accessing the Machine Status Port.
GetNetwork
Returns information that is configured in the Network Settings dialog.
Syntax: EV GetNetwork()
GetNetwork Inputs
None.
GetNetwork Outputs
GetNetwork Example
To retrieve the information configured in the Network Settings dialog, issue the following command: EV GetNetwork
Network Settings dialog is returned. In this example, the sensor is configured dynamically by the DHCP server on startup. If the UseDHCP input is
set to 0, the settings for static IP assignment are used.
GetSerialPort
Returns information that is configured in the Serial Port Settings dialog. A valid serial Port (1) must be specified.
Syntax: EV GetSerialPort(Port)
GetSerialPort Inputs
Input Description
Port Specifies which serial port's data will be returned.
GetSerialPort Outputs
GetSerialPort Example
To retrieve the information configured in the Serial Port Settings dialog, issue the following command: EV GetSerialPort(1)
Serial Port Settings dialog is returned.
Note: If Mode is set to 1 (Unused), GetSerialPort returns -1 for the Mode output.
GetStartup
Returns information that is configured in the Startup dialog.
Syntax: EV GetStartup()
GetStartup Inputs
None.
GetStartup Outputs
GetStartup Examples
To retrieve the information configured in the Startup dialog, issue the following command: EV GetStartup()
Startup dialog is returned.
GetSystemConfig
These parameters are used in conjunction with the GetSystemConfig Evaluate Native Mode command to return system information.
Active Cells Limit

DHCP Timeout
Telnet Port
Network Supported Link Modes
Network Requested Link Mode
Services Enabled
Internal Temperature
Active Cells Limit

Returns the number of available spreadsheet cells settings configured in the Active Cells Limit dialog.
Syntax: EV GetSystemConfig("ActiveCellLimit")
Inputs
Input Description
"ActiveCellLimit" The active cell limit, in units of cells. (2048 to 10400)
Outputs
A status code, followed by the number of characters (in bytes) for the results, then the results in XML format.

Returns
Example
To retrieve the active cell limit of the In-Sight vision system or vision system, issue the following command: EV GetSystemConfig
("ActiveCellsLimit")
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (33). Finally, the current limit (6144),
followed by the minimum (2048) and maximum (8192) range active cell limit ranges are returned.
DHCP Timeout
Returns DHCP Timeout information that is configured in the Network Settings dialog.
Syntax: EV GetSystemConfig("DHCPTimeout")
Inputs
Input Description
The time (5 to 180 seconds; default = 60) an In-Sight vision system will wait for a DHCP server to respond with an available IP
"DHCPTimeout" address, when the vision system is configured for DHCP. If the vision system times out, network communication will be
suspended. The vision system will not attempt to connect to the network again until power is cycled on the vision system.
Outputs
Example
To retrieve the DHCP Timeout information configured in the Network Settings dialog, issue the following command: EV GetSystemConfig
("DHCPTimeout")
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (21). Finally, the DHCP Timeout
information (30) is returned.
Telnet Port
Returns Telnet Port information that is configured in the Network Settings dialog.
Syntax: EV GetSystemConfig("TelnetPort")
Inputs
Input Description
The telnet port on which the active In-Sight vision system (a TCP/IP server waiting for communication) listens for incoming requests
"TelnetPort" from a remote device (a TCP/IP client that initiates communication). A valid port assignment is any unused number between 1 and
65535, excluding 21, 68, 80, 502, 1069, 1070, 1212, 2222, 44818 and 50000 (reserved for In-Sight communications).
Outputs
A status code, followed by the number of characters (in bytes) for the results, then the results in XML format.

Returns
Example
To retrieve the Telnet Port information configured in the Network Settings dialog, issue the following command: EV GetSystemConfig
("TelnetPort")
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (23). Finally, the Telnet Port information
(23) is returned.
Network Supported Link Modes

Returns the Ethernet link speeds and duplex modes (half or full) supported by the vision system, as configured in the Network Settings dialog.
Syntax: EV GetSystemConfig("Network.SupportedLinkModes")
Inputs
Input Description
"Network.SupportedLinkModes" The Ethernet link speeds and duplex modes supported by the vision system.
Outputs
Results
Result Description
0 Auto-Negotiate
100 10 Mbps Half Duplex
101 10 Mbps Full Duplex
Note: The 1000 Mbps Full Duplex option is only available for vision systems that support 1000 Mbps Ethernet speeds. For In-Sight 5600 series
vision systems, it is only available on models with 128MB non-volatile flash memory or higher.
Example
To retrieve the supported link speeds and duplex modes for the vision system, issue the following command: EV GetSystemConfig
("Network.SupportedLinkModes")
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (36). Finally, the supported Ethernet link
speeds and duplex modes are returned.

Returns the vision system's current Ethernet link speed and duplex mode (full or half), as configured in the Network Settings dialog.
Syntax: EV GetSystemConfig("Network.RequestedLinkMode")
Inputs
Input Description
"Network.RequestedLinkMode" The vision system's current Ethernet link speed and duplex mode.
Outputs
Results
Result Description
0 Auto-Negotiate*
*denotes default value
Note: The 1000 Mbps Full Duplex option is only available for vision systems that support 1000 Mbps Ethernet speeds. For In-Sight 5600 series
Example
To retrieve the current link speed for the vision system, issue the following command: EV GetSystemConfig("Network.RequestedLinkMode")
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (20). Finally, the current link speed is
returned.
Services Enabled
Returns Protocol Services information that is configured in the Network Settings dialog.
Note: The EtherNet/IP and ProfiNET services are mutually exclusive, therefore both services cannot be enabled at the same time.
Syntax: EV GetSystemConfig("ServicesEnabled")
Inputs
Input Description
"ServicesEnabled" Services currently enabled on the vision system.
Outputs
-2 The active job has not been saved, therefore the command could not be executed.
The results are:
The value returned is a decimal value, converted from its binary equivalent.
Service Binary Decimal Equivalent
ProfiNET 100 4
EtherNet/IP 010 2
Modbus Server 001 1
None 000 0
If more than one service is enabled, you can convert the returned decimal value to its binary equivalent to determine which services are
enabled. Example
Example
To retrieve the Protocol Services information configured in the Network Settings dialog, issue the following command: EV GetSystemConfig
("ServicesEnabled")
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (20). Finally, the enabled service(s) (2) is
returned, indicating the EtherNet/IP service is enabled.
Internal Temperature
Returns the internal temperature of the In-Sight 7600/7800 series and In-Sight 8000 series vision system, in degrees Celsius.
Syntax: EV GetSystemConfig("Internal.Temperature")
Inputs
Input Description
"Internal.Temperature" The vision system's internal temperature, in degrees Celsius.
Outputs
Results
Returns the vision system's internal temperature, in degrees Celsius.
Example
To retrieve the vision system's current internal temperature, issue the following command: EV GetSystemConfig("Internal.Temperature")
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (23). Finally, the current temperature is
returned, in degrees Celsius.
GetUserList
Returns information configured in the User List dialog.
Syntax: EV GetUserList()
GetUserList Inputs
None.
GetUserList Outputs
GetUserList Results
Name Returns the user name.
Access Returns the access level of the user.
0 Full
1 Protected
2 Locked
View
Returns whether or not the Custom View is displayed when the user logs on.
0 Custom
1 Normal (the Spreadsheet View or EasyBuilder View is displayed).
Read Returns whether or not the user has FTP Read privilege.
0 No
1 Yes
Write Returns whether or not the user has FTP Write privilege.
0 No
1 Yes
SaveJobOnline Returns whether or not the user is allowed to save jobs while online.
0 Disabled
1 Enabled
GetUserList Example
To retrieve information configured in the User List dialog, issue the following command: EV GetUserList()
Note: Count, in the first XML tag, represents the number of users in the User List.
User List dialog is returned.
Related Topics
User List Dialog
SetCellName
Sets the symbolic tag name of a specified cell, and optionally enables the symbolic tag to be transmitted over the OPC channel to the In-Sight OPC
Server or to generate audit messages to an audit message server.
Syntax: EV SetCellName(Cell,"Name",[Mode])
SetCellName Inputs
Input Description
Cell The cell reference (A4 for example).
"Name" The text string that you want to use as a symbolic tag name. The name must be enclosed in quotation marks.
Mode is an optional input.
0 = Disable Output.
2 = The symbolic tag is transmitted via the OPC channel.

Mode
8 = The symbolic tag is used to generate audit messages to an audit message server.
10= The symbolic tag is transmitted over the OPC channel and used to generate audit messages to an audit message server.
Note: To generate audit messages, the Enable Audit Messages checkbox must be checked.
SetCellName Outputs
SetCellName Example
To assign the symbolic tag name "Width" to the cell in B60, issue the following command: EV SetCellName(B60,"Width")
SetCellValue
Sets the value of specific cell appended with an EasyBuilder Tag.
Note: The In-Sight 2000 series vision sensor does not support this extended native mode command and returns -2.
Syntax: EV SetCellValue("Name",Value,[Mode])
SetCellValue Inputs
Input Description
"Name" The EasyBuilder Tag name that is being used for that cell. The name must be enclosed in quotation marks.
The value to be used in the cell; an integer, floating point value or text string. The function will return #ERR if the cell specified in
Value
"Name" input is not an EditInt, EditFloat or EditString function, or the value types do not correspond.
Mode is an optional input.
0 = Disable Output. The named value is not enabled for OPC data access and exchange.
Mode
1 = Output Enabled when the value of the cell changes.
2 = Enable Output. The named value is enabled for OPC data access and exchange.
SetCellValue Outputs

-6
SetCellValue Example
To set the Minimum Distance value of a Distance Measurement Tool, appended with the EasyBuilder Tag name "Distance_1.Minimum" and located
in cell A116, issue the following command: EV SetCellValue("Distance_1.Minimum",62)
The In-Sight sensor returns 1 to indicate that the command was executed successfully. The number of characters (in bytes) and <Float>1</Float>
follows as a second confirmation of successful command execution.
SetDeEnergizeOutputs
Configures the De-Energize Outputs While Offline setting found in the Discrete I/O Settings dialog.
Note: If the De-Energize Outputs While Offline checkbox is enabled and the CIO-MICRO or CIO-MICRO-CC I/O module has an output line
configured as a LifeLine signal type, the line will remain HIGH when the connected vision system is placed Offline.
Syntax: EV SetDeEnergizeOutputs(DeEnergizeOutputs,WriteProcSet)
SetDeEnergizeOutputs Inputs
Input Description
0 = Disabled*
DeEnergizeOutputs 1 = Enabled
WriteProcSet 0 = Settings are not saved in the proc.set file; the settings do not persist if the In-Sight sensor is power cycled.
1 = Settings are saved in the proc.set file; the settings persist after the In-Sight sensor is power cycled.
SetDeEnergizeOutputs Outputs
SetDeEnergizeOutputs Example
To configure the sensor to de-energize outputs when placed Offline, issue the following command: EV SetDeEnergizeOutputs(1,1)
SetDiscreteInput
Configures input settings that are found in the Discrete I/O Settings dialog.
Syntax: EV SetDiscreteInput(LineID,"Name",Type,Signal)
Notes:
When issuing this command, the In-Sight system must be Offline.

There are two options for enabling serial communication for the In-Sight 7000 series vision system: using the Breakout cable or using the
CIO-MICRO or CIO-MICRO-CC I/O module. When connected to the Breakout cable (and there is no connection to an I/O module), the
vision system allows one discrete input line and one discrete output line to be configured as Serial Receive and Serial Transmit, respectively.
Refer to How to Enable Serial Communication for the In-Sight 7000 Vision System for more information.
Use the Store Settings (TS) native mode command to save changes to the proc.set file. If not saved to the proc.set file, the changes will be lost
after power-cycling the In-Sight vision system.
SetDiscreteInput Inputs
Input Description
In-Sight 2000 series: (0) when connected to the Breakout cable.
In-Sight Micro 1000 series, In-Sight 5000 series and In-Sight 8000 series: (0 to 7) when connected to a supported I/O module.
In-Sight 7000 series:
(1 to 3), when connected to Direct I/O.
LineID (0 to 7 and 9 to 11), when connected to a supported I/O module.
In-Sight 7600/7800 series:

(1 to 7), when connected to the CIO-1400 I/O module.
(0 to 7), when connected to a CIO-MICRO I/O module.
The name for the input line.

"Name"
Note: The "Name" input must be enclosed in quotation marks.
Type 0 = User Data*
1 = Event Trigger (1= Reset Counters if using the In-Sight 2000 series vision sensor)
2 = Job ID Number (not supported on the In-Sight 2000)

3 = Online/Offline
4 = Acquisition Trigger (not supported on the In-Sight 2000 series vision sensors and the CIO-1400.)
5 = Job Load Switch (not supported on the In-Sight 2000)
8 = Serial Receive (Direct I/O only; only valid when LineID = 1)
Notes:
Serial Receive is only available when connecting to an In-Sight 7000 series vision system with In-Sight Explorer 4.7.1 or later, and
using In-Sight 4.7.1 or later firmware.
When the SetDiscreteInput command is issued and Input Line 1 is set to Serial Receive, the vision system determines if Output Line
1 is set to Serial Transmit. If not, Input Line 1 is temporarily reset to the default input type for this line. Once the SetDiscreteOutput
command is issued and Output Line 1 is set to Serial Transmit, Input Line 1 is automatically set to Serial Receive.
9 = Job Change (Pulsed)
Input Description
Note: Job Change (Pulsed) is only available when connecting to an In-Sight 2000 series vision sensor running In-Sight 5.2.3 or later
firmware.
0 = Rising Edge*
Signal 1 = Falling Edge
2 = Both Edges
Note: The Online/Offline, Acquisition Trigger and Job Load Switch input types may not be used on more than one input line simultaneously.
SetDiscreteInput Outputs
SetDiscreteInput Example
To configure the following settings:
LineID: 4
"Name": Line 4
Type: Job ID Number
Signal: Rising Edge
Issue the following command: EV SetDiscreteInput(4,"LINE4",2,0)
The In-Sight sensor responds with a status code (1), followed by the number of characters, in bytes (18). Finally, the results are returned in XML
format.
SetDiscreteOutput
Configures output settings in the Discrete I/O Settings dialog and the Output Details dialog.
Syntax: EV SetDiscreteOutput(LineID,"Name",Type,Pulse,PulseLen,Delay)
Notes:
When issuing this command, the In-Sight vision system must be Offline.
If an In-Sight vision system is being used in conjunction with a CIO-1400 or CIO-1450 I/O module, do not use either the SetDiscreteOutput
or SetDiscreteOutputDelay commands to change a discrete output setting over the serial port. Doing so may cause the vision system to
become unresponsive. Use the Discrete I/O Settings and Output Details dialogs to make the change, or send the commands over Telnet.
SetDiscreteOutput Inputs
Input Description
In-Sight Micro 1000 series, In-Sight 5000 series and In-Sight 8000 series:
(0, 1, 4, 5), when connected to Direct I/O.

(0 to 11), when connected to a supported I/O module.
In-Sight 7000 series:

LineID (0, 1, 4, 5), when connected to Direct I/O.
In-Sight 7600/7800 series:

The name for the output line.

"Name"
Note: The "Name" input must be enclosed in quotation marks.
Type 0 = Programmed*
1 = High
2 = Low
3 = Acquisition Start
4 = Acquisition End
5 = Job Completed
6 = System Busy
7 = Job Load OK
8 = Job Load Fail
9 = ERR: Missed Acquisition
10 = ERR: Tracking Overrun
11 = ERR: Tracking Queue Full
12 = Online/Offline
13 = Strobe
In-Sight Micro 1000 series: Only valid when LineID = 1 (HSOUT 1 for Direct I/O) or LineID = 9 (HSOUT 1 for CIO-MICRO,
CIO-MICRO-CC, and CIO-WENET).
In-Sight 5000 series: Only valid when LineID = 1 (HSOUT 1 for Direct I/O / CIO-1350 or CIO-1400) or LineID = 9 (HSOUT 1
for CIO-1450, CIO-1460, CIO-MICRO or CIO-MICRO-CC).
In-Sight 7000 series: Only valid when LineID = 0 (HSOUT 0 for Direct I/O) or LineID = 8 (HSOUT 0 for CIO-MICRO or CIO-
MICRO-CC).
The In-Sight 7600/7800 series: Only valid when LineID = 1 (HSOUT 1 for Direct I/O or CIO-1400) or LineID = 9 (HSOUT 1 for
CIO-MICRO).
In-Sight 8000 series: Only valid when LineID = 1 (HSOUT 1 for Direct I/O) or LineID = 9 (HSOUT 1 for CIO-MICRO).
14 = I/O Module Standby (CIO-1450 and CIO-1460 only; only valid when LineID = 0 - 7)
15 = Light Control (CIO-1460 only; only valid when LineID = 9)
17 = Lifeline (CIO -MICRO & CIO-MICRO-CC Only)
18 = Waveform
Input Description
20 = Serial Transmit (Direct I/O only; only valid when LineID = 1)
Notes:
Serial Transmit is only available when connecting to an In-Sight 7000 series vision system with In-Sight Explorer 4.7.1 or later, and
using In-Sight 4.7.1 or later firmware.
When the SetDiscreteOutput command is issued and Output Line 1 is set to Serial Transmit, the vision system determines if Input
Line 1 is set to Serial Receive. If not, Output Line 1 is temporarily reset to the default output type for this line. Once the
SetDiscreteInput command is issued and Input Line 1 is set to Serial Receive, Output Line 1 is automatically set to Serial Transmit.
24 = Job Pass/Fail Cell

0 = Level Output
Note: When Type is set to 13 (Strobe) and Pulse is set to 0, the Strobe/Light Control Trigger setting is set to Rising Edge.
Pulse
1 = Pulsed Output
Note: When Type is set to 13 (Strobe) and Pulse is set to 1, the Strobe/Light Control Trigger setting is set to Falling Edge.
Duration of an output pulse; In-Sight Micro 1000 series, In-Sight 5000 series, In-Sight 7600/7800 series and In-Sight 8000 series vision
systems (10 to 1000 ms; default = 10), and In-Sight 7000 series and In-Sight Micro 1402, 1412 and 1500 vision systems (1 to 1000 ms;
default = 10).
Notes:
PulseLen
For In-Sight 7000 series and In-Sight Micro 1402, 1412 and 1500 vision systems, only the pulse length of the high-speed output
lines and user-configurable LED lines can be set below 10ms.
When using the CIO-Micro or CIO-Micro-CC I/O module, the minimum pulse length for general-purpose outputs is limited by the
Update Time setting in the I/O Module Configuration dialog. For example, if the Update Time setting in the I/O Module
Configuration dialog is 20ms, the minimum pulse length cannot be set below 30ms.
Delay (0 to 1000)
SetDiscreteOutput Outputs
SetDiscreteOutput Examples
Example 1: Job Load OK Type Settings
LineID: 3
"Name": "LINE3"
Type: Job Load OK
Pulse: Level Output
PulseLen: 250 ms
Delay: 50
Issue the following command: EV SetDiscreteOutput(3,"LINE3",7,0,250,50)
format.
Example 2: Strobe Type Settings
To configure the Strobe Type settings:
LineID: 1
"Name": "LINE1"
Type: Strobe
Strobe/Light Control Trigger: Rising Edge
PulseLen: 10 ms
Delay: 50
Issue the following command: EV SetDiscreteOutput(1,"LINE1",13,0,10,50)
format.
Note: To configure the Strobe Start Position, use the SetSystemConfig native mode command.
SetDiscreteOutputDelay
Configures delay settings that are found in the Output Details dialog.
Syntax: EV SetDiscreteOutputDelay(LineID,Type,[Delay],[[WriteProcSet],[IOModule]])
Notes:
If the SetDiscreteOutput command is issued after the SetDiscreteOutputDelay command, the SetDiscreteOutputDelay settings will be
overwritten.
If an In-Sight vision system is being used in conjunction with a CIO-1400 or CIO-1450 I/O module, do not use either the SetDiscreteOutput
or SetDiscreteOutputDelay commands to change a discrete output setting over the serial port. Doing so may cause the vision system to
become unresponsive. Use the Discrete I/O Settings and Output Details dialogs to make the change, or send the commands over Telnet.
SetDiscreteOutputDelay Inputs
Input Description
LineID The output line number to be modified.
Type 0 = None
1 = Acquisition Delay
2 = Time After Trigger
Delay
If Type = 0, Delay is ignored and forced to 0.
If Type = 1, Delay is the number of acquisition or tracking pulses (0 to 1000) to delay the output after a signal pulse is
received by an output Line. If this value is 0, then the In-Sight vision system updates the output line immediately on
evaluating the WriteDiscrete function. If this value is > 0, then the output Line is always pulsed.
If Type = 2, Delay is the amount of time (0 to 10000 ms) to wait before the output is fired.
WriteProcSet WriteProcSet is an optional parameter.
0 = Settings are not saved in the proc.set file; the settings do not persist if the vision system is power cycled.
1 = Settings are saved in the proc.set file; the settings persist after the vision system is power cycled.
IOModule IOModule is an optional sub-parameter that can be used to set the Discrete Output Delay for a specific I/O Module
type.
0 = Direct I/O / CIO-1350
1 = CIO-1450 and CIO-1460

2 = CIO-1400
3 = CIO-MICRO and CIO-MICRO-CC
SetDiscreteOutputDelay Outputs
Returns A status code followed by the number of characters, in bytes. The status codes are:
SetDiscreteOutputDelayExample
Line ID: 3
Type: Time After Trigger
Delay: 250 ms
WriteProcSet: 1
IOModule: CIO-MICRO
Issue the following command: EV SetDiscreteOutputDelay(3,2,250,1,3)
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (18). Finally, the results are returned in
XML format.
SetEditRegion
Configures settings for a cell that contains an EditRegion function. The Cell must already contain an EditRegion function; SetEditRegion does not
create one.
Syntax: EV SetEditRegion(Cell,Row,Column,High,Wide,Angle,Curve)
SetEditRegion Inputs
Input Description
Cell column (A to Z)
The column letter of the cell value to set.
row (0 to 599)
The row number of the cell value to set.
Row The Row offset of the origin in fixture coordinates.
Column The Column offset of the origin in fixture coordinates.
Note: This value cannot be a negative number.
Note: This value cannot be a negative number.
Angle The orientation in fixture coordinates.
Curve The angular deviation between the region's X-axis and the opposing boundary line.
SetEditRegion Outputs
SetEditRegion Example
1. Insert an EditRegion function in cell A3 with the default settings. Assume cell A3 is populated as follows:
A3 = EditRegion(0,0,0,1,1,1,1,"",0)
An EditRegion control, along with a corresponding results table is created in the adjacent cells to the right.
2. Using the telnet client, issue the following command: EV SetEditRegion(A3,100,100,250,250,0,0)
The EditRegion results table is updated to reflect the SetEditRegion input values.
SetEIPSingleAttribute
Configures In-Sight EtherNet/IP Class and Instance Attributes.
Syntax: EV SetEIPSingleAttribute(Class,Instance,Attribute,Value)
Note: The SetEIPSingleAttribute Native Mode command is only supported on sensors with firmware version 3.1.0 - 3.2.5. For sensors with
firmware version 3.3.0 and higher, if the implicit connection times out, the sensor automatically deletes the implicit connection and session.
SetEIPSingleAttribute Inputs
Input Description
Class The identifier assigned to the Control and Information Protocol Class.
Instance The value of the Instance being referenced.
Note: The Instance should be equal to 0 if changing an Attribute of the Class.
Attribute The identifier of the Attribute being modified.
Value The value to assign to the Attribute.
Supported Parameters:
Class Instance Attribute Value Description
5 0 12 0 = Transition to Timed Out* Watchdog_timeout_action:
1 = Auto Delete Defines the class Watchdog timeout action for all new connections.
SetEIPSingleAttribute Outputs
SetEIPSingleAttribute Example
To configure the EIP I/O Watchdog Timeout Action to Auto Delete, issue the following command: EV SetEIPSingleAttribute(5,0,12,1)
SetExternalLightMode
Specifies the type of external strobe device connected to the In-Sight 7000 series vision system.
Syntax: EV SetExternalLightMode(OutputMode)
SetExternalLightMode Inputs
Input Description
0 = Disabled
OutputMode 1 = PNP (Sourcing)*
2 = NPN (Sinking)
0 = Settings are not saved in the proc.set file; the settings do not persist if the In-Sight vision system is power cycled.*
WriteProcSet
1 = Settings are saved in the proc.set file; the settings persist after the In-Sight vision system is power cycled.
*Denotes default value.
SetExternalLightMode Outputs
SetExternalLightMode Example
To specify that an NPN (sinking) external strobe device is connected to the vision system and to save the setting to the proc.set file, issue the
following command: EV SetExternalLightMode(2,1)
The vision system responds with a status code (1), indicating the command was successfully executed, followed by the number of characters, in
bytes (18). Finally, the float value (0) is returned.
SetFavorHostTable
Enables or disables the Favor Host Table over DNS option found in the In-Sight Host Table.
Syntax: EV SetFavorHostTable(FavorHostTable)
Note: Use the Store Settings (TS) native mode command to save changes to the proc.set file. If not saved to the proc.set file, the changes will be lost
SetFavorHostTable Inputs
Input Description
0 = Disabled*
FavorHostTable 1 = Enabled
SetFavorHostTable Outputs
SetFavorHostTable Example
To enable the Favor Host Table over DNS option, issue the following command: EV SetFavorHostTable(1)
After issuing the SetFavorHostTable command, the In-Sight sensor responds with a status code (1), followed by the number of characters, in bytes
(18). Finally, the results in XML format.
SetFTPSettings
Configures settings that are found in the FTP Settings dialog.
Syntax: EV SetFTPSettings
(IdleTimeout,ReadTimeout,ConnectionRetry,LocalPort,RemotePort,Passive)
SetFTPSettings Inputs
Input Description
(0 to 10000), 120*
IdleTimeout
(0 to 10000), 120*
ReadTimeout
(1 to 10), 1*
ConnectionRetry
(1 to 65535), 21*
LocalPort
(1 to 65535), 21*
RemotePort
0 = Disabled*
Passive 1 = Enabled
SetFTPSettings Outputs
SetFTPSettings Example
IdleTimeout: 180
ReadTimeout: 180
ConnectionRetry: 1
LocalPort: 21
RemotePort: 21
Passive: 0
Issue the following command: EV SetFTPSettings(180,180,1,21,21,0)
format.
SetHostTable
Configures settings that are found in the In-Sight Host Table dialog.
Syntax: EV SetHostTable(HostID,"Name","IPAddress")
SetHostTable Inputs
Input Description
(0 to 31)
HostID First Host Name in table = 0,
Second Host Name in table = 1,
...
sequentially up to 31.
The In-Sight sensor host name.
"Name"
The In-Sight sensor IP address.

"IPAddress"
SetHostTable Outputs
SetHostTable Examples
Example 1: Add a Host Table Entry
Example 2: Edit a Host Table Entry
Example 1: Add a Host Table Entry
To add a sensor with the host name of "PRODUCTION1" and the IP Address of "192.168.1.1" as the first entry in the Host Table, issue the
following command: EV SetHostTable(0,"PRODUCTION1","192.168.1.1")
To add a sensor with the host name of "PRODUCTION2" and the IP Address of "192.168.1.3" as the second entry in the Host Table, issue the
following command: EV SetHostTable(1,"PRODUCTION2","192.168.1.3").
Example 2: Edit a Host Table Entry
To edit the IP address of the second Host Table entry, issue the following command: EV SetHostTable(1,"PRODUCTION2","192.168.1.2")
SetNetwork
Configures settings that are found in the Network Settings dialog.
Syntax: EV SetNetwork
(UseDHCP,"HostName","IPAddress","SubnetMask","DefaultGateway","DNSServer","DomainName")
SetNetwork Inputs
Input Description
0 = Disabled
UseDHCP 1 = Enabled
The In-Sight sensor host name.

"HostName"
The In-Sight sensor IP address.

"IPAddress"
The In-Sight sensor subnet mask.

"SubnetMask"
The In-Sight sensor default gateway.

"DefaultGateway"
The IP address of the gateway host.

"DNSServer"
The network domain for the In-Sight sensor.

"DomainName"
Note: The IPAddress, SubnetMask, DefaultGateway, DNSServer, and DomainName parameters modify the static fields, not the current fields, as
shown in the returns from the GetNetwork command.
SetNetwork Outputs
SetNetwork Example
UseDHCP: 0
"HostName": is5100_010203
"IPAddress": 192.168.0.1
"SubnetMask": 255.255.255.0
"DefaultGateway": 192.168.0.254
"DNSServer": 192.168.0.2
"DomainName": yourdomain.com
Issue the following command: EV SetNetwork

(0,"is5100_010203","192.168.0.1","255.255.255.0","192.168.0.254","192.168.0.2","yourdomain.com")
format.
SetSerialPort
Configures settings that are found in the Serial Port Settings dialog.
Syntax: EV SetSerialPort
(SerialPortNum,Mode,BaudRate,DataBits,StopBits,Parity,Handshake,InputPacketSize,OutputPacketSize,
InputTerminator,OutputTerminator,FixedInputMode,FixedInputLength,DeviceNetTrigger)
Notes:
The In-Sight system must be Offline.

DeviceNet is only available on In-Sight vision systems using In-Sight firmware 4.x.x, and is not available on In-Sight vision systems running
In-Sight firmware 5.1.0 and later. Refer to Firmware Versions for a complete list of models and supported firmware versions.
In-Sight Micro 1000 series vision systems only support serial communication when connected to the CIO-MICRO or CIO-MICRO-CC I/O
module.
In-Sight 8000 series vision systems only support serial communication when connected to the CIO-MICRO I/O module.
The CIO-WENET Ethernet I/O module does not support serial communication.
SetSerialPort Inputs
Input Description
SerialPortNum 1
Mode 1 = Unused (Closed)

6 = Text
7 = Native*
8 = DeviceNet
9 = Motoman
10 = Kuka
BaudRate
1200
2400
4800
9600
19200
38400
57600
115200*
DataBits 4 = 7 Data Bits

8 = 8 Data Bits*
StopBits 1 = 1 Stop Bit*

4 = 2 Stop Bits
Parity 256 = None*

512 = Odd
1024 = Even
Handshake 0 = None*
1 = Hardware
Input Description
2 = Xon/Xoff
InputPacketSize (1 to 255), 1*
(DeviceNet Only)
OutputPacketSize (1 to 255), 1*
(DeviceNet Only)
InputTerminator (Text (1 to 255), 13*
and Native Only)
OutputTerminator (Text -1 = CRLF
and Native Only) 0 = No terminator
(1 to 255), 13*
FixedInputMode (Text 0 = Disabled*
and Native Only) 1 = Enabled
FixedInputLength (Text (1 to 255), 1*
and Native Only)
DeviceNetTrigger 0 = Disabled
(DeviceNet Only) 1 = Enabled*
SetSerialPort Outputs
SetSerialPort Example
SerialPortNum: 1
Mode: 7
BaudRate: 115200
DataBits: 8
StopBits: 1
Parity: 256
Handshake: 0
InputPacketSize: 0
OutputPacketSize: 0
InputTerminator: 13
OutputTerminator: 13
FixedInputMode: 0
FixedInputLength: 0
DeviceNetTrigger: 1
Issue the following command: EV SetSerialPort(1,7,115200,8,1,256,0,0,0,13,13,0,0,1)
XML format.
SetStartup
Configures settings that are found in the Startup dialog.
Syntax: EV SetStartup("JobName",Online)
SetStartup Inputs
Input Description
The name of job to load automatically on startup.

"JobName"
0 = Start Offline*
Online 1 = Start Online
SetStartup Outputs
SetStartup Example
To configure the sensor load the job "Sorting.job" on startup and boot into Online mode, issue the following command: EV SetStartup
("Sorting.job",1)
format.
SetSystemConfig
These parameters are used in conjunction with the SetSystemConfig Evaluate Native Mode command to configure system parameters.
Note: Any inputs enclosed in quotation marks must be enclosed by quotes when sent to the In-Sight vision system.
Active Cells Limit

DHCP Timeout
Telnet Port
Live Image
Online Image
Services Enabled
Audit Enable Settings
Audit IP Settings
Trigger Timestamp
Increase Image Buffers
Adjust ExtractBlobs Memory Allocation
Default Focus Position
Start Strobe Position
PulseJobChangeTiming
Active Cells Limit

Configures the number of available spreadsheet cells settings that are found in the Active Cells Limit dialog.
Syntax: EV SetSystemConfig("ActiveCellLimit",Limit,WriteProcSet)
Inputs
Input Description
"ActiveCellLimit" References the Active Cells Limit dialog settings.
The active cell limit, in units of cells. (2048 to 10400), 6144*

Limit
Note: The active cell limit for the In-Sight 5000 vision system is 4,096 cells and cannot be modified.
Input Description
WriteProcSet 0 = Settings are not saved in the proc.set file; the settings do not persist if the In-Sight vision system is power cycled.*
Outputs
Example
To specify an active cell limit of 8,192, issue the following command: EV SetSystemConfig("ActiveCellsLimit",8192,1)
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (20). Finally, a result code is returned
that either contains a 1, indicating that the limit was set, or a 0, indicating the limit was not set. The In-Sight vision system must be power cycled for
the changes to take effect.
DHCP Timeout
Configures the DHCP Timeout settings that are found in the Network Settings dialog.
Syntax: EV SetSystemConfig("DHCPTimeout",Timeout,WriteProcSet)
Inputs
Input Description
"DHCPTimeout" References the DHCP Timeout settings.
Timeout (5 to 180), 60*
Input Description
WriteProcSet
Outputs
Example
To specify a DHCP Timeout of 30 seconds, issue the following command: EV SetSystemConfig("DHCPTimeout",30,1)
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (18). Finally, the DHCP Timeout setting
(30) is returned.
Telnet Port
Configures the Telnet Port settings that are found in the Network Settings dialog.
Syntax: EV SetSystemConfig("TelnetPort",Port,WriteProcSet)
Inputs
Input Description
"TelnetPort" References the Telnet Port Settings.
Port (1 to 65535), 23*
Input Description
WriteProcSet 1 = Settings are saved in the proc.set file; the settings persist after the In-Sight vision system is power cycled.
Notes:
A valid port assignment is any unused number between 1 and 65535, excluding 21, 68, 80, 502, 1069, 1070, 1212, 2222, 44818 and
50000 (reserved for In-Sight communications).
The vision system must be rebooted before the Telnet Port settings take effect.
Outputs
Example
To specify a Telnet Port of 2000, issue the following command: EV SetSystemConfig("TelnetPort",2000,1)
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (18). Finally, the Telnet Port setting
(2000) is returned.

Configures the Link Speed setting found in the Network Settings dialog. After the command is issued, the vision system must be rebooted for the
changes to take effect.
Warning: If the network device is not configured to support the specified link speed, the vision system will not be reachable; configure the network
device's Ethernet settings to match that of the vision system.
Syntax: EV SetSystemConfig("Network.RequestedLinkMode",LinkSpeed,WriteProcSet)
Inputs
Input Description
"Network.RequestedLinkMode" References the Link Speed Settings.
0 = Auto-Negotiate*
100 = 10 Mbps Half Duplex
101 = 10 Mbps Full Duplex

LinkSpeed
102 = 100 Mbps Half Duplex
WriteProcSet 1 = Settings are saved in the proc.set file; the settings persist after the In-Sight vision system is power cycled.
Notes:
The 1000 Mbps Full Duplex option is only available for vision systems that support 1000 Mbps Ethernet speeds. For In-Sight 5600 series
Use the GetSystemConfig command to determine the link speeds and duplex modes supported by the vision system.
Outputs
Example
To configure the vision system to use 100 Mbps Full Duplex, issue the following command: EV SetSystemConfig
("Network.RequestedLinkMode",103,1)
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (20). Finally, the current link speed (103)
is returned.
Live Image
Configures the Live Acquisition settings that are found in the Image Settings dialog.
Syntax: EV SetSystemConfig("LiveImage",Resolution,MaxFrameRate)
Inputs
Input Description
"LiveImage" References the LiveImage settings.
1 = Full
Resolution 0 or 2= Half*
3 = Quarter
MaxFrameRate (0.016 to 100), 0*
Outputs
Example
To configure the vision system to use half resolution for live images with a maximum rate of 0.064 frames/sec, issue the following command: EV
SetSystemConfig("LiveImage",1,0.064)
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (18). Finally, the Live Acquisition
settings (1 0.064) are returned.
Online Image
Configures the Online Resolution settings that are found in the Image Settings dialog.
Syntax: EV SetSystemConfig("OnlineImage",Resolution,MaxFrameRate)
Inputs
Input Description
"OnlineImage" References the OnlineImage settings.
0 = Optimized*
1 = Full
Resolution
2 = Half
3 = Quarter
MaxFrameRate (0.016 to 100), 0*
Outputs
Example
To configure the vision system to use half resolution for Online images with a maximum rate of 0.064 frames/sec, issue the following command:
EV SetSystemConfig("OnlineImage",2,0.064)
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (18). Finally, the Live Acquisition
settings (2 0.064) are returned.
Services Enabled
Configures the Protocol Services settings that are found in the Network Settings dialog.
Note: The EtherNet/IP and ProfiNET services are mutually exclusive, therefore both services cannot be enabled at the same time.
Syntax: EV SetSystemConfig("ServicesEnabled",Services,Mask)
Inputs
Input Description
"ServicesEnabled" References the ProtocolServices settings.
Services Specifies all services to be enabled on the vision system. The Services parameter is a binary value that is converted into its
decimal equivalent.
ProfiNET 100 4
EtherNet/IP 010 2
Modbus Server 001 1
None 000 0
To enable more than one service, determine the binary value for the enabled services , then convert the value to its decimal
equivalent. Example
Mask Specifies the services to be modified on the vision system. The Mask parameter is a binary value that is converted into its
decimal equivalent.
ProfiNET 100 4
EtherNet/IP 010 2
Modbus Server 001 1
None 000 0
To modify more than one service, determine the binary value for the services to be modified, then convert the value to its
decimal equivalent. Example
Outputs
Examples
To Enable and Modify a Single Service
If no services are currently enabled, and you want to enable the ProfiNET service. Issue the following command: EV SetSystemConfig
("ServicesEnabled",4,4)
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (20). Finally, the enabled service(s) (4)
are returned.
Disable All Services
Since we want all services to be disabled, we know that the Service parameter is 0.
1. Determine the binary value used to modify the services.
Service ProfiNET EtherNet/IP Modbus
Binary 1 1 1
2. Convert the binary value to its decimal equivalent. This gives you the Mask parameter value
111 = 7
3. Issue the following command: EV SetSystemConfig("ServicesEnabled",0,7)
The In-Sight vision system responds with a status code (1), followed by the number of characters, in bytes (20). Finally, the enabled service(s)
(0) are returned.
Audit Enable Settings

Enables or disables automatic audit messages for the active vision system and specifies the types of events for which audit messages will be
generated.
Syntax: EV SetSystemConfig
("AuditEnableSettings",Enabled,SystemEvents,TaggedCells,SystemSettings,WriteProcSet)
Inputs
Input Description
"AuditEnableSettings" References the Audit Enable Settings.
0* = Disable automatic audit messages for the active vision system.

Enabled
1 = Enable automatic audit messages for the active vision system.
0 = Disable.
SystemEvents
1* = If an In-Sight system event occurs (logging on or off of a vision system, loading or saving a job file, transitioning from
Online to Offline mode, system startup and firmware updates), an audit message is generated.
0 = Disable.
TaggedCells 1* = If a symbolically tagged cell is edited (e.g., changes are made to the cell's formula or interactive control value) using In-
Sight Explorer, a custom application, VisionView or a PLC, an audit message is generated.
0 = Disable.
SystemSettings
1* = If a system setting (any setting stored in the proc.set file) is modified, an audit message is generated.
WriteProcSet
* denotes default
value
Outputs
Example
To enable audit messages for the active vision system. generate audit messages when system settings are changed and save the settings to the
proc.set file, issue the following command: EV SetSystemConfig("AuditEnableSettings",1,0,0,1,1)
XML format.
Audit IP Settings
Specifies the IP address and TCP/IP port of the audit message server.
Syntax: EV SetSystemConfig("AuditIPSettings","IPAddress",Port,WriteProcSet)
Inputs
Input Description
"AuditIPSettings" References the Audit IP Settings.
"IPAddress" Specifies the IP address of the audit message server.
Specifies the TCP/IP port of the audit message server. (default = 5753)
Port Note: A valid port assignment is any unused number between 1 and 65535, except for ports reserved for In-Sight
communications.
WriteProcSet
Outputs
Example
To specify the IP address and TCP/IP port of the audit message server and save the settings to the proc.set file, issue the following command: EV
SetSystemConfig("AuditIPSettings","192.168.0.13",5753,1)
XML format.
Trigger Timestamp
If an In-Sight vision system has been configured to communicate over CIP-Sync and the Precision Time Protocol (PTP), the SetSystemConfig
command is used to set the system configuration variable, "EIP.TriggerTimestampInputOffset", to the offset in the user data field, where the
timestamp will be written from the PLC.
Syntax: EV SetSystemConfig("Eip.TriggerTimestampInputOffset",Offset)
Inputs
Input Description
Sets the offset into the EtherNet/IP input assembly, to capture the 64-bit timestamp in microseconds, followed
"Eip.TriggerTimestampInputOffset" by a 64-bit system time offset in microseconds (for a total of 16 bytes), which is used to trigger the vision
system.
Offset Specifies the offset, 0 to 500; to disable this setting, set the variable to -1.
Outputs
Increase Image Buffers

Allows the default number of image buffers allocated to an In-Sight vision system to be increased, based on the vision system resolution and RAM
size. After issuing the command, the vision system must be power cycled for the changes to take effect.
Syntax: EV SetSystemConfig("StartupImageBuffers",NumberofBuffers,WriteProcSet)
Inputs
Input Description
"StartupImageBuffers" Sets the number of image buffers that will be allocated to the vision system at startup.
Specifies the number of buffers that will be allocated to the vision system.
NumberofBuffers
Note: If NumberofBuffers is set to 0, the default number of buffers will be used.
WriteProcSet
Outputs
Adjust ExtractBlobs Memory Allocation

Allows the memory allocation for the ExtractBlobs function to be set manually. When using this setting, the value specified should be no more than
half the number of pixels in the ExtractBlobs function's region of interest (ROI).
Warning: This setting should only be applied if an ExtractBlobs function is returning #ERR due to a lack of memory. When assigning the amount
of memory to the function, be conservative. Over allocating memory to the ExtractBlobs function may cause memory problems for the entire In-
Sight vision system.
Syntax: EV SetSystemConfig("ExtractBlobsMemory",k)
Inputs
Input Description
"ExtractBlobsMemory" Sets the amount of memory that will be allocated to the vision system at startup for the ExtractBlobs function.
Specifies the amount of memory that will be allocated to the vision system for the ExtractBlobs function; the value of k
depends upon the size of the ROI being used, as well as the quality of the image. Begin with a smaller value, and then
increment above that value. For example, with a ROI <= 640 x 480 and a speckled image, begin with a value of 8,000 and
k increment the value by 1,000; with a ROI <= 1600 x 1200, begin with a value of 32,000 and increment the value by 1,000;
or with a ROI <= 2448 x 2048, begin with a value of 128,000 and increment the value by 1,000.
Note: To restore the default memory allocation for ExtractBlobs, enter 0.
Outputs
Default Focus Position

Allows the In-Sight 7000 series vision system to save a focus position in the vision system's proc.set file.
Syntax: EV SetSystemConfig("DefaultFocusPosition",Position,Apply,WriteProcSet)
Note: The DefaultFocusPosition function is used to save a focus position value only, and does not move the lens.
Inputs
Input Description
"DefaultFocusPosition" Sets the default focus position that the vision system will use at startup.
Position Specifies the default focus position, 0 to 100; to disable this setting, set the variable to -1.
0* = Settings are applied after the In-Sight vision system is power cycled.
Apply
1 = Settings are applied immediately.
WriteProcSet
Outputs
Strobe Start Position

Configures the Strobe Start Position setting that are found in the Output Details dialog.
Syntax: EV SetSystemConfig("StrobeStartPosition",Position,WriteProcSet)
Note: To configure the Strobe/Light Control Trigger setting, use the SetDiscreteOutput native mode command (refer to the Example 2).
Inputs
Input Description
"StrobeStartPosition" Specifies when the strobe should begin.
0* = Acquisition Start. The strobe will pulse as the In-Sight vision system begins its acquisition. Supported on all vision
system models except the In-Sight 8405 vision system.
1 = Camera Trigger. The strobe will pulse upon receiving a camera trigger event. Supported on all vision system models
except the In-Sight 8405 vision system.
Position 2 = All Rows Exposed. The strobe will pulse only when all pixel rows are exposed. Supported on the In-Sight 8405 vision
system only.
Note: If using a strobe with the In-Sight 8405 vision system, a minimum Exposure of 72ms is recommended for a full frame
image capture, to ensure that all pixel rows are exposed when the strobe is pulsed. Refer to Rolling Shutter Operation for more
information.
WriteProcSet
Outputs
Example
To specify that the strobe will begin as the In-Sight vision system begins its acquisition, issue the following command: EV SetSystemConfig
("StrobeStartPosition",0,1)
XML format.
PulseJobChangeTiming
Specifies the widths of the input pulses for changing the job on the In-Sight 2000 series sensor via discrete input line 0, when configured as a Job
Change (Pulsed) signal type. The job change is initiated based on the detection of input pulses, differentiated by the width of the pulses. The pulses
are generated by an external device (such as a PLC), and sent to the In-Sight 2000 sensor. First, the external device issues a start pulse. Next, the
external device issues count pulses, with a pulse gap between each count pulse. Finally, the external devices issues a stop pulse. When all pulses and
pulse gaps match the specified pulse lengths, the job change request is successful and the job is loaded to the sensor. If any of the conditions fail
(i.e., an incorrect pulse or incorrect pulse gap timing), the job change request will fail and no job change will take place.
Syntax: EV SetSystemConfig
("PulseJobChangeTiming",StartPulse,StopPulse,CountPulse,PulseGap,Tolerance,WriteProcSet)
Inputs
Input Description
"PulseJobChangeTiming" Specifies the Job Change (Pulsed) timing.
Specifies the width of the start pulse.

StartPulseWidth
1ms - 22000ms (default = 20 1ms)
Specifies the width of the stop pulse.

StopPulseWidth
Specifies the width of the count pulse(s).

CountPulseWidth
Specifies the width of the pulse gap.

PulseGapWidth
Specifies the pulse width tolerance.

Tolerance
>0ms
0 = Settings are not saved in the proc.set file; the settings do not persist if the In-Sight sensor is power cycled.*
WriteProcSet
1 = Settings are saved in the proc.set file; the settings persist after the In-Sight sensor is power cycled.
Note: Issuing EV SetSystemConfig(PulseJobChangeTiming) will return the current pulse width values.
Outputs
Examples
Specify Pulse Width Values
To specify the pulse job change timing and save the settings to the proc.set file, issue the following command:
EV SetSystemConfig("PulseJobChangeTiming",15000,15000,10000,1000,100,1)
format.
Retrieve Current Pulse Width Values
To retrieve the current pulse width values, issue the following command: EV SetSystemConfig("PulseJobChangeTiming")
format.

Native Mode Commands

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Native Mode Commands

Uploaded by

Copyright:

Available Formats

Native Mode Communications Page 1 of 137

Native Mode Communications

In-Sight Communications Reference

About the Native Mode Protocol

Basic Native Mode Syntax

Extended Native Mode Syntax

List of Native Mode Commands

About the Native Mode Protocol

Custom application programs running on a PC

Basic Native Mode Syntax

Extended Native Mode Syntax

[command1] [command2] [input parameters][terminator]

1. Open the telnet client application on the remote host.

> telnet <host> <port>

Native Mode Commands

In-Sight Communications Reference

Basic Native Mode Commands

Extended Native Mode Commands

Basic Native Mode Commands

Settings & Cell Value Commands

Execution & Online Commands

Extended Native Mode Commands

Basic Native Mode Commands In-Sight Communications Reference

Load File Inputs

Load File Outputs

Returns 1 The command was executed successfully.

-1 The filename is missing.

-6 User does not have Full Access to execute the command.

Load File Example

Basic Native Mode Commands In-Sight Communications Reference

Store File Inputs

Store File Outputs

1 The command was executed successfully.

-1 The filename is missing.

-6 User does not have Full Access to execute the command.

Store File Example

Basic Native Mode Commands In-Sight Communications Reference

Read File Inputs

Read File Outputs

The status codes are:

1 The command was executed successfully.

-1 The job filename is missing.

-6 User does not have Full Access to execute the command.

The lines of job data are:

Name The first line contains the job name.

Read File Example

Basic Native Mode Commands In-Sight Communications Reference

Write File Inputs

Write File Outputs

1 The command was executed successfully.

-2 The job could not be written, or the job data is invalid.

-4 The In-Sight vision system is out of memory.

-6 User does not have Full Access to execute the command.

Write File Example

Basic Native Mode Commands In-Sight Communications Reference

Delete File Inputs

Delete File Outputs

1 The command was executed successfully.

-1 The filename is missing.

-6 User does not have Full Access to execute the command.

Delete File Examples

Example: Delete a .CXD File

Example: Delete a Job File

Example: Delete a .CXD File