# Industrial Communications Signals

The In-Sight vision system uses a fixed set of pre-named signals which transfer data and results to and, or from a PLC A Programmable Logic Controller is a ruggedized computer that you can use for automating processes or even an entire production line. and the In-Sight device.

To control triggering from the PLC with the trigger control and status signals, the following conditions must be met:

- The property must be set to Industrial Ethernet.
- The vision system must be Online.
- The $System.OnlineEnabled tag must be True.

Note: The signals are shared between the supported protocols (EtherNet/IP, PROFINET). However, they are mapped into the systems differently. For the specifics of the signal mapping for each protocol, see the following topics:

- EtherNet/IP I/O Assembly Data Format Assemblies

Input Assembly | Signal | Description
Acquisition Acquisition is the process or result of the vision system acquiring a new image. Error | This bit is set when an In-Sight device fails to acquire an image for one of the following reasons: The property is not set to Industrial Ethernet. The In-Sight device is not Online. The $System.OnlineEnabled tag is False. The In-Sight device is currently acquiring an image. The In-Sight device is out of image buffers. This bit is cleared when a successful acquisition is triggered, or the Trigger Enable bit is toggled. Note: If the Trigger bit is set while the Trigger Enable bit is Low, this results in an acquisition error, because the Trigger bit is ignored.
Acquisition ID | This ID increments on the completion of every acquisition, regardless of the trigger source, and can be used to synchronize an acquisition with its Inspection Result. The Acquisition ID is changed on the end of an acquisition. If the PLC is the trigger source, the Acquisition ID is set prior to setting the Trigger Acknowledge bit.
Command Completed | This bit is set when the command execution is completed, and cleared when the Execute Command bit is cleared.
Command Executing | This bit is set while a command execution is in progress.
Command Failed | This bit is set on the completion of a command if the command failed to execute successfully or if an unknown Command ID was set.
Command Result Code | This field is used to indicate the reason a command failed to execute successfully (the code is specific to the command executed): 0x0000 = Command succeeded / unknown failure 0x0002 = Bad command 0x208D = Request is incompatible with system state
Error | This bit is set when an error has occurred, which is defined in the Error ID field.
Error ID | See Error ID codes.
Exposure Complete | This bit is set when the vision system image sensor is no longer exposed to light. It is used to indicate that the part being inspected can be moved from under the field view of the vision system.
External Event Acknowledge | The External Event Acknowledge is generated after the associated script finishes its execution.
Inspection Completed | This bit is toggled upon the completion of an inspection.
Inspection Image ID | These bytes are used to provide the acquisition IDs for each of the images associated with this set of results.
Inspection ID | The acquisition ID associated with this set of results.
Job A job is a user-configured program in Spreadsheet consisting of functions and designed for specific applications. You can create and edit jobs using the Spreadsheet interface, and load them on a vision system for deployment in a live environment. Passed | This bit indicates the pass and, or fail state of the inspection.
Inspection Result Code | These bytes are used to pass the user-defined result code. The inspection result code is defined by the Result Code parameter of the WriteResultsBuffer function Functions are tools that are available in Spreadsheet for processing and analyzing acquisitions or other results. You can add functions to your Spreadsheet job to create tool chains and produce results for specific applications..
Inspection Results | These bytes of the inspection tool results can be written to the currently enabled factory communication protocol through the WriteResultsBuffer function.
Online | This bit indicates that the In-Sight device is online, and the $System.OnlineEnabled tag is True.
Results Buffer Overrun | This bit is set when the Enable Results Buffer bit is set, and there are more results than the result queue can hold.
Results Valid | This bit is set when the Inspected Image ID, Inspection Result Code, and Inspection Results fields are valid. The bit is cleared when the Inspection Results Acknowledge bit is set.
Set User Data Acknowledge | This bit is set to acknowledge completion of the Set User Data command.
System Ready | This bit indicates when an In-Sight device has fully started and is ready to accept and process triggers.
Trigger Acknowledge | This bit indicates when an In-Sight device is successfully triggered via the Trigger bit. The Trigger Acknowledge bit stays set until the Trigger bit is cleared.
Trigger Ready | This bit indicates when an In-Sight device can accept a new trigger through the Trigger bit. This field is true when the Trigger Enable bit is set, and the vision system is not currently acquiring an image.
Current Job ID | These bits indicate the pre-added number of the current job filename. A job ID is a 16 bit number from 0 to 65535, but the PLC function can only load job IDs between 0‑999. Note: If the job ID number in the filename is greater than 65535, then the job ID becomes 65535, because the numbering caps at 65535.
SystemValidated | This bit indicates that the vision system is in a valid state.
Output Assembly | Signal | Description
Buffer Results Enable | When this bit is set, the Inspection ID, Inspection Result and Inspection Results fields are held constant until the Inspection Results Acknowledge field has acknowledged them and been set. Up to 16 sets of results are held in the buffer. Each result must be explicitly acknowledged using the Inspection Results Acknowledge signal.
Clear Error | When this bit is set, it clears the Error and Error ID signals. The Clear Error bit needs to be held high until the Error bit is cleared. If an error is queued, clearing this bit causes the Error and Error ID signals to be set to the next queued error code.
Clear Exposure Complete | When this signal is held high, the Exposure Complete status remains reset. Once this signal is set to low, the Exposure Complete status is be set to high on the next exposure completion.
Execute Command | When the Execute Command bit is set to high, the Command ID signal is read by the vision system and the associated command is executed. The signal must be held high until the Command Completed bit is set. Once the Command Completed bit is set, clearing the Execute Command bit also clears the Command Completed bit.
External Event | Setting the External Event allows the PLC to trigger an associated event in the Spreadsheet.
Set Offline | When this bit is set, the In-Sight vision system is offline, and the state of the $System.OfflineEnabledComm is False.
Trigger Enable | This field is set to enable triggering through the Trigger bit. Clear this bit to disable the network triggering mechanism.
Command ID | This field indicates the command that is executed on the rising edge of the Execute Command bit. This signal must not be changed until the Command Completed bit has been set. 0-0x0fff = Reserved 0x1000-0x1fff = Reserved 0x2000 = Set the $System.ProcessinEnabled tag to False 0x2001 = Set the $System.ProcessinEnabled tag to True 0x2002-0xFFFF = Reserved 0x4000 16384 = Load Job by Name 0x0-0x3E7 0-999 = Load Job by ID 0x1007 = Initiates Job Validation Sets Command Executing bit if initiation was successful or Command Failed if job has invalid Job Validation configuration. When Job Validation is completed, Command Completed bit is set and Command Result Code contains Job Validation Result status. SystemValidationFlag is updated with result of Job Validation run. Command Result Code: Valid 0x0010 Invalid 0x0011 Error 0x0012
Inspection Results Acknowledge | When the Buffer Results Enable bit is set, the Inspection Results Acknowledge bit acknowledges that the PLC has received the Inspected Image ID, Inspection Result Code, and Inspection Results data.
Set User Data | This bit is used to signal that new User Data is available to be read in the vision system. After latching the entire User Data area into a holding buffer, the vision system indicates to the PLC that it has read the data, and it can start loading new data into the buffer, if required, by issuing the Set User Data Acknowledge signal.
Trigger | Setting the Trigger bit triggers an acquisition on the vision system. The Trigger Enable bit must also be set.
User Data | Data buffer which can be read into the spreadsheet using the ReadUserDataBuffer function. The buffer is written exactly as it appears in the PLC, with the bits appearing in the same order as they are defined in RSLogix 5000.