All rights reserved. The information contained herein is proprietary and is provided solely for the purpose of
allowing customers to operate and/or service Microscan manufactured equipment and is not to be released,
reproduced, or used for any other purpose without written permission of Microscan.
Throughout this manual, trademarked names might be used. We state herein that we are using the names to the
benefit of the trademark owner, with no intention of infringement.
Disclaimer
The information and specifications described in this manual are subject to change without notice.
Latest Manual Version
For the latest version of this manual, see the Download Center on our web site at:
www.microscan.com.
Technical Support
For technical support, e-mail: helpdesk@microscan.com.
Warranty
For current warranty information, see: www.microscan.com/warranty.
Microscan Systems, Inc.
United States Corporate Headquarters
+1.425.226.5700 / 800.762.1149
United States Northeast Technology Center
+1.603.598.8400 / 800.468.9503
European Headquarters
+31.172.423360
Asia Pacific Headquarters
+65.6846.1214
Statement of RoHS Compliance
LED Aperture Window
All Microscan readers with a ‘G’ suffix in the FIS number are RoHS-Compliant. All compliant
readers were converted prior to March 1, 2007. All standard accessories in the Microscan Product
Pricing Catalog are RoHS-Compliant except 20-500013-01 and 98-000039-02. These products
meet all the requirements of “Directive 2002/95/EC” European Parliament and the Council of the
European Union for RoHS compliance. In accordance with the latest requirements, our RoHS-Compliant
products and packaging do not contain intentionally added Deca-BDE, Perfluorooctanes (PFOS)
or Perfluorooctanic Acid (PFOA) compounds above the maximum trace levels. To view the document
stating these requirements, please visit:
Please contact your sales manager for a complete list of Microscan’s RoHS-Compliant products.
This declaration is based upon information obtained from sources which Microscan believes to be reliable, and from random
sample testing; however, the information is provided without any representation of warranty, expressed or implied,
regarding accuracy or correctness. Microscan does not specifically run any analysis on our raw materials or end product
to measure for these substances.
The information provided in this certification notice is correct to the best of Microscan’s knowledge at the date of publication.
This notice is not to be considered a warranty or quality specification. Users are responsible for determining the applicability
of any RoHS legislation or regulations based on their individual use of the product.
In regards to “RoHS Directive 2011_65_EU” Microscan produces Monitoring and Control Instruments as well as Industrial
Monitoring & Control Instruments as defined within the directive. Microscan has developed and is implementing a
RoHS2 compliance plan with the intention of bringing all active products listed in our current marketing literature within
full compliance as per the directive deadlines.
Key milestones for the transition plan are as follows:
• Complete internal product audit by July 2014.
• Initial “Monitoring and Control Instruments” RoHS2 compliant products available by December 2014
• Initial “Industrial Monitoring & Control Instruments” RoHS2 compliant products available by July 2015
• All new products introduced in 2015 are expected to be WEEE & RoHS2 compliant.
Microscan will mark the products with the ‘CE’ marking that complies with the RoHS2 process to acquire ‘CE’ certification
per the example given: Example >> Machinery directive + EMC directive + RoHS2 = Declaration of Conformity
Warning and Caution Summary
• Viewing the Vision MINI Xi’s LED output with optical instruments such as magnifiers, eye
loupes, or microscopes within a distance of 100 mm could cause serious eye injury.
• Maximum LED output: .564 mW; Wavelength: 470 nm; 525 nm; 617 nm.
• Location of the Vision MINI Xi’s LED aperture window:
CAUTION: Use of controls or adjustments or performance of procedures other than those
specified herein may result in hazardous radiation exposure.
IMPORTANT:
unit marked Class II and rated 24 VDC at 5 Watts, or greater if using electrical accessories.
European models must use a similarly rated Class I or Class II power supply that is certified to
comply with standard for safety EN 60950.
The Vision MINI Xi is intended for connection to a UL-listed direct plug-in power
WARNING: Baseplate temperature may exceed 70° C at maximum operating
temperature and may cause burns. Use caution when handling.
Contents
PREFACEWelcome vi
Purpose of This Manual vi
Manual Conventions vi
CHAPTER 1Introduction 1-1
Product Summary 1-2
Features and Benefits 1-2
Applications 1-3
Package Contents 1-3
Vision MINI Xi Smart Camera Models 1-4
Part Number Structure 1-4
CHAPTER 2System Components 2-1
Hardware Components 2-2
Important Label Information 2-4
Mounting and Wiring the Vision MINI Xi Smart Camera 2-5
Status Indicators 2-10
AutoVISION Button 2-11
Trigger Debounce 2-12
CHAPTER 3Optics and Lighting 3-1
Optics 3-2
Illumination 3-3
Vision MINI Xi Smart Camera Guideiv
Contents
APPENDIX AConnector Pinouts A-1
Vision MINI Xi Smart Camera Connectors A-2
APPENDIX BCable Specifications B-1
61-000153-02 Cordset, Host, Serial, M12 12-Pin Socket to DB9 Socket, 1 M B-2
61-000167-02 Cordset, M12 12-Pin Socket to Flying Leads, 3 M B-3
97-000012-01 Power Supply, 90-254VAC, 24V, M12 12-Pin Socket B-4
99-000020-02 Photo Sensor, M12 4-Pin Plug, NPN, Dark On, 2 M B-5
APPENDIX CGeneral Specifications C-1
Dimensions C-7
Field of View and Working Distance C-8
APPENDIX DSerial Commands D-1
APPENDIX EVision MINI Xi Diagnostic Boot Mode E-1
APPENDIX FCloudLink Web HMI F-1
Connecting F-2
Application Overview F-3
Application Bar F-4
Pages, Panels, and Widgets F-5
vVision MINI Xi Smart Camera Guide
Preface
PREFACEWelcome
Purpose of This Manual
This manual contains detailed information about how to configure and
operate the Vision MINI Xi Smart Camera.
Manual Conventions
The following typographical conventions are used throughout this manual.
•Items emphasizing important information are bolded.
•Menu selections, menu items and entries in screen images are
indicated as: Run (triggered), Modify..., etc.
Vision MINI Xi Smart Camera Guidevi
Preface
viiVision MINI Xi Smart Camera Guide
1
CHAPTER 1Introduction
FIGURE 1–1. Vision MINI Xi Smart Camera
1
Introduction
Vision MINI Xi Smart Camera Guide1-1
Chapter1Introduction
Product Summary
The Vision MINI Xi Smart Camera is designed for reliable vision
performance in embedded identification and inspection applications. As
the world’s smallest fully-integrated vision system, the Vision MINI Xi’s
compact size and wide angle optics provide the best performance
available for machine vision tasks at close range.
The Vision MINI Xi allows OEM design engineers to implement
inspection, color matching, symbol decoding, OCR, and more, in a single
compact solution. The camera’s small form factor allows flexible
positioning in tight spaces. The lightweight and durable magnesium alloy
case weighs less than 2 ounces.
Pressing the AutoVISION button at the back of the Vision MINI Xi enables
real time dynamic autofocus. When an object is centered in the field of view
and the AutoVISION button is pressed, the camera automatically adjusts
focal distance and sets internal parameters to optimize image captures.
AutoVISION software, designed for use with the Vision MINI Xi, provides
an intuitive interface, step-by-step configuration, and a library of presets
that allow easy setup and deployment. For more complex vision
applications,
the system can be upgraded from AutoVISION to Visionscape.
Features and Benefits
•World’s smallest fully functional vision system
•Ethernet communications
•OEM-ready for easy integration
•Integrated lighting and autofocus lens
•Flexible programming options for custom applications
•AutoVISION button for automatic targeting, calibration, and triggering
•Simplified configuration with AutoVISION software
1-2Vision MINI Xi Smart Camera Guide
Applications
•Part presence/absence
•Color detection and matching
•Medical device inspection
•Fiducial location
•Part location/orientation detection
•Packaging
•Robotics
•Auto ID (Data Matrix and other 2D symbologies, 1D, OCR)
Applications
1
Introduction
Package Contents
Before you install AutoVISION software and connect your Vision MINI Xi
Smart Camera, please take a moment to confirm that the following items
are available:
•Vision MINI Xi Smart Camera — Your package contains one of the
available models listed in Table 1–1.
•AutoVISION Software Installation USB Drive
Vision MINI Xi Smart Camera Guide1-3
Chapter1Introduction
Vision MINI Xi Smart Camera Models
Table 1–1 lists and describes the Vision MINI Xi Smart Camera models,
including acquisition modes and resolutions.
TABLE 1–1. Vision MINI Xi Smart Camera Models
Part NumberVision MINI Xi Smart Camera Model
GMV-6310-1100GVision MINI Xi, Ethernet, SD, WVGA, AutoVISION
GMV-6310-1102GVision MINI Xi, Ethernet, SD, WVGA, AutoVISION+Visionscape
GMV-6310-1104GVision MINI Xi, Ethernet, SD, WVGA, AutoVISION+Verification/OCV
GMV-6310-1106GVision MINI Xi, Ethernet, SD, WVGA, AutoVISION+Visionscape+Verification/OCV
GMV-6310-1110GVision MINI Xi, Ethernet, SD, SXGA, AutoVISION
GMV-6310-1112GVision MINI Xi, Ethernet, SD, SXGA, AutoVISION+Visionscape
GMV-6310-1114GVision MINI Xi, Ethernet, SD, SXGA, AutoVISION+Verification/OCV
GMV-6310-1116GVision MINI Xi, Ethernet, SD, SXGA, AutoVISION+Visionscape+Verification/OCV
GMV-6310-1172GVision MINI Xi, Ethernet, SD, QXGA, Color, AutoVISION+Visionscape
GMV-6310-1200GVision MINI Xi, Ethernet, HD, WVGA, AutoVISION
GMV-6310-1202GVision MINI Xi, Ethernet, HD, WVGA, AutoVISION+Visionscape
GMV-6310-1204GVision MINI Xi, Ethernet, HD, WVGA, AutoVISION+Verification/OCV
GMV-6310-1206GVision MINI Xi, Ethernet, HD, WVGA, AutoVISION+Visionscape+Verification/OCV
GMV-6310-1210GVision MINI Xi, Ethernet, HD, SXGA, AutoVISION
GMV-6310-1212GVision MINI Xi, Ethernet, HD, SXGA, AutoVISION+Visionscape
GMV-6310-1214GVision MINI Xi, Ethernet, HD, SXGA, AutoVISION+Verification/OCV
GMV-6310-1216GVision MINI Xi, Ethernet, HD, SXGA, AutoVISION+Visionscape+Verification/OCV
GMV-6310-1272GVision MINI Xi, Ethernet, HD, QXGA, Color, AutoVISION+Visionscape
Part Number Structure
GMV6310CommLensSensorOptionsRoHS
General
Machine
Vision
1-4Vision MINI Xi Smart Camera Guide
Vision
MINI Xi
1 = Ethernet
1 = Standard
Density
2 = High
Density
0 = WVGA0 = AutoVISION
1 = SXGA
7 = Color
QXGA
2 = AutoVISION +
Visionscape
4 = AutoVISION +
Verification/OCV
6 = AutoVISION +
Visionscape +
Verification/OCV
G = RoHS
compliant
2
CHAPTER 2System Components
This section contains information about system components as well as
information to help you connect the Vision MINI Xi Smart Camera. Specific
information describes connectors, adapters, cables, pinouts, and signals.
2
System Components
Note: There are no user-serviceable parts inside.
Vision MINI Xi Smart Camera Guide2-1
Chapter2System Components
Hardware Components
Table 2-1 lists Vision MINI Xi Smart Camera hardware components.
TABLE 2–1. Vision MINI Xi Smart Camera Hardware Components
Part NumberDescription
Demo Kit
98-000215-01Demo Kit (camera not included)
Power Supply
97-000012-01Power Supply, M12 12-Pin Socket, 1.3 m
Communication Devices and Cables
98-000103-01QX-1 Interface Device
61-000148-02Cordset, Common, M12 12 Pin, Socket to M12 12 Pin Plug, 3M
61-000162-02Cordset, Common, M12 12 Pin, Socket to M12 12 Pin Plug, 1M
61-000153-02Cordset, Host, Serial M12 12 pin Socket to DB9 Socket, 1M
61-000164-02Cordset, Host, Serial, M12 12 pin Socket to DB9 Socket, 3M
61-000152-02Cordset, Host, Serial, M12 12 pin Plug to DB9 Socket, 1M
61-000165-02Cordset, Host, Serial M12 12 pin Plug to DB9 Socket, 3M
61-000166-02Cordset, M12 12 Pin Plug to Flying Leads, 3M
61-000167-02Cordset, M12 12 Pin Socket to Flying Leads, 3M
61-000207-01Cordset, C-Mount-to-Smart Series Light
FIS-0210-0001GMS-Connect 210, Connectivity Box with Display
FIS-0210-0002GMS-Connect 210, Connectivity Box
FIS-0210-0003GMS-Connect 210, Connectivity Box with Display and Ethernet
FIS-0210-0004GMS-Connect 210, Connectivity Box with Ethernet
98-000013-04Relay Module, 120VAC, 3 Amp Output, Series 70, Type SM, for MS-Connect 210
98-000013-05Relay Module, 240VAC, 3 Amp Output, Series 70, Type SM for MS-Connect 210
98-000013-06Relay Module, 24VDC, 3 Amp Output, Series 70, Type SM for MS-Connect 210
Mounting Options
20-610024-01Trigger Connector, 4-pin Plug (Field-Wireable Screw Terminal ) (Self-Wiring)
98-000048-01Mounting Arm / Adapter, 4”
98-000053-01Mounting Arm Extension, 4"
98-000053-02Mounting Arm Extension, 3"
98-000054-01Mounting Stand Base Plate
98-000057-01Bracket, Through-Hole Mount
98-000059-01Bracket, Angle Mount
98-000060-01Bracket, Side Mount
98-000088-01Right Angle Mirror
99-000053-01Bracket, Smart Series Ring Illuminator 60/70 mm
99-000054-01Bracket, Smart Series Ring Illuminator 100 mm
99-000055-01Bracket, Smart Series DOAL Illuminator 50 mm
99-000057-01Bracket, Smart Series DOAL Illuminator 75 mm
99-000059-01Bracket, Smart Series DOAL Illuminator 100 mm
Object Detectors
99-000020-01Photo Sensor, M12 4-Pin Plug, NPN, Dark Off, 2 m
99-000020-02Photo Sensor, M12 4-Pin Plug, NPN, Dark On, 2 m
Documentation
37-000010-01
Microscan Tools Drive (Software, User Manuals, Quick Start Guides, Configuration Guides, links
to other documents on Microscan website
2-2Vision MINI Xi Smart Camera Guide
Front
Hardware Components
Figure 2–1 shows the front of the Vision MINI Xi Smart Camera.
FIGURE 2–1. Front
2
System Components
Base
Figure 2–2 shows the base of the Vision MINI Xi Smart Camera.
FIGURE 2–2. Base
Vision MINI Xi Smart Camera Guide2-3
Chapter2System Components
Cable (attached)
AutoVISION
Button
Status Indicators (TRIG, PASS,
FAIL, MODE, LINK/ACT, PWR)
Back
Figure 2-3 shows the back of the Vision MINI Xi Smart Camera.
FIGURE 2–3. Back
Important Label Information
Each Vision MINI Xi Smart Camera has its own label, which contains
important information about that camera.
•P/N – The Microscan part number of your Vision MINI Xi Smart Camera.
•S/N — The serial number of your Vision MINI Xi Smart Camera.
•MAC — The MAC address of your Vision MINI Xi Smart Camera.
•Type — The model type of your Vision MINI Xi Smart Camera.
2-4Vision MINI Xi Smart Camera Guide
Mounting and Wiring the Vision MINI Xi Smart Camera
Ethernet Standalone
with QX-1
Ethernet Standalone
without QX-1
1
3
1
2
3
4
Mounting and Wiring the Vision MINI Xi Smart Camera
Ethernet Standalone without QX-1
•Mount the camera (1) as required by the application.
•Ensure that the camera (1) is the optimal distance of 2” to 6” from the inspection area.
•Connect the M12 (power and I/O) end of the camera’s cable to the power supply (3).
•Connect the RJ45 (Ethernet) end of the camera’s cable to the host.
•Plug in the power supply (3) and apply power to the camera (1).
Ethernet Standalone with QX-1
•Mount the camera (1) as required by the application.
•Ensure that the camera (1) is the optimal distance of 2” to 6” from the inspection area.
•Connect the M12 (power and I/O) end of the imager’s cable to “2” on the QX-1 (2).
•Connect the RJ45 (Ethernet) end of the imager’s cable to the host.
•Connect the power supply (3) to “3” on the QX-1.
•Connect the photo sensor (4) to “T” on the QX-1.
•Plug in the power supply (3) and apply power to the camera (1).
2
System Components
Vision MINI Xi Smart Camera Guide2-5
Chapter2System Components
Direct Input / Output Diagrams
2-6Vision MINI Xi Smart Camera Guide
Isolated Trigger Input
Mounting and Wiring the Vision MINI Xi Smart Camera
2
System Components
Vision MINI Xi Smart Camera Guide2-7
Chapter2System Components
New Master Input
2-8Vision MINI Xi Smart Camera Guide
Power Requirements
Refer to Table 2-3 when determining the power supply requirements for
your camera.
TABLE 2–3. Camera Power Requirements
Mounting and Wiring the Vision MINI Xi Smart Camera
The back of the Vision MINI Xi Smart Camera has multiple LEDs that
indicate different trigger, inspection, camera, communication, and power states.
TRIG
PASS/FAIL
MODE
LINK/ACT
PWR
Additional User Feedback
On SteadyContinuous Trigger
OffWaiting for Trigger Event
On FlashingTrigger Event
OnActive State
OffInactive State
On SteadyUnit Ready
OffUnit Not Ready
On SteadyLink Established
OffNo Link/Activity
On FlashingLink Established and Activity on Link
OnPower On
OffNo Power Applied to Unit
•Green Flash – A green flash from the front of the unit indicates a Good Read.
•Blue Targeting Pattern – The blue targeting pattern from the front of the
unit allows the user to center an object in the camera’s field of view.
2-10Vision MINI Xi Smart Camera Guide
Fail has occurred.
•Beeper – The beeper is an audible verification that either a Pass or a
AutoVISION Button
AutoVISION Button
2
The AutoVISION Button has three positions, selectable by the length of
time the button is held down, and indicated by one, two, or three beeps
and LED flashes in succession. It can also be used to send a trigger
signal when Send Trigger is checked in AutoVISION software’s Connect
view. When the trigger functionality is enabled, pushing the AutoVISION
Button triggers the camera to capture an image.
1st Position: Blue Targeting Pattern
The first AutoVISION Button position turns the targeting system on.
This overrides any other targeting modes that have been configured.
2nd Position: Auto Calibration
The second AutoVISION Button position starts the Auto Calibration
process, which selects the appropriate photometry and focus settings
for the camera. The selected values are then saved for power-on.
System Components
3rd Position: Teach
The third AutoVISION Button position sets the Match String to the
next OCR string or symbol data that is decoded.
Vision MINI Xi Smart Camera Guide2-11
Chapter2System Components
Trigger Debounce
Trigger Debounce
change – a common issue with relays that have some intermittent contact while engaging.
is the ability of the system to accomodate switching noise on a trigger state
Trigger overruns (when the vision system is triggered faster than the device can process)
can be avoided by increasing the “debounce” time in the camera definition file located in
the C:\Microscan\Vscape\Drivers\CamDefs directory.
The IO Line Debounce High Time and IO Line Debounce Low Time can be added to the
file as in the example below. The default debounce time is 1 ms (1,000 μs).
Note: Although the value entered for the "IO Line Debounce Time" is in microseconds, it
will only be rounded up to a millisecond value. For example, entering the value 1001 will
resolve to 2 ms; entering a value of 2800 will resolve to 3 ms.
The min value for "IO Line Debounce Time" is 0, which disables software debounce
altogether. The maximum value is 100000 (100 ms).
Camera Definition File Example
// Camera Definition File
// Version: 1.02
Camera NameVisionMINI 1280x1024 // Name Displayed in
Camdef Selection Dialog
Digitizer Type5000// Number
associated with VisionMini SXGA
Stride1280// Image Width
Rows1024// Image Height
X Offset0// Image X Offset
Y Offset0// Image Y Offset
Bits Per Pixel8 // Bits that represent Pixel Value
Pixel Type 0 // Type of Pixel:
IO Line Debounce High Time 2000 //usecs
IO Line Debounce Low Time 2000 //usecs
// Focus & Photometry Ranges
2-12Vision MINI Xi Smart Camera Guide
Trigger Debounce
Gain Dflt20
Gain Min0
Gain Max100// 0 to 100%
Exp Dflt4000
Exp Min66
Exp Max66667// 1/15 to 1/15,000
Focus Dflt400
Focus Min200
Focus Max600// 2 to 6 inches
2
System Components
Vision MINI Xi Smart Camera Guide2-13
Chapter2System Components
2-14Vision MINI Xi Smart Camera Guide
3
CHAPTER 3Optics and Lighting
This section describes the optical and illumination characteristics of the
Vision MINI Xi Smart Camera.
3
Optics and Lighting
Vision MINI Xi Smart Camera Guide3-1
Chapter3Optics and Lighting
Optics
The monochrome and color versions of the Vision MINI Xi Smart Camera have a built-in
CMOS sensor, available in Standard Density or High Density (2.5 mm).
WVGA (752 x 480) Field of View
Standard DensityHigh Density
Working Distance
2
3
4
5
6
Horizontal FOVVertical FOV
1.4860.94920.6630.560
2.1881.39630.9540.824
2.8891.84441.2461.089
3.5912.29251.5371.354
4.2922.74061.8281.619
Working Distance
Horizontal FOVVertical FOV
SXGA (1280 x 1024) Field of View
Standard DensityHigh Density
Working Distance
2
3
4
5
6
Horizontal FOVVertical FOV
2.1861.74921.2641.011
3.1822.54531.8501.480
4.1773.34242.4361.949
5.1734.13853.0222.418
6.1684.93563.6082.886
QXGA (2048 x 1536) Field of View
Standard DensityHigh Density
Working Distance
2
3
4
5
Horizontal FOVVertical FOV
2.1651.74921.2640.948
3.1802.54531.8501.388
4.1953.34242.4361.827
5.2104.13853.0222.267
Working Distance
Working Distance
Horizontal FOVVertical FOV
Horizontal FOVVertical FOV
3-2Vision MINI Xi Smart Camera Guide
Illumination
Lighting Examples
Illumination
The Vision MINI Xi Smart Camera has built-in lighting (red LEDs). The LEDs
can be configured to operate in multiple modes – Continuous, Strobe, and Off.
3
The following lighting examples were captured using a Standard Density
Vision MINI Xi with built-in lighting (red LEDs).
FIGURE 3–1.
Optical Axis of Camera Positioned at 90° from Image Plane
FIGURE 3–2.
Optical Axis of Camera Positioned at 60° from Image Plane
On-Axis –
Off-Axis – Semi-Specular Surface (Fine Matte Metal Ruler) at 2”,
Semi-Specular Surface (Fine Matte Metal Ruler) at 2”,
Optics and Lighting
Vision MINI Xi Smart Camera Guide3-3
Chapter3Optics and Lighting
Before correct lighting
After correct lighting with
a NERLITE Illuminator
Machine Vision Lighting Principles
Proper lighting is critical to the success of a machine vision
application. The Vision MINI Xi features integrated lighting (built-in
red LEDs @ 617nm). Depending on the requirements of your
application, you may also need to add external lighting from
Microscan’s NERLITE family of machine vision lighting products.
Consider the following when setting up your application:
–Is the surface of the object flat, slightly bumpy, or very bumpy?
–Is the surface matte or shiny?
–Is the object curved or flat?
–What is the color of the object or area being inspected?
–Is the object moving or stationary?
Machine vision lighting should maximize contrast of the areas or features
being inspected while minimizing the contrast of everything else.
3-4Vision MINI Xi Smart Camera Guide
A
APPENDIX AConnector Pinouts
This section contains information about the Vision MINI Xi Smart
Camera’s connector pin assignments.
A
Connector Pinouts
Vision MINI Xi Smart Camera GuideA-1
AppendixAConnector Pinouts
Ground
Output 3
Output 1
Output 2
New Master
Default
Power
Input Common
Output Common
Host RxD
Trigger
Host
TxD
M12 12-pin Plug
RJ45 Plug
1 TX (+)
8 NC
7 NC
6 RX (–)
5 NC
4 NC
3 RX (+)
2 TX (–)
Vision MINI Xi Smart Camera Connectors
Vision MINI Xi M12 12-Pin Plug and RJ45 Plug Connectors
This section contains information about cables used in simple Vision MINI Xi
Smart Camera hardware configurations.
Note: Cable specifications are published for information only. Microscan
does not guarantee the performance or quality of cables provided by
other suppliers.
TABLE B–1. Cable Part Numbers and Descriptions
Part NumberDescription
61-000153-02
61-000167-02Cordset, M12 12-Pin Socket to Flying Leads, 3 M
This section provides descriptions of the serial commands that can be
sent to the camera via TCP (Telnet) port, AutoVISION Terminal, or
HyperTerminal.
D
Serial Commands
Vision MINI Xi Smart Camera GuideD-1
AppendixDSerial Commands
Serial Command Syntax
< > = Required argument. Replace appropriately.
For example:
-u <DB_User_name> becomes -u av where av replaces
DB_User_name.
| = Mutually exclusive arguments. Choose one from the list.
{ } = Used with | to specify a list of choices for an argument.
[ ] = Optional parameter.
Important: Unless otherwise stated, commands will respond with !OK on
Initiates serial transfer of inspection image (RS-232 only).
Note: This command always returns the last (most recent) image.
-transfer=ymodem is currentlynot optional - only Ymodem protocol is
supported.
-format={jpg|png} specifies the format of the image. If omitted, the
image format is JPG.
-quality=n specifies a JPG compression quality of n less than or equal to
100. The default quality is 80 if not specified.
Note: The PNG format provides lossless image comp ression. If format is
set to PNG, the quality setting does not apply.woi=left,top,right,bottom specifies a rectangular area of the image to be
included in the output image. If omitted, the full image buffer is returned.
-inspection=n specifies the inspection from which to retrieve an image.
The image will be from the first snapshot within that inspection. If not
specified, the image will be from the first inspection that does contain a
snapshot.
The following example will retrieve an image from the camera with these
settings: Protocol: ymodem; Format: png; Quality: N/A; Inspection:
second inspection.
The following example will retrieve an image from the camera with these
settings: Protocol: ymodem; Format: jpg (default); Quality: 50;
Inspection: first inspection (default).
GETIMAGE –transfer=ymodem –quality=50
D-2Vision MINI Xi Smart Camera Guide
ONLINE
Starts all inspections.
OFFLINE
D
Stops all inspections.
TRIGGER
Triggers an inspection.
vt [n]
Triggers an inspection by pulsing a Virtual I/O point.
For example:
vt 1
will return pulse VIO1. The inspection will run if it is configured to use VIO
1 as a trigger.
If specified, the VIO index must be in the allowed range for Virtual I/O
points within Visionscape. The virtual I/O line will be set high then low.
If VIO Index is not specified, VIO1 is assumed.
Serial Commands
Fail Return: Return !ERROR followed by the reason for the failure.
For example:
!ERROR No such trigger
when the index specified ‘n’ is out of range of virtual triggers.
REBOOT [-noload]
Reboots the device.
-noload = do not load BOOT job.
Vision MINI Xi Smart Camera GuideD-3
AppendixDSerial Commands
MEMAVAIL [-cp]
Returns available memory for device or coprocessor.
MEMCONTIG [-cp]
Returns maximum memory block for device or coprocessor.
MEMFRAGS [-cp]
Returns memory fragments for device or coprocessor.
MEMINFO [-cp] [-v]
Returns memory summary “avail/contig/frags” for device or coprocessor.
Verbose.
VERSION
Returns Visionscape software version.
JOBSAVE [-slot=]<n>
Saves current job to slot n.
JOBLOAD [-slot=]<n> [-r]
Loads job from slot n.
-r = Start inspections.
JOBDELETE {[-slot=]n|-all}
Deletes job in slot n, or all jobs if -all.
Important: Does not delete the current job loaded in camera memory.
D-4Vision MINI Xi Smart Camera Guide
JOBINFO [[-slot=]n] [-v]
Gets job summary or info about slot n.
JOBINFO with no arguments returns a list of all jobs on the device.
-v = Ve rbose n. This option shows the amount of space that would be
freed if the job were deleted. It also lists the total disk space and free disk
space.
JOBBOOT [-slot=]<n>
Sets bootup job slot n (RS-232 only).
JOBDOWNLOAD <-transfer=ymodem>
Downloads .avz job packaged via transfer method (RS-232 only).
D
Serial Commands
SET <tagname> <value>
Sets value of a global tag.
The tagname must correspond to one of the supported tags within the
device.
The value can contain spaces.
The command is terminated by a carriage return and/or line feed
character.
The value can be a list of comma-separated items to set a sequence of tags:
Send SET int1 1, 2, 3 to set int1 = 1, int2 = 2, int3 = 3.
The AVP service allows setting of step and datum information from the job
tree using forward
avp/insp1/snapshot1/acq1/gain 2.0 paths are not case -sensitive and do
not need to be fully qualified if unique.
SET avp/acq1/gain 2.0 will set the same gain value if there is only one
acquire.
slash ‘/’ in the symbolic name path. SET
Vision MINI Xi Smart Camera GuideD-5
AppendixDSerial Commands
Control tags in the A VP service such as START, STOP, a nd TRIGGER act
as momentary switches. SET avp.start 1 is equivalent to the ONLINE
command. avp.start will reset immediately and always read as 0.
Success Return: On success will return !OK followed by an echo of the
command.
For example:
!OK SET matchstring1
Fail Return: On failure will return !ERROR followed by the reason for the
failure.
For example:
!ERROR Tag matchstring66 not found
GET {tagname|service|service.tagname}
Gets value of a global tag.
The tagname must correspond to one of the supported tags within the
device.
The command is terminated by a carriage return and/or line feed
character.
Include an index to get a single value from an array such as GET int1. If
the index is omitted, the full array of values will be returned in a commaseparated list of values.
Send Get {tagname|service.tagname|service} to get the value of a tag
within the global data service. To get the value of a tag within another
service, prefix the tagname with the service name. For example, a GET <service.tagname> command such as GET eip.input for the EIP input
assembly.
The AVP service allows retrieval of step and datum information from the
job tree using forward slash ‘/’ in the symbolic name path. GET avp/insp1/snapshot1/status paths are not case-sensitive and do not
need to be fully qualified if unique.
D-6Vision MINI Xi Smart Camera Guide
GET avp/snapshot1 /st atus will return the same result if there is only one
inspection.
When issued against a step, GET avp/snapshot1 will return the values
for all datums.
Success Return: On success will return the value stored in the tag.
For example:
ABCD
Fail Return: On failure will return !ERROR followed by the reason for the
failure.
For example:
!ERROR Tag matchstring66 not found
D
Serial Commands
INFO [tagname|service]
Gets information about a tag or service.
INFO with no arguments gets a list of services.
INFO <service> gets a list of tags in that service.
INFO <service.tagname> gets attributes of the tag as well as a list of
subtags.
The AVP service allows retrieval of step and datum information from the
job tree using forward slash ‘/’ in the symbolic name path. INFO avp/insp1/snapshot1/status paths are not case-sensitive and do not
need to be fully qualified if unique.
INFO avp/snapshot1/status will return the same result if there is only
one inspection.
When issued against a step, INFO avp/snapshot1 returns properties of
the step, a list of child datums, and a list of child steps. Child steps are
indicated by a trailing forward slash.
Vision MINI Xi Smart Camera GuideD-7
AppendixDSerial Commands
QUERYAUTOCAL
Returns photometry settings: Gain, Exposure, and Focus.
AUTOCAL
Performs automatic calibration of photometry settings: Gain, Exposure,
and Focus.
TARGET {0|1|off|on}
Turns targeting LEDs On or Off.
target 1 = Turn Target On
target 0 = Turn Target Off
CHECKSUM {BOOT | KERNEL | BOOTPARAM}
Gets a checksum on an individual part of the system.
HELP
Returns a list of all serial commands showing correct syntax and
functionality descriptions.
D-8Vision MINI Xi Smart Camera Guide
E
APPENDIX EVision MINI Xi Diagnostic
Boot Mode
E
Vision MINI Xi
Diagnostic Boot Mode
This section describes the Vision MINI Xi’s Diagnostic Boot Mode and
other boot parameters.
Vision MINI Xi Smart Camera GuideE-1
AppendixEVision MINI Xi Diagnostic Boot Mode
Diagnostic Boot Mode
The Vision MINI Xi supports a special boot mode used for diagnostics and
recovery. There are two ways in which the camera can be put into this mode:
1.This method requires an Ethernet connection between the host PC
and Vision MINI Xi. Power-on the unit and hold down the AutoVISION
button until the green flash illuminates once. The unit is now
configured for IP address 192.168.188.10 with subnet mask
255.255.255.0. Establish a telnet connection between the host PC
and Vision MINI Xi. The [SAFE-KERNEL] prompt is displayed.
2.This method requires a serial connection between the host PC
running a terminal emulator and Vision MINI Xi camera. Power-on the
unit and hold down the Tab key for several seconds. The unit will boot
to a [SAFE-KERNEL] prompt with communication settings of 115200,
N, 8, 1 (baud, parity, data bits, stop bits).
Once the unit is booted, there are many possible actions the user can
take. However, the most useful actions are listed below.
In rare situations, the boot job executed at camera startup can cause
unexpected behavior. If this is the suspected case, it is possible to disable
loading and running of the boot job at startup using the following
command.
[SAFE-KERNEL] BP_UpdateStartupOptions(0, 0)
Note that the loading and running of the boot job is automatically reenabled the next time a job is saved to camera flash from AutoVISION or
FrontRunner.
At boot time, the system configures itself using a set of information known
as boot parameters. To obtain a list of the current configuration’s boot
parameters, issue the following command.
[SAFE-KERNEL] BP_Dump()
Should your device need to be configured with different IP information,
follow the example below and substitute the appropriate settings for IP
address, subnet mask, and gateway address, respectively.
It is possible to configure the system to acquire its IP address via DHCP
or to use a static IP address. Issue the following command with a ‘0’ for
static IP or a ‘1’ for DHCP.
[SAFE-KERNEL] BP_UpdateDHCP(0)
Additional Boot Parameters
BP_UpdateCameraName(cameraName)
where cameraName is a double-quoted string representing the new
camera name.
Function: Allows you to change the name of the smart camera.
BP_UpdateLaserOn(state)
where state = 0 or 1
E
Vision MINI Xi
Diagnostic Boot Mode
Function: Allows you to disable or enable the state of the targeting laser
during image acquisition. The actual display of the targeting laser is a
logical AND of job settings with this parameter. Note that when the laser is
disabled it is still possible to turn the laser on when a job is not running by
issuing the serial command target 1 (Turn Target On).
BP_UpdateGreenFlash(state)
where state = 0 or 1
Function: Allows you to disable the flash-on-pass feature to eliminate
green flash interference during color image processing.
Vision MINI Xi Smart Camera GuideE-3
AppendixEVision MINI Xi Diagnostic Boot Mode
E-4Vision MINI Xi Smart Camera Guide
F
APPENDIX FCloudLink Web HMI
CloudLink allows you to visualize Microscan Link values and images
from compatible Microscan smart cameras and vision systems. It runs in
your web browser, and is compatible with a wide variety of modern
browsers including those found on tablets and smart phones.
This appendix contains information about CloudLink support for the Vision
MINI Xi. Refer to Getting Started with CloudLink – installed in the
documentation folder C:\Microscan\Vscape\Documentation during
AutoVISION/Visionscape installation – for detailed information about
configuring and using the CloudLink web HMI.
F
CloudLink Web HMI
CloudLink requires an HTML5-compatible browser.
•Internet Explorer 10 or later
•Google Chrome
•Firefox
•Mobile Safari (iPhone / iPad)
•Mobile Chrome on Android devices
The following browswers were explicitly tested for compatibility:
•Internet Explorer 10.0.9
•Internet Explorer 11.0.2
•Google Chrome 33.0
•Firefox 28.0
Additional Notes:
•Windows Safari is not supported.
•Internet Explorer 11 or later and Google Chrome 33 or later are
recommended for extended CloudLink sessions.
Vision MINI Xi Smart Camera GuideF-1
AppendixFCloudLink Web HMI
Click the CloudLink Dashboard
icon to launch the application.
Connecting
To launch CloudLink, use your favorite web browser and enter the address of your device
in the browser’s address bar. For example, if you have a Microscan smart camera on your
network at address 10.20.1.123, you would enter:
CloudLink also works with Visionscape Software and with AutoVISION’s Emulator.
To connect to a software-based job running in FrontRunner or AutoVISION:
First, be sure the job is running, and then type the following into your browser’s address bar:
Note: You must specify port 8080 for a PC-based connection. If you are connecting to a
PC-based system from a different machine on the network, use the IP address of the PC
instead of the local host. For example, use http://10.20.1.234:8080 if the PC’s IP address
is 10.20.1.234.
Once you press the Enter key, you should see the following home page:
F-2Vision MINI Xi Smart Camera Guide
Application Overview
Application Overview
The CloudLink Dashboard user interface is a single page web app-style application. Most
web pages show information that can typically extend beyond the bottom of the browser
window, requiring the user to scroll to see it. They typically contain links to other pages,
which is how the user navigates around a web site.
In contrast, CloudLink behaves more like an application, expanding to fill the browser
window, and automatically adapting to any changes in the dimensions of the window.
Although CloudLink allows you to define and use multiple display pages, they are all
contained within a single web page.
The browser stores a maximum of 50 images. The camera stores images, image
thumbnails, and data records that can be requested via the web page or API. When
memory is full, the camera will first delete full-size images, then thumbnails, and ultimately
the data records on a first in-first out basis.
This is a typical view of a CloudLink page.
F
CloudLink Web HMI
Note: CloudLink does not currently support display of color images from color cameras.
Vision MINI Xi Smart Camera GuideF-3
AppendixFCloudLink Web HMI
Application Bar
The Application Bar is located at the top of the CloudLink interface.
There are three components to the Appplication Bar:
•A set of page selection buttons. In the example above they appear as tabs, but the
style can be customized if necessary.
•A logo. The position and contents of the logo can be customized.
•A toolbar. The toolbar provides access to various CloudLink settings and modes. The
position and size of the toolbar can be customized.
F-4Vision MINI Xi Smart Camera Guide
Pages, Panels, and Widgets
Pages, Panels, and Widgets
The main area of CloudLink displays one of a number of pages. If there is more than one
page defined, you can switch between them by using the page selection buttons on the
application bar, or by using the arrow keys on your keyboard.
Each page is organized into a set of regions called panels. The following image shows an
empty page to demonstrate the arrangement of the panels on a page.
F
CloudLink Web HMI
Note the names, which start with .panel-. It is not necessary to know these names to use
CloudLink; however they do have significance if there should be need for customization.
Customizing CloudLink requires the modification of CSS (Cascading Style Sheets). The
names shown correspond to the CSS class selector for that panel.
The purpose of the panels is to act as containers for a number of widgets. Each widget
has the ability to visualize and interact with one or more items of inspection data such as
Microscan Link values, inspection counters, timing information, or images.
Vision MINI Xi Smart Camera GuideF-5
AppendixFCloudLink Web HMI
Each panel has special layout and behavior properties that can be exploited to create a
wide variety of different layouts. The following table summarizes the position and
properties of each panel:
F-6Vision MINI Xi Smart Camera Guide
Pages, Panels, and Widgets
If a panel does not have content (i.e. no widgets are placed in it), it is hidden from view, with
the other panels adjusted to occupy the available space. Examples of possible page layouts:
F
CloudLink Web HMI
Vision MINI Xi Smart Camera GuideF-7
AppendixFCloudLink Web HMI
F-8Vision MINI Xi Smart Camera Guide
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.