Conventions Used For Examples; Examples - Banner iVu Plus TG Series Instruction Manual

iVu Plus TG and Color Gen2 Image Sensors
Command Channel Command Synopsis
There are a number of general types of commands to do, set, and get sensor data.
Command Channel Response Frames
The iVu responds to all request frames with one or two responses, depending on the type of command.
Do commands
All do commands are followed by one response that identifies the command status. For example:
>> do trigger\x0D\x0A
<< OK\x0D\x0A
Get commands
All get commands are followed by two responses: the first identifies the status of the command, and the second
contains the retrieved information. For example:
>> get info serialnumber\x0D\x0A
<< OK\x0D\x0A
<< "012345ABCDEF"\x0D\x0A
Set commands
All set commands are followed by one response that identifies the command status. For example:
>> set imager gain 20\x0D\x0A
<< OK\x0D\x0A
Command Channel Command Status
The command status is either OK or ERROR. If OK, then the command has fully and successfully completed. If an error is
ERROR nnnnn_ERROR_IDENTIFIER (for example ERROR
returned it is in the form
10001_COMMAND_NOT_RECOGNIZED). Refer to

14.4.2 Conventions Used for Examples

Some command channel examples are included here. The following are the conventions used in the examples:
• All examples use <CR><LF> for the end-of-frame delimiter, and this delimiter is always denoted in hex (\x0D\x0A)
because that is what is displayed in the iVu logs and, for example, the Port Status screen
• All commands are in bold text
• For each example, a command request to the iVu device is prefaced with a >>, and a command response frame
from the iVu device is prefaced by a << as shown below. These are only used to make the documentation clearer
>> get info companyname\x0D\x0A
<< OK\x0D\x0A
<< "Banner Engineering Corp."\x0D\x0A

14.4.3 Examples

How to Trigger the iVu and Retrieve Inspection Data using the Command
Channel
This example is based on a sort inspection. To trigger the iVu and retrieve inspection data, do the following:
1. Make sure that the Command Channel is enabled using either Ethernet or Serial I/O ( Main Menu > System >
Communications > Command Channel > Connection ).
2. Set Trigger to Command. Go to Main Menu > Imager > Trigger , and from the drop-down list select Command.
3. Issue a trigger command as follows:
>> do trigger\x0D\x0A
<< OK\x0D\x0A
4. Check that the inspection passed.
>> get inspection status\x0D\x0A
<< OK\x0D\x0A
<< Pass\x0D\x0A
112
Command Channel Error Codes
www.bannerengineering.com - Tel: + 1 888 373 6767
(p. 123) for a list of errors.