$CE Sight: Reference XLGH

$CE Sight
Reference*XLGH
I9-E-01
Copyright Notice
The information contained herein is the property of Omron Adept Technologies, Inc., and shall not be repro-
duced in whole or in part without prior written approval of Omron Adept Technologies, Inc. The information
herein is subject to change without notice and should not be construed as a commitment by Omron Adept
Technologies, Inc. The documentation is periodically reviewed and revised.
Omron Adept Technologies, Inc., assumes no responsibility for any errors or omissions in the doc-
umentation. Critical evaluation of the documentation by the user is welcomed. Your comments assist us in
preparation of future documentation. Please submit your comments to: techpubs@adept.com.
Copyright  2006 - 2016 by Omron Adept Technologies, Inc. All rights reserved.
Created in the United States of America
ACE Reference Guide, 18317-000 Rev A

Table of Contents
Table Of Contents
ACE Sight V+ and MicroV+ Keywords 35
VLOCATION transformation function 36
VPARAMETER program instruction 39
VPARAMETER real-valued function 41
VRESULT real-valued function 43
VRUN program instruction 45
VSTATE real-valued function 46
VTIMEOUT system parameter 48
VWAITI program instruction 49
ACE Sight Properties Reference for V+ and MicroV+ 51
Abort 53
ActiveCalibration 54
ActiveSettings 55
AnyFeederVRunCommand 56
AnyFeederDispenseIterations 58
AnyFeederFeedBackwardIterations 59
AnyFeederFeedBackwardSpeed 60
AnyFeederFeedFlipBackwardIterations 61
AnyFeederFeedFlipBackwardSpeed 62
AnyFeederFeedFlipForwardIterations 63
AnyFeederFeedFlipForwardSpeed 64
AnyFeederFeedForwardIterations 65
AnyFeederFeedForwardSpeed 66
AnyFeederFlipIterations 67
AnyFeederFlipSpeed 68
AnyFeederHeavyDispenseIterations 69
AnyFeederHeavyDispenseSpeed 70
AnyFeederHeavyDispenseSpeed 71
AnyFeederPurgeSpeed 72
ArcMustBeTotallyEnclosed 73
ArithmeticClippingMode 75
ArithmeticConstant 77
ArithmeticScale 78
AssignmentConstant 79
AssignmentHeight 80
AssignmentWidth 81
AutoCoarsenessSelectionEnabled 82
AutomaticCandidateCountEnabled 84
AverageContrast 86
BeltCalibrationDownstreamLimit 87
BeltCalibrationFrame 88
BeltCalibrationNearsideLimit 88
BeltCalibrationScale 90
BeltCalibrationUpstreamLimit 91
BeltLatchCalibrationOffset 91
BilinearInterpolationEnabled 93
BlobArea 95
Page 3
Table of Contents
BlobBoundingBoxBottom 96
BlobBoundingBoxCenterX 97
BlobBoundingBoxCenterY 98
BlobBoundingBoxHeight 99
BlobBoundingBoxLeft 100
BlobBoundingBoxRight 101
BlobBoundingBoxRotation 102
BlobBoundingBoxTop 103
BlobBoundingBoxWidth 104
BlobChainCode 105
BlobChainCodeDeltaX 107
BlobChainCodeDeltaY 108
BlobChainCodeLength 109
BlobChainCodeStartX 110
BlobChainCodeStartY 111
BlobConvexPerimeter 112
BlobCount 113
BlobElongation 114
BlobExtentBottom 115
BlobExtentLeft 116
BlobExtentRight 117
BlobExtentTop 118
BlobGreyLevelMaximum 119
BlobGreyLevelMean 120
BlobGreyLevelMinimum 121
BlobGreyLevelRange 122
BlobGreyLevelStdDev 123
BlobHoleCount 124
BlobInertiaMaximum 125
BlobInertiaMinimum 126
BlobInertiaXAxis 127
BlobInertiaYAxis 128
BlobIntrinsicBoundingBoxBottom 129
BlobIntrinsicBoundingBoxCenterX 130
BlobIntrinsicBoundingBoxCenterY 131
BlobIntrinsicBoundingBoxHeight 132
BlobIntrinsicBoundingBoxLeft 133
BlobIntrinsicBoundingBoxRight 134
BlobIntrinsicBoundingBoxRotation 135
BlobIntrinsicBoundingBoxTop 136
BlobIntrinsicBoundingBoxWidth 137
BlobIntrinsicExtentBottom 138
BlobIntrinsicExtentLeft 139
BlobIntrinsicExtentRight 140
BlobIntrinsicExtentTop 141
BlobPositionX 142
BlobPositionY 143
BlobPrincipalAxesRotation 144
BlobRawPerimeter 145
BlobRoundness 146
Page 4
Table of Contents
CalibratedUnitsEnabled 148
CandidatePointsCount 149
ChainCodeResultsEnabled 151
ColorFilterCount 153
ColorFilterMatchPixelCount 154
ColorFilterMatchQuality 155
CommunicationToolResults 156
ConformityTolerance 157
ConformityToleranceRangeEnabled 159
Connectivity 161
Constraints 162
ContrastPolarity 164
ContrastThreshold 166
ContrastThresholdMode 168
DefaultConformityTolerance 170
DetailLevel 172
Edge1Constraints 174
Edge1Magnitude 176
Edge1MagnitudeConstraint 177
Edge1MagnitudeScore 178
Edge1PolarityMode 179
Edge1PositionConstraint 181
Edge1PositionScore 182
Edge1PositionX 183
Edge1PositionY 184
Edge1Radius 185
Edge1Rotation 186
Edge1Score 188
Edge1ScoreThreshold 190
Edge2Constraints 191
Edge2Magnitude 193
Edge2MagnitudeConstraint 194
Edge2MagnitudeScore 195
Edge2PolarityMode 196
Edge2PositionConstraint 198
Edge2PositionScore 199
Edge2PositionX 200
Edge2PositionY 201
Edge2Radius 202
Edge2Rotation 203
Edge2Score 205
Edge2ScoreThreshold 207
EdgeCount 208
EdgeFilterHalfWidth 209
EdgeMagnitude 210
EdgeMagnitudeScore 211
EdgeMagnitudeThreshold 212
EdgePolarityMode 213
EdgePositionScore 215
EdgePositionX 216
Page 5
Table of Contents
EdgePositionY 217
EdgeRadius 218
EdgeRotation 219
EdgeScore 220
EdgeSortResultsEnabled 221
ElapsedTime 222
ExtrinsicInertiaResultsEnabled 224
FilterCount 226
FilterHalfWidth 227
FilterHueTolerance 228
FilterHueValue 230
FilteringClippingMode 232
FilteringKernelSize 234
FilteringScale 235
FilterLuminanceTolerance 236
FilterLuminanceValue 238
FilterSaturationTolerance 240
FilterSaturationValue 242
FitMode 244
FitQuality 246
FlexibowlFeederVRunCommand 247
FlexibowlFeederBlowTime 249
FlexibowlFeederFlipCount 250
FlexibowlFeederFlipDelay 251
FlexibowlFeederForwardAcceleration 252
FlexibowlFeederForwardAngle 253
FlexibowlFeederForwardDeceleration 254
FlexibowlFeederForwardSpeed 255
FlexibowlFeederShakeAcceleration 256
FlexibowlFeederShakeAngle 257
FlexibowlFeederShakeCount 258
FlexibowlFeederShakeDeceleration 259
FlexibowlFeederShakeSpeed 260
Found 261
FrameCount 262
FrameIntrinsicBoundingBox 264
FrameRotation 266
FrameTranslationX 267
FrameTranslationY 268
GreylevelRange 269
GreyLevelResultsEnabled 270
GripperInputClose 272
GripperInputExtend 273
GripperInputOpen 274
GripperInputRetract 275
GripperOffset 276
GripperOutputClose 277
GripperOutputExtend 278
GripperOutputOpen 279
GripperOutputRelease 280
Page 6
Table of Contents
GripperOutputRetract 281
GripperPayload 282
GripperToolTransform 283
Histogram 284
HistogramPixelCount 285
HistogramThreshold 286
HoleFillingEnabled 287
ImageHeight 288
ImageOriginBelt 289
ImageOriginRobot 291
ImagePixelCount 293
ImageSubsampling 294
ImageWidth 296
InspectionFilterMeasuredValue 297
InspectionFilterPassStatus 297
InstanceClearQuality 299
InstanceCount 301
InstanceFitQuality 303
InstanceIntrinsicBoundingBox 305
InstanceLocation 307
InstanceLocationGripperOffsetMaximum 309
InstanceLocationGripperOffsetMinimum 311
InstanceMatchQuality 313
InstanceModel 315
InstanceOrdering 317
InstanceOrderingReferenceX 319
InstanceOrderingReferenceY 320
InstanceRobotLocation 321
InstanceRotation 323
InstanceScaleFactor 324
InstanceSymmetry 326
InstanceTime 328
InstanceToolOffset 330
InstanceTranslationX 332
InstanceTranslationY 333
InstanceVisible 334
InstanceVisionOffset 336
InterpolatePositionMode 338
InterpolatePositionModeEnabled 339
IntrinsicBoxResultsEnabled 341
InverseKinematics 343
KernelSize 346
LastOperation 347
LastOutputType 350
LogicalConstant 352
MagnitudeConstraint 353
MagnitudeThreshold 355
MatchCount 356
MatchPositionX 357
MatchPositionY 358
Page 7
Table of Contents
MatchQuality 359
MatchRotation 360
MatchStrength 361
MatchThreshold 362
MaximumAngleDeviation 364
MaximumBlobArea 366
MaximumGreylevelValue 367
MaximumInstanceCount 368
MaximumInstanceCountEnabled 370
MaximumRotation 371
MaximumScaleFactor 372
Mean 373
MeasurementPointsCount 374
Median 375
MinimumArcPercentage 376
MinimumBlobArea 377
MinimumClearPercentage 378
MinimumClearPercentageEnabled 379
MinimumGreylevelValue 380
MinimumLinePercentage 381
MinimumModelPercentage 382
MinimumRequiredFeatures 383
MinimumRotation 385
MinimumScaleFactor 386
Mode 387
ModelDisambiguationEnabled 388
ModePixelCount 390
MorphologicalNeighborhoodSize 391
NominalRotation 392
NominalRotationEnabled 393
NominalScaleFactor 395
NominalScaleFactorEnabled 396
Operation 398
Operator 402
OutlineLevel 404
OutputArcAngle 405
OutputArcCenterPointX 406
OutputArcCenterPointY 407
OutputArcRadius 408
OutputLineAngle 409
OutputLineEndPointX 410
OutputLineEndPointY 411
OutputLineStartPointX 412
OutputLineStartPointY 413
OutputLineVectorPointX 414
OutputLineVectorPointY 415
OutputPointX 416
OutputPointY 417
OutputSymmetricInstances 418
OverrideType 420
Page 8
Table of Contents
OverrideTypeEnabled 422
PairCount 423
PairPositionX 425
PairPositionY 427
PairRotation 428
PairScore 429
PairSize 430
ParametersBasedOn 431
PatternHeight 433
PatternPositionX 435
PatternPositionY 437
PatternRotation 438
PatternWidth 440
PerimeterResultsEnabled 442
PolarityMode 444
PositionConstraint 446
PositioningLevel 447
ProjectionMode 448
RecipeManagerActiveRecipe 450
RecipeManagerRecipeCount 451
RecipeManagerRecipeSelection 452
RecipeManagerRecipeDelete 453
RecipeManagerLoadFile 454
RecipeManagerSaveFile 455
RecognitionLevel 456
Reset 457
ResultCount 458
RobotXPosition 459
RobotYPosition 461
SamplingStepCustom 463
SamplingStepCustomEnabled 465
SaveImage 467
ScoreThreshold 468
SearchBasedOnOutlineLevelOnly 469
SearchCoarseness 471
SearchMode 472
SegmentationDark 474
SegmentationDynamicDark 476
SegmentationDynamicInside 478
SegmentationDynamicLight 480
SegmentationDynamicOutside 482
SegmentationInside 484
SegmentationLight 486
SegmentationMode 488
SegmentationOutside 490
SequenceExecutionMode 492
SequenceToolCount 494
Sharpness 495
SharpnessPeak 496
ShowResultsGraphics 497
Page 9
Table of Contents
SortBlobsBy 499
SortResultsEnabled 502
StandardDeviation 503
StandardDeviationThreshold 504
SubsamplingLevel 505
TailBlack 506
TailBlackGreylevelValue 507
TailWhite 508
TailWhiteGreylevelValue 509
ThresholdBlack 510
ThresholdWhite 511
Timeout 512
TimeoutEnabled 514
ToolGuidelineOffset 515
ToolHeight 516
ToolOpening 517
ToolPositionX 519
ToolPositionY 521
ToolRadius 522
ToolRotation 524
ToolSkew 526
ToolThickness 528
ToolWidth 530
TopologicalResultsEnabled 532
TransformFlags 533
UseDefaultConformityTolerance 535
Variance 537
VideoExposure 538
VideoGain 539
VisionOriginBelt 540
VisionOriginRobot 542
VisionRotation 544
VisionXPosition 546
VisionYPosition 548
ACE Sight Properties Quick Reference 550
ACE Sight Framework Properties 574
ACE Sight Tool Properties 576
AnyFeeder Properties 578
Arc Caliper Properties 579
Arc Edge Locator Properties 581
Arc Finder Properties 583
Blob Analyzer Properties 585
Calculated Arc Properties 589
Calculated Frame Properties 590
Calculated Line Properties 591
Calculated Point Properties 592
Calibration Grid Locator Properties 593
Caliper Properties 594
Color Matching Tool Properties 596
Page 10
Table of Contents
Communication Tool Properties 597

Custom Vision Tool Properties 598
Edge Locator Properties 599
Flexibowl Feeder Properties 601
Gripper Clearance Tool Properties 602
Image Histogram Tool Properties 603
Image Processing Tool Properties 605
Image Sampling Tool Properties 606
Image Sharpness Tool Properties 607
Inspection Tool Properties 608
Line Finder Properties 609
Locator Tool Properties 611
Overlap Tool Properties 614
Pattern Locator Properties 615
Point Finder Properties 617
Recipe Manager Properties 619
Remote Vision Tool Properties 620
Virtual Camera Tool Properties 622
Customizer Reference Guide 623

PC Customization 623
Overview 623
ACE Core Library 624
ACE Vision Library 624
ACE Adept Library 624
ACE Sight Module 624
ACE PackXpert Module 624
Client and Server Side Plugins 625
Visual Studio Solution 625
Application Domains 625
Crossing the Application Domain Boundaries 625
Remoting, Object Scope, and Serialization 626
Server Side Plug-Ins 627
Data Collection Sample 627
Default C# Program 627
Referencing other objects and tools 628
Data Collection Overview 628
Step 1: Acquire a handle to a robot 628
Step 2: Identify the data to be collected 629
Step 3: Collect the data 629
Step 4: Extract the data 630
Step 5: Save the data to a file 630
Output Data File 631
Vision Tool Customization 632
Default Custom Vision Tool 632
Referencing other objects and tools 633
Complete Example 634
Process Manager Customization Overview 636
Page 11
Table of Contents
637
Process Strategy Customization 637
Controller Customizations 637
638
Robot Customizations 638
Robot: General 638
Robot: Allocation 638
Robot: Wait Mode 639
Robot: Error Responses 640
640
Control Sources: Belt Monitoring 640
641
Motion Settings: Pick and Place 641
642
Motion Settings: Refinement 642
Advanced Debugging Techniques 644
Process Manager Runtime Control 644
Event Log Display 647
Triggering Additional V+ Logging 649
Vision Results Logging 650
Virtual Camera Image Logging 650
Diagnostic Summary Display 650
V+ Profiler Display 651
System Monitor Display 652
Belt Control I/O 653
Belt Control Settings 654
Belt Control: Defining a Custom Belt Program 657
Belt Control: Default Belt Program Behavior 658
Iterate Through the Belts 658
Evaluate Type of Belt Control 658
Run Check: Turn Belt Off 659
Belt Monitoring 660
Belt Monitoring 660
Initialization 661
Monitor Encoder Motion 661
Monitor Spacing Points 662
Monitor Hardware Latches 663
Monitor Camera Points 665
Conceptual Overview 667
Top Down Approach: An Application Framework 667
Hardware Sources: Provide Instances 669
Controller Queue: Process Instances 670
Process Manager Runtime Control: Hardware Display 670
Process Strategy: Data Models 672
673
Custom Allocation Scripts 674
Creating an Allocation Script 674
Page 12
Table of Contents
Default Allocation Script 675

Default Allocation Script: Initialize Method 675
Default Allocation Script: AllocateNonBeltInstances 676
Default Allocation Script: AllocateBeltInstances 676
Default Allocation Script: NotifyInstancesProcessed 677
Default Allocation Script: LocatedInstance 678
Default Allocation Script: LocatedInstance and the Tag property 679
Custom Error Programs 681
Error Display 681
V+ Error Customization 683
Custom IO Feeder Programs 685
Customizing The Feeding Sequence 685
Customizing System Initialization 690
Custom Initialization Program 691
Custom Pick and Place Motion Programs 692
Customizing The Motion Sequence 692
Custom Process Strategy Monitoring Programs 697
Variable Initialization 698
Control Loop 699
Custom Refinement Motion Programs 699
Customizing The Refinement Sequence 700
Custom Robot Error Response Programs 701
Customizing The Error Response Program 702
Custom Robot Process Selection Program 703
Custom Robot Program: Overview 707
Specification of Processes 708
Accessing Queues 709
Custom Robot Wait Programs 710
Customizing Stop Behavior 713
Custom Stop Program 714
Part and Target Queues 715
Belt Instance Filtering 715
Instance Allocation 716
Representation on Controller 717
Rotary Buffer 717
V+ API Calls 718
Recipe Management 719
Calibration Sharing 719
Separation of motion parameters 720
C# Scripting 721
V+ Module Documentation 722

V+ AceServer Module Documentation 724
sv.create_msg(msg_num, handle, ptr) 724
Abstract 724
Input Parameters 724
Output Parameters 724
sv.read_adouble(handle, ptr, offset, value[], n_items) 724
Abstract 724
Page 13
Table of Contents

sv.read_ashort(handle, ptr, offset, value[], n_items) 724
Abstract 724
sv.read_asingle(handle, ptr, offset, value[], n_items) 725
Abstract 725
sv.read_astring(handle, ptr, offset, $value[], n_items) 725
Abstract 725
sv.read_bool(handle, ptr, value) 726
Abstract 726
Example 726
sv.read_byte(handle, ptr, value) 727
Abstract 727
Example 727
sv.read_byte(handle, ptr, value) 728
Abstract 728
Example 728
sv.read_double(handle, ptr, value) 729
Abstract 729
Example 729
sv.read_short(handle, ptr, value) 730
Abstract 730
Example 730
sv.read_single(handle, ptr, value) 731
Abstract 731
Example 731
sv.read_string(handle, ptr, $string) 732
Abstract 732
Example 732
sv.read_trans(handle, ptr, trans) 733
Page 14
Table of Contents
Abstract 733
Example 733
sv.stop_collect(robot.num) 734
Abstract 734
sv.sig.is.equal(sig.num, expected.val, is.equal.res) 734
Abstract 734
Example 735
sv.write(handle, ptr) 735
Abstract 735
sv.write_abyte($string[], offset, count, handle, ptr) 735
Abstract 735
sv.write_adoubl(first_index, value[], n_items, handle, ptr) 736
Abstract 736
sv.write_ashort(first_index, value[], n_items, handle, ptr) 736
Abstract 736
sv.write_asingl(first_index, value[], n_items, handle, ptr) 737
Abstract 737
sv.write_astrin(first_index, $value[], n_items, handle, ptr) 737
Abstract 737
sv.write_bool(value, handle, ptr) 738
Abstract 738
Example 738
sv.write_byte(value, handle, ptr) 739
Abstract 739
Example 739
sv.write_short(value, handle, ptr) 740
Abstract 740
Page 15
Table of Contents

Example 740
sv.write_hdr(handle, ptr) 741
Abstract 741
sv.write_single(value, handle, ptr) 741
Abstract 741
Example 741
sv.write_string($string, handle, ptr) 742
Abstract 742
Example 742
sv.write_trans(trans, handle, ptr) 743
Abstract 743
Example 743
V+ ACE Sight Module Documentation 746
as.save.image($filename, $ip, seq.idx, tool.idx, status) 746
Abstract 746
check_tracking(tracking_ok) 746
Abstract 746
746
clear_queue(queue_index) 746
Abstract 746
747
getinstance(queue_index, flags, location, model, encoder, visionx, visiony, visionrot) 747
Abstract 747
reset_seq($myip, seq_id) 748
Abstract 748
set_as_exec_mod($myip, seq_id, mode) 748
Abstract 748
V+ End-Effector Program Documentation 750
Page 16
Table of Contents
End-Effector Library Error Codes 750

ee.chk.er(ee.idx, tip.idx, state, sts) 750
Abstract 750
ee.chk.oc(tsk.idx, tip.idx, state, sts) 750
Abstract 750
ee.clroff(ee.idx, sts) 751
Abstract 751
ee.presence(tsk.idx, tip.idx, state, sts) 751
Abstract 751
ee.release(ee.idx, tip.idx, state, sts) 752
Abstract 752
ee.select.ck(ee.idx, tip.idx, sts) 752
Abstract 752
ee.select(ee.idx, tip.idx) 753
Abstract 753
Example 753
ee.setoff(ee.idx, tip.idx, tool.trans, sts) 754
Abstract 754
Example 754
ee.gr.settle(ee.idx, tip.idx, state, sts) 755
Abstract 755
ee.state(ee.idx, tip.idx, state, check.inputs, sts) 755
Abstract 755
Example 756
ee.gr.tip.er(tsk.idx, tip.idx, state) 756
Abstract 756
ee.tip.erdw(ee.idx, tip.idx) 757
Abstract 757
Page 17
Table of Contents

ee.tip.oc(ee.idx, tip.idx, state, sts) 757
Abstract 757
pm.gr.trans(tsk.idx, tip.idx, tool.trans, sts) 758
Abstract 758
Example 758
ee.unselect(ee.idx) 759
Abstract 759
Example 759
V+ Process Manager Documentation 762
pm.ace.blt.cam(tsk.idx, $camera, remote, encoder) 762
Abstract 762
Example 762
pm.ace.blt.ltch(blt.idx, enc, latch, value, $tag) 762
Abstract 762
Example 763
pm.ace.blt.pos(blt.idx, encoder, encoder.value, encoder.vel) 763
Abstract 763
Example 763
pm.ace.blt.sp(blt.idx, $spacing, value, $tag) 763
Abstract 763
Example 764
pm.ace.pkstate($manager, state, time.out, sts) 764
Abstract 764
pm.ace.ref(tsk.idx, $ref.name, sts) 764
Abstract 764
Example 764
pm.ace.ref.wt(tsk.idx, time.out, loc, sts) 765
Abstract 765
Example 765
Page 18
Table of Contents
pm.blt.convert(encoder) 765
Abstract 765
Example 765
pm.blt.travel(point.1, point.2, distance) 765
Abstract 765
Example 766
pm.chk.run(run) 766
Abstract 766
pm.chk.stat(run) 766
Abstract 766
Example 767
pm.chk.tskerr(tsk.idx, resp.mask, code, resp) 768
Abstract 768
Example 768
pm.def.btn.txt(tsk.idx, button, $text) 769
Abstract 769
pm.def.err.txt(tsk.idx, $text) 769
Abstract 769
pm.def.err.txt(tsk.idx, $text) 770
Abstract 770
pm.fdr.state($name, state) 770
Abstract 770
pm.get.free.tsk(first.tsk, last.tsk, tsk.num) 770
Abstract 770
pm.gr.clroff(tsk.idx, sts) 771
Abstract 771
pm.gr.release(tsk.idx, tip.idx, state, sts) 771
Abstract 771
Page 19
Table of Contents

pm.gr.select.ck(tsk.idx, tip.idx, resp) 772
Abstract 772
pm.gr.select(tsk.idx, tip.idx) 772
Abstract 772
Example 772
pm.gr.setoff(tsk.idx, tip.idx, tool.trans, sts) 773
Abstract 773
Example 773
pm.gr.settle(tsk.idx, tip.idx, state, sts) 774
Abstract 774
pm.gr.state(tsk.idx, tip.idx, state, check.inputs, sts) 774
Abstract 774
Example 775
pm.gr.trans(tsk.idx, tip.idx, tool.trans, sts) 775
Abstract 775
Example 776
pm.gr.unselect(tsk.idx) 776
Abstract 776
Example 777
pm.log($text) 777
Abstract 777
Additional Notes 777
pm.mv.attach(tsk.idx, rob.num) 778
Abstract 778
Example 778
pm.mv.chkbrk(offset, pars[]) 779
Abstract 779
Page 20
Table of Contents
pm.mv.dest(rob.idx) 779
Abstract 779
Example 780
pm.mv(blt.idx, position, offset, pars[]) 781
Abstract 781
pm.mv.idle(rob.idx) 782
Abstract 782
Example 782
pm.proc.enable($manager, proc.idx, state, sts) 782
Abstract 782
pm.prt.avail(rob.idx, part.idx, count) 783
Abstract 783
Example 783
pm.prt.done(rob.idx, part.idx, obj.idx, sts) 783
Abstract 783
pm.prt.get(rob.idx, part.idx, obj.idx, $id, position, reference, pal.idx) 784
Abstract 784
Example 784
pm.prt.get.idx(rob.idx, $part, part.idx) 786
Abstract 786
Example 786
pm.prt.getloc(rob.idx, part.idx, obj.idx, pct) 786
Abstract 786
Example 787
pm.prt.move.ptr(ptr) 788
Abstract 788
Example 788
pm.ps.error(tsk.idx, code, resp.mask, resp) 790
Abstract 790
Page 21
Table of Contents

pm.ps.map.idx(proc.idx, map.idx) 790
Abstract 790
Example 790
pm.ps.power(tsk.idx, enable) 791
Abstract 791
pm.rob.chkidle(rob.idx, part.type, grip.idx, excl[], is.reset, sts) 791
Abstract 791
pm.rob.clear(rob.idx) 792
Abstract 792
Example 792
pm.rob.gettag(rob.idx, $tag) 793
Abstract 793
Example 793
pm.rob.idlemd(rob.tsk, in.idle, code, $info) 794
Abstract 794
Example 794
pm.rob.init(rob.idx) 795
Abstract 795
Example 796
pm.rob.monque(rob.tsk, part.idx, trg.idx) 797
Abstract 797
Example 797
pm.rob.pick(rob.idx, part.type, grip.idx, excl[], is.reset, sts) 797
Abstract 797
Example 798
pm.rob.place(rob.idx, target.type, part.type, grip.idx, ms.type, excl[], is.reset, sts) 799
Abstract 799
Example 800
Page 22
Table of Contents
pm.rob.process(rob.idx, proc.idx, sts) 801

Abstract 801
Example 801
pm.rob.refine(rob.idx, refine.idx, grip.idx, sts) 802
Abstract 802
pm.rob.settag(tsk.idx, $tag) 802
Abstract 802
Example 803
pm.sig.check(sig, time, is.valid) 803
Abstract 803
Example 803
pm.sig.clear(sig) 804
Abstract 804
Example 804
pm.src.clear($manager, $source, sts) 805
Abstract 805
Example 805
pm.src.clearall($manager, sts) 805
Abstract 805
Example 806
pm.trg.avail(rob.idx, trg.idx, count) 806
Abstract 806
Example 806
pm.trg.done(rob.idx, trg.idx, obj.idx, sts) 807
Abstract 807
pm.trg.get(rob.idx, trg.idx, obj.idx, $id, position, reference, pal.idx) 807
Abstract 807
Example 808
pm.trg.get.idx(rob.idx, $target, target.idx) 809
Abstract 809
Page 23
Table of Contents

Example 809
pm.trg.getloc(rob.idx, trg.idx, obj.idx, pct) 810
Abstract 810
Example 810
pm.trg.move.ptr(ptr) 811
Abstract 811
Example 811
V+ Remote Library Documentation 814
Remote Library Error Codes 814
rm.app.event(value, wait.time, status) 814
Abstract 814
Example 815
rm.chk.server(is.alive) 815
Abstract 815
Example 815
rm.execute($object, $method, num.args, $args[], wait.time, status) 816
Abstract 816
Example 816
rm.pc.fapp($file, $line, wait.time, status) 817
Abstract 817
Example 817
rm.pc.fapps($file, num.lines, $lines[], wait.time, status) 818
Abstract 818
Example 819
rm.pc.fapps2($file, start.idx, num.lines, $lines[], wait.time, status) 820
Abstract 820
Example 820
rm.pc.fcopy($from.file, $to.file, wait.time, status) 821
Abstract 821
Example 822
Page 24
Table of Contents
rm.pc.fdel($file, wait.time, status) 823

Abstract 823
Example 823
rm.pc.fdir($file.spec, wait.time, num.items, $items[], types[], status) 825
Abstract 825
Example 825
rm.pc.log($source, $text, wait.time, status) 826
Abstract 826
Example 827
rm.read.anums($objects[], $variables[], wait.time, values[], status) 827
Abstract 827
Example 827
rm.read.num($object, $variable, wait.time, value, status) 828
Abstract 828
Example 828
rm.read.nums($object, $variables[], wait.time, values[], status) 829
Abstract 829
Example 829
rm.read.str($object, $variable, wait.time, $value, status) 830
Abstract 830
Example 830
rm.read.strs($object, $variables[], wait.time, $values[], status) 831
Abstract 831
Example 831
rm.read.trns($object, $variable, wait.time, value, status) 831
Abstract 831
Example 832
rm.read.trnss($object, $variables[], wait.time, values[], status) 832
Abstract 832
833
Page 25
Table of Contents
rm.save($file, wait.time, status) 833

Abstract 833
Example 833
rm.write.anums($objects[], $variables[], wait.time, values[], status) 833
Abstract 833
Example 834
rm.write.num($object, $variable, wait.time, value, status) 834
Abstract 834
Example 835
rm.write.nums($object, $variables[], wait.time, values[], status) 835
Abstract 835
Example 836
rm.write.str($object, $variable, wait.time, $value, status) 836
Abstract 836
Example 837
rm.write.strs($object, $variables[], wait.time, $values[], status) 837
Abstract 837
Example 838
rm.write.trns($object, $variable, wait.time, value, status) 838
Abstract 838
Example 838
rm.write.trnss($object, $variables[], wait.time, values[], status) 839
Abstract 839
Recent Changes
For the most recent change information, please see the ReadMe.rtf file, which can be viewed by selecting
the following from the Windows Start button:
Start > Program > Omron> ACE > ACE ReadMe File
Compatibility Differences
This section describes the compatibility differences between AdeptSight 2.x and ACE Sight.
Page 26
Table of Contents
1. A standard collection of ACE Sight V+ programs are contained in a file called asight.v2. This file is
updated on any controllers in the workspace when the ACE software connects to a given controller.
2. The asight.v2 file contains some of the sample code associated with AdeptSight 2.x queue
management, namely:
getinstance reset_seq string2instance
nzs2string set_as_exec_mod
It is no longer necessary to include those programs in an application being migrated from AdeptSight 2 to
ACE Sight.
3. ACE Sight operates in the “AdeptSight Server” mode of AdeptSight 2.x. This will not functionally
change applications that use the communications tool queue to access parts.
4. Several of the properties have changed. In total, there are 440 command parameter codes in
AdeptSight 2.x. The conversion to ACE Sight affects 17 of these commands. The changes are as follows:
Property Name Code Description of the Change
RobotConfiguration 10400 No longer supported.
InverseKinematics 10060 The configuration used in the kinematic calculation is based on the
current configuration of the robot. It no longer uses the
RobotConfiguration parameter.
Inverse kinematics calculations are not supported for the Cobra i-Series
robot.
GripperOffset 10100 ACE Sight returns the gripper offset from the gripper offset table
associated with a specific robot. For details, see See "GripperOffset".
The following command codes are not directly supported in ACE Sight at this time. Please contact Adept
Technical Support for programming options.
Property Name Code
LoadProject 10300
LoadSequence 10301
LoadColorCalibration 10302
LoadVisionCalibration 10303
LoadRobotCalibration 10304
Page 27
Table of Contents
Property Name Code
LoadBeltCalibration 10305
LoadCameraSettings 10306
SaveProject 10320
SaveSequence 10321
SaveColorCalibration 10322
SaveVisionCalibration 10323
SaveRobotCalibration 10324
SaveBeltCalibration 10325
SaveCameraSettings 10326
The following command codes are no longer supported.
Property Name Code
ModelAutomaticLevels 410
ModelOutlineLevel 411
ModelDetailLevel 412
ModelContrastThresholdMode 413
ModelContrastThreshold 414
ModelTrackingInertia 415
ModelFeatureSelection 416
ModelBoundingAreaBottom 417
ModelBoundingAreaTop 418
ModelBoundingAreaLeft 419
ModelBoundingAreaRight 420
ModelOriginPositionX 421
ModelOriginPositionY 422
ModelOriginRotation 423
ModelReferencePointCount 424
Page 28
Table of Contents
Property Name Code
ModelReferencePointPositionX 425
ModelReferencePointPositionY 426
ModelShadingAreaBottom 427
ModelShadingAreaTop 428
ModelShadingAreaLeft 429
ModelShadingAreaRight 430
ToolUseEntireImage 102
LearnTime 1302
Status 1002
MessageCount 1300
MessageNumber 1301
ModelDatabaseModified 402
ModelCount 404
ModelEnabled 405
CoordinateSystem 1000
OutputOutlineSceneEnabled 21
OutputDetailSceneEnabled 22
OutputInstanceSceneEnabled 23
OutputMode 24
ModelBasedScaleFactorMode 220
ModelBasedMinimumScaleFactor 221
ModelBasedMaximumScaleFactor 222
ModelBasedRotationMode 223
ModelBasedMinimumRotation 224
ModelBasedMaximumRotation 225
ModelEnabled 405
Page 29
Table of Contents
FrameTranslationX (2400), FrameTranslationY (2401), and FrameRotation (2402) should be replaced with
the InstanceTranslationX (1315), InstanceTranslationY (1316), and InstanceRotation (1314). The
Instance parameter has been expanded to support all tools.
5. Table-mounted camera refinement has changed. In AdeptSight 2.x, a table-mounted camera is treated
as a special case, and the results are used to directly offset a target position for placement. In ACE Sight,
the table-mounted camera is not treated as a special case. If you use a table-mounted camera, command
code 1311 returns the world location of the located vision object.
In addition, the instruction InstanceToolOffset (command code 1372) has been added to return the
location of the vision object relative to the gripper tip at the time the picture was taken. For details, see See
"InstanceToolOffset".
6. Additional properties and corresponding command codes have been added to enable the reading of a
robot gripper IO:
Property Name Code
GripperOutputOpen 5511
GripperOutputClose 5512
GripperOutputRelease 5513
GripperInputOpen 5514
GripperInputClose 5515
GripperOutputExtend 5516
GripperOutputRetract 5517
GripperInputExtend 5518
GripperInputRetract 5519
NOTE: In version 3.1, the parameters for these were modified to the following:
$ip IP address of the vision server
sequence Not used. Must be -1.
Tool The tip number
Index The robot number
Object The index of the signal number to access
7. Additional command codes have been added to enable the reading and writing of camera settings:
Page 30
Table of Contents
Property Name Code
ActiveCalibration 5504
ActiveSettings 5505
VideoExposure 5502
VideoGain 5503
8. A property and corresponding command code has been added to enable the reading of a tool
transformation for a given tip on the robot gripper:
Property Name Code
GripperToolTransform 11000
NOTE: In version 3.1, the parameters were modified to the following:
$ip IP address of the vision server.
sequence Not used. Must be -1.
Tool Index of the tip to access.
Instance The robot number.
Result Not used.
Frame Not used.
9. A property and corresponding command code has been added to enable the reading of the total
number of results that have been queued by all communication tools within a given sequence:
Property Name Code
CommunicationToolResults 2600
10. The following vision tools were added for ACE Sight:
Calculated Arc Calibration Grid Locator Inspection Tool
Calculated Frame Custom Vision Tool Remote Vision Tool
Calculated Line Gripper Clearance Tool
Calculated Point Image Sampling Tool
11. ACE Sight can import project files created in AdeptSight 2. ACE Sight will attempt to extract all vision
sequences and camera devices. There are some known limitations, which are described below.
Page 31
Table of Contents
• ACE Sight will not import the robot and controller device information.
AdeptSight 2 does not store enough information to automate the creation of these objects in the
workspace
• ACE Sight will not properly import uncalibrated camera devices.

AdeptSight 2 does not use a consistent scheme when defining the origin of images associated with camera
devices. In AdeptSight 2, the origin of an uncalibrated device is the top left corner of the image. The origin
of a calibrated device is the center of the image. In ACE Sight, the coordinates used for all images are the
center of the image. When an uncalibrated device is loaded, there is not enough information in the project
file to properly translate the uncalibrated data from an AdeptSight 2 device and tool locations to the
equivalent device and tool information in ACE Sight 3. In this case, the device and tools will be imported,
but the user will need to retrain the tools and device settings.
• The ACE Sight Inspection Tool does not support the same set of operations as the AdeptSight 2 Results
Inspection Tool.
An ACE Sight Inspection Tool will be created in place of an AdeptSight 2 Results Inspection Tool, but the
filters are not imported.
12. The following properties and corresponding command codes were added to the Inspection tool in ACE
Sight:
Property Name Code
InspectionFilterMeasuredValue 2700
InspectionFilterNominalDeviation 2701
InspectionFilterPassStatus 2702
13. To support the Adept AnyFeeder bulk-part feeder, the ACE Sight V+ keywords VPARAMETER, VRUN,
VSTATE, and VWAITI have been modified, and ACE Sight command codes 6000-6018 have been added.
For details, see the Adept AnyFeeder User's Guide, Rev B or later.
CAUTION: If an ACE Sight vision sequence and an Adept AnyFeeder have the
same index value, only the ACE Sight vision sequence will be executed. This
prevents any conflict with an existing ACE Sight vision system when adding an
Adept AnyFeeder.
14. The following properties and corresponding command codes were added to ACE Sight 3.2:
Property Name Code
BeltCalibrationNearsideLimit 10003
InstanceVisionOffset 1373
15. The following property and corresponding command code was added to ACE Sight 3.4:
Page 32
Table of Contents
Property Name Code
BeltLatchCalibrationOffset. 10010
For details, see See
"BeltLatchCalibrationOffset ".
Page 33
ACE Sight V+ and MicroV+ Keywords
ACE Sight V+ and MicroV+ Keywords

The following keywords are required for programming ACE Sight applications in MicroV+ or V+.
Click on a keyword to view the corresponding description.
VLOCATION transformation function
VPARAMETER program instruction
VPARAMETER real-valued function
VRESULT real-valued function
VRUN program instruction
VSTATE real-valued function
VTIMEOUT system parameter
VWAITI program instruction
Page 35
Syntax
MicroV+
VLOCATION (sequence_id, tool_id, instance_id, result_id, index_id, frame_id)
V+
VLOCATION ($ip, sequence_id, tool_id, instance_id, result_id, index_id, frame_id)
Description
Returns a Cartesian transform result of the execution of the specified vision sequence. The returned value
is a transform result: x, y, z, yaw, pitch, roll.
Parameters
$ip IP address of the vision server. Applies to V+ syntax only. Uses standard IP
address format, for example: 192.168.1.120.
sequence_id Index of the vision sequence. The first sequence is 1.
tool_id Index of the tool in the vision sequence. The first tool is 1.
instance_id Index of the instance in the specified result frame. If no result frame is specified,
it is the index for all instances returned by the tool.
result_id Identifier (ID) of the result. Refer to the ACE Sight Properties Quick Reference
tables to find the ID for the required result.
Typically this value = 1311.
For gripper offset location, this value can be set to 1400 and incremented by 1
for each additional gripper offset. The maximum value is 1499. See Example 2.
index_id Reserved for internal use. Value is always 1.
frame_id Index of the frame for which you want to retrieve the result contained in the
specified instance.
Details
The following parameters are optional: sequence_id, tool_id, instance_id, index_id, and frame_id.
These parameters are 1-based. If no value is provided for these parameters, they default to 1.
For V+ systems, the vision server is the PC on which the ACE Sight vision software is running.
Page 36
To retrieve specific values
To retrieve global values: sequence_id = -1, tool_id = -1
To retrieve camera
sequence_id = -1, tool_id = cameraIndex
values:
To retrieve camera-
sequence_id = -1, tool_id = cameraIndex, index_id = robotIndex
relative-to robot values:
To retrieve sequence
sequence_id = sequenceIndex, tool_id = -1
values:
To retrieve Belt Calibration-related values (read only)
instance_
Property sequence_id tool_id result_id index_id frame_id
id
Frame -1 cameraIndex n/a 10000 robotIndex n/a
UpstreamLimit -1 cameraIndex n/a 10001 robotIndex n/a
DownstreamLimit -1 cameraIndex n/a 10002 robotIndex n/a
NearsideLimit -1 cameraIndex n/a 10003 robotIndex n/a
VisionOrigin -1 cameraIndex n/a 10050 robotIndex n/a
To retrieve Belt Latch Calibration offsets (read only)

instance_
Property sequence_id tool_id result_id index_id frame_id
id
Latch -1 Reference n/a 10010 robotIndex n/a
CalibrationOffset number, as
defined in
Keyword
Mapping
parameter of
ACE Sight
Latch
Calibration (in
ACE
workspace).
Examples
Example 1
Page 37
In this example, the 1311 result ID indicates using the first gripper offset. This is equivalent to using
the 1400 result ID.
; Retrieve the location of a found instance

; instance location = 1311
SET location = VLOCATION($ip, 1, 2, 1, 1311)
Example 2
; set 1st gripper offset location

; 1st gripper offset location = 1400
SET location = VLOCATION ($ip, 1, 2, 1, 1400)
; set 2nd gripper offset location
...
; set 6th gripper offset location
Example 3
; Retrieve the location of the Belt frame

; BeltCalibrationFrame index is 10000
VLOCATION ($ip, -1, cameraIndex, , 10000, robotIndex)
; Retrieve the location of the Vision origin
; VisionOrigin index is 10050
VLOCATION ($ip, -1, cameraIndex, , 10050, robotIndex)
Page 38

NOTE: This keyword can also be used to control the Adept AnyFeeder. For details, see the Adept
AnyFeeder User's Guide, Rev B or later.
Syntax
MicroV+
VPARAMETER (sequence_id, tool_id, parameter_id, index_id, object_id) = value
V+
VPARAMETER (sequence_id, tool_id, parameter_id, index_id, object_id) $ip = value
Description
Sets the current value of a vision tool parameter.
Parameters
parameter_id Identifier (ID) of the parameter. Refer to the ACE Sight Properties Quick
Reference tables to find the ID for the required parameter.
object_id Some parameters require an object index to access specific values in an array.
Please refer to the details for the individual parameter to understand the
meaning and possible usage.
Details
The following parameters are optional: sequence_id, tool_id, parameter_id, index_id, and object_id.
Example
Page 39
; Set a Locator to find

; a maximum of 4 object instances.
; MaximumInstanceCount = 519
VPARAMETER(1, 2, 519) $ip = 4
Page 40
Syntax
MicroV+
value = VPARAMETER (sequence_id, tool_id, parameter_id, index_id, object_id)
V+
value = VPARAMETER ($ip, sequence_id, tool_id, parameter_id, index_id, object_id)
Description
Gets the current value of a vision tool parameter.
Parameters
parameter_id Identifier (ID) of the parameter. Refer to the ACE Sight Properties Quick
Reference tables to find the ID for the required parameter.
object_id Some parameters require an object index to access specific values in an array.
Please refer to the details for the individual parameter to understand the
meaning and possible usage.
Details
The following parameters are optional: sequence_id, tool_id, parameter_id, index_id, and object_id.
To retrieve specific values
To retrieve global values: sequence_id = -1, tool_id = -1
To retrieve camera values: sequence_id = -1, tool_id = cameraIndex
To retrieve sequence values: sequence_id = sequenceIndex, tool_id = -1
To retrieve Belt-Calibration-related values ( read only )
Page 41
Scale sequence_id = -1, tool_id = cameraIndex, index_id = robotIndex, object_id =

(10004) n/a
To retrieve sequence-related values
Mode
sequence_id = sequenceIndex, tool_id = -1, index_id = n/a, object_id = n/a
(10200)
Example
; Get the scale value for the Belt Calibration

scalevalue = VPARAMETER ($ip, -1, cameraIndex, 10004, robotIndex)
Page 42
Syntax
MicroV+
value = VRESULT (sequence_id, tool_id, instance_id, result_id, index_id, frame_id)
V+
value = VRESULT ($ip, sequence_id, tool_id, instance_id, result_id, index_id,
frame_id)
Description
Returns a specified result of a vision tool, or returns the status of a specified tool.
Parameters
result_id Identifier (ID) of the result. Refer to the ACE Sight Properties Quick Reference
tables to find the ID for the required result.
specified instance.
Details
The following parameters are optional: sequence_id, tool_id, instance, index_id, and frame_id. These
parameters are 1-based. If no value is provided for these parameters, they default to 1.
When a VRESULT is issued for a specific tool, it checks to see if that tool supports the VRESULT code. If
the specified tool does not support the code, VRESULT moves to the parent tool to see if it supports the
Page 43
code. It continues up the chain until it finds a tool that supports the code. If no valid tool is found, an
invalid vision result error is generated.
For example, suppose an Arc Finder tool is placed relative to a Blob Analyzer tool. In the application, the
Blob Analyzer tool locates many blobs and adds an Arc Finder tool at each instance. If you ask for the
blob area associated with an arc finder instance, VRESULT will recognize that the Arc Finder tool does
not support that code, so it moves to the parent tool (the Blob Analyzer tool) and finds the blob
instance associated with the specified arc result. It validates that the blob result supports the VRESULT
code, and so it returns the data.
Some vision tools are considered Frame Sources.The Blob Analyzer and Locator tool are the most
commonly used Frame Sources. When these tools execute, it will mark each results as a separate
frame or grouping. Any vision tools relative to a Frame Source will associacte each of it's results with
the frame it is relative to. In this case, you may want to use the frame_id parameter to extract the
results.
For example, going back to the Arc Finder tool relative to the Blob Analyzer tool. If the Blob Analyzer
locates 5 different results, then the Arc Finder tool will execute 5 different Arc Finder operations, one
relative to each result returned by the Blob Analyzer. The Arc Finder will associate each result with a
frame number that correlates with the index of the result returned by the Blob Analyzer. So, if you
want to get an Arc Fider result associated with the 4th result of the Blob Analyzer, you would reference
index_id =1 in frame_id = 4. You are requesting the first instance in result frame 4. In this situation,
you can still access all the Arc Finder results using frame_id = -1. But note, some child vision tools may
have multiple results within each frame and sometimes might have no results within a frame.
Example
The following illustrates how to retrieve a specific tool result.

; Get the number of instances found by a Locator.
; instance count = 1310
instance_count = VRESULT($ip, 1, 2, 1, 1310)
Page 44

Syntax
Micro V+
VRUN sequence_id
V+
VRUN $ip, sequence_id
Description
Initiates the execution of a vision sequence.
Parameters
Details
The sequence_id parameter is optional. This parameter is 1-based. If no value is provided for this
parameter, it defaults to 1.
Example
; Execute the first sequence

VRUN $ip, 1
Page 45

Syntax
MicroV+
value = VSTATE (sequence_id)
V+
value = VSTATE ($ip, sequence_id)
Description
Returns the state of the execution of a sequence.
Parameters
Details
The sequence_id parameter is optional. This parameter is 1-based. If no value is provided, it defaults to
1.
In V+ the vision server is the PC on which the ACE Sight vision software is running.
Return
Return values are different for V+ and MicroV+:
MicroV+
Value Description
0 Running
1 This value is currently unused.
Page 46
MicroV+
Value Description
2 Completed
3 Error
V+
Value Description
0 Idle
1 Running
2 Paused
3 Done
4 Error
5 Starting
Example
; Get the state of the first sequence
value = VSTATE($ip, 1)
Page 47
Syntax
MicroV+
PARAMETER VTIMEOUT = value
V+
PARAMETER VTIMEOUT = value
Description
Sets a timeout value so that an error message is returned if no response is received following a vision
command. The timeout value is expressed in seconds (for example, the value 0.15 = 150 ms).
For the MicroV+ system, the default value is 0, which causes an infinite timeout. For the V+ system, the
default value is 5 (seconds).
Details
For the MicroV+ system:
• It is important to set a value other than the default value of 0.
• VTIMEOUT = 0 sets the timeout to "infinite". In this case, the MicroV+ system will wait
indefinitely for a response from the vision system.
For the V+ system, VTIMEOUT = 0 sets the timeout value to 16 ms (which is the minimum timeout that
will be used).
Example
; Get error message if there is no response after 200 ms.
PARAMETER VTIMEOUT = 0.20
Page 48

Syntax
MicroV+
VWAITI (sequence_id) type
V+
VWAITI (sequence_id) $ip, type
Description
Waits until the specified vision sequence reaches the state specified by the type parameter. Use a VWAITI
call after VRUN. In a V+ conveyor-tracking application, the absence of a specific VWAITI instruction can
interfere with the Virtual Camera tool and the Communication tool, and cause a delay in the execution of
the application.
Parameters
type 0 Wait for full completion (default).

1 Wait until picture acquisition has completed.
Details
The following parameters are optional: sequence_id and type. The sequence_id parameter is 1-based.
If no value is provided for the sequence_id parameter, it defaults to 1. If no value is provided for the
type parameter, it defaults to 0.
In V+, the vision server is the PC on which the ACE Sight vision software is running.
Example
; Execute the first sequence

VRUN $ip, 1
Page 49
; Wait for full completion of first sequence

VWAITI (1) $ip, 0
Page 50
ACE Sight Properties Reference for V+ and MicroV+

This chapter provides details on all ACE Sight properties and their use in V+ and MicroV+.
• All properties are described in alphabetical order in the following pages.
• To find a property by name, by tool, or by ID, click a link below.
Global Tables
All properties sorted by name or ID number:
Search for Properties by Name
Search for Properties by ID
Framework Properties
Properties required for configuring standalone vision applications:
ACE Sight Framework Properties
Tool Properties
Properties that apply to the selected vision tool:
Arc Caliper Properties
Arc Edge Locator Properties
Arc Finder Properties
Blob Analyzer Properties
Calculated Arc Properties
Calculated Frame Properties
Calculated Line Properties
Calculated Point Properties
Calibration Grid Locator Properties
Caliper Properties
Color Matching Tool Properties
Communication Tool Properties
Custom Vision Tool Properties
Edge Locator Properties
Gripper Clearance Tool Properties
Image Histogram Tool Properties
Page 51
Image Processing Tool Properties

Image Sampling Tool Properties
Image Sharpness Tool Properties
Inspection Tool Properties
Line Finder Properties
Locator Model Tool Properties (NOTE: This tool cannot be accessed by ACE Sight)
Locator Tool Properties
Overlap Tool Properties
Pattern Locator Properties
Point Finder Properties
Remote Vision Tool Properties
Virtual Camera Tool Properties
Page 52
Abort
Abort
VPARAMETER
5501
Stops the execution of the specified Virtual Camera tool. This property is write-only.
Syntax
Micro V+
VPARAMETER (sequence_id, tool_id, 5501, index_id, object_id) = value
V+
VPARAMETER (sequence_id, tool_id, 5501, index_id, object_id) $ip = value
Type
Boolean
Parameters
ID 5501: the value used to reference this property.
index_id N/A
object_id N/A
Page 53
ActiveCalibration
ActiveCalibration
VPARAMETER
5504
Reads and writes the index of the active calibration relative to a camera.
Syntax
MicroV+
value = VPARAMETER (sequence_id, tool_id, 5504, index_id, object_id)
V+
value = VPARAMETER ($ip, sequence_id, tool_id, 5504, index_id, object_id)
Type
Real variable.
Range
Minimum: 0
Maximum: The number of calibrations associated with the tool.
Parameters
index_id N/A
object_id N/A
Page 54
ActiveSettings
ActiveSettings
VPARAMETER
5505
Reads and writes the index of the active settings relative to a camera.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Maximum: The number of calibrations associated with the tool.
Parameters
index_id Robot number to select.
object_id Index of the tool tip to access.
Page 55
ActiveCalibration
AnyFeederVRunCommand
VPARAMETER
6000
Identifies the command that is run when a VRUN is issued to the AnyFeeder.
Syntax
MicroV+
V+
Type
Real variable.
Range
A valid AnyFeeder command or sequence index. The valid AnyFeeder commands are:
Feed Forward 1
Feed Backward 2
Feed Flip Forward 3
Feed Flip Backward 4
Flip 5
Dispense 6
Purge 7
Heavy Dispense 8
Stop 15
Init 16
Error Reset 30
Page 56
ActiveCalibration
Firmware Restart 31
Backlight On 100
Backlight Off 101
Parameters
sequence_id Index associated with the feeder as defined in the feeder editor.
tool_id N/A
index_id N/A
object_id N/A
Page 57
ActiveCalibration
AnyFeederDispenseIterations
VPARAMETER
6012
The number of iterations used in the dispense operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 1
Maximum: 63
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 58
ActiveCalibration
AnyFeederFeedBackwardIterations
VPARAMETER
6015
The number of iteration for the feedd backwards operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 1
Maximum: 63
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 59
ActiveCalibration
AnyFeederFeedBackwardSpeed
VPARAMETER
6005
The speed used for the feed backwards operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Maximum: 10
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 60
ActiveCalibration
AnyFeederFeedFlipBackwardIterations
VPARAMETER
6015
The number of itterations used for the feed flip backwards operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 1
Maximum: 63
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 61
ActiveCalibration
AnyFeederFeedFlipBackwardSpeed
VPARAMETER
6008
The speed used for the feed flip backwards operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Maximum: 10
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 62
ActiveCalibration
AnyFeederFeedFlipForwardIterations
VPARAMETER
6017
The number of iterations used for the feed flip forward operation.
Syntax
MicroV+
V+
Type
Real variable.
RangeRange
Minimum: 1
Maximum: 63
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 63
ActiveCalibration
AnyFeederFeedFlipForwardSpeed
VPARAMETER
6007
The speed used for the feed flip forward operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Maximum: 10
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 64
ActiveCalibration
AnyFeederFeedForwardIterations
VPARAMETER
6011
The number of iterations used for the feed forward operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 1
Maximum: 63
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 65
ActiveCalibration
AnyFeederFeedForwardSpeed
VPARAMETER
6001
The speed used for the feed forward operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Maximum: 10
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 66
ActiveCalibration
AnyFeederFlipIterations
VPARAMETER
6013
The number of iterations used for the flip operation.
Syntax
MicroV+
V+
value = VPARAMETER ($ip, sequence_id, 6013, 6000, index_id, object_id)
Type
Real variable.
Range
Minimum: 1
Maximum: 63
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 67
ActiveCalibration
AnyFeederFlipSpeed
VPARAMETER
6003
The speed used for the flip operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Maximum: 10
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 68
ActiveCalibration
AnyFeederHeavyDispenseIterations
VPARAMETER
6016
The number of iterations used for the heavy dispense operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 1
Maximum: 63
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 69
ActiveCalibration
AnyFeederHeavyDispenseSpeed
VPARAMETER
6006
The speed used for the heavy dispense operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Maximum: 10
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 70
ActiveCalibration
AnyFeederHeavyDispenseSpeed
VPARAMETER
6006
The speed used for the heavy dispense operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Maximum: 10
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 71
ActiveCalibration
AnyFeederPurgeSpeed
VPARAMETER
6004
The speed used for the purge operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Maximum: 10
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 72
ArcMustBeTotallyEnclosed
VPARAMETER
5141
When set to True, the start and end points of the arc must be located on the radial bounding sides of the
Search Area. When set to False, the found arc can enter and/or exit the Search Area at the inner or outer
annular bounds of the Search Area.
Syntax
Micro V+
V+
Type
Boolean
Range
Value Description
Start and end points of the arc must be located on the sides of the
1
bounding area.
Start and end points of the arc can be anywhere inside or outside of the
0
bounding area.
Parameters
Page 73
index_id N/A
object_id N/A
Page 74
ArithmeticClippingMode
VPARAMETER
5360
Clipping mode applied by an arithmetic operation.
Syntax
Micro V+
V+
Remarks
hsClippingNormal mode forces the destination pixel value to a value from 0 to 255 for unsigned 8-bit
images, to a value from -327678 to 32767 for signed 16 bits images and so on. Values that are less
than the specified minimum value are set to the minimum value. Values greater than the specified
maximum value are set to the maximum value.
hsClippingAbsolute mode takes the absolute value of the result and clips it using the same algorithm as
for the hsClippingNormal mode.
Type
Long
Range
Value Image Processing Clipping Mode Description
0 hsClippingNormal Normal clipping method is used.
1 hsClippingAbsolute Absolute clipping method is used.
Parameters
Page 75
index_id N/A
object_id N/A
Page 76
ArithmeticConstant
ArithmeticConstant
VPARAMETER
5361
Constant applied by an arithmetic operation when no valid operand image is specified.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 1
Maximum: 256
Parameters
index_id N/A
object_id N/A
Page 77
ArithmeticScale
ArithmeticScale
VPARAMETER
5362
Scaling factor applied by an arithmetic operation.
Syntax
Micro V+
V+
Type
Double
Range
Unlimited
Parameters
index_id N/A
object_id N/A
Page 78
AssignmentConstant
AssignmentConstant
VPARAMETER
5365
Constant applied by an assignment operation.
Syntax
Micro V+
V+
Type
Long
Range
Unlimited
Parameters
index_id N/A
object_id N/A
Page 79
AssignmentHeight
AssignmentHeight
VPARAMETER
5366
Constant value that defines the height of the output image. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 1
Maximum: 2048
Parameters
index_id N/A
object_id N/A
Page 80
AssignmentWidth
AssignmentWidth
VPARAMETER
5367
Constant value that defines the width of the output image. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 1
Maximum: 2048
Parameters
index_id N/A
object_id N/A
Page 81
AutoCoarsenessSelectionEnabled
VPARAMETER
5421
When is set to True, the value of SearchCoarseness is automatically determined by the Pattern Locator
process when the pattern is learned.
Syntax
Micro V+
V+
Type
Long
Range
Value Description
1 The Coarseness levels are automatically determined and set by the tool.
0 The Coarseness levels are set by the user.
Parameters
Page 82
index_id N/A
object_id N/A
Page 83
AutomaticCandidateCountEnabled
VPARAMETER
5301
When set to True, the number of candidate measurement points is automatically determined according to
the dimension of the tool region of interest. When set to False, the number of candidate measurement
points is set manually through the CandidatePointsCount property.
Syntax
Micro V+
V+
Type
Long
Range
Value Description
1 The number of candidate measurement points is set automatically.
0 The number of candidate measurement points is set manually.
Parameters
Page 84
index_id N/A
object_id N/A
Page 85
AverageContrast
AverageContrast
VRESULT
1801
Average contrast, expressed in greylevel values, between light and dark pixels on either side of the found
entity (point, line, or arc). This property is read-only.
Syntax
Micro V+
value = VRESULT (sequence_id, tool_id, instance_id, 1801, index_id, frame_id)
V+
value = VRESULT ($ip, sequence_id, tool_id, instance_id, 1801, index_id, frame_id)
Type
Double
Range
Minimum: Greater than 0.
Maximum: 255
Parameters
instance_id Index of the instance for which you want the result.
index_id N/A
frame_id Frame that contains the entity for which you want the result.
Page 86
BeltCalibrationDownstreamLimit
BeltCalibrationDownstreamLimit
VLOCATION
10002
The downstream limit of the belt, which is defined during the Belt Calibration. Expressed as a transform.
This property is read-only.
Syntax
V+
value = VLOCATION ($ip, sequence_id, tool_id, instance_id, 10002, index_id, frame_id)
MicroV+
Not applicable. Conveyor-tracking is supported only in V+ running on the Adept
SmartController.
Type
Location
Parameters
tool_id N/A
instance_id Index of the instance for which you want the transform. 1-based.
frame_id Index of the frame that contains the specified instance.
Page 87
BeltCalibrationFrame
VLOCATION
10000
The belt frame of reference, which is defined during the Belt Calibration. Expressed as a transform. This
property is read-only.
Syntax
V+
MicroV+
SmartController.
Type
Location
Parameters
BeltCalibrationNearsideLimit
VLOCATION
10003
The nearside limit of the belt, which is defined during the Belt Calibration. Expressed as a transform. This
Page 88
Syntax
V+
MicroV+
SmartController.
Type
Location
Parameters
tool_id N/A
Page 89
BeltCalibrationScale
BeltCalibrationScale
VPARAMETER
10004
The scale factor between encoder counts and millimeters, which is defined during the Belt Calibration. This
is the number of millimeters that the belt advances for each encoder count. This property is read-only.
Syntax
V+
MicroV+

SmartController.
Type
Double
Parameters
sequence_id Must be set to -1.
tool_id The camera number referenced in the keyword mapping of the camera calibration
object.
index_id N/A
object_id The robot number associated with the calibration.
$ip IP address of the vision server. Applies to V+ syntax only. Uses standard IP address
format, for example: 192.168.1.120.
Page 90
BeltCalibrationUpstreamLimit
VLOCATION
10001
The upstream limit of the belt, which is defined during the Belt Calibration. Expressed as a transform. This
Syntax
MicroV+
SmartController.
V+
Type
Location
Parameters
tool_id N/A
index Reserved for internal use. Value is always 1.
BeltLatchCalibrationOffset
VLOCATION
10010
The robot-to-latch calibration offset, which is defined during the Latch Calibration. Expressed as a
transform. This property is read-only.
Page 91
Syntax
V+
MicroV+
SmartController.
Type
Location
Parameters
Page 92
BilinearInterpolationEnabled
VPARAMETER
120
Specifies if bilinear interpolation is used to sample the input image. By default, bilinear interpolation is
enabled because it ensures subpixel accuracy.
Syntax
Micro V+
V+
Remarks
Bilinear interpolation is crucial for obtaining accurate results with inspection tools. When a tool is
positioned in frame-based mode, the tool region of interest is rarely aligned with the pixel grid, which
results in jagged edges on edges of objects. The bilinear interpolation function smooths out the
jaggedness within the sampled image by attributing to each pixel a value interpolated from values of
neighboring pixels, which provides a more true-to-life representation of contours, as illustrated in the
following figure.
Uninterpolated sampling may provide a small increase in speed but will provide less accurate results.
Figure: Effect of Bilinear Interpolation
Type
Boolean
Page 93
Range
Value Description
1 Bilinear interpolation is enabled. Recommended default setting.
0 Bilinear interpolation is disabled.
Parameters
index_id N/A
object_id N/A
Page 94
BlobArea
BlobArea
VRESULT
1611
Area of the selected blob. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: MinimumBlobArea
Maximum: MaximumBlobArea
Parameters
instance_id Index of the blob for which you want the result.
index_id N/A
frame_id Frame containing the blob for which you want the result.
Page 95
BlobBoundingBoxBottom
BlobBoundingBoxBottom
VRESULT
1648
The bottommost coordinate of the bounding box aligned with respect to the X-axis of the Tool coordinate
system. This value is returned with respect to the selected coordinate system. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Boundaries of the input image.
Parameters
index_id N/A
Page 96
BlobBoundingBoxCenterX
BlobBoundingBoxCenterX
VRESULT
1624
X-coordinate of the center of the bounding box aligned with the Tool coordinate system. This value is
returned with respect to the selected coordinate system. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 97
BlobBoundingBoxCenterY
BlobBoundingBoxCenterY
VRESULT
1625
Y-coordinate of the center of the bounding box aligned with the Tool coordinate system. This value is
returned with respect to the selected coordinate system. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 98
BlobBoundingBoxHeight
BlobBoundingBoxHeight
VRESULT
1626
Height of the bounding box with respect to the Y-axis of the Tool coordinate system. This property is read-
only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 99
BlobBoundingBoxLeft
BlobBoundingBoxLeft
VRESULT
1645
The leftmost coordinate of the bounding box aligned with respect to the X-axis of the Tool coordinate
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 100
BlobBoundingBoxRight
BlobBoundingBoxRight
VRESULT
1646
The rightmost coordinate of the bounding box aligned with respect to the X-axis of the Tool coordinate
system. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 101
BlobBoundingBoxRotation
BlobBoundingBoxRotation
VRESULT
1649
Rotation of the bounding box with respect to the X-axis of the selected coordinate system. This property is
read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0
Maximum: 360
Parameters
index_id N/A
Page 102
BlobBoundingBoxTop
BlobBoundingBoxTop
VRESULT
1647
The topmost coordinate of the bounding box aligned with respect to the X-axis of the Tool coordinate
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 103
BlobBoundingBoxWidth
BlobBoundingBoxWidth
VRESULT
1627
Width of the bounding box with respect to the X-axis of the Tool coordinate system. This property is read-
only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 104
BlobChainCode
BlobChainCode
VRESULT
1656
Direction, in Tool coordinates, of a given boundary element in the chain code. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Value Name Description

0 hsDirectionRight Right direction
1 hsDirectionTop Top direction
2 hsDirectionLeft Left direction
3 hsDirectionBottom Bottom direction
Parameters
Page 105
BlobChainCode
index_id Index of the selected boundary element.
Page 106
BlobChainCodeDeltaX
BlobChainCodeDeltaX
VRESULT
1659
Horizontal length, in Tool coordinates, of a boundary element in the chain code. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 107
BlobChainCodeDeltaY
BlobChainCodeDeltaY
VRESULT
1660
Vertical length, in Tool coordinates, of a boundary element in the chain code. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 108
BlobChainCodeLength
BlobChainCodeLength
VRESULT
1655
Number of boundary elements in the chain code of the blob. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: Greater than 4
Maximum: unlimited
Parameters
index_id N/A
Page 109
BlobChainCodeStartX
BlobChainCodeStartX
VRESULT
1657
X-position, in Tool coordinates, of the first pixel in the chain code. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 110
BlobChainCodeStartY
BlobChainCodeStartY
VRESULT
1658
Y-position, in Tool coordinates, of the first pixel in the chain code. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 111
BlobConvexPerimeter
BlobConvexPerimeter
VRESULT
1614
Convex perimeter of the selected blob. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: Greater than 0.0
Maximum: unlimited
Parameters
index_id N/A
Page 112
BlobCount
BlobCount
VRESULT
1610
Number of blobs detected by the tool. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum:
Maximum: 65534
Parameters
index_id N/A
Page 113
BlobElongation
BlobElongation
VRESULT
1616
Ratio of the moment of inertia about the blob’s minor axis (BlobInertiaMaximum) to the moment of inertia
about the blob’s major axis (BlobInertiaMinimum). This property is read-only.
Syntax
Micro V+
V+
Remarks
No units.
Type
Double
Range
Parameters
index_id N/A
Page 114
BlobExtentBottom
BlobExtentBottom
VRESULT
1653
Distance along the Y-axis between the blob’s center of mass and the bottom side of the bounding box. This
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 115
BlobExtentLeft
BlobExtentLeft
VRESULT
1650
Distance along the Y-axis between the blob’s center of mass and the bottom side of the bounding box. This
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 116
BlobExtentRight
BlobExtentRight
VRESULT
1651
Distance along the X-axis between the blob’s center of mass and the right side of the bounding box. This
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 117
BlobExtentTop
BlobExtentTop
VRESULT
1652
Distance along the Y-axis between the blob’s center of mass and the top side of the bounding box. This
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 118
BlobGreyLevelMaximum
BlobGreyLevelMaximum
VRESULT
1622
Highest greylevel value of the selected blob. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
$ip IP address of the vision server. Applies to V+ syntax only. Uses standard
IP address format, for example: 192.168.1.120.
index_id N/A
Page 119
BlobGreyLevelMean
BlobGreyLevelMean
VRESULT
1618
Mean greylevel value in the selected blob. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
Page 120
BlobGreyLevelMinimum
BlobGreyLevelMinimum
VRESULT
1621
Lowest greylevel value in the selected blob. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
Page 121
BlobGreyLevelRange
BlobGreyLevelRange
VRESULT
1619
Range of the greylevel values in the selected blob. The range is calculated as [BlobGreyLevelMaximum -
BlobGreyLevelMinimum + 1]. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
Page 122
BlobGreyLevelStdDev
BlobGreyLevelStdDev
VRESULT
1620
Standard deviation of the greylevel values in the selected blob. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
Page 123
BlobHoleCount
BlobHoleCount
VRESULT
1654
The number of holes found in the selected blob. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: Unlimited
Parameters
index_id N/A
Page 124
BlobInertiaMaximum
BlobInertiaMaximum
VRESULT
1633
Moment of inertia about the minor axis, which corresponds to the highest moment of inertia. This property
is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: Greater than .0
Maximum: Unlimited
Parameters
index_id N/A
Page 125
BlobInertiaMinimum
BlobInertiaMinimum
VRESULT
1632
Moment of inertia about the major axis, which corresponds to the lowest moment of inertia. This property
is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Maximum: Unlimited
Parameters
index_id N/A
Page 126
BlobInertiaXAxis
BlobInertiaXAxis
VRESULT
1634
Moment of inertia about the X-axis of the Tool coordinate system. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Maximum: Unlimited
Parameters
index_id N/A
Page 127
BlobInertiaYAxis
BlobInertiaYAxis
VRESULT
1635
Moment of inertia about the Y-axis of the Tool coordinate system. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Maximum: Unlimited
Parameters
index_id N/A
Page 128
BlobIntrinsicBoundingBoxBottom
BlobIntrinsicBoundingBoxBottom
VRESULT
1639
The bottommost coordinate of the bounding box with respect to the X-axis (major axis) of the principal
axes. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 129
BlobIntrinsicBoundingBoxCenterX
BlobIntrinsicBoundingBoxCenterX
VRESULT
1628
X-coordinate of the center of the bounding box with respect to the X-axis (major axis) of the principal axes.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 130
BlobIntrinsicBoundingBoxCenterY
BlobIntrinsicBoundingBoxCenterY
VRESULT
1629
Y-coordinate of the center of the bounding box with respect to the Y-axis (minor axis) of the principal axes.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 131
BlobIntrinsicBoundingBoxHeight
BlobIntrinsicBoundingBoxHeight
VRESULT
1630
Height of the bounding box with respect to the Y-axis (minor axis) of the principal axes. This property is
read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 132
BlobIntrinsicBoundingBoxLeft
BlobIntrinsicBoundingBoxLeft
VRESULT
1636
The leftmost coordinate of the bounding box aligned with respect to the X-axis (major axis) of the principal
axes. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 133
BlobIntrinsicBoundingBoxRight
BlobIntrinsicBoundingBoxRight
VRESULT
1637
The rightmost coordinate of the bounding box aligned with the X-axis (major axis) of the principal axes.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 134
BlobIntrinsicBoundingBoxRotation
BlobIntrinsicBoundingBoxRotation
VRESULT
1640
Rotation of the intrinsic bounding box with respect to the X-axis of the selected coordinate system. This
Syntax
Micro V+
V+
Type
Double
Range
Minimum: -180
Maximum: 180
Parameters
index_id N/A
Page 135
BlobIntrinsicBoundingBoxTop
BlobIntrinsicBoundingBoxTop
VRESULT
1638
The topmost coordinate of the bounding box aligned with the Y-axis (minor axis) of the principal axes. This
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 136
BlobIntrinsicBoundingBoxWidth
BlobIntrinsicBoundingBoxWidth
VRESULT
1631
Width of the bounding box with respect to the X-axis of the Tool coordinate system. This property is read-
only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
$ip IP address of the vision server
index_id N/A
Page 137
BlobIntrinsicExtentBottom
BlobIntrinsicExtentBottom
VRESULT
1644
Distance along the minor axis between the blob's center of mass and the bottom side of the intrinsic
bounding box. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 138
BlobIntrinsicExtentLeft
BlobIntrinsicExtentLeft
VRESULT
1641
Distance along the major axis between the blob's center of mass and the left side of the intrinsic bounding
box. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 139
BlobIntrinsicExtentRight
BlobIntrinsicExtentRight
VRESULT
1642
Distance along the major axis between the blob's center of mass and the right side of the intrinsic
bounding box. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 140
BlobIntrinsicExtentTop
BlobIntrinsicExtentTop
VRESULT
1643
Distance along the major axis between the blob's center of mass and the top side of the intrinsic bounding
box. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 141
BlobPositionX
BlobPositionX
VRESULT
1612
X-coordinate of the center of mass of a given blob in the currently-selected coordinate system. This
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 142
BlobPositionY
BlobPositionY
VRESULT
1613
Y-coordinate of the center of mass of a given blob in the currently-selected coordinate system. This
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 143
BlobPrincipalAxesRotation
BlobPrincipalAxesRotation
VRESULT
1617
Angle of axis of the smallest moment of inertia with respect to the X-axis of the selected coordinate
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
Page 144
BlobRawPerimeter
BlobRawPerimeter
VRESULT
1615
Raw perimeter of the selected blob. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Maximum: Unlimited
Parameters
index_id N/A
Page 145
BlobRoundness
BlobRoundness
VRESULT
1623
Degree of similarity between the blob and a circle. The roundness is 1 for a perfectly-circular blob. This
Syntax
Micro V+
V+
Remarks
No units.
Type
Double
Range
Minimum: Greater than 0.0
Maximum: 1.0
Parameters
Page 146
BlobRoundness
index_id N/A
Page 147
CalibratedUnitsEnabled
CalibratedUnitsEnabled
VPARAMETER
103
Returns 1 if the image the virtual camera image the tool is operating on has an active calibration applied. If
no calibration is in effect, a 0 is returned. This property is read-only.
Syntax
MicroV+
V+
Type
Boolean
Range
Value Description
1 Dimensions are expressed in millimeters. (Default)
0 Dimensions are expressed in pixel units.
Parameters
index_id N/A
object_id N/A
Page 148
CandidatePointsCount
VPARAMETER
5300
Sets the number of candidate locations where the tool tries to evaluate the sharpness. When the tool is
executed, it scans the region of interest and identifies a number of candidate locations (equal to
CandidatePointsCount) where the local standard deviation is the highest. The local sharpness is then
evaluated at each candidate location that has a local standard deviation above the
StandardDeviationThreshold property.
The number of locations where the sharpness is actually measured is returned by the
MeasurementPointsCount property. When the AutomaticCandidateCountEnabled property is True, the
number of candidate measurement points is automatically determined according to the size of the region
of interest and CandidatePointsCount.
Syntax
Micro V+
V+
Type
Long
Range
Maximum: 32767
Parameters
Page 149
index_id N/A
object_id N/A
Page 150
ChainCodeResultsEnabled
VPARAMETER
1607
Enables the computation of the blob chain code properties: BlobChainCode, BlobChainCodeDeltaX,
BlobChainCodeDeltaY, BlobChainCodeLength, BlobChainCodeStartX and BlobChainCodeStartY
Figure: Illustration of Chain Code Results
Syntax
Micro V+
V+
Type
Boolean
Range
Index Description
1 Chain Code Results are output by the tool.
0 Chain Code Results are not output.
Page 151
Parameters
index_id N/A
object_id N/A
Page 152
ColorFilterCount
ColorFilterCount
VPARAMETER
5700
Returns the number of filters that are defined for the Color Matching tool. This property is read-only.
Syntax
Micro V+
V+
Remarks
ColorFilterCount reports the number of filters that are defined in the tool and that appear in the Filters
list in the interface. This value is not affected by the number of filter results in an image.
Type
Long
Range
Minimum: 0
Maximum: Unlimited
Parameters
index_id N/A
object_id N/A
Page 153
ColorFilterMatchPixelCount
ColorFilterMatchPixelCount
VRESULT
2502
Counts the number of pixels that match the conditions set by the filter. This result is output for each filter,
starting at Filter 0. This property is read-only.
Syntax
Micro V+
value = VRESULT (sequence_id, tool_id, instance_id, 2502, filter_id, frame_id)
V+
value = VRESULT ($ip, sequence_id, tool_id, instance_id, 2502, filter_id, frame_id)
Type
Long
Range
Minimum: 0
Maximum: ImagePixelCount
Parameters
filter_id Index of the filter for which you want the result. First Filter is 0.
frame_id Frame for which you want the results.
Page 154
ColorFilterMatchQuality
ColorFilterMatchQuality
VRESULT
2501
Calculates the percentage of pixels matched to the specified filter. This value is equal to the number of
matched pixels (Filter (n) Match Pixel Count), divided by the total number of pixels in the region of
interest (Image Pixel Count). This property is read-only.
Syntax
Micro V+
value = VRESULT (sequence_id, tool_id, instance_id, 2501, filter_id, frame_id)
V+
value = VRESULT ($ip, sequence_id, tool_id, instance_id, 2501, filter_id, frame_id)
Type
Long
Range
Maximum: 1.0
Parameters
filter_id Index of the filter for which you want the result. First Filter is 0.
frame_id Frame for which you want the results.
Page 155
CommunicationToolResults
CommunicationToolResults
VRESULT
2600
Returns the total number of results that have been queued by all communication tools within a given
sequence. This property is read-only.
Syntax
Micro V+
V+
Type
Integer
Parameters
tool_id Should always be set to -1.
instance_id Not used
index_id Not used
frame_id Not used
Page 156
ConformityTolerance
ConformityTolerance
VPARAMETER
556
Maximum local deviation between the expected model contours of an instance and the contours actually
detected in the input image. It corresponds to the maximum distance by which a matched contour can
deviate from either side of its expected position in the model. This property can only be set when
UseDefaultConformityTolerance is set to False. Otherwise, it is read-only.
Syntax
MicroV+
V+
Type
Double
Remarks
This property can be set to any positive value if ConformityToleranceRangeEnabled is set to False.
Type
Double
Range
Minimum: MinimumConformityTolerance
Maximum: MaximumConformityTolerance
Parameters
Page 157
ConformityTolerance
index_id N/A
object_id N/A
Page 158
ConformityToleranceRangeEnabled
VPARAMETER
553
When ConformityToleranceRangeEnabled is set to True, the allowable range of values for
ConformityTolerance is set by the read-only MinimumConformityTolerance and
MaximumConformityTolerance properties. When set to False, ConformityTolerance can be set to any
positive value.
Syntax
MicroV+
V+
Remarks
Disabling the conformity tolerance range can be useful for finding deformable objects, which requires a
high conformity tolerance value for a better match.
Type
Boolean
Range
Value Description
0 ConformityToleranceRange is enabled.
1 ConformityToleranceRange is disabled.
Parameters
Page 159
index_id N/A
object_id N/A
Page 160
Connectivity
Connectivity
VPARAMETER
5120
Defines a minimum number of connected edges required to generate a point hypothesis from a a specific
found edge, which satisfies the search constraints.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 1
Maximum: 20
Parameters
index_id N/A
object_id N/A
Page 161
Constraints
Constraints
VPARAMETER
5220
Defines the edge detection constraints of an Arc Locator tool or an Edge Locator tool. Constraints can be
set for position and/or magnitude and are used to score edges.
Syntax
Micro V+
V+
Type
Long
Range
Value Constraints NAme Description
0 hsNone No constraint.
1 hsPosition Position constraint.
2 hsMagnitude Magnitude constraint.
3 hsAllConstraints Magnitude and position
Parameters
Page 162
Constraints
index_id N/A
object_id N/A
Page 163
ContrastPolarity
ContrastPolarity
VPARAMETER
522
Selects the type of polarity accepted for object recognition. Contrast polarity identifies the direction of
change in greylevel values between an object and its surrounding area. Polarity is always defined with
respect to the initial polarity in the image on which the model was created.
Figure: Contrast Polarity
Syntax
MicroV+
V+
Type
Long
Range
Value hsContrastPolarity Description

0 hsContrastPolarityNormal The Locator accepts only instances having the same
Page 164
ContrastPolarity
Value hsContrastPolarity Description

polarity as that of the model and does not recognize
local changes in polarity.
1 hsContrastPolarityReverse The Locator accepts only instances having the inverse
polarity as that of the model and does not recognize
local changes in polarity.
2 hsContrastPolarityNormalAndReverse The Locator accepts only instances having a polarity
that is either the same or the inverse of the model's
polarity but does not recognize local changes in
polarity.
3 hsContrastPolarityDontCare Accepts any polarity for the object, INCLUDING local
changes in polarity.
Parameters
index_id N/A
object_id N/A
Page 165
ContrastThreshold
ContrastThreshold
VPARAMETER
303
Defines the minimum contrast needed for an edge to be detected in the input image and used for arc
computation. This threshold is expressed in terms of a step in greylevel values. Except when
ContrastThresholdMode is set to hsContrastThresholdFixedValue, the property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 1
Maximum: 255
Remark(s)
By default, the tool selects a ContrastThresholdMode based on image content to provide flexibility to
variations in image lighting conditions and contrast. Adaptive threshold modes are generally
recommended. A fixed-value contrast threshold should only be used when adaptive values do not
provide satisfactory results.
Parameters
Page 166
ContrastThreshold
index_id N/A
object_id N/A
Related Properties
ContrastThresholdMode
Page 167
VPARAMETER
302
Selects the method used to compute the threshold used for detecting edges in the input image.
Syntax
Micro V+
V+
Type
Long
Remarks
By default, the tool selects a ContrastThresholdMode based on image content to provide flexibility to
variations in image lighting conditions and contrast. Adaptive threshold modes are generally
recommended. A fixed-value contrast threshold should only be used when adaptive values do not
provide satisfactory results.
Range
The valid range for this property is as follows:
Value Contrast Threshold Mode Name Description
Uses a low sensitivity adaptive threshold

for detecting edges. Adaptive Low
0 hsContrastThresholdAdaptiveLowSensitivity Sensitivity reduces the amount of noisy
edges but may also cause significant
edges to be undetected.
Uses a normal sensitivity adaptive

1 hsContrastThresholdAdaptiveNormalSensitivity
threshold for detecting edges.
Page 168
Value Contrast Threshold Mode Name Description
Uses a high sensitivity adaptive threshold

for detecting edges. Adaptive High
2 hsContrastThresholdAdaptiveHighSensitivity Sensitivity can help detect weak-contrast
edges but also increases the amount of
noisy edges.
Uses a fixed value threshold for detecting

3 hsContrastThresholdFixedValue
edges.
Parameters
index_id N/A
object_id N/A
Page 169
DefaultConformityTolerance
VPARAMETER
552
Default value for ConformityTolerance computed by the Locator by analyzing the calibration, the contour
detection parameters, and the search parameters. This property is read-only.
Syntax
MicroV+
V+
Remarks
This default value is used for ConformityTolerance when UseDefaultConformityTolerance is set to True.
Type
Double
Range
Greater than 0.
Parameters
index_id N/A
object_id N/A
Related Properties
Page 170
MaximumConformityTolerance
MinimumConformityToleranceInstanceLocationGripperOffsetMinimum
Page 171
DetailLevel
DetailLevel
VPARAMETER
301
The coarseness of the contours at the Detail level. This property can only be set when ParametersBasedOn
is set to hsParametersCustom. Otherwise, it is read-only.
Syntax
MicroV+
V+
Remarks
For most applications, the ParametersBasedOn property should be set to hsParametersAllModels.

Custom contour detection should only be used when the default values do not work correctly.
Type
Long
Range
Minimum: 1
Maximum: 16
Parameters
Page 172
DetailLevel
index_id N/A
object_id N/A
Page 173
Edge1Constraints
Edge1Constraints
VPARAMETER
5221
Defines the detection constraints for the first edge of the selected pair. Constraints can be set for position
and/or magnitude and are used to score edges.
Syntax
Micro V+
V+
Type
Long
Range
Value Constraint Name Description
0 hsNone No constraint
1 hsPosition Position constraint
2 hsMagnitude Magnitude constraint
3 hsAllConstraints Magnitude and position constraints.
Parameters
Page 174
Edge1Constraints
index_id Index of the edge pair. Range [1, PairCount -1]
object_id N/A
Page 175
Edge1Magnitude
Edge1Magnitude
VRESULT
1940
Magnitude of the first edge of the selected pair. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: -255
Maximum: 255
Parameters
index_id Index of the edge pair. Range [1, PairCount -1].
frame_id Index of the frame containing the edge pair.
Page 176
Edge1MagnitudeConstraint
VPARAMETER
5227
Indexed property used to set the magnitude constraint function. Two points are used: Base and Top.
Syntax
Micro V+
VPARAMETER (sequence_id, tool_id, 5227, index_id, constraint_id) = value
value = VPARAMETER (sequence_id, tool_id, 5227, index_id, constraint_id)
V+
VPARAMETER (sequence_id, tool_id, 5227, index_id, constraint_id) $ip = value
value = VPARAMETER ($ip, sequence_id, tool_id, 5227, index_id, constraint_id)
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
constraint_id One of the two points of the magnitude constraint function

(hsMagnitudeConstraintIndex)
1: Base point
2: Top point
Page 177
Edge1MagnitudeScore
Edge1MagnitudeScore
VRESULT
1942
Magnitude score of the first edge of the selected pair. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
Page 178
Edge1PolarityMode
Edge1PolarityMode
VPARAMETER
5211
Selection criterion for the first edge of the selected pair. The greyscale transition of the edge must respect
the polarity set by this property.
Syntax
Micro V+
V+
Type
Long
Range
Polarity Mode
Value Description
Name
0 hsDarkToLight The greylevel value must go from dark to light when crossing an edge.
1 hsLightToDark The greylevel value must go from light to dark when crossing an edge.
2 hsEitherPolarity The change in greylevel value is not a criterion for locating an edge.
Parameters
Page 179
Edge1PolarityMode
object_id N/A
Page 180
Edge1PositionConstraint
VPARAMETER
5224
Indexed property used to set the position constraint function of the first edge of the selected pair. Four
points are used: Base Left, Top Left, Top Right, Base Right.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
object_id N/A
Page 181
Edge1PositionScore
Edge1PositionScore
VRESULT
1944
Position score of the first edge of the selected pair. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
Page 182
Edge1PositionX
Edge1PositionX
VRESULT
1946
X-coordinate of the center of the first edge of the selected pair in the currently-selected coordinate system.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
Page 183
Edge1PositionY
Edge1PositionY
VRESULT
1947
Y-coordinate of the center of the first edge of the selected pair in the currently-selected coordinate system.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
Page 184
Edge1Radius
Edge1Radius
VRESULT
1954
Radius of the first edge of the selected pair. ToolPositionX and ToolPositionY are at the center of the circular
arc described by the selected edge. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Greater than 0.
Parameters
Page 185
Edge1Rotation
Edge1Rotation
VRESULT
1950
Rotation of the first edge of the selected pair in the vision coordinate system. This property is read-only.
Syntax
Micro V+
V+
Remarks
The rotation is defined as the angle between the X-axis of the vision coordinate system and the
selected edge.
Type
Double
Range
Minimum: -180
Maximum: 180
Parameters
Page 186
Edge1Rotation
Page 187
Edge1Score
Edge1Score
VRESULT
1952
Minimum score needed to accept an edge as the first edge of the selected pair. The score is computed
according to the constraints set by the Edge1Constraints property. This property is read-only.
Syntax
Micro V+
V+
Remarks
selected edge.
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
Page 188
Edge1Score
Page 189
Edge1ScoreThreshold
Edge1ScoreThreshold
VPARAMETER
5241
Minimum score needed to accept an edge as the first edge of the selected pair. The score of the first edge is
returned by the Edge1Score property.
Syntax
MicroV+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
object_id Index of the frame containing the edge pair.
Page 190
Edge2Constraints
Edge2Constraints
VPARAMETER
5222
Defines the detection constraints for the second edge of the selected pair. Constraints can be set for
position and/or magnitude and are used to score edges.
Syntax
Micro V+
V+
Type
Long
Range
0 hsNone No constraint
1 hsPosition Position constraint
2 hsMagnitude Magnitude constraint
3 hsAllConstraints Magnitude and position constraints.
Parameters
Page 191
Edge2Constraints
object_id N/A
Page 192
Edge2Magnitude
Edge2Magnitude
VRESULT
1941
Magnitude of the second edge of the selected pair. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: -255
Maximum: 255
Parameters
Page 193
VPARAMETER
5228
Indexed property used to set the magnitude constraint function of the second edge of the selected pair.
Two points are used: Base and Top.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
object_id N/A
Page 194
Edge2MagnitudeScore
Edge2MagnitudeScore
VRESULT
1943
Magnitude score of the second edge of the selected pair. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
Page 195
Edge2PolarityMode
Edge2PolarityMode
VPARAMETER
5212
Selection criterion for the second edge of the selected pair. The greyscale transition of the edge must
respect the polarity set by this property.
Syntax
Micro V+
V+
Type
Long
Range
The change in greylevel value change is not a criterion for locating an

2 hsEitherPolarity
edge.
Parameters
Page 196
Edge2PolarityMode
object_id N/A
Page 197
VPARAMETER
5225
Indexed property used to set the position constraint function of the second edge of the selected pair. Four
points are used: Base Left, Top Left, Top Right, Base Right.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
object_id N/A
Page 198
Edge2PositionScore
Edge2PositionScore
VRESULT
1945
Position score of the second edge of the selected pair. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
Page 199
Edge2PositionX
Edge2PositionX
VRESULT
1948
X-coordinate of the center of the second edge of the selected pair in the currently-selected coordinate
Syntax
Micro V+
V+
Type
Double
Range
Parameters
Page 200
Edge2PositionY
Edge2PositionY
VRESULT
1949
Y-coordinate of the center of the second edge of the selected pair in the currently-selected coordinate
Syntax
Micro V+
V+
Type
Double
Range
Parameters
Page 201
Edge2Radius
Edge2Radius
VRESULT
1955
Radius of the second edge of the selected pair. ToolPositionX and ToolPositionY ar at center of the circular
arc described by the selected edge. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Greater than 0.
Parameters
Page 202
Edge2Rotation
Edge2Rotation
VRESULT
1951
Rotation of the second edge of the selected pair in the vision coordinate system. This property is read-only.
Syntax
Micro V+
V+
Remarks
selected edge.
Type
Double
Range
Minimum: -180
Maximum: 180
Parameters
Page 203
Edge2Rotation
Page 204
Edge2Score
Edge2Score
VRESULT
1953
Minimum score to accept an edge as the second edge of the selected pair The score is computed according
to the constraints set by the Edge2Constraints property. This property is read-only.
Syntax
Micro V+
V+
Remarks
selected edge.
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
Page 205
Edge2Score
Page 206
Edge2ScoreThreshold
Edge2ScoreThreshold
VPARAMETER
5242
Minimum score to accept an edge as the second edge of the selected pair. The score of the second edge is
returned by the Edge2Score property.
Syntax
MicroV+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
Page 207
EdgeCount
EdgeCount
VRESULT
1900
Number of edges detected by the tool. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: Unlimited
Parameters
$ip IP address of the vision server. Applies to V+ syntax only. Uses

standard IP address format, for example: 192.168.1.120.
instance_id N/A
index_id N/A
frame_id N/A
Page 208
EdgeFilterHalfWidth
EdgeFilterHalfWidth
VPARAMETER
5203
Half-width of the convolution filter used to compute the edge magnitude curve from which actual edges
are detected. The filter approximates the first derivative of the projection curve. The half width of the filter
should be set in order to match the width of the edge in the projection curve (the extent of the greyscale
transition expressed in number of pixels).
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 1
Maximum: 25
Parameters
index_id N/A
object_id N/A
Page 209
EdgeMagnitude
EdgeMagnitude
VRESULT
1901
Magnitude of the selected edge. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: -255
Maximum: 255
Parameters

index_id Index of the edge.
frame_id Index of the frame containing the edge.
Page 210
EdgeMagnitudeScore
EdgeMagnitudeScore
VRESULT
1902
Magnitude score of the selected edge. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0.0
Maximum: 1.0
Parameters

index_id Index of the edge.
frame_id Index of the frame containing the edge.
Page 211
EdgeMagnitudeThreshold
EdgeMagnitudeThreshold
VPARAMETER
5201
Magnitude threshold is used to find edges on the magnitude curve. In order to locate edges, a subpixel,
peak-detection algorithm is applied on the region of every minimum or maximum of the curve that
exceeds this threshold.
Syntax
Micro V+
V+
Type
Range
Minimum: 0
Maximum: 255
Parameters
$ip IP address of the vision server. Applies to V+ syntax only.

Uses standard IP address format, for example:
192.168.1.120.
index_id N/A
object_id N/A
Page 212
EdgePolarityMode
EdgePolarityMode
VPARAMETER
5210
Edge-selection criterion. The greyscale transition of the edge must respect the polarity set by this
property.
Syntax
Micro V+
V+
Type
Long
Range
The change in greylevel value change is not a criterion for locating an

2 hsEitherPolarity
edge.
Parameters

Page 213
EdgePolarityMode
index_id N/A
object_id N/A
Page 214
EdgePositionScore
EdgePositionScore
VRESULT
1903
Position score of the selected edge. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0.0
Maximum: 1.0
Parameters

index_id Index of the edge for which you want the results.
frame_id Index of the frame that contains the selected edge.
Page 215
EdgePositionX
EdgePositionX
VRESULT
1904
X-coordinate of the center of the selected edge in the currently-selected coordinate system. This property
is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Parameters
Page 216
EdgePositionY
EdgePositionY
VRESULT
1905
Y-coordinate of the center of the selected edge in the currently-selected coordinate system. This property
is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
Page 217
EdgeRadius
EdgeRadius
VRESULT
1908
Radius of the selected edge. ToolPositionX and ToolPositionY designate the center of the circular arc
described by the selected edge. This property is read-only.
Syntax
Micro V+
V+
Type
Range
Minimum: -180
Maximum: 180
Parameters

192.168.1.120.
Page 218
EdgeRotation
EdgeRotation
VRESULT
1906
Rotation of the selected edge with respect to the currently-selected coordinate system. This property is
read-only.
Syntax
Micro V+
V+
Type
Range
Greater than 0.
Parameters

Page 219
EdgeScore
EdgeScore
VRESULT
1907
Score of the selected edge. The score is computed according the constraints set by the Constraints
property. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters

Page 220
EdgeSortResultsEnabled
EdgeSortResultsEnabled
VPARAMETER
5243
Property that specifies if edges are sorted in descending order of score values.
Syntax
Micro V+
V+
Type
Boolean
Range
Value Description
0 The edges are sorted in descending order of score values.
1 The edges are not sorted.
Parameters
index_id N/A
object_id N/A
Page 221
ElapsedTime
ElapsedTime
VRESULT
1001
Total time elapsed (in milliseconds) during the last execution of the Locator tool. This time includes the
time for the learn process, the time for the search process, and the overhead required to create and output
the results structures. This property is read-only.
Syntax
MicroV+
V+
Remarks
This property returns the total elapsed time; it is not the used CPU time.
Type
Double
Range
Minimum: 0.0
Maximum: unlimited
Parameters
instance_id N/A
index_id N/A
Page 222
ElapsedTime
Range: [1, ResultCount -1]
Page 223
ExtrinsicInertiaResultsEnabled
VPARAMETER
1604
Enables the computation of the following blob properties: BlobInertiaXAxis, BlobInertiaYAxis and
BlobPrincipalAxesRotation.
Figure: Illustration of Extrinsic Inertia Results
Syntax
Micro V+
V+
Type
Boolean
Range
Value Description
1 The extrinsic inertia properties will be computed
0 No extrinsic inertia properties will be computed
Page 224
Parameters
index_id N/A
object_id N/A
Page 225
FilterCount
FilterCount
VPARAMETER
5601
Number of filters applied by the tool. This property is read-only.
Syntax
MicroV+
V+
Type
Long
Range
Greater than or equal to 0.
Parameters
index_id N/A
object_id N/A
Page 226
FilterHalfWidth
FilterHalfWidth
VPARAMETER
5202
Half-width of the convolution filter used by the tool to compute an edge-magnitude curve from which
edges are detected. This value should be set to a value approximately equivalent to the width of the edge,
in pixels, as it appears in the image.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 1
Maximum: 25
Parameters
index_id N/A
object_id N/A
Page 227
FilterHueTolerance
FilterHueTolerance
VPARAMETER
5716
For the selected filter, the value of the tolerance allowed for the Hue value defined by FilterHueValue. The
FilterHueTolerance value is distributed equally above and below the FilterHueValue. For example, if
FilterLuminanceValue = 200 and FilterHueTolerance = 20, the filter will accept pixels with a range of hue
values = [190,200].
Syntax
Micro V+
VPARAMETER (sequence_id, tool_id, 5716, filter_id, object_id) = value
value = VPARAMETER (sequence_id, tool_id, 5716, filter_id, object_id)
V+
VPARAMETER (sequence_id, tool_id, 5716, filter_id, object_id) $ip = value
value = VPARAMETER ($ip, sequence_id, tool_id, 5716, filter_id, object_id)
Remarks
When FilterHueTolerance = 1, no tolerance (variation) in luminance is accepted. The filter will only
accept pixels with a luminance value equal to FilterHueValue.
Type
Long
Range
Minimum: 1
Maximum: 128
Parameters
Page 228
FilterHueTolerance
filter_id Index of the filter to which the value applies First Filter is 0.
object_id N/A
Page 229
FilterHueValue
FilterHueValue
VPARAMETER
5713
Value of the Hue component, in the HSL colorspace, for the selected filter. This value may be modified if
any changes are made to the RGB values of the filter. Hue is the quality of color that is perceived as the
color itself. It is commonly expressed by the color name, for example: red, green, yellow. Hue is
determined by the perceived dominant wavelength, or the central tendency of combined wavelengths,
within the visible spectrum.
Syntax
Micro V+
V+
Remarks
The value of a filter can be configured either by its HSL values or its RGB values. The Tolerance in a color
filter can only be expressed in HSL values.
HSL values are defined by properties: FilterHueValue, FilterLuminanceValue, and

FilterSaturationValue.
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
Page 230
FilterHueValue
filter_id Index of the filter to which this value applies.
object_id N/A
Page 231
FilteringClippingMode
VPARAMETER
5370
Sets the clipping mode applied by a filtering operation. Typically, the hsClippingAbsolute mode is used for
filter operations.
Syntax
Micro V+
V+
Remarks
hsClippingNormal mode forces the destination pixel value to a value from 0 to 255 for unsigned 8-bit
images, to a value from -327678 to 32767 for signed 16 bits images, and so on. Values that are less
than the specified minimum value are set to the minimum value. Values greater than the specified
maximum value are set to the maximum value.
hsClippingAbsolute mode takes the absolute value of the result and clips it using the same algorithm
used for hsClippingNormal mode.
Range
Value Image Processing Clipping Mode Description
0 hsClippingNormal Normal clipping method is used.
1 hsClippingAbsolute Absolute clipping method is used.
Parameters
Page 232
index_id N/A
object_id N/A
Page 233
FilteringKernelSize
FilteringKernelSize
VPARAMETER
5371
Kernel size applied by a fixed (predefined) filtering operation.
Syntax
Micro V+
V+
Type
Long
Range
Valid sizes are 3,5,7
Parameters
index_id N/A
object_id N/A
Page 234
FilteringScale
FilteringScale
VPARAMETER
5372
Scaling factor applied by a filtering operation. After the operation has been applied, the value of each pixel
is multiplied by the FilteringScale value.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0
Maximum: Unlimited
Parameters
index_id N/A
object_id N/A
Page 235
FilterLuminanceTolerance
VPARAMETER
5718
Value of the tolerance allowed for the Luminance value, defined by FilterLuminanceValue, for the selected
filter. The FilterLuminanceTolerance value is distributed equally above and below the
FilterLuminanceValue. For example, if FilterLuminanceValue = 200 and FilterLuminanceTolerance = 20,
the filter will accept pixels within a range of luminance values = [190,200].
Syntax
Micro V+
V+
Remarks
When FilterLuminanceTolerance = 1, no tolerance (variation) in luminance is accepted. The filter will

only accept pixels with a luminance value equal to FilterLuminanceValue.
Type
Long
Range
Minimum: 1
Maximum: 128
Parameters
Page 236
object_id N/A
Page 237
FilterLuminanceValue
VPARAMETER
5715
Value of the Luminance component, in the HSL colorspace, for the selected filter. This value may be
modified if any changes are made to the RGB values of the filter. Luminance is perceived as the brightness
of the color or the amount of white contained in the color. When FilterLuminanceValue = 0, the color is
completely black (RGB= 0,0,0). When FilterLuminanceValue = 255, the color is almost completely white.
Syntax
Micro V+
V+
Remarks

Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
Page 238
object_id N/A
Page 239
FilterSaturationTolerance
VPARAMETER
5717
Value of the tolerance allowed for the saturation value, defined by FilterSaturationValue, for the selected
filter. The FilterSaturationTolerance value is distributed equally above and below the
For example, if FilterSaturationValue = 200 and FilterSaturationTolerance = 20, the filter will accept pixels
with a range of saturation values = [190,200].
Syntax
Micro V+
V+
Remarks
When FilterSaturationTolerance = 1, no tolerance (variation) in saturation is accepted. The filter will

only accept pixels with a saturation value equal to FilterSaturationValue.
Type
Long
Range
Minimum: 1
Maximum: 128
Parameters
Page 240
object_id N/A
Page 241
FilterSaturationValue
VPARAMETER
5714
Value of the Saturation component, in the HSL colorspace, for the selected filter. This value may be
modified if any changes are made to the RGB values of the filter. Saturation is perceived as the amount of
purity of the color or of the amount of grey in a color. When FilterSaturationValue = 0, the color appears as
mid-grey (RGB = 112,126,126). When FilterSaturationValue = 255, the color is said to be saturated.
Syntax
Micro V+
V+
Remarks

Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
Page 242
object_id N/A
Page 243
FitMode
FitMode
VPARAMETER
5140
Specifies the mode used by the tool to calculate and return values for the found arc.
Syntax
MicroV+
V+
Type
Long
Range
Value hsFitMode Description

0 hsBoth The Arc Finder calculates and returns both the arc center and arc radius.
1 hsRadius The arc radius is calculated, the arc center returned is the value of the tool
center.
2 hsCenter The arc center is calculated; the radius returned is the value of the tool
radius
Parameters
Page 244
FitMode
index_id N/A
object_id N/A
Page 245
FitQuality
FitQuality
VRESULT
1803
Normalized average error between the calculated arc or line entity and the actual edges matched to the
found entity. Fit quality ranges from 0 to 1, with 1 being the best quality. A value of 1 means that the
average error is 0. Conversely, a value of 0 means that the average matched error is equal to Conformity
Tolerance. This property is read-only.
Syntax
MicroV+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
index_id N/A

Page 246
ActiveCalibration
FlexibowlFeederVRunCommand
VPARAMETER
7000
Identifies the command that is run when a VRUN is issued to the Flexibowl Feeder.
Syntax
MicroV+
V+
Type
Real variable.
Range
A valid Flexibowl Feeder command or sequence index. The valid Flexibowl Feeder commands are:
Blow 1
Forward 2
Shake 3
Flip 1 4
Flip 2 5
Flip Blow 6
Forward Blow 7
Forward Flip Blow 8
Light On 15
Light Off 16
Parameters
Page 247
ActiveCalibration
tool_id N/A
index_id N/A
object_id N/A
Page 248
ActiveCalibration
FlexibowlFeederBlowTime
VPARAMETER
7012
The length of time (in ms) for the blow operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 1
Maximum: Unbounded
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 249
ActiveCalibration
FlexibowlFeederFlipCount
VPARAMETER
7005
The number of iterations used in the flip operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 1
Maximum: Unbounded
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 250
ActiveCalibration
FlexibowlFeederFlipDelay
VPARAMETER
7006
The amount of time (in ms) to delay in the flip operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 1
Maximum: Unbounded
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 251
ActiveCalibration
FlexibowlFeederForwardAcceleration
VPARAMETER
7001
The acceleration for the forward operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 10
Maximum: 10000
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 252
ActiveCalibration
FlexibowlFeederForwardAngle
VPARAMETER
7003
The angle used in the forward operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: -360
Maximum: 360
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 253
ActiveCalibration
FlexibowlFeederForwardDeceleration
VPARAMETER
7002
The deceleration for the forward operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 10
Maximum: 10000
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 254
ActiveCalibration
FlexibowlFeederForwardSpeed
VPARAMETER
7004
The speed for the forward operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 1
Maximum: 130
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 255
ActiveCalibration
FlexibowlFeederShakeAcceleration
VPARAMETER
7007
The acceleration for the shake operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 10
Maximum: 10000
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 256
ActiveCalibration
FlexibowlFeederShakeAngle
VPARAMETER
7009
The angle for the shake operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: -360
Maximum: 360
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 257
ActiveCalibration
FlexibowlFeederShakeCount
VPARAMETER
7011
The number of iterations used in the shake operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 1
Maximum: Unbounded
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 258
ActiveCalibration
FlexibowlFeederShakeDeceleration
VPARAMETER
7008
The deceleration for the shake operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 10
Maximum: 10000
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 259
ActiveCalibration
FlexibowlFeederShakeSpeed
VPARAMETER
7010
The speed for the shake operation.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 1
Maximum: 130
Parameters
tool_id N/A
index_id N/A
object_id N/A
Page 260
Found
Found
VRESULT
1800
Specifies if an entity was found. If True, at least one entity (point, line or arc) was found in the current
image. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Value State Description

0 False No entity was found.
1 True An entity was found.
Parameters
index_id N/A
frame_id N/A
Page 261
FrameCount
FrameCount
VRESULT
2410
Uses the frame index to return the number of results relative to the specified frame. This property is read-
only.
NOTE: This ACE Sight property is interchangeable with InstanceCount.
Syntax
MicroV+
V+
Type
Long
Range
Parameters
instance_id N/A
index_id N/A

Related Topics
Page 262
FrameCount
InstanceCount
ResultCountInstanceCount
Page 263
FrameIntrinsicBoundingBox
VRESULT
2420
Sets the coordinates of the instrinsic bounding box that defines a frame. The intrinsic bounding box is the
smallest box that can enclose the frame. This property is read-only.
Syntax
MicroV+
value = VRESULT (sequence_id, tool, instance_id, 2420, bounding_id, frame_id)
V+
value = VRESULT ($ip, sequence_id, tool, instance_id, 2420, bounding_id, frame_id)
Type
Double
Range
Parameters
bounding_id 1 to 8: Index of the X/Y-coordinates that define corners of the intrinsic bounding
box:
1: X-coordinate of the corner
2: Y-coordinate of the corner
Page 264

specified instance.
Page 265
FrameRotation
FrameRotation
VRESULT
2402
Rotation of the specified output frame. It does not include a tool offset or camera calibration offset. This
NOTE: InstanceRotation is the preferred property. Therefore, you should update your code to use that
property.
Syntax
Micro V+
V+
Type
Double
Parameters
index_id Index of the frame for which you want to set the mode.
frame_id N/A
Page 266
FrameTranslationX
FrameTranslationX
VRESULT
2400
X-coordinate of the origin of the specified output frame. It does not include a tool offset or camera
calibration offset. This property is read-only.
NOTE: InstanceTranslationX is the preferred property. Therefore, you should update your code to use that
property.
Syntax
Micro V+
V+
Type
Double
Parameters
frame_id N/A
Page 267
FrameTranslationY
FrameTranslationY
VRESULT
2401
Y-coordinate of the origin of the specified output frame. It does not include a tool offset or camera
calibration offset. This property is read-only.
NOTE: InstanceTranslationY is the preferred property. Therefore, you should update your code to use that
property.
Syntax
Micro V+
V+
Type
Double
Parameters
frame_id N/A
Page 268
GreylevelRange
GreylevelRange
VRESULT
1508
Range of greylevel values of the pixels in the tool region of interest that are included in the final histogram.
Pixels removed from the histogram by tails or thresholds are not included in this calculation. The range is
equal to [MaximumGreylevelValue - MinimumGreylevelValue + 1]. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: 256
Parameters
index_id The index of the frame for which you want to set the mode.
frame_id N/A
Page 269
GreyLevelResultsEnabled
VPARAMETER
1608
Enables the computation of the following blob greylevel properties: BlobGreyLevelMaximum,
BlobGreyLevelMean, BlobGreyLevelMaximum, BlobGreyLevelMinimum, BlobGreyLevelRange, and
BlobGreyLevelStdDev.
Syntax
Micro V+
V+
Type
Boolean
Range
Value Description
1 The greylevel blob properties will be computed
0 No greylevel blob properties will be computed
Parameters
Page 270
index_id N/A
object_id N/A
Page 271
GripperInputClose
GripperInputClose
VPARAMETER
5515
Returns the close input signal for a given tip on the gripper. This property is read-only.
Syntax
MicroV+
V+
Type
Real variable.
Parameters
sequence_id Should always be set to -1.
tool_id The tip number.
index_id The robot number.
object_id The index of the signal number to access.
Page 272
GripperInputExtend
GripperInputExtend
VPARAMETER
5518
Returns the extend input signal for a given tip on the gripper. This property is read-only.
Syntax
MicroV+
V+
Type
Real variable.
Parameters
Page 273
GripperInputOpen
GripperInputOpen
VPARAMETER
5514
Returns the open input signal for a given tip on the gripper. This property is read-only.
Syntax
MicroV+
V+
Type
Real variable.
Parameters
Page 274
GripperInputRetract
GripperInputRetract
VPARAMETER
5519
Returns the retract input signal for a given tip on the gripper. This property is read-only.
Syntax
MicroV+
V+
Type
Real variable.
Parameters
Page 275
GripperOffset
GripperOffset
VLOCATION
10100
Allows an application program to extract the gripper offsets for the tips associated with a robot in the
workspace. The "instance" number is used to identify the robot number to access. The result index is used
to specify the tip to return.
Syntax
MicroV+
VLOCATION (sequence_id, tool_id, instance_id, 10100, index_id, frame_id)
V+
VLOCATION ($ip, sequence_id, tool_id, instance_id, 10100, index_id, frame_id)
Type
Location
Parameters
instance_id The robot number to access.
index_id Index of the tip to return.
frame_id N/A
Page 276
GripperOutputClose
GripperOutputClose
VPARAMETER
5512
Returns the close output signal for a given tip on the gripper. This property is read-only.
Syntax
MicroV+
V+
Type
Real variable.
Parameters
Page 277
GripperOutputExtend
GripperOutputExtend
VPARAMETER
5516
Returns the extend output signal for a given tip on the gripper. This property is read-only.
Syntax
MicroV+
V+
Type
Real variable.
Parameters
Page 278
GripperOutputOpen
GripperOutputOpen
VPARAMETER
5511
Returns the open output signal for a given tip on the gripper. This property is read-only.
Syntax
MicroV+
V+
Type
Real variable.
Parameters
Page 279
GripperOutputRelease
GripperOutputRelease
VPARAMETER
5513
Returns the release signal for a given tip on the gripper. This property is read-only.
Syntax
MicroV+
V+
Type
Real variable.
Parameters
Page 280
GripperOutputRetract
GripperOutputRetract
VPARAMETER
5517
Returns the retract output signal for a given tip on the gripper. This property is read-only.
Syntax
MicroV+
V+
Type
Real variable.
Parameters
Page 281
ActiveCalibration
GripperPayload
VPARAMETER
5550
Allows an application program to read the payload associated with a gripper associated with a robot in the
workspace. The "instance" number is used to identify the robot number to access.
Syntax
MicroV+
V+
Type
Real variable.
Parameters
tool_id
object_id
Page 282
GripperToolTransform
GripperToolTransform
VLOCATION
11000
Returns the tool transformation for a given tip on the gripper. This property is read-only.
Syntax
MicroV+
value = VLOCATION (sequence_id, tool_id, instance_id, 11000, result_id, frame_id)
V+
value = VLOCATION ($ip, sequence_id, tool_id, instance_id, 11000, result_id, frame_id)
Type
Transformation.
Parameters
tool_id Index of the tip number to access.
instance_id The robot number.
result_id Not used.
frame_id Not used.
Page 283
Histogram
Histogram
VRESULT
1511
Histogram of greylevel values of the pixels in the tool region of interest that are included in the final
histogram. Pixels removed from the histogram by tails or thresholds are not included in this calculation.
The histogram comprises 256 bins. One histogram bin is associated with each of the 256 possible greylevel
values. It contains the number of pixels with the corresponding greylevel value in the region of interest.
Syntax
Micro V+
V+
Type
Long
Range
Parameters
index_id N/A
frame_id N/A
Page 284
HistogramPixelCount
HistogramPixelCount
VRESULT
1512
Total number of pixels in the histogram. The number of pixels in the histogram is equal to
ImagePixelCount minus the pixels excluded from the Histogram by any threshold or tail functions set by
the properties: ThresholdBlack, ThresholdWhite, TailWhite, or TailBlack. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Parameters
index_id N/A
frame_id N/A
Page 285
HistogramThreshold
HistogramThreshold
VPARAMETER
5385
Threshold value applied by a histogram thresholding operation.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
Page 286
HoleFillingEnabled
HoleFillingEnabled
VPARAMETER
5002
Enables the filling of the holes in each blob.
Syntax
Micro V+
V+
Type
Boolean
Range
Value Description
1 All holes will be filled.
0 No hole will be filled.
Parameters
index_id N/A
object_id N/A
Page 287
ImageHeight
ImageHeight
VRESULT
1021
Height, in pixels, of the tool region of interest. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Parameters
index_id N/A
frame_id N/A
Page 288
ImageOriginBelt
ImageOriginBelt
VLOCATION
10053
Origin of the image frame of reference. Expressed as a transform relative to the robot frame of reference.
Figure: Illustration of ImageOrigin and VisionOrigin Properties
Syntax
V+
MicroV+
value = Not applicable. Conveyor tracking is supported only in V+.
Type
Location
Parameters
Page 289
ImageOriginBelt
Related Properties
ImageOriginRobot
VisionOriginBelt
VisionOriginRobot
Page 290
ImageOriginRobot
ImageOriginRobot
VLOCATION
10051
Origin of the image frame of reference. Expressed as a transform relative to the robot frame of reference.
Syntax
MicroV+
value = VLOCATION (sequence_id, tool_id, instance_id, 10051, index_id, frame_id)
V+
Type
Location
Parameters
Page 291
ImageOriginRobot
Related Properties
ImageOriginBelt
VisionOriginBelt
VisionOriginRobot
Page 292
ImagePixelCount
ImagePixelCount
VRESULT
1513
Number of pixels in the tool region of interest. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Parameters

index_id N/A
frame_id N/A
Page 293
ImageSubsampling
ImageSubsampling
VPARAMETER
5324
Factor used to subsample the greyscale image in the tool region of interest. With a subsampling factor of 1,
the greyscale image is not subsampled. With a subsampling factor of 2, the greyscale image is subsampled
in tiles of 2x2 pixels. With a subsampling factor of 3 the greyscale image is subsampled in tiles of 3x3
pixels, and so on.
Syntax
Micro V+
V+
Remarks
Color Matching Tool
Increasing the subsampling level reduces the number of pixels and the quantity information analyzed
by the tool. Increasing the Image Subsampling may reduce the execution time but affects the accuracy
of color matching results.
Image Histogram
Using a higher subsampling factor speeds up the generation of the histogram but slightly reduces the
accuracy of the statistics computed from the histogram. The pixel properties computed by the Image
Histogram tool are normalized with respect to the subsampling factor (HistogramPixelCount,
ImageHeight, ImagePixelCount and ImageWidth). Therefore, the total number of pixels in the
histogram should remain the same at any subsampling factor. Note that there might be slight
differences in the values of these properties when either of the width or the height of the region of
interest is not a multiple of the subsampling factor used.
Type
Long
Range
Page 294
ImageSubsampling
1 (no subsampling),2, 3, 4, 5, 6, 7, 8
Parameters
index_id N/A
object_id N/A
Page 295
ImageWidth
ImageWidth
VRESULT
1020
Width, in pixels, of the tool region of interest. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Remarks
Instance is relative for the Image Histogram tool. Note that it is:
l Not relative for the Color Matching tool.
l Not implemented for virtual cameras.
Parameters
Page 296
ImageWidth
index_id N/A
frame_id N/A
InspectionFilterMeasuredValue
VRESULT
2700
Returns the measured value of the specified filter for the instance. This property is read-only.
Syntax
Micro V+
value = VRESULT (sequence_id, tool_id, instance_id, 2700, index_id)
V+
value = VRESULT ($ip, sequence_id, tool_id, instance_id, 2700, index_id)
Type
Long
Parameters
index_id Index of the filter for which you want the result.
InspectionFilterPassStatus
VRESULT
2702
Returns the pass status of the specified filter for the instance. This property is read-only.
Page 297
ImageWidth
Syntax
Micro V+
V+
Type
Long
Parameters
index_id Index of the filter for which you want the result.
frame_id Index of the category you wish to access.
Range: 1, Category Count + 1
Where Category Count + 1 = Unassigned.
Page 298
InstanceClearQuality
VRESULT
1319
Measure of the unencumbered area surrounding the specified object instance. Clear quality ranges from 0
to 1, with 1 being the best quality. A value of 1 means that the instance is completely free of obstacles.
Syntax
MicroV+
V+
Type
Double
Remarks
In MicroV+/V+, the frame_id parameter is required.
Range
Minimum: 0.0
Maximum: 1.0
Parameters
index_id N/A
Page 299
Page 300
InstanceCount
InstanceCount
VRESULT
1310
Uses the frame index to return the number of results relative to the specified frame. This property is read-
only.
NOTE: This ACE Sight property is interchangeable with FrameCount.
Syntax
MicroV+
V+
Remarks
Type
Long
Range
Parameters
instance_id N/A
index_id N/A
Page 301
InstanceCount
Related Topics
FrameCount
ResultCount
Page 302
InstanceFitQuality
InstanceFitQuality
VRESULT
1317
Normalized average error between the matched model contours of the selected object instance and the
actual contours detected in the input image. Fit quality ranges from 0 to 1, with 1 being the best quality. A
value of 1 means that the average error is 0. Conversely, a value of 0 means that the average matched
error is equal to ConformityTolerance. This property is read-only.
Syntax
MicroV+
V+
Remarks
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
index_id N/A
Page 303
InstanceFitQuality

Page 304
InstanceIntrinsicBoundingBox
VRESULT
1330
Returns the coordinates of the instrinsic bounding box that defines an instance. The intrinsic bounding box
is the smallest box that can enclose the instance. This property is read-only.
Syntax
MicroV+
value = VRESULT (sequence_id, tool_id, instance_id, 1330, bounding_id, frame_id)
V+
value = VRESULT ($ip, sequence_id, tool_id, instance_id, 1330, bounding_id, frame_id)
Type
Double
Range
Parameters
bounding_id 1 to 8: Index of the XY-coordinates that define corners of the intrinsic bounding
box:
Page 305


Page 306
InstanceLocation
InstanceLocation
VLOCATION
1311
Returns the location of the selected instance in the frame of reference of the specified robot. If a gripper
offset has been assigned to the instance, it is automatically applied to the location. If no robot-to-vision
calibration has been applied, InstanceLocation returns the location in the vision frame of reference. This
Syntax
MicroV+
V+
Remarks
If there is a single gripper offset, InstanceLocation (1311) is the same as

InstanceLocationGripperOffsetMinimum (1400). If there are multiple gripper offsets that can be
applied to the instance, you should use InstanceLocationGripperOffsetMinimum = 1400 for the
location with the first gripper offset, InstanceLocationGripperOffsetMinimum = 1401 for the location
with the second gripper offset, and so on, for additional gripper offsets.
Parameters
instance_id Index of the instance for which the location is required.
index_id Index of the robot.
frame_id Index of the frame in which the instance is found. Typically this is '0' (i.e. the
Locator is not frame-based).
Page 307
InstanceLocation
Related Properties
InstanceRobotLocation
InstanceLocationGripperOffsetMaximum
InstanceLocationGripperOffsetMinimum
Page 308
VLOCATION
1499
Returns the maximum number of gripper offsets. This property is read-only.
Syntax
MicroV+
V+
Type
Location
Remarks

applied to the instance you should use InstanceLocationGripperOffsetMinimum = 1400 for the location
with the first gripper offset, InstanceLocationGripperOffsetMinimum = 1401 for the location with the
second gripper offset, and so forth, for additional gripper offsets.
Range
Minimum: Greater than or equal to InstanceLocationGripperOffsetMinimum
Maximum: 100
Parameters
index_id N/A
Page 309
object_id N/A
Related Properties
InstanceLocation
Page 310
VLOCATION
1400
Returns the minimum number of gripper offsets. This property is read-only.
Syntax
MicroV+
V+
Type
Location
Remarks

applied to the instance, you should use InstanceLocationGripperOffsetMinimum = 1400 for the
location with the first gripper offset, InstanceLocationGripperOffsetMinimum = 1401 for the location
with the second gripper offset, and so on, for additional gripper offsets.
Range
Minimum: Greater than or equal to 0
Maximum: Greater than or equal to InstanceLocationGripperOffsetMaximum
Parameters
index_id N/A
Page 311
object_id N/A
Related Properties
InstanceLocation
Page 312
InstanceMatchQuality
VRESULT
1318
Returns a value representing the percent of matched model contours for the selected object instance.
Match quality ranges from 0 to 1, with 1 being the best quality. A value of 1 means that 100% of the
model contours were successfully matched to the actual contours detected in the input image. This
Syntax
MicroV+
V+
Remarks
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
index_id N/A
Page 313

Page 314
InstanceModel
InstanceModel
VRESULT
1312
Returns the index of the model associated with the selected object instance. This property is read-only.
Syntax
MicroV+
V+
Remarks
Type
Long
Range
Minimum: 0
Maximum: Number of models - 1
Parameters
index_id N/A
Page 315
InstanceModel
frame Index of the frame that contains the specified instance.

Page 316
InstanceOrdering
InstanceOrdering
VPARAMETER
530
Order in which the instances are processed and output.
Syntax
MicroV+
V+
Remarks
With the hsDistanceImage and hsDistanceWorld modes, the reference coordinate used to compute the
distance is set with the InstanceOrderingReferenceX and InstanceOrderingReferenceY properties.
Type
Long
Range
Value Mode Name Description
Instances are processed and output according to their

0 hsEvidence hypothesis strength, beginning with the strongest
hypothesis.
Instances are processed and output in the order they

1 hsLeftToRight
appear in the search area, from left to right.

2 hsRightToLeft
appear in the search area, from right to left.

3 hsTopToBottom
appear in the search area, from top to bottom.
Page 317
InstanceOrdering
Value Mode Name Description

4 hsBottomToTop
appear in the search area, from bottom to top.
All the instances are first processed and then they are
5 hsQuality output according to their Quality, beginning with the
highest quality.

6 hsDistanceImage distance from a reference image coordinate, beginning
with the closest.

7 hsDistanceWorld distance from a reference world coordinate, beginning with
the closest.

8 hsShadingConsistency shading consistency with respect to the model, beginning
with the strongest hypothesis.
Parameters
index_id N/A
object_id N/A
Page 318
InstanceOrderingReferenceX
InstanceOrderingReferenceX
VPARAMETER
531
Reference X-coordinate used to compute the distance when the hsDistanceImage or hsDistanceWorld
ordering mode is enabled through the InstanceOrdering property.
Syntax
MicroV+
V+
Type
Double
Range
Not applicable.
Parameters
index_id N/A
object_id N/A
Page 319
InstanceOrderingReferenceY
InstanceOrderingReferenceY
VPARAMETER
532
Reference Y-coordinate used to compute the distance when the hsDistanceImage or hsDistanceWorld
ordering mode is enabled through the InstanceOrdering property.
Syntax
MicroV+
V+
Type
Double
Range
Not applicable.
Parameters
index_id N/A
object_id N/A
Page 320
VLOCATION
1371
Returns the location of the selected instance in the frame of reference for the specified robot. No offset
transformations are applied to the location. If a gripper offset has been assigned to the instance, it is
ignored. If no vision-to-robot calibration has been applied, the system returns an error. This property is
read-only.
Syntax
MicroV+
V+
Type
Location
Remarks
This differs from InstanceLocation, which applies any calculated offset and returns the vision frame of
reference coordinates if there is no robot-to-vision calibration.
Parameters
instance_id Index of the instance for which the location is required.
frame_id Index of the frame in which the instance is found. Typically this is '0' (i.e. the
Locator is not frame-based).
Page 321
Related Properties
InstanceLocation
Page 322
InstanceRotation
InstanceRotation
VRESULT
1314
Angle of rotation of the Object coordinate system of the selected object instance. It does not include a tool
offset or camera-calibration offset. This property is read-only.
Syntax
MicroV+
V+
Remarks
When the NominalRotationEnabled property is True, the rotation of the object instance is always equal
to NominalRotation.
Type
Double
Parameters
index_id N/A

Page 323
InstanceScaleFactor
InstanceScaleFactor
VRESULT
1313
Scale factor of the selected object instance based on its size relative to the associated model. This property
is read-only.
Syntax
MicroV+
V+
Remarks
When the NominalScaleFactorEnabled property is True, the scale factor of the object instance is always
equal to NominalScaleFactor.
Type
Double
Range
Minimum: MinimumScaleFactor or NominalScaleFactor
Maximum: MaximumScaleFactor or NominalScaleFactor
Parameters
Page 324
InstanceScaleFactor
index_id N/A

Page 325
InstanceSymmetry
InstanceSymmetry
VRESULT
1320
Index of the object instance that is symmetrical to the selected object instance. This property is read-only.
Syntax
MicroV+
V+
Remarks
If OutputSymmetricInstances is set to False, InstanceSymmetry is always equal to the instance's

index.
Type
Long
Range
Minimum: 0
Maximum: InstanceCount -1
Parameters
Page 326
InstanceSymmetry
index_id N/A

Page 327
InstanceTime
InstanceTime
VRESULT
1322
Time, in milliseconds, needed to recognize and locate the selected object instance. This property is read-
only.
Syntax
MicroV+
V+
Remarks
The time needed to locate the first object instance is usually longer because it includes all low-level
image preprocessing.
Type
Double
Range
Greater than 0.
Parameters
Page 328
InstanceTime
index_id N/A

Page 329
InstanceToolOffset
InstanceToolOffset
VLOCATION
1372
Returns the location of the selected instance relative to the position of the robot at the last picture
position. This property is read-only.
Syntax
MicroV+
V+
Remarks
The time needed to locate the first object instance is usually longer because it includes all low-level
image preprocessing.
Type
Double
Range
Greater than 0.
Parameters
Page 330
InstanceToolOffset
index_id N/A

Page 331
InstanceTranslationX
InstanceTranslationX
VRESULT
1315
X-translation of the Object coordinate system for the selected object instance. It does not include a tool
Syntax
MicroV+
V+
Remarks
Type
Double
Parameters
index_id N/A

Page 332
InstanceTranslationY
InstanceTranslationY
VRESULT
1316
Y-translation of the Object coordinate system for the selected object instance. It does not include a tool
Syntax
MicroV+
V+
Remarks
Type
Double
Parameters
index_id N/A

Page 333
InstanceVisible
InstanceVisible
VRESULT
1321
Returns the percentage of the instance bounding box that was found in the image. If the entire instance
bounding box is in the field of view, the percentage is 100; if it is partially outside the field of view, the
percentage is less than 100. This property is read-only.
Figure: Instance Visible at 100%
Page 334
InstanceVisible
Figure: Instance Visible at less than 100%
Syntax
MicroV+
V+
Remarks
Type
Double
Parameters
Page 335
InstanceVisible
index_id N/A

InstanceVisionOffset
VLOCATION
1373
Returns the vision coordinates of a located instance. This property is read-only.
Syntax
MicroV+
V+
Type
Double
Range
Greater than 0.
Parameters
Page 336
InstanceVisible
Page 337
InterpolatePositionMode
InterpolatePositionMode
VPARAMETER
5122
Sets the mode used by the Point Finder tool to compute a point hypothesis
Syntax
Micro V+
V+
Type
Long
Range
The tool will compute a hypothesis that fits a corner point to interpolated
0 hsCorner
lines from connected edges.
The tool will compute a hypothesis that is an intersection between the

1 hsIntersection
search axis and connected edges of an interpolated line.
Parameters
index_id N/A
object_id N/A
Page 338
InterpolatePositionModeEnabled
VPARAMETER
5123
When InterpolatePositionModeEnabled is set to True, the Point Finder tool uses the value set by the
InterpolatePositionMode property to compute a point hypothesis. Otherwise, point hypothesis coordinates
are taken directly from a specific found edge that satisfies search constraints.
Syntax
Micro V+
V+
Type
Long
Range
The Point Finder tool uses the value set by the InterpolatePositionMode
1
property to compute a point hypothesis
The Point Finder tool calculates point hypothesis directly from a specific found
0
edge that satisfies search constraints.
Parameters
Page 339
index_id N/A
object_id N/A
Page 340
IntrinsicBoxResultsEnabled
VPARAMETER
1605
Enables the computation of the following intrinsic bounding boxes and intrinsic extents:
BlobIntrinsicBoundingBoxBottom, BlobIntrinsicBoundingBoxCenterX, BlobIntrinsicBoundingBoxCenterY,
BlobIntrinsicBoundingBoxHeight, BlobIntrinsicBoundingBoxLeft, BlobIntrinsicBoundingBoxRight,
BlobIntrinsicBoundingBoxRotation, BlobIntrinsicBoundingBoxTop, BlobIntrinsicBoundingBoxWidth,
BlobIntrinsicExtentBottom, BlobIntrinsicExtentLeft, BlobIntrinsicExtentRight and BlobIntrinsicExtentTop.
Figure: Illustration of Intrinsic Box Results
Syntax
Micro V+
V+
Type
Boolean
Range
Page 341
Value Description
1 The intrinsic box properties will be computed
0 No intrinsic box properties will be computed
Parameters
index_id N/A
object_id N/A
Page 342
InverseKinematics
InverseKinematics
VLOCATION
10060
For a robot with a tool-mounted or an arm-mounted camera, InverseKinematics retrieves the location to
which to move the robot so the camera sees a specific point in the workspace (robot frame of reference) at
a specific point in the image (image frame of reference). The X/Y-coordinates of the point in the workspace
are defined by RobotXPosition and RobotYPosition, and the X/Y-coordinates of the point in the image are
defined by VisionXPosition and VisionYPosition.
If the camera is arm-mounted, the configuration used in the kinematic calculation is based on the current
arm configuration of the robot If the camera is tool-mounted, there are an infinite number of solutions for
positioning the robot. Therefore, using the VisionRotation property, you must specify the angle of rotation
between the vision X-axis and the robot X-axis.
NOTE: Inverse kinematics calculations for the Cobra i-series (i600 and i800) robots are not supported.
Syntax
MicroV+
value = VPARAMETER (sequence_id, tool_id, instance_id, 10060, index_id, frame_id)
V+
value = VPARAMETER ($ip, sequence_id, tool_id, instance_id, 10060, index_id, frame_id)
Type
Location
Parameters
tool_id The camera number, as defined in Keyword Mapping parameter of the ACE Sight
Camera Calibration (in the ACE workspace).
instance_id Not used.
Page 343
InverseKinematics
index The robot number, as defined in Keyword Mapping parameter of the ACE Sight
Camera Calibration (in the ACE workspace).
frame_id Not used.
Example
This example illustrates the use of the following properties: InverseKinematics, RobotXPosition,
RobotYPosition, VisionXPosition, VisionYPosition, and VisionRotation.
.PROGRAM demo()
; This program will move the robot so that a given point in the
; robot frame of reference can be seen in a given point in the vision
; Coordinate system (Calibrated)
; This defines the IP address of the PC

$ip = "192.168.0.223"
; This defines the point in the robot coordinate system that should
; be visible in the camera
robot_x = 300
robot_y = 0
; This is the point where the robot point should be seen in the
; camera coordinate system. These units are mm (Calibrated Image).
; When they are set to (0,0), it means the center of the image.
; Vision_rot only applies for a ToolMountedCamera
vision_x = 0
vision_y = 0
vision_rot = 0
; Tell ACE Sight what are the chosen values

; for configuration and vision points.
VPARAMETER(-1, 1, 10401, 1) $ip = vision_x
VPARAMETER(-1, 1, 10402, 1) $ip = vision_y
VPARAMETER(-1, 1, 10403, 1) $ip = vision_rot
WHILE TRUE DO
; Tell ACE Sight what are the chosen values for robot point.
VPARAMETER(-1, 1, 10404, 1) $ip = robot_x
VPARAMETER(-1, 1, 10405, 1) $ip = robot_y
; Ask ACE Sight where to move the robot in order to make

; robot point seen in vision point
SET loc = VLOCATION($ip, -1, 1, , 10060, 1)
; Move to the position

MOVES loc
Page 344
InverseKinematics
BREAK
END
.END
Related Properties
RobotXPosition
RobotYPosition
VisionXPosition
VisionYPosition
VisionRotation
Page 345
KernelSize
KernelSize
VPARAMETER
5304
Sets the size of the kernel of the operator for the sharpness process. The default setting of 5 (for a 5X5
kernel) is generally sufficient for most cases. This property is read-only.
Syntax
Micro V+
VRESULT (sequence_id, tool_id, instance_id, 5304, index_id, frame_id) = value
V+
VRESULT (sequence_id, tool_id, instance_id, 5304, index_id, frame_id) $ip = value
Type
Long
Range
Minimum: 2
Maximum: 16
Parameters

instance_id Index of the pair for which you want the result.
index_id N/A
frame_id Frame containing the pair.
Page 346
LastOperation
LastOperation
VRESULT
2200
Operation applied by the Image Processing tool at the last iteration. This property is read-only.
Type
Long
Range
Operand value (constant or Operand Image pixel) is added to

0 hsArithmeticAddition
the corresponding pixel in the input image.
Operand value (constant or Operand Image pixel) is

1 hsArithmeticSubtraction
subtracted from the corresponding pixel in the input image.
The input image pixel value is multiplied by the Operand

2 hsArithmeticMultiplication
value (constant or corresponding Operand Image pixel).
The input image pixel value is divided by the Operand value

3 hsArithmeticDivision (constant or corresponding Operand image pixel). The result
is scaled and clipped, and finally written to the output image.
The Operand value (constant or Operand Image pixel) and

4 hsArithmeticLightest corresponding pixel in the input image are compared to find
the maximal value.

5 hsArithmeticDarkest corresponding pixel in the input image are compared to find
the minimal value.
All the pixels of the output image are set to a specific

6 hsAssignmentInitialization constant value. The height and width of the output image
must be specified.
Each input image pixel is copied to the corresponding output

7 hsAssignmentCopy
image pixel.
The input image pixel value is inverted and the result is

8 hsAssignmentInversion
copied to the corresponding output image pixel.
Page 347
LastOperation
AND operation is applied to the Operand value (constant or

9 hsLogicalAnd Operand image pixel) and the corresponding pixel in the input
image.
NAND operation is applied to the Operand value (constant or

10 hsLogicalNAnd Operand image pixel) and the corresponding pixel in the input
image.
OR operation is applied to the Operand value (constant or

11 hsLogicalOr Operand image pixel) and the corresponding pixel in the input
image.
XOR operation is applied to the Operand value (constant or

12 hsLogicalXOr Operand image pixel) and the corresponding pixel in the input
image.
NOR operation is applied using the Operand value (constant

13 hsLogicalNOr or Operand image pixel) and the corresponding pixel in the
input image.
14 hsFilteringCustom Applies a Custom filter.
15 hsFilteringAverage Applies an Average filter.
16 hsFilteringLaplacian Applies a Laplacian filter.
17 hsFilteringHorizontalSobel Applies a Horizontal Sobel filter.
18 hsFilteringVerticalSobel Applies a Vertical Sobel filter.
19 hsFilteringSharpen Applies a Sharpen filter.
20 hsFilteringSharpenLow Applies a SharpenLow filter.
21 hsFilteringHorizontalPrewitt Applies a Horizontal Prewitt filter.
22 hsFilteringVerticalPrewitt Applies a Vertical Prewitt filter.
23 hsFilteringGaussian Applies Gaussian filter.
24 hsFilteringHighPass Applies High Pass filter.
25 hsFilteringMedian Applies a Median filter.
Sets each pixel in the output image as the largest luminance

26 hsMorphologicalDilate value of all the input image pixels in the neighborhood
defined by the selected kernel size.
Page 348
LastOperation
Sets each pixel in the output image as the smallest

27 hsMorphologicalErode luminance value of all the input image pixels in the
neighborhood defined by the selected kernel size.
Has the effect of removing small dark particles and holes

28 hsMorphologicalClose
within objects.
Has the effect of removing peaks from an image, leaving

29 hsMorphologicalOpen
only the image background.
Equalization operation enhances the Input Image by

30 hsHistogramEqualization
flattening the histogram of the Input Image.
Stretches (increases) the contrast in an image by applying a

31 hsHistogramStretching simple piecewise linear intensity transformation based on
the histogram of the Input Image.
Changes each pixel value depending on whether they are

less or greater than the specified threshold. If an input pixel
32 hsHistogramLightThreshold value is less than the threshold, the corresponding output
pixel is set to the minimum acceptable value. Otherwise, it is
set to the maximum presentable value.

33 hsHistogramDarkThreshold value is less than the threshold, the corresponding output
pixel is set to the maximum presentable value. Otherwise, it
is set to the minimum acceptable value.
Converts and outputs a frequency description of the input

34 hsTransformFFT
image by applying a Fast Fourier Transform (FFT).

35 hsTransformDCT image by applying a Discrete Cosine Transform
(DCT).Parameters
Page 349
LastOutputType
LastOutputType
VRESULT
2201
Type of the image output by the Image Processing tool at the last iteration. This property is read-only.
Syntax
MicroV+
V+
Type
Long
Range
1 hsType8Bits Unsigned 8-bit image.
10 hsType16Bits Signed 16-bit image.
7 hsType32Bits Signed 32-bit image
Parameters
Page 350
LastOutputType
index_id N/A

Page 351
LogicalConstant
LogicalConstant
VPARAMETER
5380
Constant applied by a logical operation when no valid operand image is specified.
Syntax
MicroV+
V+
Type
Long
Range
Minimum: -32768
Maximum: 32767
Parameters
index_id N/A
object_id N/A
Page 352
MagnitudeConstraint
MagnitudeConstraint
VPARAMETER
5226
Indexed property used to set the magnitude-constraint function for edge detection. Two points are used:
Base and Top.
Syntax
Micro V+
VPARAMETER (sequence_id, tool_id, 5226, index_id, constraint_id) = value
value = VPARAMETER (sequence_id, tool_id, 5226, index_id, constraint_id)
V+
VPARAMETER (sequence_id, tool_id, 5226, index_id, constraint_id) $ip = value
value = VPARAMETER ($ip, sequence_id, tool_id, 5226, index_id, constraint_id)
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
constraint_id One of the two points of the magnitude constraint function

(hsMagnitudeConstraintIndex)
Page 353
MagnitudeConstraint
1: Base point
2: Top point
Page 354
MagnitudeThreshold
MagnitudeThreshold
VPARAMETER
5200
Magnitude threshold sets the threshold used to find edges on the magnitude curve. In order to locate
edges, a subpixel, peak-detection algorithm is applied on the region of every minimum or maximum of the
curve that exceeds this threshold.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0
Maximum: 255
Parameters

192.168.1.120.
index_id N/A
object_id N/A
Page 355
MatchCount
MatchCount
VRESULT
2100
Number of matched patterns found. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: Unlimited
Parameters
instance_id Index of the pattern instance for which you want the result.
index_id N/A
frame_id Index of the frame containing the pattern instance for which you want the
result.
Page 356
MatchPositionX
MatchPositionX
VRESULT
2102
X-coordinate of a matched pattern in the currently-selected coordinate system. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
result.
Page 357
MatchPositionY
MatchPositionY
VRESULT
2103
Y-coordinate of a matched pattern in the currently-selected coordinate system. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
result.
Page 358
MatchQuality
MatchQuality
VRESULT
1802
Percentage of edges actually matched to the found entity (point, arc, or line). MatchQuality ranges from 0
to 1, with 1 being the best quality. A value of 1 means that edges were matched for every point along the
found entity. Similarly, a value of 0.2 means edges were matched to 20% of the points along the found
entity. This property is read-only.
Syntax
MicroV+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
index_id N/A

Page 359
MatchRotation
MatchRotation
VRESULT
2104
Rotation of a matched pattern in the currently-selected coordinate system. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
result.
Page 360
MatchStrength
MatchStrength
VPARAMETER
2101
Strength of the match matrix for the selected matched pattern. Match value ranges from 0 to 1, with 1
being the best quality. A value of 1 means that 100% of the reference pattern was successfully matched
to the found pattern instance. This property is read-only.
Syntax
MicroV+
V+
Type
Double
Range
Minimum: MatchThreshold
Maximum: 1.0
Parameter
index_id N/A
result.
Page 361
MatchThreshold
MatchThreshold
VPARAMETER
5420
Sets the minimum match strength required for a pattern to be recognized as valid. A perfect match value
is 1.
Syntax
MicroV+
V+
Remarks
Type
Double
Range
Minimum: 0.0 (weak match)
Maximum: 1.0 (strong match)
Parameters
Page 362
MatchThreshold
index_id N/A
object_id N/A
Page 363
MaximumAngleDeviation
VPARAMETER
5102
Maximum angular deviation allowed for a detected edge to be used to generate an entity hypothesis.
Syntax
MicroV+
V+
Remarks
For an arc entity, the deviation is calculated between the tangent angle of the arc at points where the
edge is matched to the arc. For a line entity, the Line Finder accepts a 20 degree deviation (default).
However, the tool uses the defined MaximumAngleDeviation value to test the hypothesis and refine
the pose of the found line.
Type
Double
Range
Minimum: 0 degrees
Maximum: 20 degrees
Parameters
Page 364
index_id N/A
object_id N/A
Page 365
MaximumBlobArea
MaximumBlobArea
VPARAMETER
5001
Maximum area for a blob. This validation criterion is used to filter out unwanted blobs from the results.
Syntax
MicroV+
V+
Type
Double
Range
0 or greater.
index_id N/A
object_id N/A
Page 366
MaximumGreylevelValue
MaximumGreylevelValue
VRESULT
1507
Highest greylevel value of all pixels in the tool region of interest that are included in the final histogram.
Pixels removed from the histogram by tails or thresholds are not included in this calculation. This property
is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
frame_id N/A
Page 367
MaximumInstanceCount
VPARAMETER
519
Maximum number of object instances that are searched for in the input greyscale Image. All of the object
instances respecting the search constraints are output, up to a maximum of MaximumInstanceCount.
They are ordered according to the InstanceOrdering property.
Syntax
MicroV+
V+
Remarks
This property is applicable only if the MaximumInstanceCountEnabled property is set to True.
Type
Double
Range
Minimum: 1
Maximum: 2000
Parameter
index_id N/A
Page 368
object_id N/A
Page 369
MaximumInstanceCountEnabled
MaximumInstanceCountEnabled
VPARAMETER
518
When True, limits the search to the number of instances set by the MaximumInstanceCount property
Syntax
MicroV+
V+
Type
Long
Range
Value Description
1 Search is limited to number of instances specified by MaximumInstanceCount.
0 Search is not limited to a set number of instances.
Parameters
index_id N/A
object_id N/A
Page 370
MaximumRotation
MaximumRotation
VPARAMETER
517
Maximum angle of rotation allowed for an object instance to be recognized.
Syntax
MicroV+
V+
Remarks
This property is applicable only if the NominalRotationEnabled property is set to False. When
MaximumRotation is lower than MinimumRotation, the search range is equivalent to MinimumRotation
to (MaximumRotation + 360 degrees).
Type
Double
Parameters
index_id N/A
object_id N/A
Page 371
MaximumScaleFactor
MaximumScaleFactor
VPARAMETER
513
Maximum scale factor allowed for an object instance to be recognized.
Syntax
MicroV+
V+
Remarks
This property is applicable only if the NominalRotation property is set to False.
Type
Double
Range
Minimum: 0.1
Maximum: 10.0
Parameters
index_id N/A
object_id N/A
Page 372
Mean
Mean
VRESULT
1500
Mean of the greylevel distribution of the pixels in the tool region of interest that are included in the final
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
object_id N/A
Page 373
MeasurementPointsCount
MeasurementPointsCount
VRESULT
2002
The number of points where the local sharpness is evaluated. When the Image Sharpness tool is executed,
it scans the region of interest and identifies a number of candidate locations (equal to
evaluated at each of the candidate locations that has a local standard deviation above
StandardDeviationThreshold. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: CandidatePointsCount
Parameters
index_id N/A
object_id N/A
Page 374
Median
Median
VRESULT
1501
Median of the greylevel distribution of the pixels in the tool region of interest that are included in the final
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
object_id N/A
Page 375
MinimumArcPercentage
MinimumArcPercentage
VPARAMETER
5142
Minimum percentage of arc contours that need to be matched for an arc hypothesis to be considered as
valid.
Syntax
MicroV+
V+
Type
Double
Range
Minimum: 1
Maximum: 100.0
index_id N/A
object_id N/A
Page 376
MinimumBlobArea
MinimumBlobArea
VPARAMETER
5000
Minimum area for a blob. This validation criterion is used to filter out unwanted blobs from the results.
Syntax
MicroV+
V+
Type
Double
Range
0 or greater.
index_id N/A
object_id N/A
Page 377
MinimumClearPercentage
MinimumClearPercentage
VPARAMETER
559
When MinimumClearPercentageEnabled is set to True, MinimumClearPercentage sets the minimum
percentage of the model bounding-box area that must be free of obstacles to consider an object instance
as valid.
Syntax
MicroV+
V+
Type
Double
Range
Minimum: 0.1 or greater.
Maximum: 100.0
Parameters
index_id N/A
object_id N/A
Page 378
MinimumClearPercentageEnabled
MinimumClearPercentageEnabled
VPARAMETER
558
When set to True, the MinimumClearPercentage constraint is applied to the search process.
Syntax
MicroV+
V+
Type
Boolean
Range
Value Description
1 The MinimumClearPercentage constraint is enabled and applied to the Search process.
0 The MinimumClearPercentage constraint is not enabled.
Parameters
index_id N/A
object_id N/A
Page 379
MinimumGreylevelValue
MinimumGreylevelValue
VRESULT
1506
Lowest greylevel value of all pixels in the tool region of interest that are included in the final histogram.
Pixels removed from the histogram by tails or thresholds are not included in this calculation. This property
is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
frame_id N/A
Page 380
MinimumLinePercentage
MinimumLinePercentage
VPARAMETER
5130
Minimum percentage of line contours that need to be matched for a line hypothesis to be considered as
valid.
Syntax
MicroV+
V+
Type
Double
Range
Minimum: 0.1
Maximum: 100.0
Parameters
index_id N/A
object_id N/A
Page 381
MinimumModelPercentage
MinimumModelPercentage
VPARAMETER
557
Minimum percentage of model contours that need to be matched in the input image in order to consider
the object instance as valid.
Syntax
MicroV+
V+
Type
Double
Range
Maximum: 100.0
Parameters
index_id N/A
object_id N/A
Page 382
MinimumRequiredFeatures
VPARAMETER
560
Minimum percentage of required features that must be recognized in order to consider the object instance
as valid.
Syntax
MicroV+
V+
Type
Double
Range
Maximum: 100.0
Remark(s)
The minimum percentage of required features is expressed in terms of the number of required features
in a model without considering the amount of contour each required feature represents in the model.
For example, if the model contains 3 required features and MinimumRequiredFeatures is set to 50%,
an instance of the object will be considered valid as long as 2 out of 3 required features are recognized.
Parameters
Page 383
index_id N/A
object_id N/A
Page 384
MinimumRotation
MinimumRotation
VPARAMETER
516
Minimum angle of rotation allowed for an object instance to be recognized.
Syntax
MicroV+
V+
Remarks
This property is applicable only if the NominalRotationEnabled property is set to False. When
MaximumRotation is lower than MinimumRotation, the search range is equivalent to MinimumRotation
to (MaximumRotation + 360 degrees).
Type
Double
Parameters
index_id N/A
object_id N/A
Page 385
MinimumScaleFactor
MinimumScaleFactor
VPARAMETER
512
Minimum scale factor allowed for an object instance to be recognized.
Syntax
MicroV+
V+
Remarks
This property is applicable only if the NominalScaleFactor property is set to False.
Type
Double
Range
Minimum: 0.1
Maximum: 10.0
Parameters
index_id N/A
object_id N/A
Page 386
Mode
Mode
VRESULT
1504
Mode of the greylevel distribution of the pixels in the tool region of interest that are included in the final
The mode is the greylevel value which corresponds to the histogram bin with the highest number of pixels.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
object_id N/A
Page 387
ModelDisambiguationEnabled
VPARAMETER
403
When set to True (default), the Locator applies disambiguation to discriminate between similar models and
similar hypotheses of a single object. When set to False, the Locator does not apply disambiguation.
Syntax
MicroV+
V+
Type
Boolean
Range
Value Description
1 Locator applies disambiguation.
0 Locator does not apply disambiguation.
Parameters
Page 388
index_id N/A
object_id N/A
Page 389
ModePixelCount
ModePixelCount
VRESULT
1505
Number of pixels in the histogram bin which corresponds to the Mode of the greylevel distribution of all
pixels in the tool region of interest that are included in the final histogram. Pixels removed from the
histogram by tails or thresholds are not included in this calculation. The mode is the greylevel value which
corresponds to the histogram bin with the highest number of pixels. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters
index_id N/A
object_id N/A
Page 390
MorphologicalNeighborhoodSize
MorphologicalNeighborhoodSize
VPARAMETER
5390
Neighborhood size applied by a morphological operation.
Syntax
MicroV+
V+
Type
Long
Range
Fixed value: 3
Parameters
index_id N/A
object_id N/A
Page 391
NominalRotation
NominalRotation
VPARAMETER
515
Required angle of rotation for an object instance to be recognized.
Syntax
MicroV+
V+
Remarks
This property is applicable only if the NominalRotationEnabled property is set to True.
Type
Double
Parameters
index_id N/A
object_id N/A
Page 392
NominalRotationEnabled
VPARAMETER
514
Specifies whether the rotation of a recognized instance must fall within the range set by MinimumRotation
and MaximumRotation or be equal to the nominal value set by the NominalRotation property. When
NominalRotationEnabled is set to True, the nominal value is applied. Otherwise, the range is used.
Syntax
MicroV+
V+
Type
Boolean
Range
Value Description
1 Locator searches for instances that meet NominalRotation constraint
Locator searches for instances within range set by MinimumRotation and

0
MaximumRotation.
Parameters
Page 393
index_id N/A
object_id N/A
Page 394
NominalScaleFactor
NominalScaleFactor
VPARAMETER
511
Required scale factor for an object instance to be recognized.
Syntax
MicroV+
V+
Remarks
This property is applicable only if the NominalScaleFactorEnabled property is set to True.
Type
Long
Range
Minimum: 0.1
Maximum: 10.0
Parameters
index_id N/A
object_id N/A
Page 395
NominalScaleFactorEnabled
VPARAMETER
510
Specifies whether the scale factor of a recognized instance must fall within the range set by
MinimumScaleFactor and MinimumScaleFactor or be equal to the nominal value set by the
NominalScaleFactor property. When NominalScaleFactorEnabled is set to True, the nominal value is
applied. Otherwise, the range is used.
Syntax
MicroV+
V+
Type
Boolean
Range
Value Description
1 Locator searches for instances that meet NominalScaleFactor constraint.
Locator searches for instances within range set by MinimumScaleFactor and

0
MaximumScaleFactor.
Parameters
Page 396
index_id N/A
object_id N/A
Page 397
Operation
Operation
VPARAMETER
5355
Operation applied by the Image Processing tool.
Syntax
MicroV+
V+
Type
Long
Range
Operand value (constant or Operand Image pixel) is added to

0 hsArithmeticAddition
the corresponding pixel in the input image.
Operand value (constant or Operand Image pixel) is

1 hsArithmeticSubtraction
subtracted from the corresponding pixel in the input image.
The input image pixel value is multiplied by the Operand

2 hsArithmeticMultiplication
value (constant or corresponding Operand Image pixel).
The input image pixel value is divided by the Operand value

3 hsArithmeticDivision (constant or corresponding Operand image pixel). The result
is scaled and clipped, and finally written to the output image.

4 hsArithmeticLightest corresponding pixel in the input image are compared to find
the maximal value.

5 hsArithmeticDarkest
corresponding pixel in the input image are compared to find
Page 398
Operation
the minimal value.
All the pixels of the output image are set to a specific

6 hsAssignmentInitialization constant value. The height and width of the output image
must be specified.
Each input image pixel is copied to the corresponding output

7 hsAssignmentCopy
image pixel.
The input image pixel value is inverted and the result is

8 hsAssignmentInversion
copied to the corresponding output image pixel.
AND operation is applied to the Operand value (constant or

9 hsLogicalAnd Operand image pixel) and the corresponding pixel in the input
image.
NAND operation is applied to the Operand value (constant or

10 hsLogicalNAnd Operand image pixel) and the corresponding pixel in the input
image.
OR operation is applied to the Operand value (constant or

11 hsLogicalOr Operand image pixel) and the corresponding pixel in the input
image.
XOR operation is applied to the Operand value (constant or

12 hsLogicalXOr Operand image pixel) and the corresponding pixel in the input
image.
NOR operation is applied using the Operand value (constant

13 hsLogicalNOr or Operand image pixel) and the corresponding pixel in the
input image.
14 hsFilteringCustom Applies a Custom filter.
15 hsFilteringAverage Applies an Average filter.
16 hsFilteringLaplacian Applies a Laplacian filter.
17 hsFilteringHorizontalSobel Applies a Horizontal Sobel filter.
18 hsFilteringVerticalSobel Applies a Vertical Sobel filter.
19 hsFilteringSharpen Applies a Sharpen filter.
20 hsFilteringSharpenLow Applies a SharpenLow filter.
21 hsFilteringHorizontalPrewitt Applies a Horizontal Prewitt filter.
Page 399
Operation
22 hsFilteringVerticalPrewitt Applies a Vertical Prewitt filter.
23 hsFilteringGaussian Applies Gaussian filter.
24 hsFilteringHighPass Applies High Pass filter.
25 hsFilteringMedian Applies a Median filter.
Sets each pixel in the output image as the largest luminance

26 hsMorphologicalDilate value of all the input image pixels in the neighborhood
defined by the selected kernel size.
Sets each pixel in the output image as the smallest

27 hsMorphologicalErode luminance value of all the input image pixels in the
neighborhood defined by the selected kernel size.
Has the effect of removing small dark particles and holes

28 hsMorphologicalClose
within objects.
Has the effect of removing peaks from an image, leaving

29 hsMorphologicalOpen
only the image background.
Equalization operation enhances the Input Image by

30 hsHistogramEqualization
flattening the histogram of the Input Image
Stretches (increases) the contrast in an image by applying a

31 hsHistogramStretching simple, piecewise, linear-intensity transformation based on
the histogram of the Input Image.

32 hsHistogramLightThreshold value is less than the threshold, the corresponding output
pixel is set to the minimum acceptable value. Otherwise, it is
set to the maximum presentable value.

33 hsHistogramDarkThreshold value is less than the threshold, the corresponding output
pixel is set to the maximum-presentable value. Otherwise, it
is set to the minimum-acceptable value.

34 hsTransformFFT
image by applying a Fast Fourier Transform (FFT).

35 hsTransformDCT image by applying a Discrete Cosine Transform
(DCT).Parameters
Page 400
Operation
Parameters
index_id N/A
object_id N/A
Page 401
Operator
Operator
VPARAMETER
5600
Logical operator applied by the Results Inspection tool.
Syntax
MicroV+
V+
Type
Long
Range
0 or 1
Range
1 AND AND operator is applied.
0 OR OR operator is applied.
Parameters
Page 402
Operator
index_id N/A
object_id N/A
Page 403
OutlineLevel
OutlineLevel
VPARAMETER
300
The coarseness of the contours at the Outline level. This property can only be set when
ParametersBasedOn is set to hsParametersCustom. Otherwise, it is read-only.
Syntax
MicroV+
V+
Remarks

Type
Long
Range
Minimum: 1
Maximum: 16
Parameters
index_id N/A
object_id N/A
Page 404
OutputArcAngle
OutputArcAngle
VRESULT
1841
Angle of the specified arc entity. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: -180
Maximum: 180 degrees
Parameters
index_id N/A
frame_id N/A
Page 405
OutputArcCenterPointX
OutputArcCenterPointX
VRESULT
1846
X-coordinate of the center point of the specified arc entity. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Unbounded
Parameters
index_id N/A
frame_id N/A
Page 406
OutputArcCenterPointY
OutputArcCenterPointY
VRESULT
1847
The Y-coordinate of the center point of the specified arc entity. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Unbounded
Parameters
index_id N/A
frame_id N/A
Page 407
OutputArcRadius
OutputArcRadius
VRESULT
1840
The radius of the specified arc entity. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Unbounded
Parameters
index_id N/A
frame_id N/A
Page 408
OutputLineAngle
OutputLineAngle
VRESULT
1820
Angle of the specified line entity. This property is read-only.
Syntax
MicroV+
V+
Type
Double
Range
Minimum: -180
Maximum: 180
Parameters
index_id N/A

Page 409
OutputLineEndPointX
OutputLineEndPointX
VRESULT
1823
X-coordinate of the end point of the specified line entity. This property is read-only.
Syntax
MicroV+
V+
Type
Double
Range
Unbounded
Parameters
index_id N/A

Page 410
OutputLineEndPointY
OutputLineEndPointY
VRESULT
1824
Y-coordinate of the end point of the specified line entity. This property is read-only.
Syntax
MicroV+
V+
Type
Double
Range
Unbounded
Parameters
index_id N/A

Page 411
OutputLineStartPointX
OutputLineStartPointX
VRESULT
1821
X-coordinate of the start point of the specified line entity. This property is read-only.
Syntax
MicroV+
V+
Type
Double
Range
Unbounded
Parameters
index_id N/A

Page 412
OutputLineStartPointY
OutputLineStartPointY
VRESULT
1822
Y-coordinate of the start point of the specified line entity. This property is read-only.
Syntax
MicroV+
V+
Type
Double
Range
Unbounded
Parameters
index_id N/A

Page 413
OutputLineVectorPointX
OutputLineVectorPointX
VRESULT
1825
X-coordinate of the vector point of the specified line entity. This property is read-only.
Syntax
MicroV+
V+
Type
Double
Range
Unbounded
Parameters
index_id N/A

Page 414
OutputLineVectorPointY
OutputLineVectorPointY
VRESULT
1826
Y-coordinate of the vector point of the specified line entity. This property is read-only.
Syntax
MicroV+
V+
Type
Double
Range
Unbounded
Parameters
index_id N/A

Page 415
OutputPointX
OutputPointX
VRESULT
1810
X-coordinate of the specified point entity. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Unbounded
Parameters
index_id N/A
frame_id N/A
Page 416
OutputPointY
OutputPointY
VRESULT
1811
Y-coordinate of the specified point entity. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Unbounded
Parameters
index_id N/A
frame_id N/A
Page 417
OutputSymmetricInstances
VPARAMETER
520
When set to True, all the symmetric poses of the object instance are output. If False, only the single best-
quality symmetric pose of the object instance is output.
Syntax
MicroV+
V+
Remarks
See also InstanceSymmetry.
Type
Boolean
Range
Value Description
1 Locator outputs all symmetrical poses of an instance.
0 Locator outputs only single best pose of an instance.
Parameters
Page 418
index_id N/A
object_id N/A
Page 419
OverrideType
OverrideType
VPARAMETER
5351
Output image type when the OverrideTypeEnabled property is set to True. By default, the Image
Processing Tool outputs all resulting images as unsigned 8-bit images.
Syntax
MicroV+
V+
Type
Long
Range
1 hsType8Bits Unsigned 8-bit image.
10 hsType16Bits Signed 16-bit image.
7 hsType32Bits Signed 32-bit image
Parameters
Page 420
OverrideType
index_id N/A
object_id N/A
Page 421
OverrideTypeEnabled
OverrideTypeEnabled
VPARAMETER
5350
Enables or disables the OverrideType property.
Syntax
MicroV+
V+
Type
Long
Range
1 Enabled The output image type is set based on the setting of OverrideType [5351].
0 Disabled The output image type is automatically set to the same type as the input image.
Parameters
index_id N/A
object_id N/A
Page 422
PairCount
PairCount
VPARAMETER
1920
PairCount indicates the number of pairs that have been configured for the tool. This property is read-only.
Syntax
Micro V+
V+
Remarks
If an edge pair is not found, results for that edge pair appear as zero. However, the PairCount property
is not affected. To get the number of pairs found by the tool use the ResultCount property.
Type
Long
Range
Minimum: 0
Maximum: Unlimited
Parameters

Page 423
PairCount
index_id N/A
frame_id N/A
Page 424
PairPositionX
PairPositionX
VRESULT
1921
X-coordinate of the center of the selected pair. The position of a pair is defined as the middle of the line
segment drawn from the X/Y-coordinates of the first and second edges of the pair. This property is read-
only.
Figure: Position of Arc Caliper and Caliper Pairs
Syntax
Micro V+
V+
Type
Long
Range
Parameters
Page 425
PairPositionX
index_id N/A
frame_id N/A
Page 426
PairPositionY
PairPositionY
VRESULT
1922
Y-coordinate of the center of the selected pair. The position of a pair is defined as the middle of the line
segment drawn from the X/Y-coordinates of the first and second edges of the pair. This property is read-
only.
Syntax
Micro V+
V+
Type
Double
Range
Parameters

192.168.1.120.
index_id N/A
frame_id N/A
Page 427
PairRotation
PairRotation
VRESULT
1923
Angle of rotation of the selected pair in the currently-selected coordinate system. The rotation of a given
pair is always the same as the rotation of its first and second edges. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: -180
Maximum: 180
Parameters

index_id N/A
frame_id N/A
Page 428
PairScore
PairScore
VRESULT
1924
Score of the selected pair. The score of the pair is equal to the mean score of the two edges (Edge1Score
and Edge2Score) that form the pair. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters

index_id N/A
frame_id N/A
Page 429
PairSize
PairSize
VRESULT
1925
Size of the selected pair. The size of the pair is equal to the mean size of the two edges (Edge1Score and
Edge2Score) that form the pair. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Greater than 0.
Parameters

index_id N/A
frame_id Frame containing the pair.
Page 430
ParametersBasedOn
ParametersBasedOn
VPARAMETER
304
Sets how the contour detection parameters are configured.
l When set to hsContourParametersAllModels, the contour detection parameters are optimized by

analyzing the parameters used to build all the models.
l When set to hsContourParametersCustom, the contour detection parameters are set manually.
l When set to a value greater than hsContourParametersCustom, the contour detection parameters
of a specific model are used.
The contour detection parameters on which this property has an effect are DetailLevel, OutlineLevel,
ContrastThresholdMode, and ContrastThreshold
Syntax
MicroV+
V+
Remarks

Type
Long
Range
Value Detection Mode Description
The contour detection parameters are optimized

-2 hsContourParametersAllModels by analyzing the parameters used to build all the
models.
Page 431
ParametersBasedOn
Value Detection Mode Description
The contour detection parameters are set

-1 hsContourParametersCustom
manually.
Integer from Integer specifying the index of a The contour detection parameters of the
1 - 10 model specified model are used.
Parameters
index_id N/A
object_id N/A
Page 432
PatternHeight
PatternHeight
VPARAMETER
5403
Height of the region of interest of the Pattern. This is the sample pattern for which the Pattern Locator
searches.
Figure: Illustration of Pattern Height and Width
Syntax
MicroV+
V+
Type
Long
Range
Greater than or equal to three pixels. Minimum size is 3x3 pixels.
Parameters
Page 433
PatternHeight
index_id N/A
object_id N/A
Page 434
PatternPositionX
PatternPositionX
VPARAMETER
5400
X-coordinate of the center of the pattern region of interest. This is the sample pattern for which the
Pattern Locator searches.
Figure: Illustration of the Pattern location
Syntax
MicroV+
V+
Type
Long
Range
Unbounded
Parameters
Page 435
PatternPositionX
index_id N/A
object_id N/A
Page 436
PatternPositionY
PatternPositionY
VPARAMETER
5401
Y-coordinate of the center of the pattern region of interest. This is the sample pattern for which the
Pattern Locator searches.
Syntax
MicroV+
V+
Type
Long
Range
Unbounded
Parameters
index_id N/A
object_id N/A
Page 437
PatternRotation
PatternRotation
VPARAMETER
5404
Angle of rotation of the pattern region of interest. This is the sample pattern for which the Pattern Locator
searches.
Figure: Illustration of Pattern Rotation
MicroV+
V+
Type
Double
Parameters
Page 438
PatternRotation
index_id N/A
object_id N/A
Page 439
PatternWidth
PatternWidth
VPARAMETER
5402
Width of the pattern region of interest.This is the sample pattern for which the Pattern Locator searches.
Figure: Illustration of Pattern Height and Width
Syntax
MicroV+
V+
Type
Long
Range
Greater than or equal to three pixels. Minimum size is 3x3 pixels.
Parameters
Page 440
PatternWidth
index_id N/A
object_id N/A
Page 441
PerimeterResultsEnabled
VPARAMETER
1602
Enables the computation of the following blob properties: BlobRawPerimeter, BlobConvexPerimeter and
BlobRoundness.
Syntax
Micro V+
V+
Type
Boolean
Range
Value Description
1 The perimeter properties will be computed.
0 No perimeter properties will be computed.
Parameters
Page 442
index_id N/A
object_id N/A
Page 443
PolarityMode
PolarityMode
VPARAMETER
5100
Selects the type of polarity accepted for finding an entity. Polarity identifies the change in greylevel values
from the tool center (inside) towards the outside.
Syntax
MicroV+
V+
Type
Long
Range
Value Mode Description
The tool searches only for arc instances occurring at a dark-to-light

0 hsDarkToLight
transition in greylevel values.
The tool searches only for arc instances occurring at a light-to-dark

1 hsLightToDark
transition in greylevel values.
The tool searches only for arc instances occurring either at a light-to-
2 hsEither
dark or dark-to-light transition in greylevel values.
The tool searches only for arc instances occurring at any transition in
3 hsDontCare greylevel values including reversals in contrast along the arc, for
example, on an unevenly colored background.
Parameters
Page 444
PolarityMode
index_id N/A
object_id N/A
Page 445
PositionConstraint
PositionConstraint
VPARAMETER
5223
Indexed property used to set the position-constraint function for edge detection. Four points are used:
Base Left, Top Left, Top Right, Base Right.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
index_id N/A
object_id N/A
Page 446
PositioningLevel
PositioningLevel
VPARAMETER
561
Configurable effort level of the instance positioning process. The value is expressed as a percentage. The
minimal allowable value is 10. Lower values will provide coarser positioning and lower execution time.
Conversely, a value of 100 will provide the highest accuracy for the positioning of object instances.
Syntax
MicroV+
V+
Type
Long
Range
Minimum: 0
Maximum: 10
Parameters
index_id N/A
object_id N/A
Page 447
ProjectionMode
ProjectionMode
VPARAMETER
140
Projection mode used by the tool to detect edges.
Figure: Projection Modes used by Arc Caliper and Arc Edge Caliper
Syntax
MicroV+
V+
Type
0 or 1
Range
Value Projection Mode Description
Annular projection is used to find edges that are aligned with the
0 hsProjectionAnnular
median annulus, such as arcs on concentric circles.
Radial projection is used to find edges aligned along radial

1 hsProjectionRadial
projections, similar to the spokes of a wheel.
Page 448
ProjectionMode
Parameters
index_id N/A
object_id N/A
Page 449
RecipeManagerActiveRecipe
RecipeManagerActiveRecipe
VPARAMETER
8001
Returns the currently selected recipe associated with the Recipe Manager.
Syntax
MicroV+
V+
Type
Real variable.
Parameters
sequence_id Index associated with the recipe manager as defined in the recipe manager
editor.
tool_id N/A
index_id N/A
object_id N/A
Page 450
RecipeManagerRecipeCount
RecipeManagerRecipeCount
VPARAMETER
8000
Returns the number of available recipes associated with the Recipe Manager.
Syntax
MicroV+
V+
Type
Real variable.
Parameters
editor.
tool_id N/A
index_id N/A
object_id N/A
Page 451
RecipeManagerRecipeSelection
RecipeManagerRecipeSelection
VPARAMETER
8002
Identifies the new recipe that will be selected when a VRUN is issued against the Recipe Manager.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Maximum: The number of available recipes - 1
Parameters
editor.
tool_id N/A
index_id N/A
object_id N/A
Page 452
RecipeManagerRecipeDelete
RecipeManagerRecipeDelete
VPARAMETER
8003
Deletes a specified recipe from a recipe manager object in the workspace.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Parameters
editor.
tool_id N/A
index_id N/A
object_id N/A
Page 453
RecipeManagerRecipeLoadFile
RecipeManagerLoadFile
VPARAMETER
8004
Load a recipe from a file into the specified recipe manager. When this command is invoked, the variable
$as.filename[0] will be read to identify the file to load. A sample showing how this is used is located in the
ASIGHT.V2 module in the program as.load.recipe.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Parameters
editor.
tool_id N/A
index_id N/A
object_id N/A
Page 454
RecipeManagerRecipeSaveFile
RecipeManagerSaveFile
VPARAMETER
8005
Saves a recipe into a file from the specified recipe manager. When this command is invoked, the variable
$as.filename[0] will be read to identify the file to save into. A sample showing how this is used is located in
the ASIGHT.V2 module in the program as.save.recipe.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Parameters
editor.
tool_id N/A
index_id N/A
object_id N/A
Page 455
RecognitionLevel
RecognitionLevel
VPARAMETER
550
Configurable effort level of the search process. A value of 0 will lead to a faster search that may miss
instances that are partly occluded. Conversely, a value of 10 is useful for finding partly occluded objects in
cluttered or noisy images, or for models made up of small features at the Outline Level.
Syntax
MicroV+
V+
Type
Long
Range
Minimum: 0
Maximum: 10
Parameters
index_id N/A
object_id N/A
Page 456
Reset
Reset
VPARAMETER
5500
Resets the data currently stored for the tool. This property is write-only.
Syntax
MicroV+
V+
Type
Long
Range
Not applicable
Parameters
index_id N/A
object_id N/A
Page 457
ResultCount
ResultCount
VRESULT
1010
Returns the total number of results found by the tool in all frames of reference. If you want the number of
results within a specified frame of reference, see FrameCount. This property is read-only.
Syntax
Micro V+
V+
Type
Long
Parameters

instance_id N/A
index_id N/A
frame_id N/A
Related Topics
FrameCount
InstanceCount
Page 458
RobotXPosition
RobotXPosition
VPARAMETER
10404
X-coordinate (in millimeters) of a location in the robot frame of reference, which is required for the
InverseKinematics property.
Syntax
MicroV+
V+
Type
Long
Parameters
index_id N/A
object_id N/A
Example
See the InverseKinematics for an example of this property and related properties
Related Properties
RobotYPosition
VisionXPosition
Page 459
RobotXPosition
VisionYPosition
VisionRotation
InverseKinematics
Page 460
RobotYPosition
RobotYPosition
VPARAMETER
10405
Y-coordinate (in millimeters) of a location in the robot frame of reference, which is required for the
Syntax
MicroV+
V+
Type
Long
Parameters
index_id N/A
object_id N/A
Example
Related Properties
RobotXPosition
VisionXPosition
Page 461
RobotYPosition
VisionYPosition
VisionRotation
InverseKinematics
Page 462
SamplingStepCustom
SamplingStepCustom
VPARAMETER
124
When SamplingStepCustomEnabled is set to True, this property defines the sampling step used to sample
the region of interest from the input image. WhenSamplingStepCustomEnabled is set to False, the default
sampling step is used.
Syntax
Micro V+
V+
Remark
A custom sampling step is usually not recommended.
Type
Single
Range
Minimum: Greater than zero.
Maximum: Boundaries of the input image.
Parameters
Page 463
SamplingStepCustom
index_id N/A
object_id N/A
Related Properties
SamplingStepCustomEnabled
Page 464
VPARAMETER
121
When enabled, the tool uses the user-defined sampling step (SamplingStepCustom) instead of the optimal
(default) sampling step to sample the region of interest from the input image.
Syntax
Micro V+
V+
Remark
A custom sampling step is usually not recommended.
Type
Boolean
Range
Value Description
0 The tool uses the default sampling step.
1 The default sampling step is overridden by SamplingStepCustom.
Parameters
Page 465
index_id N/A
object_id N/A
Related Properties
SamplingStepCustom
Page 466
SaveImage
SaveImage
VPARAMETER
10327
Saves the current image to file. Various file formats are available, including the Adept hig file format. The
hig format saves the calibration information in the image file. Files with this format can be reused in
ACE Sight applications through an Emulation device. This property is write-only.
Syntax
MicroV+
V+
Type
Long
Parameters
index_id N/A
object_id N/A
Details
This functionality can be accessed using the ACE API program "as.save.image", as follows:
.PROGRAM as.save.image($filename, $ip, seq.idx, tool_id.idx, status)
For more details on as.save.image, see the ACE Sight section of the V+ Module chapter in the
ACE Reference Guide, which can be accessed from the Help menu in the ACE software.
Page 467
ScoreThreshold
ScoreThreshold
VPARAMETER
5240
Minimum score to accept an edge. The score of an edge is returned by the EdgeScore property.
Syntax
MicroV+
V+
Remarks
Type
Double
Range
Minimum: 0.0
Maximum: 1.0
Parameters
index_id N/A
Page 468
SearchBasedOnOutlineLevelOnly
VPARAMETER
521
When set to True, the Locator positions object instances using Outline-level models. This mode can be
used to improve the speed when only a coarse positioning of object instances is required.
Syntax
MicroV+
V+
Type
Boolean
Range
Value Description
1 Only Outline-level models are used to position instances
0 Both Outline- and Detail-level models are used to position instances.
Parameters
index_id N/A
object_id N/A
Page 469
Page 470
SearchCoarseness
SearchCoarseness
VPARAMETER
5430
Subsampling level used to find pattern-match hypotheses. High values provide a coarser search and lower
execution time than lower values. If AutoCoarsenessSelectionEnabled is set to True, this property is read-
only.
Syntax
MicroV+
V+
Type
Long
Range
[1,2,4,8,16,32]
Parameters
index_id N/A
object_id N/A
Page 471
SearchMode
SearchMode
VPARAMETER
5101
Specifies the method used by a Finder tool to select a hypothesis.
Syntax
MicroV+
V+
Type
Long
Range
The range depends on the type of entity. For arcs (Arc Finder Tool), the range is:
Value Description
0 hsBestArc Selects the best arc according to hypothesis strength.
1 hsArcClosestToGuideline Selects the arc hypothesis closest to the Guideline.
Selects the arc hypothesis closest to the inside of the

2 hsArcClosestToInside
tool Search Area. (closest to the tool center).
Selects the arc hypothesis closest to the outside of

3 hsArcClosestToOutside
the tool Search Area. (furthest from the tool center)
For lines (Line Finder Tool), the range is:
Value Description
0 hsBestLine Selects the best line according to hypothesis
Page 472
SearchMode
Value Description
strength.
Selects the line hypothesis closest to the

1 hsLineClosestToGuideline
Guideline.
Selects the line hypothesis closest to the Search

2 hsLineWithMaximumNegativeXOffset
Area bound that is at maximum negative X-offset.
Selects the line hypothesis closest to the Search

3 hsLineWithMaximumPositiveXOffset
Area bound that is at maximum positive X-offset.
For points (Point Finder Tool), the range is:
Value Description
Selects the point hypothesis closest to the

1 hsPointClosestToGuideline
Guideline.

2 hsPointWithMaximumNegativeXOffset Search Area bound that is at maximum negative
X-offset.

3 hsPointWithMaximumPositiveXOffset Search Area bound that is at maximum positive X-
offset
Parameters
index_id N/A
object_id N/A
Page 473
SegmentationDark
SegmentationDark
VPARAMETER
5005
Indexed property used to access the Dark Segmentation function. Two points are available, from left to
right: Top and Bottom.
Syntax
Micro V+
VPARAMETER (sequence_id, tool_id, 5005, constraint_id, object_id) = value
value = VPARAMETER (sequence_id, tool_id, 5005, constraint_id, object_id)
V+
VPARAMETER (sequence_id, tool_id, 5005, constraint_id, object_id) $ip = value
value = VPARAMETER ($ip, sequence_id, tool_id, 5005, constraint_id, object_id)
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
constraint_id Point index for the Dark Segmentation function.

(hsSegmentationDarkPoint)
1: DarkTop point
Page 474
SegmentationDark
2: DarkBottom point
object_id N/A
Page 475
SegmentationDynamicDark
VPARAMETER
5009
Indexed property used to access the Dynamic Dark Segmentation function. Two points are available, from
left to right: Top and Bottom.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0.0
Maximum: 100.0
Parameters
constraint_id Point index for the Dynamic Dark Segmentation function.

(hsSegmentationDarkPoint)
1: DarkTop point
Page 476
2: DarkBottom point
object_id N/A
Page 477
SegmentationDynamicInside
VPARAMETER
5010
Indexed property used to access the Dynamic Inside Segmentation function. Four points are available,
from left to right: Bottom Left, Top Left, Top Right and Bottom Right.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0.0
Maximum: 100.0
Parameters
constraint_id Point index for the Dynamic Inside Segmentation.

(hsSegmentationInsidePoint)
0: hsInsideBottomLeft point
Page 478
1: hsInsideTopLeft point
2: hsInsideTopRight point
3: hsInsideBottomRight point
object_id N/A
Page 479
SegmentationDynamicLight
VPARAMETER
5008
Indexed property used to access the Dynamic Light Segmentation function. Two points are available (from
left to right): Bottom and Top.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0.0
Maximum: 100.0
Parameters
constraint_id Point index for the Dynamic Light Segmentation function.

(hsSegmentationLightPoint)
1: hsLightBottom point
Page 480
2: hsLightTop point
object_id N/A
Page 481
SegmentationDynamicOutside
VPARAMETER
5011
Indexed property used to access the Dynamic Outside Segmentation function. Four points are available,
from left to right: Top Left, Bottom Left, Bottom Right and Top Right.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0.0
Maximum: 100.0
Parameters
constraint_id Point index for the Dynamic Outside Segmentation function.

(hsSegmentationOutsidePoint)
0: hsOutsideTopLeft point
Page 482
1: hsOutsideBottomLeft point
2: hsOutsideBottomRight point
3: hsOutsideTopRight point
object_id N/A
Page 483
SegmentationInside
SegmentationInside
VPARAMETER
5006
Indexed property used to access the Inside Segmentation function. Four points are available: from left to
right, Bottom Left, Top Left, Top Right and Bottom Right.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
constraint_id Point index for the Inside Segmentation.

(hsSegmentationInsidePoint)
0: hsInsideBottomLeft point
Page 484
SegmentationInside
1: hsInsideTopLeft point
2: hsInsideTopRight point
3: hsInsideBottomRight point
object_id N/A
Page 485
SegmentationLight
SegmentationLight
VPARAMETER
5004
Indexed property used to access the Light Segmentation function. Two points are available, from left to
right: Bottom and Top.
Syntax
Micro V+
VPARAMETER (sequence_id, tool_id, 5004, index_id, constraint_id, object_id) = value
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
constraint_id Point index for the Light Segmentation function.

(hsSegmentationLightPoint)
1: hsLightBottom point
Page 486
SegmentationLight
2: hsLightTop point
object_id N/A
Page 487
SegmentationMode
SegmentationMode
VPARAMETER
5003
Segmentation mode used by the tool to segment the input image.
Syntax
Micro V+
V+
Type
Long
Range
Value Segmentation Mode
0 hsLight
1 hsDark
2 hsInside
3 hsOutside
4 hsDynamicLight
5 hsDynamicDark
6 hsDynamicInside
7 hsDynamicOutside
8 HSL Inside
9 HSL Outside
Parameters
Page 488
SegmentationMode
index_id N/A
object_id N/A
Page 489
SegmentationOutside
SegmentationOutside
VPARAMETER
5007
Indexed property used to access the Outside Segmentation function. Four points are available, from left to
right: Top Left, Bottom Left, Bottom Right and Top Right.
Syntax
Micro V+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
constraint_id Point index for the Outside Segmentation function.

(hsSegmentationOutsidePoint)
0: hsOutsideTopLeft point
Page 490
SegmentationOutside
1: hsOutsideBottomLeft point
2: hsOutsideBottomRight point
3: hsOutsideTopRight point
object_id N/A
Page 491
SequenceExecutionMode
VPARAMETER
10200
Sets the mode for execution of the sequence. When VRUN is called the sequence is run if single execution
mode is selected (0) or in continuously if continuous mode is selected.
Syntax
MicroV+
V+
Type
Long
Range
Value Execution Mode Description
0 Single execution Executes the vision sequence once.
Executes the vision sequence continuously, until the execution is

1 Continuous mode
stopped by a program instruction.
Parameters
index_id N/A
Page 492
object_id N/A
Page 493
SequenceToolCount
SequenceToolCount
VPARAMETER
10201
Returns the number of tools in the specified ACE Sightr sequence.
Syntax
MicroV+
V+
Type
Long
Parameters
ID 10201 : the value used to reference this property.
index_id N/A
object_id N/A
Page 494
Sharpness
Sharpness
VRESULT
2000
Average sharpness computed in the region of interest. When the Image Sharpness tool is executed, it
scans the region of interest and identifies a number of candidate locations (equal to
evaluated at each of the candidate locations that has a local standard deviation above
StandardDeviationThreshold. The tool then computes the average of all the local sharpness values, which
were computed at every measurement point, and returns it through the Sharpness property. This
Syntax
MicroV+
V+
Type
Double
Range
Minimum: 0
Maximum: 1000
Parameters
index_id N/A
object_id N/A
Page 495
SharpnessPeak
SharpnessPeak
VRESULT
2001
Maximum Sharpness value computed by the tool. This property is read-only.
Syntax
MicroV+
V+
Type
Double
Range
Minimum: 0
Maximum: 1000
Parameters
index_id N/A
object_id N/A
Page 496
ShowResultsGraphics
ShowResultsGraphics
VPARAMETER
150
When enabled, vision results are displayed in the image display control. When disabled, vision results are
not displayed.
Syntax
Micro V+
V+
Type
Boolean
Range
Value Description
1 Enabled: Vision results are displayed in the image display control.
0 Disabled: Vision results are not displayed.
Parameters
Page 497
ShowResultsGraphics
index_id N/A
object_id N/A
Page 498
SortBlobsBy
SortBlobsBy
VPARAMETER
1601
Sorting mode used by the tool to sort the found blobs.
Remark(s)
Default Value: 0:hsArea
Syntax
Micro V+
V+
Type
Long
Range
Value Sorting Mode

0 hsArea
1 hsBoundingBoxBottom
2 hsBoundingBoxCenterX
3 hsBoundingBoxCenterY
4 hsBoundingBoxHeight
5 hsBoundingBoxLeft
6 hsBoundingBoxRight
7 hsBoundingBoxRotation
8 hsBoundingBoxTop
Page 499
SortBlobsBy
Value Sorting Mode

9 hsBoundingBoxWidth
10 hsChainCodeDeltaX
11 hsChainCodeDeltaY
12 hsChainCodeLength
13 hsChainCodeStartX
14 hsChainCodeStartY
15 hsConvexPerimeter
16 hsElongation
17 hsExtentBottom
18 hsExtentLeft
19 hsExtentRight
20 hsExtentTop
21 hsGreyLevelMaximum
22 hsGreyLevelMean
23 hsGreyLevelMinimum
24 hsGreyLevelRange
25 hsGreyLevelStdDev
26 hsHoleCount
27 hsInertiaMaximum
28 hsInertiaMinimum
29 hsInertiaXAxis
30 hsInertiaYAxis
31 hsIntrinsicBoundingBoxBottom
32 hsIntrinsicBoundingBoxCenterX
33 hsIntrinsicBoundingBoxCenterY
34 hsIntrinsicBoundingBoxHeight
35 hsIntrinsicBoundingBoxLeft
36 hsIntrinsicBoundingBoxRight
Page 500
SortBlobsBy
Value Sorting Mode

37 hsIntrinsicBoundingBoxRotation
38 hsIntrinsicBoundingBoxTop
39 hsIntrinsicBoundingBoxWidth
40 hsIntrinsicExtentBottom
41 hsIntrinsicExtentLeft
42 hsIntrinsicExtentRight
43 hsIntrinsicExtentTop
44 hsPositionX
45 hsPositionY
46 hsPrincipalAxesRotation
47 hsRawPerimeter
48 hsRoundness
Parameters
index_id N/A
object_id N/A
Page 501
SortResultsEnabled
SortResultsEnabled
VPARAMETER
1600
Specifies if the found blobs are sorted in descending order using the sorting mode set by the SortBlobsBy
property.
Syntax
Micro V+
V+
Type
Boolean
Range
Value Description
0 Blobs are not sorted.
1 Blobs are sorted in descending order using the sorting mode set by SortBlobsBy.
Parameters
index_id N/A
object_id N/A
Page 502
StandardDeviation
StandardDeviation
VRESULT
1503
Standard deviation of the greylevel distribution of the pixels in the tool region of interest that are included
in the final histogram. Pixels removed from the histogram by tails or thresholds are not included in this
calculation. This property is read-only.
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
object_id N/A
Page 503
StandardDeviationThreshold
StandardDeviationThreshold
VPARAMETER
5302
Threshold used to validate candidate locations before computing their local sharpness. When the tool is
executed, it scans the region of interest and identifies a number of candidate locations (equal to
evaluated at each of the candidate location that has a local standard deviation above
StandardDeviationThreshold.
Syntax
Micro V+
V+
VPARAMETER (sequence_id, tool_id, 5302, index_id, object_id) $ip = value value =
VPARAMETER ($ip, sequence_id, tool_id, 5302, index_id, object_id)
Type
Double
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
object_id N/A
Page 504
SubsamplingLevel
SubsamplingLevel
VPARAMETER
5110
Subsampling level used to detect edges that are used by the tool to generate hypotheses. High values
provide a coarser search and lower execution time than lower values.
Syntax
MicroV+
V+
Type
Long
Range
Minimum: 1
Maximum: 8
Parameters
index_id N/A
object_id N/A
Page 505
TailBlack
TailBlack
VPARAMETER
5323
Amount of pixels to ignore at the dark end of the greylevel distribution in the tool region of interest.
TailBlack is expressed as a percentage of the total number of pixels in the histogram before tails are
removed. After its creation, the histogram is scanned starting from bin 0. The bins at the dark end of the
histogram are then cleared until the amount of pixels defined by TailBlack is reached.
Syntax
MicroV+
V+
Type
Double
Range
Minimum: 0
Maximum: 100
Parameters
index_id N/A
object_id N/A
Page 506
TailBlackGreylevelValue
TailBlackGreylevelValue
VRESULT
1509
Represents the darkest greylevel value that remains in the histogram after the tail is removed. Used in
conjunction with TailBlack, which is used to ignore pixels at the dark end of the greylevel distribution.
Syntax
MicroV+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
object_id N/A
Page 507
TailWhite
TailWhite
VPARAMETER
5322
Amount of pixels to ignore at the bright end of the greylevel distribution in the tool region of interest.
TailWhite is expressed as a percentage of the total number of pixels in the histogram before tails are
removed. After its creation, the histogram is scanned starting from bin 255. The bins at the bright end of
the histogram are then cleared until the amount of pixels defined by TailWhite is reached.
Syntax
MicroV+
V+
Type
Double
Range
Minimum: 0
Maximum: 100
Parameters
index_id N/A
object_id N/A
Page 508
TailWhiteGreylevelValue
TailWhiteGreylevelValue
VRESULT
1510
Represents the brightest greylevel value that remains in the histogram after the tail is removed. Used in
conjunction with TailWhite, which is used to ignore pixels at the bright end of the greylevel distribution.
Syntax
MicroV+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
object_id N/A
Page 509
ThresholdBlack
ThresholdBlack
VPARAMETER
5320
Darkest greylevel value to consider when building the histogram. Greylevel values below ThresholdBlack
are ignored during the histogram creation process. When a threshold is used and the tool is also configured
to remove a percentage of pixels at the dark tail of the histogram (see the TailBlack property), the tail-
removal process begins to scan the histogram at the bin corresponding to ThresholdBlack instead of
starting at bin 0.
Syntax
MicroV+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
object_id N/A
Page 510
ThresholdWhite
ThresholdWhite
VPARAMETER
5321
Brightest greylevel value to consider when building the histogram. Greylevel values above ThresholdWhite
are ignored during the histogram creation process. When a threshold is used and the tool is also configured
to remove a percentage of pixels at the bright tail of the histogram (see the TailWhite property), the tail
removal process begins to scan the histogram at the bin corresponding to ThresholdWhite instead of
starting at bin 255.
Syntax
MicroV+
V+
Type
Long
Range
Minimum: 0
Maximum: 255
Parameters
index_id N/A
object_id N/A
Page 511
Timeout
Timeout
VPARAMETER
501
Time (in milliseconds) after which the Locator tool aborts its search process. This timeout period does not
include the model-learning phase. When the timeout is reached and TimeoutEnabled is set to True, the
instances recognized up to the timeout are output by the Locator and the search is aborted.
Syntax
MicroV+
V+
Remarks
Due to internal and operating system latencies, it may take the Locator a few milliseconds more than
the time specified by Timeout to abort. This property is applied only when TimeoutEnabled is set to
True.
Type
Long
Range
Minimum: 1 ms
Maximum: 60,000 ms
Parameters
Page 512
Timeout
index_id N/A
object_id N/A
Page 513
TimeoutEnabled
TimeoutEnabled
VPARAMETER
500
Specifies if the timeout period set by the Timeout property will be used to limit the search time.
Syntax
MicroV+
V+
Type
Boolean
Range
Value Description
1 Search time is limited by the Timeout property.
0 Search time is not limited.
Parameters
index_id N/A
object_id N/A
Page 514
ToolGuidelineOffset
ToolGuidelineOffset
VPARAMETER
130
The radial offset of the Guideline marker from the center of the tool search area.
Syntax
MicroV+
V+
Type
Long
Range
Maximum: +0.5*ToolThickness
Maximum: -0.5*ToolThickness
Parameters
index_id N/A
object_id N/A
Page 515
ToolHeight
ToolHeight
VPARAMETER
111
Height of the tool region of interest.
Figure: Illustration of Tool Height and Width
Syntax
MicroV+
V+
Type
Double
Range
Greater than 0.
Parameters
Page 516
ToolHeight
index_id N/A
object_id N/A
ToolOpening
VPARAMETER
137
Angle between the two bounding radii of the tool sector.
Figure: Illustration of the ToolOpening Property
Syntax
MicroV+
V+
Type
Long
Page 517
ToolHeight
Parameters
index_id N/A
object_id N/A
Page 518
ToolPositionX
ToolPositionX
VPARAMETER
100
X-coordinate of the center of the tool region of interest.
Figure: Illustration of the Tool position
Syntax
MicroV+
V+
Type
Double
Range
Unbounded
Parameters
Page 519
ToolPositionX
index_id N/A
object_id N/A
Page 520
ToolPositionY
ToolPositionY
VPARAMETER
101
Y-coordinate of the center of the tool region of interest.
Syntax
MicroV+
V+
Type
Double
Range
Unbounded
Parameters
index_id N/A
object_id N/A
Page 521
ToolRadius
ToolRadius
VPARAMETER
135
The radius of the tool corresponds to the radius of the median annulus of the tool sector.
Figure: Illustration of the ToolRadius Property
Syntax
MicroV+
V+
Type
Long
Range
Greater than 0.
Parameters
Page 522
ToolRadius
index_id N/A
object_id N/A
Page 523
ToolRotation
ToolRotation
VPARAMETER
112
Angle of rotation of the tool region of interest.
Figure: Illustration of Tool Rotation
MicroV+
V+
Type
Double
Parameters
index_id N/A
Page 524
ToolRotation
object_id N/A
Page 525
ToolSkew
ToolSkew
VPARAMETER
113
Skew angle of the tool region of interest. The angle of skew is defined as the angle between the Y-axis of an
orthogonal Tool coordinate system and the Y-axis of the skewed Tool coordinate system.
The Edge Locator tool and the Caliper tool search for edges that are parallel to the X-axis of the tool.
Skewing allows positioning of the tool to match the inclination of features within an object.
Figure: Illustration of the tool skew and image of use on an object
Syntax
MicroV+
V+
Type
Double
Range
Minimum: -90 degrees.
Maximum: +90 degrees.
Parameters
Page 526
ToolSkew
index_id N/A
object_id N/A
Page 527
ToolThickness
ToolThickness
VPARAMETER
136
Distance between the two bounding annuli of the tool region of interest.
Figure: Illustration of the ToolThickness Property
Syntax
MicroV+
V+
Type
Long
Range
1 or greater.
Parameters
Page 528
ToolThickness
index_id N/A
object_id N/A
Page 529
ToolWidth
ToolWidth
VPARAMETER
110
Width of the tool region of interest.
Figure: Illustration of Tool Height and Width
Syntax
MicroV+
V+
Type
Double
Range
Greater than 0.
Parameters
Page 530
ToolWidth
index_id N/A
object_id N/A
Page 531
TopologicalResultsEnabled
TopologicalResultsEnabled
VPARAMETER
1609
Enables the computation of the BlobHoleCount property.
Syntax
Micro V+
V+
Type
Boolean
Range
Value Description
1 The topological properties will be computed.
0 No topological properties will be computed.
Parameters
index_id N/A
object_id N/A
Page 532
TransformFlags
TransformFlags
VPARAMETER
5395
Sets the flag used by a transform operation, either FFT or DCT.
Syntax
MicroV+
V+
Type
Long
Range
Value Transform Flag Type Description
0 TransformFlag2DLinear Transform results output in linear 2D format
1 hsTransformFlag2DLogarithmic Transform results in logarithmic scale
2 hsTransformFlag1DLinear Transform results in 1D linear format
3 hsTransformFlagHistogram Transform results as histogram
Parameters
Page 533
TransformFlags
index_id N/A
object_id N/A
Page 534
UseDefaultConformityTolerance
VPARAMETER
551
Specifies whether the default conformity tolerance returned by the DefaultConformityTolerance is used
instead of the user-defined conformity tolerance set by the ConformityTolerance property. When set to
True, the default conformity tolerance is used.
Syntax
MicroV+
V+
Type
Boolean
Range
Value Description
1 DefaultConformityToleranceRange is enabled.
0 DefaultConformityToleranceRange is disabled.
Parameters
index_id N/A
Page 535
object_id N/A
Page 536
Variance
Variance
VRESULT
1502
Variance of the greylevel distribution of the pixels in the tool region of interest that are included in the final
Syntax
Micro V+
V+
Type
Double
Range
Minimum: 0
Maximum: 65535
Parameters
index_id N/A
object_id N/A
Page 537
VideoExposure
VideoExposure
VPARAMETER
5502
Reads and writes the exposure setting for the active settings object relative to a camera.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Maximum: 32767
Parameters
Page 538
VideoGain
VideoGain
VPARAMETER
5503
Reads and writes the gain setting for the active settings object relative to a camera.
Syntax
MicroV+
V+
Type
Real variable.
Range
Minimum: 0
Maximum: 32767
Parameters
Page 539
VisionOriginBelt
VisionOriginBelt
VLOCATION
10052
Origin of the vision frame of reference, which was defined during the calibration. It is expressed as a
transform relative to the Belt frame of reference. This property is read-only.
Syntax
V+
MicroV+
Not applicable. Conveyor tracking is supported only in V+.
Type
Location
Parameters
Page 540
VisionOriginBelt
Related Properties
ImageOriginBelt
ImageOriginRobot
VisionOriginRobot
Page 541
VisionOriginRobot
VisionOriginRobot
VLOCATION
10050
Origin of the vision frame of reference, which was defined during the calibration. It is expressed as a
transform relative to the robot frame of reference. This property is read-only.
Syntax
MicroV+
V+
Type
Location
Parameters
Page 542
VisionOriginRobot
Related Properties
ImageOriginBelt
ImageOriginRobot
VisionOriginBelt
Page 543
VisionRotation
VisionRotation
VPARAMETER
10403
Specifies the rotation required to define the InverseKinematics property for a tool-mounted camera. This
rotation is defined by the angle between the robot X-axis and the vision X-axis.
Figure: Illustration of the VisionRotation Angle
Syntax
MicroV+
V+
Type
Double
Parameters
Page 544
VisionRotation
index_id N/A
object_id N/A
Example
See the InverseKinematics for an example of this property and related properties.
Related Properties
InverseKinematics
RobotXPosition
RobotYPosition
VisionXPosition
VisionYPosition
Page 545
VisionXPosition
VisionXPosition
VPARAMETER
10401
X-coordinate (in millimeters) of a position in the vision frame of reference, which is required for the
Syntax
MicroV+
V+
Type
Double
Parameters
index_id N/A
object_id N/A
Example
Related Properties
InverseKinematics
RobotXPosition
Page 546
VisionXPosition
VisionRotation
VisionYPosition
Page 547
VisionYPosition
VisionYPosition
VPARAMETER
10402
Y-coordinate (in millimeters) of a position in the vision frame of reference, which is required for the
Syntax
MicroV+
V+
Type
Double
Parameters
index_id N/A
object_id N/A
Example
Related Properties
InverseKinematics
RobotXPosition
Page 548
VisionYPosition
RobotYPosition
VisionRotation
VisionXPosition
Page 549
ACE Sight Quick Reference
ACE Sight Properties Quick Reference

The following lookup tables provide a quick reference for ACE Sight properties.
• Property Name: The name of the property or method.
• Keyword: The V+/ MicroV+ keyword that must be used to access the property or method.
• ID: The identifier parameter required by the V+/MicroV+ keyword to access the property or
method.
There are two ways to locate the information:
• Search for Properties by Name
• Search for Properties by ID
Search for Properties by Name
A B C D E F G
H I K L M N O
P R S T V
Table 1 Global List of ACE Sight Properties - Sorted by Property Name
Property Name V+/MicroV+ Keyword Property ID

Abort VPARAMETER 5501
ActiveCalibration VPARAMETER 5504
ActiveSettings VPARAMETER 5505
ArcMustBeTotallyEnclosed VPARAMETER 5141
ArithmeticClippingMode VPARAMETER 5360
ArithmeticConstant VPARAMETER 5361
ArithmeticScale VPARAMETER 5362
AssignmentConstant VPARAMETER 5365
AssignmentHeight VPARAMETER 5366
AssignmentWidth VPARAMETER 5367
Page 550

AutoCoarsenessSelectionEnabled VPARAMETER 5421
AutomaticCandidateCountEnabled VPARAMETER 5301
AverageContrast VRESULT 1801
BeltCalibrationDownstreamLimit VLOCATION 10002
BeltCalibrationFrame VLOCATION 10000
BeltCalibrationNearsideLimit VLOCATION 10003
BeltCalibrationScale VPARAMETER 10004
BeltCalibrationUpstreamLimit VLOCATION 10001
BeltLatchCalibrationOffset VLOCATION 10010
BilinearInterpolationEnabled VPARAMETER 120
BlobArea VRESULT 1611
BlobBoundingBoxBottom VRESULT 1648
BlobBoundingBoxCenterX VRESULT 1624
BlobBoundingBoxCenterY VRESULT 1625
BlobBoundingBoxHeight VRESULT 1626
BlobBoundingBoxLeft VRESULT 1645
BlobBoundingBoxRight VRESULT 1646
BlobBoundingBoxRotation VRESULT 1649
BlobBoundingBoxTop VRESULT 1647
BlobBoundingBoxWidth VRESULT 1627
BlobChainCode VRESULT 1656
BlobChainCodeDeltaX VRESULT 1659
BlobChainCodeDeltaY VRESULT 1660
BlobChainCodeLength VRESULT 1655
BlobChainCodeStartX VRESULT 1657
BlobChainCodeStartY VRESULT 1658
BlobConvexPerimeter VRESULT 1614
BlobCount VRESULT 1610
BlobElongation VRESULT 1616
BlobExtentBottom VRESULT 1653
Page 551

BlobExtentLeft VRESULT 1650
BlobExtentRight VRESULT 1651
BlobExtentTop VRESULT 1652
BlobGreyLevelMaximum VRESULT 1622
BlobGreyLevelMean VRESULT 1618
BlobGreyLevelMinimum VRESULT 1621
BlobGreyLevelRange VRESULT 1619
BlobGreyLevelStdDev VRESULT 1620
BlobHoleCount VRESULT 1654
BlobInertiaMaximum VRESULT 1633
BlobInertiaMinimum VRESULT 1632
BlobInertiaXAxis VRESULT 1634
BlobInertiaYAxis VRESULT 1635
BlobIntrinsicBoundingBoxBottom VRESULT 1639
BlobIntrinsicBoundingBoxCenterX VRESULT 1628
BlobIntrinsicBoundingBoxCenterY VRESULT 1629
BlobIntrinsicBoundingBoxHeight VRESULT 1630
BlobIntrinsicBoundingBoxLeft VRESULT 1636
BlobIntrinsicBoundingBoxRight VRESULT 1637
BlobIntrinsicBoundingBoxRotation VRESULT 1640
BlobIntrinsicBoundingBoxTop VRESULT 1638
BlobIntrinsicBoundingBoxWidth VRESULT 1631
BlobIntrinsicExtentBottom VRESULT 1644
BlobIntrinsicExtentLeft VRESULT 1641
BlobIntrinsicExtentRight VRESULT 1642
BlobIntrinsicExtentTop VRESULT 1643
BlobPositionX VRESULT 1612
BlobPositionY VRESULT 1613
BlobPrincipalAxesRotation VRESULT 1617
BlobRawPerimeter VRESULT 1615
Page 552

BlobRoundness VRESULT 1623
CalibratedUnitsEnabled VPARAMETER 103
CandidatePointsCount VPARAMETER 5300
ChainCodeResultsEnabled VPARAMETER 1607
ColorFilterCount VPARAMETER 5700
ColorFilterMatchPixelCount VRESULT 2502
ColorFilterMatchQuality VRESULT 2501
CommunicationToolResults VPARAMETER 2600
ConformityTolerance VPARAMETER 556
ConformityToleranceRangeEnabled VPARAMETER 553
Connectivity VPARAMETER 5120
Constraints VPARAMETER 5220
ContrastPolarity VPARAMETER 522
ContrastThreshold VPARAMETER 303
ContrastThresholdMode VPARAMETER 302
DefaultConformityTolerance VPARAMETER 552
DetailLevel VPARAMETER 301
Edge1Constraints VPARAMETER 5221
Edge1Magnitude VRESULT 1940
Edge1MagnitudeConstraint VPARAMETER 5227
Edge1MagnitudeScore VRESULT 1942
Edge1PolarityMode VPARAMETER 5211
Edge1PositionConstraint VPARAMETER 5224
Edge1PositionScore VRESULT 1944
Edge1PositionX VRESULT 1946
Edge1PositionY VRESULT 1947
Edge1Radius VRESULT 1954
Edge1Rotation VRESULT 1950
Edge1Score VRESULT 1952
Edge1ScoreThreshold VPARAMETER 5241
Page 553

Edge2Constraints VPARAMETER 5222
Edge2Magnitude VRESULT 1941
Edge2MagnitudeConstraint VPARAMETER 5228
Edge2MagnitudeScore VRESULT 1943
Edge2PolarityMode VPARAMETER 5212
Edge2PositionConstraint VPARAMETER 5225
Edge2PositionScore VRESULT 1945
Edge2PositionX VRESULT 1948
Edge2PositionY VRESULT 1949
Edge2Radius VRESULT 1955
Edge2Rotation VRESULT 1951
Edge2Score VRESULT 1953
Edge2ScoreThreshold VPARAMETER 5242
EdgeCount VRESULT 1900
EdgeFilterHalfWidth VPARAMETER 5203
EdgeMagnitude VRESULT 1901
EdgeMagnitudeScore VRESULT 1902
EdgeMagnitudeThreshold VPARAMETER 5201
EdgePolarityMode VPARAMETER 5210
EdgePositionScore VRESULT 1903
EdgePositionX VRESULT 1904
EdgePositionY VRESULT 1905
EdgeRadius VRESULT 1908
EdgeRotation VRESULT 1906
EdgeScore VRESULT 1907
EdgeSortResultsEnabled VPARAMETER 5243
ElapsedTime VRESULT 1001
ExtrinsicInertiaResultsEnabled VPARAMETER 1604
FilterCount VPARAMETER 5601
FilterHalfWidth VPARAMETER 5202
Page 554

FilterHueTolerance VPARAMETER 5716
FilterHueValue VPARAMETER 5713
FilteringClippingMode VPARAMETER 5370
FilteringKernelSize VPARAMETER 5371
FilteringScale VPARAMETER 5372
FilterLuminanceTolerance VPARAMETER 5718
FilterLuminanceValue VPARAMETER 5715
FilterSaturationTolerance VPARAMETER 5717
FilterSaturationValue VPARAMETER 5714
FitMode VPARAMETER 5140
FitQuality VRESULT 1803
Found VRESULT 1800
FrameCount VRESULT 2410
FrameIntrinsicBoundingBox VRESULT 2420
FrameRotation VRESULT 2402
FrameTranslationX VRESULT 2400
FrameTranslationY VRESULT 2401
GreylevelRange VRESULT 1508
GreyLevelResultsEnabled VPARAMETER 1608
GripperInputClose VPARAMETER 5515
GripperInputExtend VPARAMETER 5518
GripperInputOpen VPARAMETER 5514
GripperInputRetract VPARAMETER 5519
GripperOffset VLOCATION 10100
GripperOutputClose VPARAMETER 5512
GripperOutputExtend VPARAMETER 5516
GripperOutputOpen VPARAMETER 5511
GripperOutputRelease VPARAMETER 5513
GripperOutputRetract VPARAMETER 5517
GripperToolTransform VLOCATION 11000
Histogram VRESULT 1511
Page 555

HistogramPixelCount VRESULT 1512
HistogramThreshold VPARAMETER 5385
HoleFillingEnabled VPARAMETER 5002
ImageHeight VRESULT 1021
ImageOriginBelt VLOCATION 10053
ImageOriginRobot VLOCATION 10051
ImagePixelCount VRESULT 1513
ImageSubsampling VPARAMETER 5324
ImageWidth VRESULT 1020
InspectionFilterMeasuredValue VRESULT 2700
InspectionFilterPassStatus VRESULT 2702
InstanceClearQuality VRESULT 1319
InstanceCount VRESULT 1310
InstanceFitQuality VRESULT 1317
InstanceIntrinsicBoundingBox VRESULT 1330
InstanceLocation VLOCATION 1311
InstanceLocationGripperOffsetMaximum VLOCATION 1499
InstanceLocationGripperOffsetMinimum VLOCATION 1400
InstanceMatchQuality VRESULT 1318
InstanceModel VRESULT 1312
InstanceOrdering VPARAMETER 530
InstanceOrderingReferenceX VPARAMETER 531
InstanceOrderingReferenceY VPARAMETER 532
InstanceRobotLocation VLOCATION 1371
InstanceRotation VRESULT 1314
InstanceScaleFactor VRESULT 1313
InstanceSymmetry VRESULT 1320
InstanceTime VRESULT 1322
InstanceToolOffset VLOCATION 1372
InstanceTranslationX VRESULT 1315
Page 556

InstanceTranslationY VRESULT 1316
InstanceVisible VRESULT 1321
InstanceVisionOffset VLOCATION 1373
InterpolatePositionMode VPARAMETER 5122
InterpolatePositionModeEnabled VPARAMETER 5123
IntrinsicBoxResultsEnabled VPARAMETER 1605
InverseKinematics VPARAMETER 10060
KernelSize VPARAMETER 5304
LastOperation VRESULT 2200
LastOutputType VRESULT 2201
LogicalConstant VPARAMETER 5380
MagnitudeConstraint VPARAMETER 5226
MagnitudeThreshold VPARAMETER 5200
MatchCount VRESULT 2100
MatchPositionX VRESULT 2102
MatchPositionY VRESULT 2103
MatchQuality VRESULT 1802
MatchRotation VRESULT 2104
MatchStrength VRESULT 2101
MatchThreshold VPARAMETER 5420
MaximumAngleDeviation VPARAMETER 5102
MaximumBlobArea VPARAMETER 5001
MaximumGreylevelValue VRESULT 1507
MaximumInstanceCount VPARAMETER 519
MaximumInstanceCountEnabled VPARAMETER 518
MaximumRotation VPARAMETER 517
MaximumScaleFactor VPARAMETER 513
Mean VRESULT 1500
MeasurementPointsCount VRESULT 2002
Median VRESULT 1501
Page 557

MinimumArcPercentage VPARAMETER 5142
MinimumBlobArea VPARAMETER 5000
MinimumClearPercentage VPARAMETER 559
MinimumClearPercentageEnabled VPARAMETER 558
MinimumGreylevelValue VRESULT 1506
MinimumLinePercentage VPARAMETER 5130
MinimumModelPercentage VPARAMETER 557
MinimumRequiredFeatures VPARAMETER 560
MinimumRotation VPARAMETER 516
MinimumScaleFactor VPARAMETER 512
Mode VRESULT 1504
ModelDisambiguationEnabled VPARAMETER 403
ModePixelCount VRESULT 1505
MorphologicalNeighborhoodSize VPARAMETER 5390
NominalRotation VPARAMETER 515
NominalRotationEnabled VPARAMETER 514
NominalScaleFactor VPARAMETER 511
NominalScaleFactorEnabled VPARAMETER 510
Operation VPARAMETER 5355
Operator VPARAMETER 5600
OutlineLevel VPARAMETER 300
OutputArcAngle VRESULT 1841
OutputArcCenterPointX VRESULT 1846
OutputArcCenterPointY VRESULT 1847
OutputArcRadius VRESULT 1840
OutputLineAngle VRESULT 1820
OutputLineEndPointX VRESULT 1823
OutputLineEndPointY VRESULT 1824
OutputLineStartPointX VRESULT 1821
OutputLineStartPointY VRESULT 1822
Page 558

OutputLineVectorPointX VRESULT 1825
OutputLineVectorPointY VRESULT 1826
OutputPointX VRESULT 1810
OutputPointY VRESULT 1811
OutputSymmetricInstances VPARAMETER 520
OverrideType VPARAMETER 5351
OverrideTypeEnabled VPARAMETER 5350
PairCount VRESULT 1920
PairPositionX VRESULT 1921
PairPositionY VRESULT 1922
PairRotation VRESULT 1923
PairScore VRESULT 1924
PairSize VRESULT 1925
ParametersBasedOn VPARAMETER 304
PatternHeight VPARAMETER 5403
PatternPositionX VPARAMETER 5400
PatternPositionY VPARAMETER 5401
PatternRotation VPARAMETER 5404
PatternWidth VPARAMETER 5402
PerimeterResultsEnabled VPARAMETER 1602
PolarityMode VPARAMETER 5100
PositionConstraint VPARAMETER 5223
PositioningLevel VPARAMETER 561
ProjectionMode VPARAMETER 140
RecognitionLevel VPARAMETER 550
Reset VPARAMETER 5500
ResultCount VRESULT 1010
RobotXPosition VPARAMETER 10404
RobotYPosition VPARAMETER 10405
SamplingStepCustom VPARAMETER 124
Page 559

SamplingStepCustomEnabled VPARAMETER 121
SaveImage VPARAMETER 10327
ScoreThreshold VPARAMETER 5240
SearchBasedOnOutlineLevelOnly VPARAMETER 521
SearchCoarseness VPARAMETER 5430
SearchMode VPARAMETER 5101
SegmentationDark VPARAMETER 5005
SegmentationDynamicDark VPARAMETER 5009
SegmentationDynamicInside VPARAMETER 5010
SegmentationDynamicLight VPARAMETER 5008
SegmentationDynamicOutside VPARAMETER 5011
SegmentationInside VPARAMETER 5006
SegmentationLight VPARAMETER 5004
SegmentationMode VPARAMETER 5003
SegmentationOutside VPARAMETER 5007
SequenceExecutionMode VPARAMETER 10200
Sharpness VRESULT 2000
SharpnessPeak VRESULT 2001
ShowResultsGraphics VPARAMETER 150
SortBlobsBy VPARAMETER 1601
SortResultsEnabled VPARAMETER 1600
StandardDeviation VRESULT 1503
StandardDeviationThreshold VPARAMETER 5302
SubsamplingLevel VPARAMETER 5110
TailBlack VPARAMETER 5323
TailBlackGreylevelValue VRESULT 1509
TailWhite VPARAMETER 5322
TailWhiteGreylevelValue VRESULT 1510
ThresholdBlack VPARAMETER 5320
ThresholdWhite VPARAMETER 5321
Page 560

Timeout VPARAMETER 501
TimeoutEnabled VPARAMETER 500
ToolGuidelineOffset VPARAMETER 130
ToolHeight VPARAMETER 111
ToolOpening VPARAMETER 137
ToolPositionX VPARAMETER 100
ToolPositionY VPARAMETER 101
ToolRadius VPARAMETER 135
ToolRotation VPARAMETER 112
ToolSkew VPARAMETER 113
ToolThickness VPARAMETER 136
ToolWidth VPARAMETER 110
TopologicalResultsEnabled VPARAMETER 1609
TransformFlags VPARAMETER 5395
Variance VRESULT 1502
VideoExposure VPARAMETER 5502
VideoGain VPARAMETER 5503
VisionOriginBelt VLOCATION 10052
VisionOriginRobot VLOCATION 10050
VisionRotation VPARAMETER 10403
VisionXPosition VPARAMETER 10401
VisionYPosition VPARAMETER 10402
Search for Properties by ID

Table 2 Global List of ACE Sight Properties - Sorted by Property ID
Property ID Property Name V+/MicroV+ Keyword

100 ToolPositionX VPARAMETER
101 ToolPositionY VPARAMETER
103 CalibratedUnitsEnabled VPARAMETER
110 ToolWidth VPARAMETER
Page 561

111 ToolHeight VPARAMETER
112 ToolRotation VPARAMETER
113 ToolSkew VPARAMETER
120 BilinearInterpolationEnabled VPARAMETER
121 SamplingStepCustomEnabled VPARAMETER
124 SamplingStepCustom VPARAMETER
130 ToolGuidelineOffset VPARAMETER
135 ToolRadius VPARAMETER
136 ToolThickness VPARAMETER
137 ToolOpening VPARAMETER
140 ProjectionMode VPARAMETER
150 ShowResultsGraphics VPARAMETER
300 OutlineLevel VPARAMETER
301 DetailLevel VPARAMETER
302 ContrastThresholdMode VPARAMETER
303 ContrastThreshold VPARAMETER
304 ParametersBasedOn VPARAMETER
403 ModelDisambiguationEnabled VPARAMETER
500 TimeoutEnabled VPARAMETER
501 Timeout VPARAMETER
510 NominalScaleFactorEnabled VPARAMETER
511 NominalScaleFactor VPARAMETER
512 MinimumScaleFactor VPARAMETER
513 MaximumScaleFactor VPARAMETER
514 NominalRotationEnabled VPARAMETER
515 NominalRotation VPARAMETER
516 MinimumRotation VPARAMETER
517 MaximumRotation VPARAMETER
518 MaximumInstanceCountEnabled VPARAMETER
519 MaximumInstanceCount VPARAMETER
Page 562

520 OutputSymmetricInstances VPARAMETER
521 SearchBasedOnOutlineLevelOnly VPARAMETER
522 ContrastPolarity VPARAMETER
530 InstanceOrdering VPARAMETER
531 InstanceOrderingReferenceX VPARAMETER
532 InstanceOrderingReferenceY VPARAMETER
550 RecognitionLevel VPARAMETER
552 DefaultConformityTolerance VPARAMETER
553 ConformityToleranceRangeEnabled VPARAMETER
556 ConformityTolerance VPARAMETER
557 MinimumModelPercentage VPARAMETER
558 MinimumClearPercentageEnabled VPARAMETER
559 MinimumClearPercentage VPARAMETER
560 MinimumRequiredFeatures VPARAMETER
561 PositioningLevel VPARAMETER
1001 ElapsedTime VRESULT
1010 ResultCount VRESULT
1020 ImageWidth VRESULT
1021 ImageHeight VRESULT
1310 InstanceCount VRESULT
1311 InstanceLocation VLOCATION
1312 InstanceModel VRESULT
1313 InstanceScaleFactor VRESULT
1314 InstanceRotation VRESULT
1315 InstanceTranslationX VRESULT
1316 InstanceTranslationY VRESULT
1317 InstanceFitQuality VRESULT
1318 InstanceMatchQuality VRESULT
1319 InstanceClearQuality VRESULT
1320 InstanceSymmetry VRESULT
Page 563

1321 InstanceVisible VRESULT
1322 InstanceTime VRESULT
1330 InstanceIntrinsicBoundingBox VRESULT
1371 InstanceRobotLocation VLOCATION
1372 InstanceToolOffset VLOCATION
1373 InstanceVisionOffset VLOCATION
1400 InstanceLocationGripperOffsetMinimum VLOCATION
1499 InstanceLocationGripperOffsetMaximum VLOCATION
1500 Mean VRESULT
1501 Median VRESULT
1502 Variance VRESULT
1503 StandardDeviation VRESULT
1504 Mode VRESULT
1505 ModePixelCount VRESULT
1506 MinimumGreylevelValue VRESULT
1507 MaximumGreylevelValue VRESULT
1508 GreylevelRange VRESULT
1509 TailBlackGreylevelValue VRESULT
1510 TailWhiteGreylevelValue VRESULT
1511 Histogram VRESULT
1512 HistogramPixelCount VRESULT
1513 ImagePixelCount VRESULT
1600 SortResultsEnabled VPARAMETER
1601 SortBlobsBy VPARAMETER
1602 PerimeterResultsEnabled VPARAMETER
1604 ExtrinsicInertiaResultsEnabled VPARAMETER
1605 IntrinsicBoxResultsEnabled VPARAMETER
1607 ChainCodeResultsEnabled VPARAMETER
1608 GreyLevelResultsEnabled VPARAMETER
1609 TopologicalResultsEnabled VPARAMETER
Page 564

1610 BlobCount VRESULT
1611 BlobArea VRESULT
1612 BlobPositionX VRESULT
1613 BlobPositionY VRESULT
1614 BlobConvexPerimeter VRESULT
1615 BlobRawPerimeter VRESULT
1616 BlobElongation VRESULT
1617 BlobPrincipalAxesRotation VRESULT
1618 BlobGreyLevelMean VRESULT
1619 BlobGreyLevelRange VRESULT
1620 BlobGreyLevelStdDev VRESULT
1621 BlobGreyLevelMinimum VRESULT
1622 BlobGreyLevelMaximum VRESULT
1623 BlobRoundness VRESULT
1624 BlobBoundingBoxCenterX VRESULT
1625 BlobBoundingBoxCenterY VRESULT
1626 BlobBoundingBoxHeight VRESULT
1627 BlobBoundingBoxWidth VRESULT
1628 BlobIntrinsicBoundingBoxCenterX VRESULT
1629 BlobIntrinsicBoundingBoxCenterY VRESULT
1630 BlobIntrinsicBoundingBoxHeight VRESULT
1631 BlobIntrinsicBoundingBoxWidth VRESULT
1632 BlobInertiaMinimum VRESULT
1633 BlobInertiaMaximum VRESULT
1634 BlobInertiaXAxis VRESULT
1635 BlobInertiaYAxis VRESULT
1636 BlobIntrinsicBoundingBoxLeft VRESULT
1637 BlobIntrinsicBoundingBoxRight VRESULT
1638 BlobIntrinsicBoundingBoxTop VRESULT
1639 BlobIntrinsicBoundingBoxBottom VRESULT
Page 565

1640 BlobIntrinsicBoundingBoxRotation VRESULT
1641 BlobIntrinsicExtentLeft VRESULT
1642 BlobIntrinsicExtentRight VRESULT
1643 BlobIntrinsicExtentTop VRESULT
1644 BlobIntrinsicExtentBottom VRESULT
1645 BlobBoundingBoxLeft VRESULT
1646 BlobBoundingBoxRight VRESULT
1647 BlobBoundingBoxTop VRESULT
1648 BlobBoundingBoxBottom VRESULT
1649 BlobBoundingBoxRotation VRESULT
1650 BlobExtentLeft VRESULT
1651 BlobExtentRight VRESULT
1652 BlobExtentTop VRESULT
1653 BlobExtentBottom VRESULT
1654 BlobHoleCount VRESULT
1655 BlobChainCodeLength VRESULT
1656 BlobChainCode VRESULT
1657 BlobChainCodeStartX VRESULT
1658 BlobChainCodeStartY VRESULT
1659 BlobChainCodeDeltaX VRESULT
1660 BlobChainCodeDeltaY VRESULT
1800 Found VRESULT
1801 AverageContrast VRESULT
1802 MatchQuality VRESULT
1803 FitQuality VRESULT
1810 OutputPointX VRESULT
1811 OutputPointY VRESULT
1820 OutputLineAngle VRESULT
1821 OutputLineStartPointX VRESULT
1822 OutputLineStartPointY VRESULT
Page 566

1823 OutputLineEndPointX VRESULT
1824 OutputLineEndPointY VRESULT
1825 OutputLineVectorPointX VRESULT
1826 OutputLineVectorPointY VRESULT
1840 OutputArcRadius VRESULT
1841 OutputArcAngle VRESULT
1846 OutputArcCenterPointX VRESULT
1847 OutputArcCenterPointY VRESULT
1900 EdgeCount VRESULT
1901 EdgeMagnitude VRESULT
1902 EdgeMagnitudeScore VRESULT
1903 EdgePositionScore VRESULT
1904 EdgePositionX VRESULT
1905 EdgePositionY VRESULT
1906 EdgeRotation VRESULT
1907 EdgeScore VRESULT
1908 EdgeRadius VRESULT
1920 PairCount VRESULT
1921 PairPositionX VRESULT
1922 PairPositionY VRESULT
1923 PairRotation VRESULT
1924 PairScore VRESULT
1925 PairSize VRESULT
1940 Edge1Magnitude VRESULT
1941 Edge2Magnitude VRESULT
1942 Edge1MagnitudeScore VRESULT
1943 Edge2MagnitudeScore VRESULT
1944 Edge1PositionScore VRESULT
1945 Edge2PositionScore VRESULT
1946 Edge1PositionX VRESULT
Page 567

1947 Edge1PositionY VRESULT
1948 Edge2PositionX VRESULT
1949 Edge2PositionY VRESULT
1950 Edge1Rotation VRESULT
1951 Edge2Rotation VRESULT
1952 Edge1Score VRESULT
1953 Edge2Score VRESULT
1954 Edge1Radius VRESULT
1955 Edge2Radius VRESULT
2000 Sharpness VRESULT
2001 SharpnessPeak VRESULT
2002 MeasurementPointsCount VRESULT
2100 MatchCount VRESULT
2101 MatchStrength VRESULT
2102 MatchPositionX VRESULT
2103 MatchPositionY VRESULT
2104 MatchRotation VRESULT
2200 LastOperation VRESULT
2201 LastOutputType VRESULT
2400 FrameTranslationX VRESULT
2401 FrameTranslationY VRESULT
2402 FrameRotation VRESULT
2410 FrameCount VRESULT
2420 FrameIntrinsicBoundingBox VRESULT
2501 ColorFilterMatchQuality VRESULT
2502 ColorFilterMatchPixelCount VRESULT
2600 CommunicationToolResults VPARAMETER
2700 InspectionFilterMeasuredValue VRESULT
2702 InspectionFilterPassStatus VRESULT
5000 MinimumBlobArea VPARAMETER
Page 568

5001 MaximumBlobArea VPARAMETER
5002 HoleFillingEnabled VPARAMETER
5003 SegmentationMode VPARAMETER
5004 SegmentationLight VPARAMETER
5005 SegmentationDark VPARAMETER
5006 SegmentationInside VPARAMETER
5007 SegmentationOutside VPARAMETER
5008 SegmentationDynamicLight VPARAMETER
5009 SegmentationDynamicDark VPARAMETER
5010 SegmentationDynamicInside VPARAMETER
5011 SegmentationDynamicOutside VPARAMETER
5100 PolarityMode VPARAMETER
5101 SearchMode VPARAMETER
5102 MaximumAngleDeviation VPARAMETER
5110 SubsamplingLevel VPARAMETER
5120 Connectivity VPARAMETER
5122 InterpolatePositionMode VPARAMETER
5123 InterpolatePositionModeEnabled VPARAMETER
5130 MinimumLinePercentage VPARAMETER
5140 FitMode VPARAMETER
5141 ArcMustBeTotallyEnclosed VPARAMETER
5142 MinimumArcPercentage VPARAMETER
5200 MagnitudeThreshold VPARAMETER
5201 EdgeMagnitudeThreshold VPARAMETER
5202 FilterHalfWidth VPARAMETER
5203 EdgeFilterHalfWidth VPARAMETER
5210 EdgePolarityMode VPARAMETER
5211 Edge1PolarityMode VPARAMETER
5212 Edge2PolarityMode VPARAMETER
5220 Constraints VPARAMETER
Page 569

5221 Edge1Constraints VPARAMETER
5222 Edge2Constraints VPARAMETER
5223 PositionConstraint VPARAMETER
5224 Edge1PositionConstraint VPARAMETER
5225 Edge2PositionConstraint VPARAMETER
5226 MagnitudeConstraint VPARAMETER
5227 Edge1MagnitudeConstraint VPARAMETER
5228 Edge2MagnitudeConstraint VPARAMETER
5240 ScoreThreshold VPARAMETER
5241 Edge1ScoreThreshold VPARAMETER
5242 Edge2ScoreThreshold VPARAMETER
5243 EdgeSortResultsEnabled VPARAMETER
5300 CandidatePointsCount VPARAMETER
5301 AutomaticCandidateCountEnabled VPARAMETER
5302 StandardDeviationThreshold VPARAMETER
5304 KernelSize VPARAMETER
5320 ThresholdBlack VPARAMETER
5321 ThresholdWhite VPARAMETER
5322 TailWhite VPARAMETER
5323 TailBlack VPARAMETER
5324 ImageSubsampling VPARAMETER
5350 OverrideTypeEnabled VPARAMETER
5351 OverrideType VPARAMETER
5355 Operation VPARAMETER
5360 ArithmeticClippingMode VPARAMETER
5361 ArithmeticConstant VPARAMETER
5362 ArithmeticScale VPARAMETER
5365 AssignmentConstant VPARAMETER
5366 AssignmentHeight VPARAMETER
5367 AssignmentWidth VPARAMETER
Page 570

5370 FilteringClippingMode VPARAMETER
5371 FilteringKernelSize VPARAMETER
5372 FilteringScale VPARAMETER
5380 LogicalConstant VPARAMETER
5385 HistogramThreshold VPARAMETER
5390 MorphologicalNeighborhoodSize VPARAMETER
5395 TransformFlags VPARAMETER
5400 PatternPositionX VPARAMETER
5401 PatternPositionY VPARAMETER
5402 PatternWidth VPARAMETER
5403 PatternHeight VPARAMETER
5404 PatternRotation VPARAMETER
5420 MatchThreshold VPARAMETER
5421 AutoCoarsenessSelectionEnabled VPARAMETER
5430 SearchCoarseness VPARAMETER
5500 Reset VPARAMETER
5501 Abort VPARAMETER
5502 VideoExposure VPARAMETER
5503 VideoGain VPARAMETER
5504 ActiveCalibration VPARAMETER
5505 ActiveSettings VPARAMETER
5511 GripperOutputOpen VPARAMETER
5512 GripperOutputClose VPARAMETER
5513 GripperOutputRelease VPARAMETER
5514 GripperInputOpen VPARAMETER
5515 GripperInputClose VPARAMETER
5516 GripperOutputExtend VPARAMETER
5517 GripperOutputRetract VPARAMETER
5518 GripperInputExtend VPARAMETER
5519 GripperInputRetract VPARAMETER
Page 571

5600 Operator VPARAMETER
5601 FilterCount VPARAMETER
5700 ColorFilterCount VPARAMETER
5713 FilterHueValue VPARAMETER
5714 FilterSaturationValue VPARAMETER
5715 FilterLuminanceValue VPARAMETER
5716 FilterHueTolerance VPARAMETER
5717 FilterSaturationTolerance VPARAMETER
5718 FilterLuminanceTolerance VPARAMETER
10000 BeltCalibrationFrame VLOCATION
10001 BeltCalibrationUpstreamLimit VLOCATION
10002 BeltCalibrationDownstreamLimit VLOCATION
10003 BeltCalibrationNearsideLimit VLOCATION
10004 BeltCalibrationScale VPARAMETER
10010 BeltLatchCalibrationOffset VLOCATION
10050 VisionOriginRobot VLOCATION
10051 ImageOriginRobot VLOCATION
10052 VisionOriginBelt VLOCATION
10053 ImageOriginBelt VLOCATION
10060 InverseKinematics VPARAMETER
10100 GripperOffset VLOCATION
10200 SequenceExecutionMode VPARAMETER
10201 SequenceToolCount VPARAMETER
10327 SaveImage VPARAMETER
10401 VisionXPosition VPARAMETER
10402 VisionYPosition VPARAMETER
10403 VisionRotation VPARAMETER
10404 RobotXPosition VPARAMETER
10405 RobotYPosition VPARAMETER
11000 GripperToolTransform VLOCATION
Page 572

ACE Sight framework properties are properties that do not apply to vision tools.
The table below lists the ACE Sight properties that apply to the ACE Sight framework. Click on a property
name to access the reference for the property.
V+/MicroV+ V+/MicroV+
Property Name Access Type
Keyword ID
BeltCalibrationDownstreamLimit VLOCATION 10002 R -O location
BeltCalibrationFrame VLOCATION 10000 R -O location
BeltCalibrationNearsideLimit VLOCATION 10003 R -O location
BeltCalibrationScale VPARAMETER 10004 R -O Double
BeltCalibrationUpstreamLimit VLOCATION 10001 R -O location
BeltLatchCalibrationOffset VLOCATION 10010 R -O location
GripperOffset VLOCATION 10100 R -O location
ImageOriginBelt VLOCATION 10053 R -O location
ImageOriginRobot VLOCATION 10051 R -O location
InstanceLocation VLOCATION 1311 R -O location
InstanceLocationGripperOffsetMaximum VLOCATION 1499 R -O location
InstanceLocationGripperOffsetMinimum VLOCATION 1400 R -O location
InstanceRobotLocation VLOCATION 1371 R -O location
BlobExtentBottom VLOCATION 1653 R -O location
BlobExtentLeft VLOCATION 1650 R -O location
BlobExtentRight VLOCATION 1651 R -O location
BlobExtentTop VLOCATION 1652 R -O location
RobotXPosition VPARAMETER 10404 R -W Double
RobotYPosition VPARAMETER 10405 R -W Double
SaveImage VPARAMETER 10327 R -W Long
SequenceExecutionMode VPARAMETER 10200 R -W Long
SequenceToolCount VPARAMETER 10201 R-O Long
VisionOriginBelt VLOCATION 10052 R-O location
VisionOriginRobot VLOCATION 10050 R-O location
VisionRotation VPARAMETER 10403 R -W Double
Page 574
Keyword ID
VisionXPosition VPARAMETER 10401 R -W Double
VisionYPosition VPARAMETER 10402 R -W Double
Page 575
ACE Sight Tool Properties

The following sections list the properties that apply to the selected vision tool.
AnyFeeder Properties
Caliper Properties
Locator Model Tool Properties (NOTE: This tool cannot be accessed by ACE Sight)
Page 576
Page 577
AnyFeeder Properties
The AnyFeeder manages and controls the AnyFeeder hardware.
Keyword ID
AnyFeederVRunCommand VPARAMETER 6000 R/W Long
AnyFeederDispenseIterations VPARAMETER 6012 R/W Long
AnyFeederDispenseSpeed VPARAMETER 6002 R/W Long
AnyFeederFeedBackwardIterations VPARAMETER 6015 R/W Long
AnyFeederFeedBackwardSpeed VPARAMETER 6005 R/W Long
AnyFeederFeedFlipBackwardIterations VPARAMETER 6018 R/W Long
AnyFeederFeedFlipBackwardSpeed VPARAMETER 6005 R/W Long
AnyFeederFeedFlipForwardIterations VPARAMETER 6017 R/W Long
AnyFeederFeedFlipForwardSpeed VPARAMETER 6007 R/W Long
AnyFeederFeedForwardIterations VPARAMETER 6011 R/W Long
AnyFeederFeedForwardSpeed VPARAMETER 6001 R/W Long
AnyFeederFlipIterations VPARAMETER 6013 R/W Long
AnyFeederFlipSpeed VPARAMETER 6003 R/W Long
AnyFeederHeavyDispenseIterations VPARAMETER 6016 R/W Long
AnyFeederHeavyDispenseSpeed VPARAMETER 6006 R/W Long
AnyFeederPurgeIterations VPARAMETER 6014 R/W Long
AnyFeederPurgeSpeed VPARAMETER 6004 R/W Long
Page 578

The Arc Caliper finds and locates one or more edge pairs on an arc-shaped or circular area and measures
distances between the two edges within each pair.
Keyword ID
BilinearInterpolationEnabled VPARAMETER 120 R/W Boolean
CalibratedUnitsEnabled VPARAMETER 103 R -O Boolean
Edge1Constraints VPARAMETER 5221 R/W Long
Edge1Magnitude VRESULT 1940 R -O Double
Edge1MagnitudeConstraint VPARAMETER 5227 R/W Long
Edge1MagnitudeScore VRESULT 1942 R -O Double
Edge1PolarityMode VPARAMETER 5211 R/W Long
Edge1PositionConstraint VPARAMETER 5224 R/W Double
Edge1PositionScore VRESULT 1944 R -O Double
Edge1PositionX VRESULT 1946 R -O Double
Edge1PositionY VRESULT 1947 R -O Double
Edge1Radius VRESULT 1954 R -O Double
Edge1Rotation VRESULT 1950 R -O Double
Edge1Score VRESULT 1952 R -O Double
Edge1ScoreThreshold VPARAMETER 5241 R/W Double
Edge2Radius VRESULT 1955 R -O Double
Page 579
Keyword ID
EdgeFilterHalfWidth VPARAMETER 5203 R/W Long
EdgeMagnitudeThreshold VPARAMETER 5201 R/W Double
ElapsedTime VRESULT 1001 R -O Double
FrameCount VRESULT 2410 R -O Long
FrameRotation VRESULT 2402 R -O Double
FrameTranslationX VRESULT 2400 R -O Double
FrameTranslationY VRESULT 2401 R -O Double
InstanceLocation VLOCATION 1311 R -O Location
InstanceLocationGripperOffsetMaximum VLOCATION 1499 R -O Location
InstanceLocationGripperOffsetMinimum VLOCATION 1400 R -O Location
PairCount VRESULT 1920 R -O Long
PairPositionX VRESULT 1921 R -O Double
PairPositionY VRESULT 1922 R -O Double
PairRotation VRESULT 1923 R -O Double
PairScore VRESULT 1924 R -O Double
PairSize VRESULT 1925 R -O Double
ProjectionMode VPARAMETER 140 R/W Long
ResultCount VRESULT 1010 R -O Long
SamplingStepCustom VPARAMETER 124 R/W Double
SamplingStepCustomEnabled VPARAMETER 121 R/W Boolean
ShowResultsGraphics VPARAMETER 150 R/W Boolean
ToolOpening VPARAMETER 137 R/W Double
ToolPositionX VPARAMETER 100 R/W Double
ToolPositionY VPARAMETER 101 R/W Double
ToolRadius VPARAMETER 135 R/W Double
ToolRotation VPARAMETER 112 R/W Double
ToolThickness VPARAMETER 136 R/W Double
Page 580

The Arc Edge Locator finds and locates an edge or a set of edges in an arc-shaped or circular area.
Keyword ID
Constraints VPARAMETER 5220 R/W Long
EdgeCount VRESULT 1900 R -O Long
EdgeMagnitude VRESULT 1901 R -O Double
EdgeMagnitudeScore VRESULT 1902 R -O Double
EdgePolarityMode VPARAMETER 5210 R/W Long
EdgePositionScore VRESULT 1903 R -O Double
EdgePositionX VRESULT 1904 R -O Double
EdgePositionY VRESULT 1905 R -O Double
EdgeRadius VRESULT 1908 R -O Double
EdgeRotation VRESULT 1906 R -O Double
EdgeScore VRESULT 1907 R -O Double
EdgeSortResultsEnabled VPARAMETER 5243 R/W Long
FilterHalfWidth VPARAMETER 5202 R/W Long
MagnitudeConstraint VPARAMETER 5226 R/W Long
MagnitudeThreshold VPARAMETER 5200 R/W Double
PositionConstraint VPARAMETER 5223 R/W Double
ProjectionMode VPARAMETER 140 R/W Long
Page 581
Keyword ID
ScoreThreshold VPARAMETER 5240 R/W Double
Page 582

The Arc Finder finds and locates circular features on objects and returns the coordinates of the center of
the arc, the start and end angles, and the radius.
Keyword ID
ArcMustBeTotallyEnclosed VPARAMETER 5141 R/W Boolean
AverageContrast VRESULT 1801 R -O Double
ConformityTolerance VPARAMETER 556 R/W Double
ContrastThreshold VPARAMETER 303 R/W Long
ContrastThresholdMode VPARAMETER 302 R/W Long
FitMode VPARAMETER 5140 R/W Long
FitQuality VRESULT 1803 R -O Double
Found VRESULT 1800 R -O Boolean
MatchQuality VRESULT 1802 R -O Double
MaximumAngleDeviation VPARAMETER 5102 R/W Double
MinimumArcPercentage VPARAMETER 5142 R/W Double
OutputArcAngle VRESULT 1841 R -O Double
OutputArcCenterPointX VRESULT 1846 R -O Double
OutputArcCenterPointY VRESULT 1847 R -O Double
OutputArcRadius VRESULT 1840 R -O Double
PolarityMode VPARAMETER 5100 R/W Long
PositioningLevel VPARAMETER 561 R/W Long
Page 583
Keyword ID
SearchMode VPARAMETER 5101 R/W Long
SubsamplingLevel VPARAMETER 5110 R/W Long
ToolGuidelineOffset VPARAMETER 130 R/W Double
Page 584

The Blob Analyzer finds, labels and analyzes irregular shaped objects. This tool detects and computes
intrinsic/extrinsic geometric and greylevel properties of blobs that meet user-defined criteria.
Keyword ID
BlobArea VRESULT 1611 R -O Double
BlobBoundingBoxBottom VRESULT 1648 R -O Double
BlobBoundingBoxCenterX VRESULT 1624 R -O Double
BlobBoundingBoxCenterY VRESULT 1625 R -O Double
BlobBoundingBoxHeight VRESULT 1626 R -O Double
BlobBoundingBoxLeft VRESULT 1645 R -O Double
BlobBoundingBoxRight VRESULT 1646 R -O Double
BlobBoundingBoxRotation VRESULT 1649 R -O Double
BlobBoundingBoxTop VRESULT 1647 R -O Double
BlobBoundingBoxWidth VRESULT 1627 R -O Double
BlobChainCode VRESULT 1656 R -O Long
BlobChainCodeDeltaX VRESULT 1659 R -O Double
BlobChainCodeDeltaY VRESULT 1660 R -O Double
BlobChainCodeLength VRESULT 1655 R -O Long
BlobChainCodeStartX VRESULT 1657 R -O Double
BlobChainCodeStartY VRESULT 1658 R -O Double
BlobConvexPerimeter VRESULT 1614 R -O Double
BlobCount VRESULT 1610 R -O Long
BlobElongation VRESULT 1616 R -O Double
BlobExtentBottom VRESULT 1653 R -O Double
BlobExtentLeft VRESULT 1650 R -O Double
BlobExtentRight VRESULT 1651 R -O Double
BlobExtentTop VRESULT 1652 R -O Double
BlobGreyLevelMaximum VRESULT 1622 R -O Long
BlobGreyLevelMean VRESULT 1618 R -O Double
Page 585
Keyword ID
BlobGreyLevelMinimum VRESULT 1621 R -O Long
BlobGreyLevelRange VRESULT 1619 R -O Long
BlobGreyLevelStdDev VRESULT 1620 R -O Double
BlobHoleCount VRESULT 1654 R -O Long
BlobInertiaMaximum VRESULT 1633 R -O Double
BlobInertiaMinimum VRESULT 1632 R -O Double
BlobInertiaXAxis VRESULT 1634 R -O Double
BlobInertiaYAxis VRESULT 1635 R -O Double
BlobIntrinsicBoundingBoxBottom VRESULT 1639 R -O Double
BlobIntrinsicBoundingBoxCenterX VRESULT 1628 R -O Double
BlobIntrinsicBoundingBoxCenterY VRESULT 1629 R -O Double
BlobIntrinsicBoundingBoxHeight VRESULT 1630 R -O Double
BlobIntrinsicBoundingBoxLeft VRESULT 1636 R -O Double
BlobIntrinsicBoundingBoxRight VRESULT 1637 R -O Double
BlobIntrinsicBoundingBoxRotation VRESULT 1640 R -O Double
BlobIntrinsicBoundingBoxTop VRESULT 1638 R -O Double
BlobIntrinsicBoundingBoxWidth VRESULT 1631 R -O Double
BlobIntrinsicExtentBottom VRESULT 1644 R -O Double
BlobIntrinsicExtentLeft VRESULT 1641 R -O Double
BlobIntrinsicExtentRight VRESULT 1642 R -O Double
BlobIntrinsicExtentTop VRESULT 1643 R -O Double
BlobPositionX VRESULT 1612 R -O Double
BlobPositionY VRESULT 1613 R -O Double
BlobPrincipalAxesRotation VRESULT 1617 R -O Double
BlobRawPerimeter VRESULT 1615 R -O Double
BlobRoundness VRESULT 1623 R -O Double
ChainCodeResultsEnabled VPARAMETER 1607 R/W Boolean
ExtrinsicInertiaResultsEnabled VPARAMETER 1604 R/W Boolean
Page 586
Keyword ID
GreyLevelResultsEnabled VPARAMETER 1608 R/W Boolean
HoleFillingEnabled VPARAMETER 5002 R/W Boolean
IntrinsicBoxResultsEnabled VPARAMETER 1605 R/W Boolean
MaximumBlobArea VPARAMETER 5001 R/W Double
MinimumBlobArea VPARAMETER 5000 R/W Double
PerimeterResultsEnabled VPARAMETER 1602 R/W Boolean
SegmentationDark VPARAMETER 5005 R/W Long
SegmentationDynamicDark VPARAMETER 5009 R/W Double
SegmentationDynamicInside VPARAMETER 5010 R/W Double
SegmentationDynamicLight VPARAMETER 5008 R/W Double
SegmentationDynamicOutside VPARAMETER 5011 R/W Double
SegmentationInside VPARAMETER 5006 R/W Long
SegmentationLight VPARAMETER 5004 R/W Long
SegmentationMode VPARAMETER 5003 R/W Long
SegmentationOutside VPARAMETER 5007 R/W Long
SortBlobsBy VPARAMETER 1601 R/W Long
SortResultsEnabled VPARAMETER 1600 R/W Boolean
ToolHeight VPARAMETER 111 R/W Double
Page 587
Keyword ID
ToolWidth VPARAMETER 110 R/W Double
TopologicalResultsEnabled VPARAMETER 1609 R/W Boolean
Page 588

The Calculated Arc calculates the circle enclosing an arc based on a specific calculation mode. Possible
modes are:
• Three points on the arc
• Center point and one point on the arc
V+/MicroV+
Property Name V+/MicroV+ ID Access Type
Keyword
InstanceCount VRESULT 1310 R -O Long
InstanceRobotLocation VLOCATION 1371 R -O Location
Page 589

The Calculated Frame is used to create a vision frame from other features. Frames allow you to place vision
tools on objects that are not always in the same location or orientation. This tool calculates a frame based
on a specific calculation mode. Possible modes are:
• Two lines (X axis line, Y axis line)
• Two points (Origin, +X point)
• A fixed frame of reference
• Single point (Origin point with no rotation)
• Relative to a frame
• One point and a line (An origin point following the angle of the line)
V+/MicroV+
Keyword
Page 590

The Calculated Line can be created from two points, or from a point and a line. In the latter case, the
calculated line will be running through the point and perpendicular to the line. This tool calculates a line
based on a specific calculation mode. Possible modes are:
• Two points
• Perpendicular line
V+/MicroV+
Keyword
Page 591

The Calculated Point can be calculated based on the intersection two lines, a line and a circle, or midway
between two points. A Calculated Point tool is also used to place a fixed point in the field of view. A fixed
point could be used if you want to make all your measurements from a known reference point.. This tool
calculates a point based on a specific calculation mode. Possible modes are:
• Midpoint (midpoint between two points)
• Point and a line (closet point on the line to another point)
• Point and an arc (closest point on the arc to another point)
• Fixed point
• A line and an arc (Line/Arc intersection)
• Two lines (Line-line intersection)
• Two arcs (Arc-arc intersection)
V+/MicroV+
Keyword
Page 592

The Calibration Grid Locator is used to locate a collection of dots in the field of view. It is used by the grid
calibration procedure.
V+/MicroV+
Keyword
OutlineLevel VPARAMETER 300 R/W Long
Page 593
Caliper Properties
Caliper Properties
The Caliper finds and locates one or more edge pairs and measures distances between the two edges
within each pair.
Keyword ID
Page 594
Caliper Properties
Keyword ID
EdgeFilterHalfWidth VPARAMETER 5203 R/W Long
EdgeMagnitudeThreshold VPARAMETER 5201 R/W Double
PairCount VRESULT 1920 R -O Long
PairPositionX VRESULT 1921 R -O Double
PairPositionY VRESULT 1922 R -O Double
PairRotation VRESULT 1923 R -O Double
PairScore VRESULT 1924 R -O Double
PairSize VRESULT 1925 R -O Double
ToolSkew VPARAMETER 113 R/W Double
Page 595

The Color Matching tool analyzes images according and outputs statistics on areas that match defined
color filters.
V+/MicroV+
Keyword
ColorFilterCount VPARAMETER 5700 R -O Long
ColorFilterMatchPixelCount VRESULT 2502 R -O Long
ColorFilterMatchQuality VRESULT 2501 R -O Double
FilterHueTolerance VPARAMETER 5716 R/W Long
FilterHueValue VPARAMETER 5713 R/W Long
FilterLuminanceTolerance VPARAMETER 5718 R/W Long
FilterLuminanceValue VPARAMETER 5715 R/W Long
FilterSaturationTolerance VPARAMETER 5717 R/W Long
FilterSaturationValue VPARAMETER 5714 R/W Long
Page 596

The Communication tool manages and sends vision instances to a queue on the Adept Controller. The
queue can be accessed using the "getinstance" program by a V+ program.
V+/MicroV+
Property Name V+/MicroV+ Keyword Access Type
ID
CommunicationToolResults VRESULT 2600 R -O Integer
Reset VPARAMETER 5500 W -O Long
Page 597

The Custom Vision Tool is used to fill in the program that is called when the tool is executed. From within a
Custom Vision tool, other tools can be executed, and return a set of results which are used as the output of
the tool.
V+/MicroV+
Keyword
Page 598

The Edge Locator finds and locates an edge or a set of edges that meet user-defined criteria.
Keyword ID
Constraints VPARAMETER 5220 R/W Long
EdgeCount VRESULT 1900 R -O Long
EdgeMagnitude VRESULT 1901 R -O Double
EdgeMagnitudeScore VRESULT 1902 R -O Double
EdgePolarityMode VPARAMETER 5210 R/W Long
EdgePositionScore VRESULT 1903 R -O Double
EdgePositionX VRESULT 1904 R -O Double
EdgePositionY VRESULT 1905 R -O Double
EdgeRotation VRESULT 1906 R -O Double
EdgeScore VRESULT 1907 R -O Double
EdgeSortResultsEnabled VPARAMETER 5243 R/W Long
FilterHalfWidth VPARAMETER 5202 R/W Long
MagnitudeConstraint VPARAMETER 5226 R/W Long
MagnitudeThreshold VPARAMETER 5200 R/W Double
PositionConstraint VPARAMETER 5223 R/W Double
Page 599
Keyword ID
ScoreThreshold VPARAMETER 5240 R/W Double
ToolSkew VPARAMETER 113 R/W Double
Page 600
Flexibowl Feeder Properties
The Flexibowl Feeder manages and controls the Flexinowl Feeder hardware.
Keyword ID
FlexibowlFeederVRunCommand VPARAMETER 7000 R/W Long
FlexibowlFeederBlowTime VPARAMETER 7012 R/W Long
FlexibowlFeederFlipCount VPARAMETER 7005 R/W Long
FlexibowlFeederFlipDelay VPARAMETER 7006 R/W Long
FlexibowlFeederForwardAcceleration VPARAMETER 7001 R/W Long
FlexibowlFeederForwardAngle VPARAMETER 7003 R/W Long
FlexibowlFeederForwardDeceleration VPARAMETER 7002 R/W Long
FlexibowlFeederForwardSpeed VPARAMETER 7004 R/W Long
FlexibowlFeederShakeAcceleration VPARAMETER 7007 R/W Long
FlexibowlFeederShakeAngle VPARAMETER 7009 R/W Long
FlexibowlFeederShakeCount VPARAMETER 7011 R/W Long
FlexibowlFeederShakeDeceleration VPARAMETER 7008 R/W Long
FlexibowlFeederShakeSpeed VPARAMETER 7010 R/W Long
Page 601

The Gripper Clearance Tool is used to check that a region around an instance is clear of any obstructions.
This is done by applying a user-defined number of histogram checks to the region (typically one histogram
per gripper finger) to determine whether there is another instance that would interfere with the gripper
when picking up an instance.
V+/MicroV+
Keyword
Page 602

The Image Histogram tool computes greylevel statistics within a user-defined region of interest.
Keyword ID
GreylevelRange VRESULT 1508 R -O Long
Histogram VRESULT 1511 R -O Long
HistogramPixelCount VRESULT 1512 R -O Long
ImageHeight VRESULT 1021 R -O Long
ImagePixelCount VRESULT 1513 R -O Long
ImageSubsampling VPARAMETER 5324 R/W Long
ImageWidth VRESULT 1020 R -O Long
MaximumGreylevelValue VRESULT 1507 R -O Long
Mean VRESULT 1500 R -O Double
Median VRESULT 1501 R -O Double
MinimumGreylevelValue VRESULT 1506 R -O Long
Mode VRESULT 1504 R -O Long
ModePixelCount VRESULT 1505 R -O Long
SamplingStepCustom VPARAMETER 121 R/W Boolean
StandardDeviation VRESULT 1503 R -O Double
TailBlack VPARAMETER 5323 R/W Double
TailBlackGreylevelValue VRESULT 1509 R -O Long
TailWhite VPARAMETER 5322 R/W Double
TailWhiteGreylevelValue VRESULT 1510 R -O Long
ThresholdBlack VPARAMETER 5320 R/W Long
ThresholdWhite VPARAMETER 5321 R/W Long
Page 603
Keyword ID
Variance VRESULT 1502 R -O Double
Page 604

The Image Processing Tool processes grey-scale images by applying arithmetic, assignment, logical,
filtering, morphological or histogram operators. Users can define custom filtering operators.
Keyword ID
ArithmeticClippingMode VPARAMETER 5360 R/W Long
ArithmeticConstant VPARAMETER 5361 R/W Long
AssignmentConstant VPARAMETER 5365 R/W Long
ArithmeticScale VPARAMETER 5362 R/W Double
AssignmentHeight VPARAMETER 5366 R -O Long
AssignmentWidth VPARAMETER 5367 R -O Long
FilteringClippingMode VPARAMETER 5370 R/W Long
FilteringKernelSize VPARAMETER 5371 R/W Long
FilteringScale VPARAMETER 5372 R/W Double
HistogramThreshold VPARAMETER 5385 R/W Long
LastOperation VRESULT 2200 R -O Long
LastOutputType VRESULT 2201 R -O Long
LogicalConstant VPARAMETER 5380 R/W Long
MorphologicalNeighborhoodSize VPARAMETER 5390 R/W Long
Operation VPARAMETER 5355 R/W Long
OverrideType VPARAMETER 5351 R/W Long
OverrideTypeEnabled VPARAMETER 5350 R/W Boolean
TransformFlags VPARAMETER 5395 R/W Long
Page 605

The Image Sampling tool is used to extract an area of an image and output it as a separate Image.
Keyword ID
Page 606

The Image Sharpness Tool computes the sharpness of preponderant edges in a user-defined region of
interest.
Keyword ID
AutomaticCandidateCountEnabled VPARAMETER 5301 R/W Long
CandidatePointsCount VPARAMETER 5300 R/W Long
KernelSize VPARAMETER 5304 R/W Long
MeasurementPointsCount VRESULT 2002 R -O Long
Sharpness VRESULT 2000 R -O Double
SharpnessPeak VRESULT 2001 R -O Double
StandardDeviationThreshold VPARAMETER 5302 R/W Double
Page 607

The Inspection tool analyzes the results of other tools based on a configuration of inspection filters. Logical
operators AND and OR are applied to a set of conditions that apply to the results of other tools in a vision
sequence.
Keyword ID
InspectionFilterMeasuredValue VRESULT 2700 R -O Double
InspectionFilterPassStatus VRESULT 2702 R -O Double
Page 608

The Line Finder finds and locates linear features on objects and returns the line angle and point
coordinates.
Keyword ID
DefaultConformityTolerance VPARAMETER 552 R -O Double
FitQuality VRESULT 1803 R -O Double
MatchQuality VRESULT 1802 R -O Double
MaximumAngleDeviation VPARAMETER 5102 R/W Double
MinimumLinePercentage VPARAMETER 5130 R/W Double
OutputLineAngle VRESULT 1820 R -O Double
OutputLineEndPointX VRESULT 1823 R -O Double
OutputLineEndPointY VRESULT 1824 R -O Double
OutputLineStartPointX VRESULT 1821 R -O Double
OutputLineStartPointY VRESULT 1822 R -O Double
OutputLineVectorPointX VRESULT 1825 R -O Double
OutputLineVectorPointY VRESULT 1826 R -O Double
Page 609
Keyword ID
Page 610

The Locator finds and locates objects based on the geometry of their contours. Scale factor, orientation,
and position are provided for each located instance. Models are built using the integrated Model Editor.
Keyword ID
ConformityToleranceRangeEnabled VPARAMETER 553 R/W Boolean
ContrastPolarity VPARAMETER 522 R/W Long
DefaultConformityTolerance VPARAMETER 552 R -O Double
DetailLevel VPARAMETER 301 R/W Long
InstanceClearQuality VRESULT 1319 R -O Double
InstanceFitQuality VRESULT 1317 R -O Double
InstanceIntrinsicBoundingBox VRESULT 1330 R -O Double
InstanceMatchQuality VRESULT 1318 R -O Double
InstanceModel VRESULT 1312 R -O Long
InstanceOrdering VPARAMETER 530 R/W Long
InstanceOrderingReferenceX VPARAMETER 531 R/W Double
InstanceOrderingReferenceY VPARAMETER 532 R/W Double
Page 611
Keyword ID
InstanceRotation VRESULT 1314 R -O Double
InstanceScaleFactor VRESULT 1313 R -O Double
InstanceSymmetry VRESULT 1320 R -O Long
InstanceTime VRESULT 1322 R -O Double
InstanceTranslationX VRESULT 1315 R -O Double
InstanceTranslationY VRESULT 1316 R -O Double
InstanceVisible VRESULT 1321 R -O Double
MaximumInstanceCount VPARAMETER 519 R/W Long
MaximumInstanceCountEnabled VPARAMETER 518 R/W Long
MaximumRotation VPARAMETER 517 R/W Double
MaximumScaleFactor VPARAMETER 513 R/W Double
MinimumClearPercentage VPARAMETER 559 R/W Double
MinimumClearPercentageEnabled VPARAMETER 558 R/W Boolean
MinimumModelPercentage VPARAMETER 557 R/W Double
MinimumRequiredFeatures VPARAMETER 560 R/W Double
MinimumRotation VPARAMETER 516 R/W Double
MinimumScaleFactor VPARAMETER 512 R/W Double
ModelDisambiguationEnabled VPARAMETER 403 R/W Boolean
NominalRotation VPARAMETER 515 R/W Double
NominalRotationEnabled VPARAMETER 514 R/W Boolean
NominalScaleFactor VPARAMETER 511 R/W Double
NominalScaleFactorEnabled VPARAMETER 510 R/W Boolean
OutlineLevel VPARAMETER 300 R/W Long
OutputSymmetricInstances VPARAMETER 520 R/W Long
ParametersBasedOn VPARAMETER 304 R/W Long
RecognitionLevel VPARAMETER 550 R/W Long
ResultCount VRESULT 1010 R-O Long
SearchBasedOnOutlineLevelOnly VPARAMETER 521 R/W Long
Page 612
Keyword ID
Timeout VPARAMETER 501 R/W Long
TimeoutEnabled VPARAMETER 500 R/W Boolean
Page 613

The purpose of the overlap tool is to filter instance found in an input image so that the robot is not
instructed to pick up the same part more than once.
Keyword ID
Reset VPARAMETER 5500 W -O Long
Page 614

The Pattern Locator finds and locates instances of a greyscale pattern
Keyword ID
AutoCoarsenessSelectionEnabled VPARAMETER 5421 R/W Long
MatchCount VRESULT 2100 R -O Long
MatchPositionX VRESULT 2102 R -O Double
MatchPositionY VRESULT 2103 R -O Double
MatchRotation VRESULT 2104 R -O Double
MatchStrength VRESULT 2101 R -O Double
MatchThreshold VPARAMETER 5420 R/W Double
MaximumInstanceCount VPARAMETER 519 R/W Long
MaximumInstanceCountEnabled VPARAMETER 518 R/W Long
PatternHeight VPARAMETER 5403 R/W Double
PatternPositionX VPARAMETER 5400 R/W Double
PatternPositionY VPARAMETER 5401 R/W Double
PatternRotation VPARAMETER 5404 R/W Double
PatternWidth VPARAMETER 5402 R/W Double
Page 615
Keyword ID
Page 616

The Point Finder finds and locates point features on objects and returns the angle as well as the
coordinates of the found point.
Keyword ID
Connectivity VPARAMETER 5120 R/W Long
InterpolatePositionMode VPARAMETER 5122 R/W Long
InterpolatePositionModeEnabled VPARAMETER 5123 R/W Boolean
OutputPointX VRESULT 1810 R -O Double
OutputPointY VRESULT 1811 R -O Double
Page 617
Keyword ID
Page 618
Recipe Manager Properties
Recipe Manager Properties

The recipe manager controls the recipe subsystem.
Keyword ID
RecipeManagerActiveRecipe VPARAMETER 8001 R -O Long
RecipeManagerRecipeCount VPARAMETER 8000 R -O Long
RecipeManagerRecipeSelection VPARAMETER 8002 R/W Long
RecipeManagerRecipeDelete VPARAMETER 8003 R -O Long
RecipeManagerLoadFile VPARAMETER 8004 R -O Long
RecipeManagerSaveFile VPARAMETER 8005 R -O Long
Page 619

The Custom Vision Tool allows an ACE application, such as the ACE PackXpert, to run a vision tool on a
remote PC.
V+/MicroV+
Keyword
Page 620
Acquire Image Tool Properties

The Virtual Camera tool provides input images to tools in a vision sequence. A Virtual Camera tool can
acquire images from a camera, or from a database of images, through a virtual camera called an Emulation
device.
Keyword ID
Abort VPARAMETER 5501 W -O Boolean
ActiveCalibration VPARAMETER 5504 R/W Long
ActiveSettings VPARAMETER 5505 R/W Long
VideoExposure VPARAMETER 5502 R/W Long
VideoGain VPARAMETER 5503 R/W Long
Page 622
Customizer Reference Guide

There are many ways which ACE can be extended, modified, or changed. This section will detail many
examples of customization. You should also reference the AceDemo.zip file included with the ACE
installation. It contains several samples using Visual Studio for creating 3rd party applications that work
with ACE.
See Also
PC Customization
Process Manager Customization Overview
PC Customization
This section details the customizations that can be done on the PC.
See Also
Overview
Data Collection Sample
Vision Tool Customization
Overview
ACE is a software package that can be used to develop a wide array of robotic applications. The software is
divided into several components, each of which provides some of the functionality available to the user.
Though ACE is generally sufficient for most applications, it was designed so it can be extended. Below is a
simplified diagram showing the various functional components of ACE:
Page 623
ACE Core Library

The ACE core library contains all the objects and classes that define the ACE runtime framework. This
runtime framework is build upon the .NET framework.
ACE Vision Library

The ACE Vision library encapsulates the vision system functions that can be used to trigger vision
operations on images supplied from cameras connected to the PC.
ACE Adept Library

The ACE Adept library contains all the communications and class structures needed to interact with all
robots and controllers supplied by Adept.
ACE Sight Module

ACE Sight is a higher level functional module that exposes the ACE Vision library to a user through the V+
ACE Sight keywords.
ACE PackXpert Module

ACE PackXpert is a higher level functional module that provides a solution for packaging applications.
Page 624
Client and Server Side Plugins

Plugins are 3rd party libraries developed with Visual Studio that are loaded directly within the ACE.exe
process. Client Plugins are assciated with the ACE user interface. Server Plugins are associated with the
ACE runtime. Examples of Client and Server plugins can be located in the AceDemo.zip file that ships with
ACE.
Visual Studio Solution
A user can develop external applications that interact with ACE using a tool like Visual Studio. In this case,
Visual Studio is used to create a separate executable that communicates with the ACE.exe process using
the ACE API. Examples of this can also be found in the AceDemo.zip file that ships with ACE.
Application Domains
When developing a Plugin, Visual Studio solution that interacts with ACE or scriptable objects within ACE, it
is important to understand Application Domains.
Application domains are sandboxes which allow for the isolation of software components. The ACE software
is a multi-application domain application and under this model, the AceServer is run in its own isolated
application domain. It uses the .NET framework remoting infrastructure to expose itself to software
components outside of its application domain. Depending on how you are accessing the AceServer, there
are implications for users seeking to customize ACE. This table details the different ways the ACE product
can be customized and identifies if it is running in the AceServer application domain:
Customization Type Running in AceServer Application Domain

C# Program Object No
Custom Allocation Script Yes
C# Custom Vision
No
Tooloffset
Yes or no, depending how ACE was
Client Side Plug-In
launched.
Server Side Plug-In Yes
Crossing the Application Domain Boundaries

If you are accessing a property or a method that exists in a different application domain, it should be
understood that the access involves transferring information from the current application domain to the
remote application domain. The process of transferring information is known as marshalling data. The way
data is marshaled depends on the kind data being passed. If the object is considered a value type, then a
copy of the data is made and passed to the remote domain. Any changes made to the value type on the
server are not reflected in the original application domain where the object was originally created.
If the object is considered a reference type, then the object itself will be passed across the domain
boundary. Any changes made in the remote application domain are reflected in the original object. All
reference types in the ACE API will derive from Ace.Core.RemoteableObject which derives from the
System.MarshalByRef base class. ACE Reference Guide, 18317-000 Rev A
Page 625
Remoting, Object Scope, and Serialization

When an object is created, it is always created within the scope of the application domain in which it was
created. If, for example, you are creating an object that derives from RemotableObject, it will be owned
by the current application domain. If your intention is to create an object and used it in the AceServer
application domain, you must use the AceServer::CreateObject method to create the object. This
method will force the object to be created in the AceServer application domain.
This is important because there are limitations imposed by the .NET framework when saving information
that crosses an application domain boundary. Using the AceServer::CreateObject method will ensure
all objects existing in the application domain of the AceServer and that there are no access or serialization
issues if the data is saved as part of the workspace.
Here is an example showing a C# script creating an object that is saved as part of the workspace
incorrectly:
The correct way to create remotable objects that cross the application domain boundary would be:
This special handling of object creation is not required for value types, objects that will not cross the
application domain boundary. or objects that are not saved as part of the workspace.
Page 626
Server Side Plug-Ins

As noted in the table above, server side plug-ins always run in the application domain of the AceServer. As
such, all objects created by the plug-in already belong to the AceServer application domain. However, the
AceServer::CreateObject also handles other initializations, assignments, and type mapping that may be
needed when an object is created. Because of this, even server-side plug-ins should use the
AceServer::CreateObject method when dealing with RemotableObject types.
Data Collection Sample

This sample shows how to use data collection from within a C# program.
Default C# Program
When a C# Program is created, the following is created:
The script is comprised of several major elements:
l C# class defenition
l IAceServer field
l Main method entry point
The script contains many lines that cannot be modified and are considered protected. These are designated
by the light grey background. Notice that the namespace, class name, IAceServer field name, and Main
method lines are protected and cannot be changed.
When the C# Program is executed, the text in the script is dynamically compiled in memory and the Main
method is called. It is up to the user to define the logic of the script.
Page 627
Referencing other objects and tools

It is often useful to reference other objects in the wqorkspace when running a script. You can reference
other objects by dragging and dropping vision tools from the Workspace Explorer to the body of the script
as such:
Data Collection Overview

In this sample, the script will collect the encoder position for all 4 motors of a Cobra robot while the robot is
moving. Do to this, the following steps will be required:
l Acquire a handle to a robot
l Identify the data to be collected
l Collect the data
l Extract the data
l Save the data
Step 1: Acquire a handle to a robot

We first drag and drop a robot from the workspace into the script. Since the script will be moving the robot,
the script will ensure that robot power is enabled and the robot is calibrated.
Page 628
Step 2: Identify the data to be collected

The script must create a DataCollectionConfiguration collection and add DataCollectionItem objects
associated with each data item that should be collected. In our case, we must create a
DataCollectionItem for each motor of the robot and associate each one with the ServoData we wish to
collect.
The DataCollectionConfiguration also must be told how many samples are to be collected each second
and how many seconds to run the test.
Lastly, the DataCollectionConfiguration needs to be associated with the robot.
Step 3: Collect the data

Before collection is started, a CartesianMove object is created so we can command the robot to move to a
cartesian position while the data collection is being performed. The Move command is a non-blocking
command, so once issued, the script continues to run.
After the robot is ordered to move to the cartesian position, the data collection is invoked. While the data is
being collected and the robot is moving, the script will delay. Once the delay is complete, the script waits
until the motion has completed, detaches the robot, and disposes of the move command.
Page 629
Step 4: Extract the data

After data collection has competed, the data resides on the Adept Controller and must be extracted. This
extraction is done using the AdeptRobot::ReadDataCollection method as noted below.
The script is accessing the position of each motor. Once the motor positions are extracted, the motor
positions are combined to calculate the world location of the robot at each sample point.
Step 5: Save the data to a file

Lastly, the transformation data is written to a file
Page 630
Output Data File

Here is a sample of the data that was collected with the script listed above. The example moves the Z axis of
the robot up. This can be seen in the data snippet:
268.227 -102.832 66.469 0.000 180.000 -116.872

268.227 -102.832 66.469 0.000 180.000 -116.860
268.227 -102.832 66.470 0.000 180.000 -116.864
268.227 -102.832 66.470 0.000 180.000 -116.874
268.227 -102.832 66.470 0.000 180.000 -116.868
268.227 -102.832 66.470 0.000 180.000 -116.859
268.227 -102.832 66.471 0.000 180.000 -116.867
268.227 -102.832 66.471 0.000 180.000 -116.874
268.227 -102.833 66.472 0.000 180.000 -116.864
268.227 -102.832 66.472 0.000 180.000 -116.860
268.227 -102.832 66.474 0.000 180.000 -116.871
268.227 -102.832 66.475 0.000 180.000 -116.872
268.227 -102.832 66.476 0.000 180.000 -116.861
268.227 -102.832 66.478 0.000 180.000 -116.862
268.227 -102.832 66.481 0.000 180.000 -116.873
268.227 -102.832 66.483 0.000 180.000 -116.869
268.227 -102.832 66.485 0.000 180.000 -116.859
268.227 -102.832 66.489 0.000 180.000 -116.865
268.227 -102.832 66.492 0.000 180.000 -116.874
268.227 -102.832 66.494 0.000 180.000 -116.866
268.227 -102.832 66.497 0.000 180.000 -116.859
268.227 -102.832 66.501 0.000 180.000 -116.869
268.227 -102.832 66.505 0.000 180.000 -116.874
268.227 -102.832 66.508 0.000 180.000 -116.863
268.227 -102.832 66.511 0.000 180.000 -116.860
268.227 -102.832 66.515 0.000 180.000 -116.872
268.227 -102.832 66.519 0.000 180.000 -116.872
268.227 -102.832 66.522 0.000 180.000 -116.860
268.227 -102.832 66.526 0.000 180.000 -116.864
268.227 -102.832 66.530 0.000 180.000 -116.874
268.227 -102.832 66.533 0.000 180.000 -116.868
268.227 -102.832 66.536 0.000 180.000 -116.859
268.227 -102.832 66.541 0.000 180.000 -116.867
268.227 -102.832 66.545 0.000 180.000 -116.875
268.227 -102.832 66.549 0.000 180.000 -116.865
268.227 -102.832 66.552 0.000 180.000 -116.860
268.227 -102.832 66.557 0.000 180.000 -116.871
268.227 -102.832 66.562 0.000 180.000 -116.873
268.227 -102.832 66.565 0.000 180.000 -116.861
268.227 -102.832 66.569 0.000 180.000 -116.862
268.227 -102.832 66.574 0.000 180.000 -116.874
268.227 -102.832 66.579 0.000 180.000 -116.870
Page 631
Vision Tool Customization

This sample shows how to create a custom vision tool.
Default Custom Vision Tool

When a custom vision tool is created, the following is created:
The script is comprised of several major elements:
l C# class defenition
l IAceServer field
l Main method entry point
l return values from the script
The script contains many lines that cannot be modified and are considered protected. These are designated
by the light grey background. Notice that the namespace, class name, IAceServer field name, and Main
method lines are protected and cannot be changed.
When the custom vision tool is invoked, the text in the script is dynamically compiled in memory and the
Main method is called. By default, the script must return an array of VisionTransform objects. These
define the coordinates of any objects located by the tool. The default custom vision tool simply returns an
empty array of transformations. It is up to the user to define the logic of the script and to return an array
of transformations.
Page 632
Referencing other objects and tools

It is often useful to reference other vision tools or objects when running a script. You can reference other
objects by dragging and dropping vision tools from the Workspace Explorer to the body of the script as such:
Any object can be dragged and dropped from the workspace explorer to the body of a script. When an
object is dropped, the script automatically creates a reference to the object through the IAceServer field
defined in the scrip. Once an object has been inserted into a script, you can access the properties and
methods of that object as such:
Here is a sample of a custom vision tool that executes a blob tool and returns the results of the blob tool:
Page 633
Complete Example
Here is an example showing a custom vision tool that will use a blob tool and a line finder to locate a square
part. The vision tool will initially execute a blob tool to coarsely locate all parts in the vision window.
Once the blob tool executes, the script will iterate through all the results and will position a line finder tool
and execute the tool at 0, 90, 180, and 270 degrees offset from the blob center. It will use the line
returned from the line finder to calculate the 4 corners and, ultimately, the center of the square. The
center point will be returned as the result for the tool.
Page 634
Here is the output of the tool in the vision window:
Page 635
Process Manager Customization Overview

The process manager architecture was designed with extensibility and customization in mind. Many
aspects of the product can be changed to meet custom application needs. When you customize some
aspect of a process manager application, the system will create a copy of the default behavior as a starting
point for your changes.
Customizations can be defined at various places in the process manager user interface. This section details
provides an overview of the possible customizations, identifies where these are located in the user
interface, and provides links to the relevant topics in the customizer guide.
Page 636
Process Strategy Customization

The process strategy section contains parameters related to the way processes are managed. Settings
related to the process strategy can be access in the process manager editor here:
The form containing the process strategy parameters presents them into functional categories based on
the hardware components of the application.
Controller Customizations
The general controller parameters are displayed when the controller node is selected in the process
strategy editor:
Custom Error Programs V+ program called when any robot error occurs.
Customizing Stop V+ program that runs when process manager stops
Behavior running.
Page 637
Robot Customizations
The robot parameters are displayed when a robot node is selected in the process strategy editor. There are
many parameters associated with a robot. These settings are further broken down into a variety of
categories represented by tabs in the display.
Robot: General
Custom Robot Program: Main V+ robot program that initiates all robot
Overview logic and behaviors.
Custom Robot Process V+ program called to select a process for the robot
Selection Program to execute.
Robot: Allocation
The parameters in the allocation section control how part and target instances are allocated to the
associated robot:
Page 638
Custom Allocation C# Script running on the PC which decides which instances to

Scripts allocate to a robot.
Robot: Wait Mode

The parameters in the wait mode section control how the robot behaves when an instance or process is not
available for processing:
Custom Robot Wait V+ program deciding what a robot will do if no instances are
Page 639
Programs available for processing.
Robot: Error Responses

The error responses section detail how individual error conditions should be handled by the selected robot:
Custom Robot Error V+ program that is called when a specific error

Response Programs condition is detected for a given robot.
Control Sources: Belt Monitoring

When a belt is used to present part or target instances to a robot, the software creates a default V+
program to manage the belt operation. The settings associated with the belt monitoring can be viewed
under the Control Sources section in the process manager editor:
When selected, the available control sources are presented in a list on the left. When you select the belt
source for a given belt object in your process configuration, you will see a page similar to this:
Page 640
Depending on your specific configurations, different settings will be available.
V+ program that monitors the status of a belt, and any associated

Belt
latches, cameras, and spacing configurations. Reports the status of these
Monitoring
items to the PC.
Motion Settings: Pick and Place

When the user defines a process that is composed of a part and a part target, the software will create
motion settings that are used when processing the parts and targets. You can access the settings in the
configuration item section. When one is selected, it will look like this:
Page 641
Custom Pick and Place Motion V+ Program called when an instance is to be

Programs picked or placed.
Motion Settings: Refinement

A process can be configured to refine the location of a part in the gripper before placement. Once this is
defined, the software will create motion settings for the refinement operation in the configuration item
section. When selected, it will look like this:
Page 642
Custom Refinement Motion V+ Program called when a refinement operation is to

Programs be performed.
Page 643
Advanced Debugging Techniques

When running a process manager, there may be times where you need to troubleshoot what the software
is doing. There are several features in the software that can be used to understand the state of the
system:
l Process Manager Runtime Control
l Event Log Display
l Triggering Additional V+ Logging
l Vision Results Logging
l Virtual Camera Image Logging
l Diagnostic Summary Display
l V+ Profiler Display
l System Monitor Display
Process Manager Runtime Control

The process manager runtime control will give an overview of the status of the process manager:
Page 644
Page 645
The hardware section will show you the status of the hardware associated with the process configuration.
When errors occur, they are displayed in the status tab:
If a robot is waiting for a part or target, the process manager display will show a warning rather than an
error as such:
Page 646
Event Log Display

Any errors and general messages that are generated by the system are placed into the event log. The
event log can be located under the main menu Help pull down:
Page 647
When the event log is selected, the following window will appear:
Clicking on the columns will allow you to sort the event details. The copy button will convert the log to a
text format and copy it to the clipboard. If you double click on an error or warning message, additional
details will be displayed concerning the log entry. For example, double clicking on an error message will
display the details of the error message:
Page 648
Triggering Additional V+ Logging

You can enable additional logging information by setting special V+ variables at the V+ monitor window. To
enable logging for all process manager tasks, you can type the following at the monitor window:
SETR pm.log = TRUE
You may not want to enable logging for all V+ tasks. In that case, you can set a task specific variable. For
example, to enable logging for task 3, you can type the following at the monitor window:
SETR pm.tsk.log[3] = TRUE
When additional logging is enabled, additional entries will be placed in the AceServer event log. For
example:
When advanced logging is enabled, the following will be written to the log:
Page 649
l Process Selection information
l Belt on/off and speed control
l Robot waiting for an instance to track into a belt window
l Robot skipping an instance because it travels out of the belt window
l Latch signals detected by the belt handler program.
Vision Results Logging

Many of the vision tools supports an advanced parameter called Results Logging. When enabled, it will
log the results to the specified text file:
The file extension will dictate the format for the data. If the extension is "csv", then the file will be a
comma separated value file. Any other extension will result in a common text format familiar to users of
AdeptSight 2.
Virtual Camera Image Logging

The virtual camera can be configured to automatically save images to a folder:
When enabled, the virtual camera will maintain a rolling buffer of image files in the specified directory.
When the total number of images has been written, the oldest image will be deleted when the next image
is saved.
These images can be imported directly into an emulation camera and associated with a virtual camera to
test vision tools offline.
Diagnostic Summary Display

The diagnostic summary display shows detailed status information on many different aspects of the
system. This can be accessed under the help menu:
Page 650
When the diagnostic summary is selected, the following window is displayed:
When selected, details of the process manager are placed into the summary. If a process manager is
running, it will detail the following information:
l Process manager name and run status
l The communication status of all robots and instances associated with each robot
l The instances associated with each hardware source.
This information can be used to check the allocation status.
V+ Profiler Display
Under the controller development tools is a profiler display that shows the amount of processor time being
used on the selected controller. The profiler button is located on the controller development toolbar and
looks like this:
When selected, the following is displayed:
Page 651
When an application is running, if you have a low amount of Null processor time, it is an indication that the
V+ operating system may be overloaded and not operating efficiently.
System Monitor Display

The system monitor is a central place where statistics concerning a process manager can be accessed. The
system monitor can be quickly accessed using the toolbar icon:
When displayed, you can select a process manager in your workspace and view/graph statistics relating to
the process manager runtime:
Page 652
Belt Control I/O

The ACE PackXpert software can be configured to control a belt using digital inputs and outputs associated
with a controller. These belt control signals must first be defined in the Belt object in the workspace:
Page 653
Once the controller is identified, you must specify the digital outputs from the controller that will be wired
as inputs to the controller dirver. The following output signals are used by ACE PackXpert:
l On/Off: Used to turn the belt on and off. When the signal is asserted, the belt is expected to turn on.
l Fast/Slow: Relative speed of the belt. When the signal is asserted, the belt is expected to move
faster. This allows for 2 levels of speed control.
l Reverse/Forward: Direction of the belt. When the signal is off, the conveyor is expected to travel in
the nominal direction representing normal part flow through the system.
The Fast/Slow and Reverse/Forward signals are optional. If they are not used, then the signals should be
set to 0.
Belt Control Settings

After the belt control signals are defined, the user needs to configure how those signals will normally be
used. This is done in the Process Manager editor under the Process Strategy settings:
Once selected, navigate to the belt object in the Process Strategy Editor:
Page 654
The belt control has 3 different modes of operation:
l Do not control the belt: The I/O signals defined in the Belt editor are not used.
l Leave the belt always on: When the process manager starts, the belt will be turned on and will
remain on.
l Control the belt: When the process manager starts, the belt will be turned on and off based on the
product flow through the system.
When the Control the belt option is selected, the belt will be turned off based on the product flow for a
selected robot. A typical configuration would look like this:
Page 655
Normally, you would select the robot that is furthest downstream in your system. You can then set the Off
threshold. If an instance on the belt reach that position in the robot belt window, the conveyor would be
turned off. Once the robot processed that instance and there are no instances beyond the off threshold,
the belt would be turned on. You can also enable speed control to be used. When enabled, you can set a
second threshold in the belt window. When an instance reaches that threshold, the speed will be changed
from fast to slow. If used correctly, you can minimize the number of times the belt will completely stop.
In the above graphic, the robot queue that is selected is /Hardware/Cobra 350 1. When running, if an
instance reaches 30% into the robot belt window, the fast/slow I/O signal defined in the belt editor will be
turned off. If an instance passes the 75% threshold, the belt would be turned off. The location of the belt
stop line can be visualized in the 3D virtual display. For example, if the process manager is being displayed,
you might see the following:
Page 656
The black line represents the stop line at the 75% position along the belt window.
Belt Control: Defining a Custom Belt Program

The default belt monitoring program is responsible for monitoring all belts being controlled on a single
controller. That program monitors the part and target queues associated with the specified robots and
applying the I/O signals associated with each belt. If the default behavior is not acceptable, the default
program can be customized in the process strategy configuration section located here:
Page 657
When a custom belt control program is specified, you will start with a copy of the default belt monitoring
program. That program, as noted, is responsible for monitoring all belts that are defined in the process
manager. The person customizing the belt program is responsible for ensuring the customized program
behaves as expected for the application.
Belt Control: Default Belt Program Behavior

In order to provide a custom belt program, it will be helpful to review the workings of the default belt
program. To do this, we will break the code into sections.
Iterate Through the Belts

In the first section, the default belt program starts by going through all defined belts. If any belts are
configured to not be controlled, those belts are skipped.
Evaluate Type of Belt Control

For any belts that are being controlled, if the process manager is actively running, it will check to see if the
belt control was configured to "always on.". If that is the case, the belt is turned on. If the belt mode is not
always on, it will find the farthest downstream position of any part or target instance associated with the
robot on the belt being checked. This is done in the call to pm.ps.obj.dist. The farthest downstream
instance position is compared against the off and speed threshold. The appropriate signals are asserted
based on those comparisons.
Page 658
It is important to note that the instance position is based on all instances currently in the robot queues.
Instances on the PC that have not been sent to the robot are not taken into account when calculating the
farthest downstream instance position.
Run Check: Turn Belt Off

If the program was called when the process manager was shutting down, the code would turn off the belt if
belt control was enabled.
Page 659
Belt Monitoring
A part or target can be configured for presentation on a belt in one of three modes:
l Belt Camera
l Latch Input signal
l Instances created at a spacing interval
To handle these 3 cases, the process manager must download and run a V+ program. This program must
monitor and control when parts and targets are created based on feedback from the belt encoders. As the
various belt encoders change position, the program will send messages to the PC triggering the creation of
parts and targets.
Belt Monitoring
If the default behavior of the belt program is not sufficient, then the user can customize the default belt
control program. The customization can be done in the control source editor:
The belt control program is a rather long program. To discuss the behavior, it can best be consumed by
breaking it into separate sections:
l Initialization
l Monitor encoder motion
l Monitor spacing points
l Monitor hardware latches
l Monitor camera points
Page 660
Initialization
When the belt program starts, it will first initialize all tracking structures. The code section starts around
here:
It will initialize the following:
l Current position and velocity of the belt
l The spacing point based on the current belt position
l The camera reference point based on the current belt position
l Clears all tracking structures
Monitor Encoder Motion
Once the belt control finishes initializing control variables, it will monitor the encoder position and velocity.
After it checks all of the encoders, it will periodically send the current encoder position and velocity to the PC
using the call pm.ace.blt.pos.
Page 661
Monitor Spacing Points
In the initialization section, tracking variables are initialized for the spacing reference points. When a
spacing part or target is defined, the user specifies the distance between the generated instances. This
spacing parameter is used, along with the scale, to determine how much the conveyor must move before
a part is generated. After the conveyor moves the specified distance from the reference point, it will send a
message to the PC to create an instance using pm.ace.blt.sp.
Page 662
If you would like a custom tag to be associated with instances created by the spacing event, the call to
pm.ace.blt.sp can be modified to pass in a tag for the last argument.
Monitor Hardware Latches
The program will go through the list of encoders that need to be monitored for latches. When a latch is
detected, it will check the latched encoder position against the minimum latch distance that was defined in
the belt editor. If the latch distance is sufficient, the latch information is sent to the PC using
pm.ace.blt.ltch.
Page 663
Some applications may want to change the logic for when latches are reported. For example, an
application may require only sending every-other latch so a robot only processes 50% of the instances
generated from the latch.
Additionally, if you would like a custom tag to be associated with instances created by the latch event, the
call to pm.ace.blt.ltch can be modified to pass in a tag for the last argument.
Page 664
Monitor Camera Points
In the initialization section, tracking variables are initialized for the camera reference points. When a belt-
camera based part or target is referenced in the process manager, the user can specify if the picture is
triggered by conveyor motion or a digital signal. When conveyor motion is specified, the user will specify a
camera picture percent. This is used, along with the scale and the average field of view size, to determine
how much the conveyor must move before a camera picture request is generated. After the conveyor
moves the specified distance from the reference point, it will send a message to the PC to perform a picture
using pm.ace.blt.cam.
If the user specified a signal trigger, pictures will be taken when the signal is asserted.
Page 665
Page 666
Conceptual Overview
The process manager is an application development module within ACE. The goal is to allow for the
development of packaging applications.
The term “Packaging” represents a class of applications that involve belt tracking of product which is being
processed by multiple robots spread along a conveyor. These robots must coordinate their actions and
ensure that the finished product is adequately handled. The classic example is multiple robots placing
chocolates into boxes of candy. These robots must coordinate their actions and ensure that all boxes of
chocolates have all slots filled by the time the last robot is done with a given box. In this application domain,
multiple robots may be capable of processing the same part, with or without additional rules and
restrictions. Additionally, robots are capable of performing multiple tasks. Lastly, multiple instances of a
given product must be tracked simultaneously.
These kinds of applications focus heavily on the aspect of synchronizing multiple robots where a given
robot’s current behavior is selected based on availability of product. Because of the robot synchronization
requirement and the fact that multiple instances of product must be tracked across multiple robot
domains, these applications need to be built from a “top down” approach. These applications start with the
definition of “parts” and “targets”. Then the user describes which robots can do with parts and targets. The
concepts of the locations, paths, IO are all derived from the top down approach.
Top Down Approach: An Application Framework

In order to correctly synchronize instances between multiple robots and controllers, the software takes a
"top down" approach to defining the application. Since there is a lot of infrastructure required to track and
synchronize instance information, the process manager provides a large amount of pre-packaged software
and behaviors. Many of the default software behaviors can be customized.
Assuming you have a workspace that contains a controller and a robot object, an application starts with the
definition of a part that needs to be picked and a belt object the part may be presented on:
Once the part is created, the target where the part will be placed must likewise be defined:
Page 667
After defining the part and targets, the user will create a processes in the process manager
Once all the parts, targets, and processes are define, the software creates a series of data points that are
required by the framework: robot configuration data, robot-to-belt calibrations, and robot-to-
sensor/camera/latch calibrations. This data can be directly accessed in the process manager editor:
Page 668
Hardware Sources: Provide Instances

When a process manager application is run, the framework uses the part and targets referenced in the
process list to create many tracking structures. In general terms, each part and target has a tracking object
that identifies instances that are available for processing. Sometimes these objects are called hardware
sources and they are represented in the software as a BaseSource.
Each BaseSource will identify what instances are available for processing. For a given part, a different kind
of BaseSource will be created depending on the configurations of the part.
In the example above, the source object used to manage the belt based part is a BeltSource. The
BeltSource is responsible for taking pictures using the camera and matching the vision coordinates with
latch information sent from the controllers for any robots that can pick that part.
Page 669
The source object used to manage the static target is the StaticPartTargetSource.
Often times, the BaseSource will communicate with programs running in V+ in order to manage the
availability of instances. In the case of a BeltSource, each source will have a V+ belt program that is
responsible for monitoring the belt encoders and will send messages to the BeltSource on the PC when
pictures need to be taken and latches are detected.
Controller Queue: Process Instances

When a process manager application is run, the framework uses the process list to identify all the robots
that are capable of processing parts and targets. Each RobotStation is capable of consuming the
instances that are provided by the BaseSource objects.
Process Manager Runtime Control: Hardware Display

The runtime control for the process manager is located in the ACE Task Status Control. Each process
manager will have an entry under the process manager section. When a process manager is selected, the
runtime control and status for that process manager is displayed in the Task Status Control.
The process manager runtime control displays the BaseSoruce and RobotStation objects:
Page 670
Page 671
You can use the Instances tab on the runtime display to view instances associated with a specific hardware
source.
Process Strategy: Data Models

The process strategy is the object that is responsible for associating instances supplied by the hardware
sources with robots that can process those instances. As an example, here is a diagram showing the data
flow for the vision-located belt part:
When the application runs, a V+ belt control program is launched on the robot controller. The belt control
program monitors for conveyor motion and input latchs. As the conveyor advances, it will send requests to
the belt handler to take a picture with the camera. Additionally, the belt control program sends the latch
information to the belt handler as they are detected.
The belt handler will take the instances located by a camera vision operation and associate it with latches
received from the controller. Once it identifies instances for processing, it adds it to the list of parts that are
available.
The allocation algorithm is notified when instances are made available for any hardware source. At that
point, it will locate the farthest upstream robot that can process the instance. It will allocate that instance
to that robot. This diagram shows the data flow for how RobotStation queues are managed:
Page 672
When an instance is identified by a hardware source, it is unallocated. The process strategy code will
identify the first robot capable of processing the instance. For belt based instances, this will be the farthest
upstream robot that can pick the part.
When the instance is associated with a given robot, it is put in a "potential queue." These are instances
that are allocated to a robot but have not been sent to the controller for processing by the robot controller.
If space is available in the queue of instances on the robot controller, the part is moved to the "allocated
queue" and sent to the robot controller.
When the robot controller is finished processing an instance, it will send a message to the process strategy
indicating if the instance was processed or if the part was skipped. If the part was processed, the instance is
removed from all tracking structures on the PC. If the part was not processed, the instance is moved to the
"potential queue" of the next robot that can process the instance. If there are no more robots capable of
processing the instance, the instance is removed from all tracking structures.
Page 673
Custom Allocation Scripts

The process manager allows for customization of the allocation logic if the default allocation strategy does
not fit your needs.
The default allocation strategy is designed so that each robot will pick as many instance as possible and
instances are ordered from farthest downstream to farthest upstream. Any instances not processed by a
given robot are placed in the next robot queue that is capable of processing the instance.
Some examples of situations that would require a custom allocation script:
l Instances need to be picked up in rows perpendicular to the flow of parts. In this case, instances
may need to be grouped into rows then sorted left-to-right.
l Instances need to be "load balanced" between a certain number of robots.
Creating an Allocation Script
An allocation script can be added to the workspace as such:
Once created, the script must be associated with each robot that will use the script:
Page 674
Each robot maintains a queue size which defines how many instances of a given kind can be send to a robot
controller. This queue size parameter is not the total number of instances, it is the total number of
instances of each part or target that can be sent. The robot controller maintains a different queue for each
possible part or target that a robot can process. This parameter defines the queue size for each of these
queues.
Default Allocation Script

When a default allocation script is created, it is initialized to use the logic of the default allocation algorithm.
There are 4 different methods that can be customized:
l Initialize
l Allocate Non-Belt Instances
l Allocate Belt Instances
l Notification as Instances are Processed
Default Allocation Script: Initialize Method
The Initialization method is called when the process manager is started. Each robot that is associated with
the script will used to call the initialize method:
Page 675
Default Allocation Script: AllocateNonBeltInstances
The data requirements and allocation logic for belt based instances is very different than for non-belt based
instances. As such, each class of instances is handled by a separate method. The non-belt instance
method is called to allocate static and non-belt camera instances. The default behavior is to allocate the
instances to the robot as long as there is space in the queues.
The non-belt instances method is passed two different arrays of note:
l availableInstances: Input parameter containing the list of all instances that could be allocated.
l instancesToAllocate: Output parameter containing the instances that should be sent to the
robot controller.
It is the job of the AllocateNonBeltInstances to move instances from the availableInstances list to
the instancesToAllocate list.
Default Allocation Script: AllocateBeltInstances
The default behavior for allocation of belt-based instances is similar to non-belt instance handling from the
standpoint that instances are allocated to a robot as long as the queue can take more instances.
The belt instances allocation method is passed three different arrays of note:
l availableInstances: Input parameter containing the list of all instances that could be allocated.
l instancesToAllocate: Output parameter containing the instances that should be sent to the
robot controller.
Page 676
l instancesToAllocate: Output parameter containing the instances that should be sent to the next
down-stream robot capable of processing the instance.
It is the job of the AllocateBeltInstances to move instances from the availableInstances either the
instancesToAllocate list or the instancesToSkip list. The availableInstances list is an ordered list
where the first instance in the list is the farthest downstream instance that is still capable of being
processed by the robot station.
If an instance is never allocated by the AllocateBeltInstances method, the instance will automatically
be moved to the queue of the next downstream robot once the instance passes out of the robot belt
window.
Default Allocation Script: NotifyInstancesProcessed
After an instance is sent to a RobotStation, the robot will either respond indicating that the instance was
processed sucessfully or the instance was not processed. For example, if a belt-based instance was picked
by the robot, it would respond to the PC that the instance was sucessfully processed. However, there are
times where the robot was not able to pick all the instances on the conveyor because there are too many
given the belt speed. In this case, the instances are robot responds to the PC that those instances were not
processed.
As robots report which instances are processed and not processed, the NotifyInstanceProcessed
method is called:
Page 677
Default Allocation Script: LocatedInstance
The LocatedInstance class represents an instance that can be processed by a robot. There are many
properties which can be useful when defining if an instance should be processed:
l BeltRelativePosition: Gives the position of the instance relatively to the belt frame and varies with
time
l DistanceToPickLine: Gives the distance between the instance and the pick line limit and varies with
time
l DistanceToUpstreamWindow: Gives the distance the upstream line and the instance and varies
with time
l Handler: Gives the source handler that generated the instance
Page 678
l Location: Location of the instance in its local frame
l ObjectType: Gives the “name” of the object type as a string
l PalletIndex: used only if the instance is pallet relative and defines the index of the pallet slot.
l PalletInstance: used only if the instance is pallet relative. unique identifier (Guid) of the pallet
associated with this instance
There are also several methods that can be used in the process of allocating instances:
l GetControllerLatchPosition: Get the latched value of the instance (reference)
Default Allocation Script: LocatedInstance and the Tag property

There is one additional property that can be very useful when synchronizing a custom allocation script with
a C# custom vision tool and/or robot behavior in V+. When a custom vision tool executes, a
VisionTransform collection is returned as an output of the Main method. The VisionTransform class
Page 679
has a Tag property which is of type object. You can use this property to tag a vision instance in the
custom vision tool and retrieve this tag from an allocations script.
For example, your custom vision tool might look like this:
From within the allocation script, you can access the information as such:
Additionally, if the Tag is defined for a LocatedInstance, the Tag will be converted to a string representation
and send to V+ as part of the instance information. From within a custom motion sequence program, the
tag can be extracted as follows:
Page 680
Custom Error Programs

The process manager runtime control will display errors that are reported during the execution of a process
manager application. Many of these errors are generated from the V+ programs that control the robot and
monitor other aspects of the hardware on the Adept controller.
For all errors generated on the controller, the user can customize how errors are handled and which errors
are reported to the user interface.
Error Display
The process manager runtime display will show errors for all hardware sources, controllers, and robot
stations:
Page 681
Page 682
V+ Error Customization
When an error is generated on a controller, a single program on the robot is called to handle the error. This
program makes a determination if an error is to be send to the PC to display or if the error should be
automatically handled without user notification.
This program can be customized on a controller by controller basis:
When the program is customized, the user will start with a copy of the default error handling program. Here
is a copy of the default program:
Page 683
Page 684
The error program will be called and passed the task number that has the error, the error code, and other
details of the error. The program must pass back a status code the describes the response on how the error
is to be handled in the resp parameter. The possible values are:
Response
Description
Code
pm.tsk.success The operation has completed successfully.
Stop processing current instance as if it was properly
pm.tsk.skip
processed and move to the next operation.
pm.tsk.retry Retry processing of the current instance.
pm.tsk.abort Stop processing the current process and clear the gripper.
Stop processing the current instance and move to the
pm.tsk.next
next instance in the queue.
pm.tsk.fail The operation failed.
The default program will check to see if an error code indicates a belt window violation was detected. If this
is true, the error program will automatically return a pm.tsk.abort response. This will cause the robot to
abort the current process, clear the gripper, and look for a new process.
The default program will also check to see if an error code indicates an error from the gripper operation. If
this is true, the error program will automatically return a pm.tsk.fail response. Doing so, the part or target
that was being processed will be marked as failed causing the system to remove it from queues and not
pushing it to the next robot on the conveyor : indeed we assume it may have moved when we tried to
process it.
If the error is not a belt window violation, the default program will call pm.error, which will send the error
to display on the process manager runtime control. When called, the error is presented to the user and any
response will be returned.
Some applications may want to display errors in a different way. For example, if a user wants to display an
error using an IO panel with lights and monitor for button presses, the application should not call the
pm.error program. Rather, it should turn on IO signals to indicate an error has been detected and then
monitor for the press of a button through digital input points.
Custom IO Feeder Programs

When an IO Feeder is created it comes with a standard program managing a sequence of input and output
signals and performing the feeding operation of the device. If the default sequence does not meet the
requirements, the program that governs the behavior of the IO Feeder can be customized.
Customizing The Feeding Sequence

The IO Feeder editor defines all the parameters used when feeding parts or targets. The program managing
the sequence can be overridden:
Page 685
Use Custom Program checkbox allows replacing the standard program by user's one. When checked, the
custom program selection box is available and user can select which program to use.
When the feeding program is customized and user wants to start from the standard one, the system starts
by creating a copy of the default feeding sequence. The default feeding program allows 2 operations :
l Managing the input and output sequence performing the feeding operation
l Defining a set of instruction to be executed at initialization (called at IOFeeder start)
The definition of the default feeding program header looks like this:
Page 686
The feed sequence will be passed the IO Feeder number and the flag indicating the method is called to
perform the initialization or to perform the feeding sequence.
The first step of the default program is to declare variables and to perform the initialization sequence when
init.flag is true.
Page 687
During this step the variables are declared and the case init.flag is true is handled. This is called when the
IO Feeder is started. A 2D array is used to indicate for each IO Feeder the Controller tasks it is allowed to
use. Default will indicate tasks 2 to 20. At start, this array is scanned and the first available task is used to
run the IO Feeder main program.
If user is running his own programs on dedicated tasks he can then ensure the IO Feeder will never try to
use it. He can also fill it with only one value to force the IO Feeder running on a known task.
When called with the init.flag value to true, this will be the only operation performed by this program.
The rest of the program contains the Feeding sequence.
First step of feeding sequence is its initialization :
The call to fdr.pc.op.start indicates the PC that the IO Feeder identified by fdr.idx started running. The
sts value is simply the result of this instruction and is not used here.
fdr.command[fdr.idx] is then switched to a neutral value indicating the IO Feeder main task the
requested operation is being performed.
Page 688
Then all the parameters used to perform the operation are stored in local variables : if they are modified by
user during the sequence it then has no impact on current operation. Feeder status is set to 'running'.
The last part of initialization is checking the handshake input is low in the case it is used. If not, feeding is
not possible and an error will be returned.
Note : Reading a signal value is done using sv.sig.is.equal program. This program reads the input and
tells if it is at the expected state. Any customization should use this program to read inputs as it manages
the case we are running on an emulator. Signals can be read using the SIG keyword but in this case it may
not work properly with the emulator.
Once the initialization and checking are performed, the feeding can start.
the sig.part.proc output is switched on and activates the IO Feeder. Once it is activated we are waiting for
the specified dwell time before continuing.
If an handshake signal is to be used the program is waiting for it to be on using the debounce.sec value to
check it remains stable long enough.
After these operations are completed, the feeding is done and we have to terminate the sequence:
Page 689
The processed output is switched off and program waits for handshake signal to go off.
fdr.status[fdr.idx] is set to 'available' and fdr.pc.op.end indicates to the PC that the IO Feeder
operation is finished. This instruction will report the operation result stored in fdr.status[fdr.idx] to the
PC : this can be a success value or an error code that will be managed on PC side.
Customizing System Initialization

When the process manager establishes communications with a controller in runtime, it will go through a
data initialization and startup phase. The user can define a V+ program that is called when the process
manager starts the initialization process on a controller through the following menu:
Page 690
Custom Initialization Program

The custom initialization program looks like this:
Page 691
By default, the standard stop program does nothing. It can be used to initialize variables, parameters or
tasks used by an application. For example, if you wanted to start a custom V+ program in a background
task, this program could be used to execute the program task.
Custom Pick and Place Motion Programs

When a process is created, the process specifies that a robot must pick a set of parts and should place
those parts at a set of targets. The process manager will supply a default set of motions used to acquire the
parts and place at the targets. If the default motions do not meet the requirements, the program that
governs the behavior of the motions can be customized.
In addition to defining parts and targets, a process may also reference a refinement station that locates
parts in the gripper before placement at targets. The program that defines the motions of a refinement
operation can also be overridden if the default motions are not sufficent.
Customizing The Motion Sequence

The motion sequence configuration item defines all the parameters used when moving to pick a part and
place at a target. The motion sequence logic can be overridden:
Page 692
When the motion sequence program is customized, the system starts by creating a copy of the default
motion sequence. The default motion sequence can be broken down into several steps:
l Calculate Approach, Move, and Depart Positions
l Wait for belt based objects to track into the belt window
l Perform the Approach Sequence
l Perform Move to Destination
l Perform the Depart Sequence
The definition of the default motion program header looks like this:
The motion sequence will be passed the task umber and the name of the type of product being processed in
the $type variable. The $type variable can be used to determine what part or target is being called. For
example, if your process manager references a target named "/Process/Target", the following code is valid:
IF $target == "/Process/Target" THEN
Page 693
The first step of the motion sequence program is to calculate the approach, move, and depart positions:
The default program will account for the transform associated with the gripper tip by applying the INVERSE
of the offset to the position so the robot will not stop when a TOOL command is executed.
After the positions are define, the software will wait for any belt based objects to track into the belt
window:
Page 694
The call to pm.rob.monque is very important. That program will check the part and target queues
associated with the robot. If any parts or targets can no longer be processed, the instances are marked so
they can be returned to the PC for processing for a downstream robot.
Once the instance can be accessed by the robot, the software will then process the approach sequence:
Page 695
The approach sequence is relatively straightforward. The motion primitive pm.mv will issue the move
instruction to the robot and pm.mv.chkbrk will check for any BREAK settings on the approach sequence.
Lastly, the program will make sure the correct gripper tip is selected.
After the approach is processed, the software will perform the move to the destination:
Page 696
The move to the destination is very similar to the approach and uses some of the same primitive functions.
Once the call to pm.mv.chkbrk has completed, the software will ensure the gripper is in the correct state
before continuing.
Once the move has been processed and the gripper is in the correct state, the software will perform the
depart motion sequence:
The depart sequence is very similar to the approach sequence.
Custom Process Strategy Monitoring Programs

The process manager application software will run a background program on each controller that is
responsible for managing part and target queues and triggering belt monitoring programs. It is highly
unlikely one would need to customize this program, but it is available in the process strategy editor here:
Page 697
The process strategy monitoring program is broken into two different sections:
l Variable Initialization
l Control Loop
Variable Initialization
The default program first initializes variables that are used to monitor initialization of data structures used
by the task. These should not be modified:
Page 698
Control Loop
After variable initialization has completed, the software will then enter a continuous loop as long as the
process manager is running. The program simply calls other programs to ensure the servicing of the
following:
l Process strategy data structures (pm.psp.init)
l Belt control monitoring (pm.psp.belt)
l Instance processing (pm.ps.monitor)
Great care should be taken when modifying this program. The servicing of these three functions is critical
to the normal operation of the system. These programs affect how the robots process the instance queues.
Custom Refinement Motion Programs

When a process is created, the user can define a refinement operation. When the refinement is specified,
the instance will be located with a camera after the pick operation and before the placement operation.
The program that defines the motions of a refinement operation can also be overridden if the default
motions are not sufficient.
Page 699
Customizing The Refinement Sequence

The refinement configuration item defines all the parameters used when refining parts in the gripper
before placing at a target. The motion sequence logic can be overridden:
When the refinement program is customized, the system starts by creating a copy of the default
refinement sequence. The default refinement sequence can be broken down into several steps:
l If normal camera refinement is enabled
l Calculate the Approach, Move, and Depart Positions
l Perform the Approach Sequence
l Perform Move to Destination
l Issue Camera Refinement Operation
l Perform the Depart Sequence
l If Vision-on-the-Fly refinement is enabled
l Calculate the Start and End Positions
l Move to the Start Position
l Start Moving to the End Position
l Trigger the Refinement Operation
The definition of the default refinement program header looks like this:
Page 700
Many of the primitives are the same as what was seen in the default motion sequence program, so the
program will not be reviewed with the same level of detail.
Custom Robot Error Response Programs

The process manager allows you to specify how a robot handles a specific error or class of error. If custom
operations need to happen when the error is being handled, the user can specify a custom V+ program that
will be called:
Page 701
Customizing The Error Response Program

The default error response program does not perform any operations:
This program should be modified to implement any custom operations that are required. Typically, this
might involve setting application specific variables or triggering other custom operations.
As an example, here is custom code that shows a typical customization that might take place. When the
error program is called, it will use digital I/O to communicate with an external PLC. After continuing, it
checks the system power state:
Page 702
Custom Robot Process Selection Program

Some applications may only need to customize the process that is selected for a given robot without
customizing the entire robot program. If this is the case, the process selection can be customized here:
The default process selection program looks like this:
Page 703
The first section will check to see if only one process exists. If that is the case, the process is automatically
selected, regardless of the availability of any parts or targets. If this is the case, no other logic is performed
for process selection.
Page 704
If multiple process are define, the program will go through all of the processes and check to see if all parts
for a given process are available in the queue by calling the pm.ps.chk.part and pm.ps.chk.partx
programs. Those programs will scan the queues and ensure the total number of instances required by the
process are available and return the farthest upstream and downstream position of the required instances.
If all parts are available, the program will next check to see if all targets for the given process are available in
the queue by calling the pm.ps.chk.targ and pm.ps.chk.targx programs. Those programs will scan the
queues and ensure the total number of instances required by the process are available and return the
farthest upstream and downstream position of the required instances.
Page 705
If all parts and targets are available for a process, the program will decide if this process should be marked
for selection. If no other processes have been selected, then it will select the process. If another process
had already been selected, it will pick the process that has the farthest downstream instance.
Page 706
The program will iterate through all of the process. There is an additional check performed after all the
processes have been checked. If only one process is enabled, then that process will automatically be
selected.
Using a custom process selection program, you can change the selection criteria for a process. For example,
the following code will force the selection of a process based on the part position, ignoring the status of any
targets.
Custom Robot Program: Overview

The process manager application software allows you to take complete control over the behaviors of a robot
by customizing the main program that governs the robot top level behaviors. When a custom robot
program is created, a copy of the default program is used as the basis for the custom program.
Page 707
There default main robot program will call a process selection program and then execute that process.
However, some applications may benefit from customizing the main robot program to force the selection
of a process directly based on some custom condition or bypass the concept of processes entirely and
command the robot to pick directly from the part and target queues. These two possibilities are detailed
below.
The robot program can be customized in the process strategy editor:
Specification of Processes
One possibility for customization is to change the selection of processes. Below is an example of a program
that does the following:
l Initializes the robot program moving it to an idle position
l Looks up the process index for 2 processes defined in the process manager
l Command the robot to execute the first process 3 times followed by 1 execution of process two.
l Check to see if the stop button was pressed
Page 708
The process index used in the custom robot program in the call to pm.ps.map.idx is the process index
associated with the process on the PC. This process index can be located in the part process editor in the
process manager editor:
The program pm.ps.map.idx converts the process index on the PC to an index relative to the current
robot task. It is this converted index that must be used when calling pm.rob.process.
Accessing Queues
There is an alternative to using process selection to customize the robot behaviors. A custom application
can directly access the part and target queues without using processes. There are times where the options
Page 709
allowed in the confines of a process are to restrictive. Using this technique, you can create more custom
logic without having to specify low level motions of the robot.
Below is an example of a program that does the following:
l Initializes the robot program moving it to an idle position
l Looks up the queue numbers for a part and a part target.
l Command the robot to pick a part and then perform a placement of that part at a part target.
l Check to see if the stop button was pressed
Custom Robot Wait Programs

When the robot does not have product available, it enters idle mode. The process strategy allows you to
select the behavior of the robot when it enters an idle waiting mode:
Page 710
By default you have the option to leave the robot at the current position or move it to the idle position after
waiting a certain amount of time. If you want, you can customize the robot wait program. When it is
customized, you start with a copy of the default program:
Page 711
The default program gets called while the robot is waiting. By default this program implements the logic
described above. If Move to Idle is enabled, it will monitor the elapsed time and move the robot to the idle
position as needed. This can be seen in the body of the program:
Page 712
Customizing Stop Behavior

When the process manager application is stopped, the system will perform a stop procedure to stop the V+
tasks used by the runtime.
The user can define a V+ program that is called when the process manager is in the process of stopping
through the following menu:
Page 713
Custom Stop Program

The default stop program looks like this:
The stop program will be called twice. It will first be called before the V+ process manager tasks are
stopped. After the V+ tasks are stopped, the program will be called a second time. When the custom
program is executed, the program will be allowed to run for 500 ms each time. If the program has not
completed execution in the allowed time period, the program will be aborted.
Page 714
The default stop program will perform any belt stop operations that are configured in the process manager.
Part and Target Queues

Parts and target instances are generated by hardware sources. These instances are allocated to robots by
the packaging software based on a number of factors. The basic parameters that dictate when and how
parameters are allocated are located in the Process Strategy Editor under the Allocation tab for each robot:
Belt Instance Filtering
For a given robot, you can specify how you want it to manage belt based part and target instances. When
instances are first created, these settings dictate how the flow of instances will be managed for the given
robot. You have the following modes of instance filtering to choose from:
No
The robot will attempt to pick all instances that are available.
Filtering
Pick/Skip Robot will be allocated ‘m’ instances then skip ‘n’ instances. This is
Instances interpreted as a strict requirement.
Percentage The robot will be allocated ‘x’ percentage of instances spread across the
of range of instances.
Page 715
Instances
Robot will attempt to skip instances to achieve the specified rate of
instances for downstream robots. The system calculates the
Skip Rate
instantaneous instances/minute on the belt and set the allocation %
based on desired skip rate.
The instances are spaced out based on the minimum distance between
Relative
instances in the direction of the conveyor travel. This can be used if you
Belt
have a much larger number of instances that can be processed by the
Position
robot.
Pick/Skip The robot will be allocated ‘m’ pallets then skip ‘n’ pallets. This is
Pallets interpreted as a strict requirement.
For many applications, these parameters are not needed. However, for applications that have a large
number of instances or have multiple robots, these settings may be useful. For example, in a multi-robot
applications, you may want to configure the first robot to use a Skip Rate allocation so the downstream
robots are supplied a constant rate of product. This may allow the system to smooth out the flow of
instances and achieve higher throughputs and more even distribution of work.
Instance Allocation
After the Belt Instance Filtering has been applied, a collection of instances will have been identified for
the robot to process. The Instance Allocation parameters identify when those instances will be sent to
the robot.
Identifies how many instances a robot can actively process and

track. If there are more instances available than can fit in the
queue, those instances will be sent as instances are process by
Queue Size
the robot. If unsent instances pass out of the belt window of the
robot, they will automatically be moved for processing by the
next downstream robot.
Allocation The distance from the upstream belt window an instance must
Distance be before allocating to the robot.
The distance from the belt window pick limit an instance must
Allocation Limit be before allocating to the robot. This can be used to push the
allocation further upstream of the pick limit. It is most often
Page 716
used for very fast belts where the robot needs extra time to
position itself for picking an instance.
Use Custom Should a custom allocation script be used. Details about
Allocation/Custom custom allocation scripts can be located in the Custom
Allocation Script Allocation Scripts section of this guide.
If an instance meets all the parameters for instance allocation, it will be sent to the robot controller for
runtime processing and tracking. The instances sent to the robot continue to be tracked on the PC, but the
actual processing of each instance is managed by the robotic controller.
Representation on Controller
Rotary Buffer
When an instance is sent to the robotic controller for processing, it is placed in a rotary buffer. The data
structures and tables used to track parts and part targets are completely separate. Each part or target type
is kept in a separate area of the respective data tables.
The rotator buffer has three different pointers:
l Robot Index: Identifies the next instance that will be processed by the robot.
l PC Index: Identifies the position in the buffer where new instances will be added.
l Process Strategy Index: Identifies the position in the buffer of the last instance whose status has
been sent to the controller.
If no instances are in the queue, then all three indexes will be at the same position. When the PC sends
instances for processing by the robot, the instance information is placed into the rotary buffer and the PC
index is incremented so it points to the last instance. When there are instances in the queue, the robot will
start processing the instances in the queue. As instances are processed, the robot index will be
incremented so it is closer and closer to the PC index. If all instances are processed by the robot, the robot
index and PC index will be equal.
The robot tasks are not responsible for communicating the status of instances processed. That task is
handled by the V+ process strategy task. It monitors the Process Strategy Index. When the Robot Index is
incremented, the process strategy task recognizes that instances have been processed. It will then send
instance information back to the PC. As details of the instances are sent to the PC, it will increment the
Process Strategy Index. When the Process Strategy Index catches up to the Robot Index, it means the
status of all processed instances have been sent to the PC for processing.
This graphic illustrates the relationship between the three indexes:
Page 717
There are 5 instances in the queue for processing by the robot. There are 2 instances that the robot has
processed but the PC has not been notified of their status. Any new instances will be added at the end of
the robot queue at the PC Index location. The "direction" of processing of the queue is represented by the
arrow in the graphic.
V+ API Calls
There are several V+ programs that can be used by an application to interact with the part and target
queues.
pm.prt.get.idx(rob.idx, $part, part.idx) Retrieve the index of the instance

pm.trg.get.idx(rob.idx, $target, target.idx) queue for a robot associated with a
part or target.
pm.prt.avail(rob.idx, part.idx, count)
Retrieve the number of instances for
processing by the robot for a part or
pm.trg.avail(rob.idx, trg.idx, count)
target queue.
pm.prt.get(rob.idx, part.idx, obj.idx, $id,
position, reference, pal.idx) Get details concerning a part or
pm.trg.get(rob.idx, trg.idx, obj.idx, $id, position, target instance in the robot queue.
reference, pal.idx)
pm.prt.getloc(rob.idx, part.idx, obj.idx, pct)

Returns the relative position on the
belt of a part or target instance in the
pm.trg.getloc(rob.idx, trg.idx, obj.idx, pct)
robot queue.
pm.prt.move.ptr(ptr) Increment the pointer to the next
pm.trg.move.ptr(ptr) instance in the part or target queue.
Refer to the documentation on these programs for examples for how each of these can be used within a
V+ application.
Page 718
Recipe Management
The requirements for recipe management varies from one application to another. There are several
features of the packaging and ACE software that facilitate different application requirements:
l Calibration sharing
l Separation of motion parameters
l C# Scripting
Calibration Sharing
When a user defines a process, the software detects what kinds of robot-to-hardware calibrations are
required. For example, if a robot is configures to pick a part from a belt based camera like this:
The process manager automatically understands that two calibrations are required:
l Robot-to-belt calibration
l Robot-to-belt camera calibration
These calibrations will appear automatically in the process manager display:
Page 719
It is important to understand that the calibration is between the robot and the specified hardware source.
If you have multiple processes with different parts and targets, but the parts are targets are associated
with the set of cameras and belts, only 1 calibration is required for each hardware resource. So, if we have
2 different parts located by the same belt camera, we would only have one robot-to-belt and one robot-to-
belt camera calibrations.
When multiple process managers are in the workspace, each one will show their own list of robot-to-
hardware calibrations based on the process configuration. If a process in one process manager references
the same hardware resources as a process in a different calibration, they will share the same robot-to-
hardware calibration. For example, if you have a process manager with a part that is located using a
camera, it will have a robot-to-camera calibration for that camera. If there is another process manager in
the workspace with a different part that is located using the same camera, it will also have a robot-to-
camera calibration for that camera and it will be the same as the camera calibration as the first process
manager.
It is important to note that the sharing of calibrations is handled through a process of replication. Each
process manager will maintain a local copy of the robot-to-hardware calibrations, but when a calibration is
performed in one process manager, the newly updated values will overwrite all other matching robot-to-
hardware calibrations referenced in other process managers in the workspace.
Separation of motion parameters

Whereas hardware calibrations are shared between process managers, the configuration items that define
the locations, offsets, timing, and other settings associated with robot operations are different in each
process manager in the workspace:
Page 720
If you have two process managers in the workspace with identical processes, they will share the robot-to-
hardware calibrations, but will maintain completely separate motion settings. As such, each process
manager represents a different product run configuration. For many applications, this is sufficient to
account for recipe management.
C# Scripting
In some applications, a user may want a more customized solution to recipe management. For example,
perhaps an application only requires a different pallet layout and having separate process managers with
completely separate motion settings would be considered burdensome. In this case, a C# script can be
used to make targeted changes. For example, a script can be created for each product configuration and
the appropriate script can be run at product changeover time.
It is important to note that many parameters cannot be changed while a process manager is running. You
typically will need to stop running a process manager, execute the product change-over script, then restart
the process manager.
Page 721
V+ Module Documentation
V+ Module Documentation
This section details many of the methods that are available for use by a custom V+ applicaiton.
See Also
See "V+ AceServer Module Documentation" on page 724
See "V+ ACE Sight Module Documentation" on page 746
See "V+ End-Effector Program Documentation" on page 750
See "V+ Process Manager Documentation" on page 762
See "V+ Remote Library Documentation" on page 814
Page 722
V+ AceServer Module Documentation

The V+ AceServer library documents the V+ programs a user might use in the process of customizing an
application leveraging ACE.
sv.create_msg(msg_num, handle, ptr)
Abstract
Creates a new message, initializing the header for writing.
Input Parameters
Parameter Description
msg_num Message number to create
Output Parameters
handle Handle to new message
ptr Pointer into the new message
sv.read_adouble(handle, ptr, offset, value[], n_items)
Abstract
Read an array of double-precision floats from the message buffer. The message pointer is incremented
after the read.
Input Parameters
handle Index of the message to read from
ptr Position in the message buffer to read at
offset Offset into output array for first item. 0 is default
Output Parameters
ptr Index pointing to the next data item in the message
value[] Array filled with data read
n_items Number of items read
sv.read_ashort(handle, ptr, offset, value[], n_items)
Abstract
Read an array of 16-bit integers from the message buffer. The message pointer is incremented after the
read.
Page 724
Input Parameters
Output Parameters
sv.read_asingle(handle, ptr, offset, value[], n_items)
Abstract
Read an array of single-precision float variables from the message buffer. The message pointer is
incremented after the read.
Input Parameters
Output Parameters
sv.read_astring(handle, ptr, offset, $value[], n_items)
Abstract
Read an array of strings from the message buffer. The message pointer is incremented after the read.
Input Parameters
Page 725

Output Parameters
$value[] Array filled with data read
sv.read_bool(handle, ptr, value)
Abstract
Read a boolean from the message buffer. The message pointer is incremented after the read.
Input Parameters
Output Parameters
value Value of the parameter read from the message stream
Example
.PROGRAM ex1.msg(handle, ptr)
; ABSTRACT: Demonstrate writing then reading to a message buffer
;
; INPUTS: handle: Index of the message to write into
; ptr: Position in the message buffer
AUTO REAL saved.ptr
AUTO REAL bool.val, byte.val, double.val, short.val
AUTO REAL single.val
AUTO $string.val
AUTO LOC trans.val
; Save the original position of the pointer

saved.ptr = ptr
; Write some data

CALL sv.write_bool(TRUE, handle, ptr)
CALL sv.write_byte(8, handle, ptr)
CALL sv.write_double(100.1, handle, ptr)
Page 726
CALL sv.write_short(2, handle, ptr)

CALL sv.write_single(121.2, handle, ptr)
CALL sv.write_string("Text", handle, ptr)
CALL sv.write_trans(NULL, handle, ptr)
; Read the data that was written

CALL sv.read_bool(handle, saved.ptr, bool.val)
CALL sv.read_byte(handle, saved.ptr, byte.val)
CALL sv.read_double(handle, saved.ptr, double.val)
CALL sv.read_short(handle, saved.ptr, short.val)
CALL sv.read_single(handle, saved.ptr, single.val)
CALL sv.read_string(handle, saved.ptr, $string.val)
CALL sv.read_trans(handle, saved.ptr, trans.val)
.END
sv.read_byte(handle, ptr, value)
Abstract
Reads a byte from the message buffer. The message pointer is incremented after the read.
Input Parameters
Output Parameters
Example
;
AUTO REAL saved.ptr
AUTO $string.val
AUTO LOC trans.val
saved.ptr = ptr
; Write some data
Page 727

.END
sv.read_byte(handle, ptr, value)
Abstract
Reads a byte from the message buffer. The message pointer is incremented after the read.
Input Parameters
Output Parameters
Example
;
AUTO REAL saved.ptr
AUTO $string.val
AUTO LOC trans.val
saved.ptr = ptr
; Write some data
Page 728

.END
sv.read_double(handle, ptr, value)
Abstract
Read a double-precision float from the message buffer. The message pointer is incremented after the read.
Input Parameters
Output Parameters
Example
;
AUTO REAL saved.ptr

AUTO $string.val
AUTO LOC trans.val

saved.ptr = ptr
; Write some data

Page 729


.END
sv.read_short(handle, ptr, value)
Abstract
Read a 16-bit integer from the message buffer. The message pointer is incremented after the read.
Input Parameters
Output Parameters
Example
;
AUTO REAL saved.ptr

AUTO $string.val
AUTO LOC trans.val

saved.ptr = ptr
; Write some data

Page 730


.END
sv.read_single(handle, ptr, value)
Abstract
Read a single-precision float from the message buffer. The message pointer is incremented after the read.
Input Parameters
Output Parameters
Example
;
AUTO REAL saved.ptr

AUTO $string.val
AUTO LOC trans.val

saved.ptr = ptr
; Write some data

Page 731


.END
sv.read_string(handle, ptr, $string)
Abstract
Read a string from the message buffer. The message pointer is incremented after the read.
Input Parameters
Output Parameters
$string Value of the parameter read from the message stream
Example
;
AUTO REAL saved.ptr

AUTO $string.val
AUTO LOC trans.val

saved.ptr = ptr
; Write some data

Page 732


.END
sv.read_trans(handle, ptr, trans)
Abstract
Read a transform from the message buffer. The message pointer is incremented after the read.
Input Parameters
Output Parameters
trans Value of the parameter read from the message stream
Example
;
AUTO REAL saved.ptr

AUTO $string.val
AUTO LOC trans.val

saved.ptr = ptr
; Write some data

Page 733


.END
sv.stop_collect(robot.num)
Abstract
Stop the data collection operations on the specified robot.
Input Parameters
robot.num The robot number to stop data collection on.
Output Parameters
None
sv.sig.is.equal(sig.num, expected.val, is.equal.res)
Abstract
Compares a signal to an expected value. This method is employed when a program checks a signal is at the
expected state. It encapsulates the comparison process but it also manages the fact a program is running
on an emulator or not. In the case of an emulator, reading inputs can be a problem as in emulator mode
external system generating the input signals is not available. In emulator mode, this method will always
consider the signal is at the expected state and will then always return true.
Input Parameters
sig.num the signal number we want to check
expected.val The expected signal value
Output Parameters
is.equal.res The result value, indicating if signal is at the expected value
Page 734
Example
.PROGRAM ex1()
; ABSTRACT: Demonstrate comparing a signal to an expected value
;
; INPUTS:
AUTO REAL my.signal1 = 1001

AUTO REAL my.signal2 = 1002
AUTO REAL is.off, is.on
; Check a signal is not at an incorrect value. This is checking an error case

; In emulator mode, is.off will always be true and program will not generate errors
CALL sv.sig.is.equal(my.signal1, FALSE, is.off)
IF NOT is.off THEN

TYPE "input is not at the correct state : it is on and should be off."
END
; wait a signal is at the expected value. If emulation mode is active, true will be returned and program can continue.
; In normal mode, the signal is read periodically and is compared to expected value.
DO
CALL sv.sig.is.equal(my.signal2, TRUE, is.on)
UNTIL is.on
.END
sv.write(handle, ptr)
Abstract
Write a message to the client.
Input Parameters
Output Parameters
None
sv.write_abyte($string[], offset, count, handle, ptr)
Abstract
Read an array of 16-bit integers from the message buffer. The message pointer is incremented after the
read.
Input Parameters
Page 735
$string[] Array of strings to write

offset 1-based starting byte offset in the string array
count Number of bytes to transfer
Output Parameters
sv.write_adoubl(first_index, value[], n_items, handle, ptr)
Abstract
Write an array of doubles to the output message at the specified offset.
Input Parameters
first_index First index in the array to write
value[] Array of data values to write
n_items Number of items in value[] to write into the buffer
Output Parameters
sv.write_ashort(first_index, value[], n_items, handle, ptr)
Abstract
Write an array of shorts to the output message at the specified offset.
Input Parameters
Page 736

Output Parameters
sv.write_asingl(first_index, value[], n_items, handle, ptr)
Abstract
Write an array of floats to the output message at the specified offset.
Input Parameters
Output Parameters
sv.write_astrin(first_index, $value[], n_items, handle, ptr)
Abstract
Write an array of strings to the output message at the specified offset.
Input Parameters
$value[] Array of data values to write
Page 737
Output Parameters
sv.write_bool(value, handle, ptr)
Abstract
Write a boolean to the output message at the specified offset.
Input Parameters
value Value to write
Output Parameters
Example
;
AUTO REAL saved.ptr

AUTO $string.val
AUTO LOC trans.val

saved.ptr = ptr
; Write some data


Page 738

.END
sv.write_byte(value, handle, ptr)
Abstract
Write a byte to the output message at the specified offset.
Input Parameters
Output Parameters
Example
;
AUTO REAL saved.ptr

AUTO $string.val
AUTO LOC trans.val

saved.ptr = ptr
; Write some data


Page 739

.END
sv.write_short(value, handle, ptr)
Abstract
Write a 16-bit integer to the output message at the specified offset.
Input Parameters
Output Parameters
Example
;
AUTO REAL saved.ptr

AUTO $string.val
AUTO LOC trans.val

saved.ptr = ptr
; Write some data


Page 740

.END
sv.write_hdr(handle, ptr)
Abstract
Write the header for an output message.
Input Parameters
Output Parameters
None
sv.write_single(value, handle, ptr)
Abstract
Write a float to the output message at the specified offset.
Input Parameters
Output Parameters
Example
;
AUTO REAL saved.ptr

Page 741
AUTO $string.val
AUTO LOC trans.val

saved.ptr = ptr
; Write some data


.END
sv.write_string($string, handle, ptr)
Abstract
Write a string to the output message at the specified offset.
Input Parameters
$string Value to write
Output Parameters
Example
;
AUTO REAL saved.ptr

Page 742
AUTO $string.val
AUTO LOC trans.val

saved.ptr = ptr
; Write some data


.END
sv.write_trans(trans, handle, ptr)
Abstract
Write a string to the output message at the specified offset.
Input Parameters
trans Value to write
Output Parameters
Example
;
AUTO REAL saved.ptr

Page 743
AUTO $string.val
AUTO LOC trans.val

saved.ptr = ptr
; Write some data


.END
Page 744
V+ ACE Sight Module Documentation

The V+ ACE Sight library documents the default ACE Sight V+ programs.
as.save.image($filename, $ip, seq.idx, tool.idx, status)
Abstract
Save the image associated with the vision tool into a file.
Input Parameters
$filename The name of the file to save into
$ip The IP address of the PC
seq.idx The index of the sequence
tool.idx The index of the virtual camera ; or other image tool
Output Parameters
status Status of the operation. 0 = Success
check_tracking(tracking_ok)
Abstract
This function is used to check if the robot is successfully tracking the belt
Input Parameters
None
Output Parameters
If true, the robot is tracking the belt successfully; otherwise an
tracking_ok
error occured while tracking the belt
clear_queue(queue_index)
Abstract
Clears an ACE Sight queue
Page 746
Input Parameters
queue_index The index of the queue to clear
Output Parameters
None
getinstance(queue_index, flags, location, model, encoder, visionx, visiony,

visionrot)
Abstract
This function is the main function called to retrieve the instance.
Input Parameters
queue_
This is the queue index in which we want to retrieve the instance
index
flags Flag bits to control operation of the routine:
l Bit 1: If set, routine waits for queue element to be defined; otherwise, "fail" if
the element is not defined
l Bit 2: If set, do not remove the instance from the queue; otherwise, remove
the instance from the queue.
l Bit 3: If set, we are sure there is an instance in the queue. When using this bit,
the calling program is responsible for checking if an instance is ready in the
queue; otherwise, getinstance will check if there is an instance before retrieving
it from the queue.
Output Parameters
Location of the part found by iSight. The location can be relative to the belt reference
location frame or the robot reference frame depending on the option selected in the
communication tool on iSight side.
model Model Index (-1 if there was an error)
encoder Contains the encoder value when the instance was found.
visionx Countains the part X position in the vision coordinates reference frame
visiony Countains the part Y position in the vision coordinates reference frame
Page 747
visionrot Countains the part Rotation in the vision coordinates reference frame
reset_seq($myip, seq_id)
Abstract
Reset an ACE Sight sequence.
Input Parameters
$myip String containing the IP Address of the ACE Sight vision server
seq_id Index of the sequence to reset
Output Parameters
None
set_as_exec_mod($myip, seq_id, mode)
Abstract
Set the ACE Sight execution mode for a given sequence.
Input Parameters
$myip String containing the IP Address of the ACE Sight vision server
seq_id Index of the sequence to reset
mode Desired ACE Sight execution.
0 = Single execution mode; otherwise: Continuous execution
mode
Output Parameters
None
Page 748
V+ End-Effector Program Documentation

The V+ end-effector library documents the V+ programs a user might use to interact with the end-
effector. These programs are a sub-set of the Ace Server program module.
End-Effector Library Error Codes

If a problem is encountered when executing an end-effector library method, the following error codes can
be returned:
Error Code Description

-20003 The end-effector will not close
-20004 The end-effector will not open
-20010 Invalid end-effector referenced
-20026 The end-effector will not extend
-20027 The end-effector will not retract
-20030 A part is detected in the end-effector
-20031 No part detected in the end-effector
ee.chk.er(ee.idx, tip.idx, state, sts)
Abstract
Checks the status of the end-effector for extend or release input signals. The gripper waits until the end-
effector reaches the desired state before moving.
Input Parameters
ee.idx Index of the end-effector
tip.idx Zero based index of the tip to access
state State of the gripper
Output Parameters
sts Status of operation
ee.chk.oc(tsk.idx, tip.idx, state, sts)
Abstract
Checks the status of the gripper for an open or close input signal. The robot waits until the gripper reaches
the desired state.
Page 750
Input Parameters
tsk.idx Index of the task
Output Parameters
ee.clroff(ee.idx, sts)
Abstract
Clears all refinement offsets associated with the end-effector.
Input Parameters
Output Parameters
ee.presence(tsk.idx, tip.idx, state, sts)
Abstract
Check if the part presence sensor is in the desired state. The robot waits until the gripper reaches the
desired state.
Input Parameters
state Desired state of the part presence sensors
Page 751
Output Parameters
ee.release(ee.idx, tip.idx, state, sts)
Abstract
Turns the release signals on the end-effector on or off.
Input Parameters
tip.idx Zero-based index of the tip to access:

-1 All tips
0...N The tip to operate with
Output Parameters
ee.select.ck(ee.idx, tip.idx, sts)
Abstract
Checks for any end-effector selection errors.
Input Parameters
Page 752
Output Parameters
ee.select(ee.idx, tip.idx)
Abstract
Performs a tip selection, extending or retracting tips as needed. It also checks to see if a tip selection
program is associated with the current robot end-effector. If one is specified it is executed.
Input Parameters

-1 All tips
0...N The tip to operate with
Output Parameters
None
Example
.PROGRAM a.ex2.gripper(ee.idx)
AUTO REAL sts

AUTO LOC tool.trans
; Select the first tip

CALL ee.select(ee.idx, 0)
; Select all tips

CALL ee.select(ee.idx, -1)
; Unselect all tips

CALL ee.unselect(ee.idx)
; Extend tip #1 and #2

CALL ee.state(ee.idx, 0, TRUE, TRUE, sts)
Page 753
; Set the offset associated with tip #2

CALL ee.setoff(ee.idx, 0, NULL, sts)
; Get the offset associated with tip #2

CALL ee.trans(ee.idx, 0, tool.trans, sts)
.END
ee.setoff(ee.idx, tip.idx, tool.trans, sts)
Abstract
Associates an offset with a specific end-effector tip.
Input Parameters
tool.trans Gripper tip transform
Output Parameters
Example
AUTO REAL sts

AUTO LOC tool.trans

; Select all tips

; Unselect all tips

Page 754



.END
ee.gr.settle(ee.idx, tip.idx, state, sts)
Abstract
Waits for the required settling time for the end-effector.
Input Parameters
Output Parameters
ee.state(ee.idx, tip.idx, state, check.inputs, sts)
Abstract
Changes the state of the end-effector tip.
Input Parameters
Page 755
check.inputs Check to see if the end-effector is waiting for an input
Output Parameters
Example
AUTO REAL sts

AUTO LOC tool.trans

; Select all tips

; Unselect all tips




.END
ee.gr.tip.er(tsk.idx, tip.idx, state)
Abstract
Changes the extend or retract state of the gripper tip for the specified robot.
Page 756
Input Parameters
Output Parameters
None
ee.tip.erdw(ee.idx, tip.idx)
Abstract
Performs the required extend or retract dwell of the end-effector tip.
Input Parameters
Output Parameters
None
ee.tip.oc(ee.idx, tip.idx, state, sts)
Abstract
Changes the open and closed state of the end-effector tip.
Input Parameters
Page 757
Output Parameters
pm.gr.trans(tsk.idx, tip.idx, tool.trans, sts)
Abstract
Associates an offset with a specific gripper tip.
Input Parameters
Output Parameters
tool.trans The gripper tip transformation
Example
This program is always used in the context of a robot program and should always be called directly from the
robot task.
.PROGRAM a.ex2.gripper()
AUTO REAL tsk.idx, sts

AUTO LOC tool.trans
tsk.idx = TASK()

CALL pm.gr.select(tsk.idx, 0)
; Select all tips

CALL pm.gr.select(tsk.idx, -1)
; Unselect all tips

CALL pm.gr.unselect(tsk.idx)

CALL pm.gr.state(tsk.idx, 0, TRUE, TRUE, sts)
Page 758

CALL pm.gr.setoff(tsk.idx, 0, NULL, sts)

CALL pm.gr.trans(tsk.idx, 0, tool.trans, sts)
.END
ee.unselect(ee.idx)
Abstract
Retracts all of the end-effector tips.
Input Parameters
Output Parameters
None
Example
AUTO REAL sts

AUTO LOC tool.trans

; Select all tips

; Unselect all tips


Page 759

.END
Page 760
V+ Process Manager Documentation

The V+ process manager library documents the V+ programs a user might use in the process of
customizing a process manager application.
pm.ace.blt.cam(tsk.idx, $camera, remote, encoder)
Abstract
Indicate to ace that a camera needs to be triggered.
Input Parameters
$camera Name of the camera that needs to be triggered
remote Is the camera remote or local?
encoder Encoder reference
Output Parameters
None
Example
This program is always used in the context of a belt monitoring program. Create a custom belt program to
see this in use.
pm.ace.blt.ltch(blt.idx, enc, latch, value, $tag)
Abstract
Send a command to the PC that a latch has been detected.
Input Parameters
blt.idx Index of the belt
enc Encoder channel
latch Latch number that was triggered
value Latched encoder value defining the location
$tag Tag to associate with instances created
Output Parameters
None
Page 762
Example
see this in use or refer to the Process Manager documentation under the Belt Monitoring section.
Note that if the user passes in a $tag, all instances created relative to that latch event will be assigned the
specified tag.
pm.ace.blt.pos(blt.idx, encoder, encoder.value, encoder.vel)
Abstract
Send the current belt position to the PC.
Input Parameters
blt.idx Index of the task that owns the belt being updated
encoder Index of the encoder being updated
encoder.value The encoder position
encoder.vel The encoder velocity
Output Parameters
None
Example
see this in use.
pm.ace.blt.sp(blt.idx, $spacing, value, $tag)
Abstract
Indicate to ace that a part/target belt spacing event has occurred.
Input Parameters
blt.idx Index of the task that owns the belt being updated
$spacing Name of the part/target to which the spacing is relative
value Encoder value defining the location
$tag Tag to associate with instances created
Output Parameters
None
Page 763
Example
see this in use or refer to the Process Manager documentation under the Belt Monitoring section.
Note that if the user passes in a $tag, all instances created relative to that spacing event will be assigned
the specified tag.
pm.ace.pkstate($manager, state, time.out, sts)
Abstract
Change the run state of a process manager. This program is called by the startup program to start/stop a
process manager application.
Input Parameters
$manager Process manager name
state The desired state where True = Start False = Stop
time.out Time (in s) which rm.execute is allowed to run
Output Parameters
sts Status of the operation.
pm.ace.ref(tsk.idx, $ref.name, sts)
Abstract
Sends a refinement request to the PC.
Input Parameters
tsk.idx Index of the task requiring refinement
$ref.name Name of the refinement operation
Output Parameters
Example
This program is always used in the context of a refinement program. Create a custom refinement program
to see an example.
Page 764
pm.ace.ref.wt(tsk.idx, time.out, loc, sts)
Abstract
Wait for the refinement operation to complete.
Input Parameters
tsk.idx Index of the task requiring refinement
time.out Maximum amount of time to wait for the operation.
Output Parameters
Example
This program is always used in the context of a refinement program. Create a custom refinement program
to see an example.
pm.blt.convert(encoder)
Abstract
Convert a real world reference location to an encoder value in range between min/max.
Input Parameters
encoder The encoder reference to convert
Output Parameters
encoder The converted position
Example
see this in use.
pm.blt.travel(point.1, point.2, distance)
Abstract
Determine the distance the belt has traveled between 2 encoder values.
Page 765
Input Parameters
point.1 The first encoder position
point.2 The second encoder position
Output Parameters
distance The distance between the 2 positions
Example
see this in use.
pm.chk.run(run)
Abstract
Check to see if a process application is running.
Input Parameters
None
Output Parameters
run Checks to see if a process manager application is running.
pm.chk.stat(run)
Abstract
Determine if both the process manager application is running and the ACE server is running. Process
manager tasks uses this method to check if they should continue running.
Input Parameters
None
Output Parameters
run True - ACE and a process manager application are running
False - ACE and/or the process manager application are not
running
Page 766
Example
.PROGRAM cu.robot()
; ABSTRACT: Custom robot program for the Process Manager
; Process Strategy.
AUTO REAL tsk.idx, is.reset, , is.running, sts

AUTO REAL part.idx, target.idx
tsk.idx = TASK()
; Initialize the robot

CALL pm.rob.init(tsk.idx)
CALL pm.rob.idlemd(tsk.idx, TRUE, 0, "")
; Get the part and target indexes

CALL pm.prt.get.idx(tsk.idx, "/Process/Part - Spacing 2", part.idx)
CALL pm.trg.get.idx(tsk.idx, "/Process/Target 2 - Static", target.idx)
; Control loop
DO
; Perform a pick
CALL pm.rob.pick(tsk.idx, part.idx, -1, , is.reset, sts)
; Perform a place
CALL pm.rob.place(tsk.idx, target.idx, part.idx, -1, , is.reset, sts)
; Indicate we are entering idle mode

; Move to the current destination to ensure

; we are no longer tracking a belt.
CALL pm.mv.dest(tsk.idx)
; Wait for a period of time

WAIT.EVENT , 3
; Check to see if any errors occured while we were delaying

CALL pm.chk.tskerr(tsk.idx, pm.tsk.retry, , sts)
IF (sts <> pm.tsk.success) THEN
CALL pm.mv.attach(tsk.idx, pm.tsk.robnum[tsk.idx])
END
; Indicate we are leaving idle mode

CALL pm.rob.idlemd(tsk.idx, FALSE, 0, "")
; Check to see if the process manager is still running

CALL pm.chk.stat(is.running)
UNTIL is.running == FALSE
CALL pm.rob.clear(tsk.idx, sts)

RETURN
.END
Page 767
pm.chk.tskerr(tsk.idx, resp.mask, code, resp)
Abstract
Check for error conditions and display an error if one exists on the specified task.
Input Parameters
tsk.idx Index of the task.
resp.mask Possible responses to the error.
Output Parameters
code Detected error code, or 0 if no error detected
resp Response to the error
Example
.PROGRAM cu.robot()
; Process Strategy.

tsk.idx = TASK()


; Control loop
DO
; Perform a pick
; Perform a place


Page 768

WAIT.EVENT , 3

END



RETURN
.END
pm.def.btn.txt(tsk.idx, button, $text)
Abstract
Define the text associated with a response button for the next error reported on a given task. This method
must be called before calling pm.error.
Input Parameters
button Response code associated with the button
$text Text associated with the button. "" will clear the text.
Output Parameters
None
pm.def.err.txt(tsk.idx, $text)
Abstract
Define a custom text message associated with an error for the next error reported on the specified task
index. This method must be called before calling pm.error.
Input Parameters
$text Text associated with the error. "" will clear the text.
Page 769
Output Parameters
None
pm.def.err.txt(tsk.idx, $text)
Abstract
Define a custom text message associated with an error for the next error reported on the specified task
index. This method must be called before calling pm.error.
Input Parameters
$text Text associated with the error. "" will clear the text.
Output Parameters
None
pm.fdr.state($name, state)
Abstract
Updates the state of a feeder on the PC.
Input Parameters
$name Name of the feeder part or target
state State of the feeder:
pm.fst.avail Is available
pm.fst.busy Is not available
pm.fst.cycle Is cycling
pm.fst.hshk Waiting for handshake
Output Parameters
None
pm.get.free.tsk(first.tsk, last.tsk, tsk.num)
Abstract
Selects an available task that can be used Tasks from first.tsk to last.tsk are scanned and the first available
one is returned
Page 770
Input Parameters
first.task The task number at which to start scanning
last.task The task number at which we want to stop scanning
Output Parameters
task.num The task number. If value is -1, no available task was found
pm.gr.clroff(tsk.idx, sts)
Abstract
Clears all refinement offsets associated with the gripper.
Input Parameters
Output Parameters
sts Status of the operation
pm.gr.release(tsk.idx, tip.idx, state, sts)
Abstract
Turn on/off the gripper release signals.
Input Parameters
Zero based index of the tip to access
tip.idx -1 = All tips
0...N = The tip to operate with
Output Parameters
Page 771
pm.gr.select.ck(tsk.idx, tip.idx, resp)
Abstract
Check for any gripper selection errors.
Input Parameters
Output Parameters
resp User response to an error
pm.gr.select(tsk.idx, tip.idx)
Abstract
Perform a tip selection, extending or retracting tips as needed. It also checks if a tip selection program is
associated with the current robot gripper. If one is specified it will be executed.
Input Parameters
Zero based index of the tip to access
tip.idx -1 = All tips
0...N = The tip to operate with
Output Parameters
None
Example
robot task.

AUTO LOC tool.trans
tsk.idx = TASK()

Page 772
; Select all tips

; Unselect all tips




.END
pm.gr.setoff(tsk.idx, tip.idx, tool.trans, sts)
Abstract
Input Parameters
tool.trans Gripper tip transform
Output Parameters
Example
robot task.

AUTO LOC tool.trans
tsk.idx = TASK()

; Select all tips

Page 773
; Unselect all tips




.END
pm.gr.settle(tsk.idx, tip.idx, state, sts)
Abstract
Wait for the required settling time for the gripper.
Input Parameters
state Desired state of the gripper
Output Parameters
pm.gr.state(tsk.idx, tip.idx, state, check.inputs, sts)
Abstract
Change the state of the gripper tip for the specified robot.
Input Parameters
state Desired state of the gripper
check.inputs Do we wait for inputs
Page 774
Output Parameters
Example
robot task.

AUTO LOC tool.trans
tsk.idx = TASK()

; Select all tips

; Unselect all tips




.END
pm.gr.trans(tsk.idx, tip.idx, tool.trans, sts)
Abstract
Input Parameters
Output Parameters
Page 775
tool.trans The gripper tip transformation

Example
robot task.

AUTO LOC tool.trans
tsk.idx = TASK()

; Select all tips

; Unselect all tips




.END
pm.gr.unselect(tsk.idx)
Abstract
Retract all the tips.
Input Parameters
Output Parameters
None
Page 776
Example
robot task.

AUTO LOC tool.trans
tsk.idx = TASK()

; Select all tips

; Unselect all tips




.END
pm.log($text)
Abstract
Send text associated with the current task to the AceServer log file.
Input Parameters
$text The text to append to the AceServer log on the PC
Output Parameters
None
Additional Notes
The pm.log method should only be called on a process manager task. The program will check to see if
logging is enabled before sending the log string to the PC. The variable pm.log will enable logging on all V+
process manager tasks. If you want to enable logging for an individual V+ task, the variable pm.tsk.log
[TASK()] can be set to TRUE.
Page 777
pm.mv.attach(tsk.idx, rob.num)
Abstract
Attach the robot to the current task.
Input Parameters
rob.num Robot number to attach
Output Parameters
None
Additional Notes
For a robot task, the global variable pm.tsk.robnum[] saves the robot number associated with the task.
Example
.PROGRAM cu.robot()
; Process Strategy.

tsk.idx = TASK()


; Control loop
DO
; Perform a pick
; Perform a place


Page 778

WAIT.EVENT , 3

END



RETURN
.END
pm.mv.chkbrk(offset, pars[])
Abstract
Check for a break in motion using the specified motion parameters.
Input Parameters
offset Starting index in the motion parameters array
pars[] Motion parameters array
Output Parameters
None
pm.mv.dest(rob.idx)
Abstract
Move to the current destination. Used to stop robot fram tracking a part.
Input Parameters
rob.idx Index of the robot
Output Parameters
None
Page 779
Example
.PROGRAM cu.robot()
; Process Strategy.

tsk.idx = TASK()


; Control loop
DO
; Perform a pick
; Perform a place



WAIT.EVENT , 3

END



RETURN
.END
Page 780
pm.mv(blt.idx, position, offset, pars[])
Abstract
Perform a move to the location using the specified motion parameters.
Input Parameters
Belt number to move relative to 0 = Non-belt relative move > 0
blt.idx
= Belt relative move
position Position to move to
offset Starting index in the motion parameters array
pars[] Motion parameters array
Output Parameters
None
Additional Notes
The pars[] parameter uses the following offset values when applying the motion parameters:
Variable Usage
pm.fmv.spd The speed percentage
pm.fmv.spdmd The Speed Mode
pm.fmv.accel The acceleration percentage
pm.fmv.decel The deceleration percentage
pm.fmv.dur The move duration
pm.fmv.scv The S-curve profile
pm.fmv.straigh Is straight line motion requested
pm.fmv.motend Motion end parameter
pm.fmv.stlpct The settle percentage
pm.fmv.break Should it wait until motion is done
pm.fmv.single Single/multiple mode
pm.fmv.righty Righty/Lefty mode
pm.fmv.above Above/below mode
pm.fmv.flip Flip/No-flip
For a standard motion sequence, the following values are used for the offset parameter.
Page 781
Variable Usage
pm.ms.aoffset Approach motion segment
pm.ms.poffset Move motion segment
pm.ms.doffset Depart motion segment
For a standard vision refinement sequence, the following values are used for the offset parameter.
Variable Usage
pm.vrf.aoffset Approch motion segment
pm.vrf.poffset Move motion segment
pm.vrf.doffset Depart motion segment
pm.mv.idle(rob.idx)
Abstract
Move a robot to the idle location. The robot first retracts the Z axis (maintaining the current XY position) to
the level of the idle position. Once retracted it moves to idle.
Input Parameters
Output Parameters
None
Example
CALL pm.mv.idle(rob.idx)
pm.proc.enable($manager, proc.idx, state, sts)
Abstract
Enable or disable a process based on the process index.
Input Parameters
$manager Name of the process manager
proc.idx Name of the process manager
State of the process
state True = Enable the process
False = Disable the process
Page 782
Output Parameters
sts Status of the operation:
0 = success
< 0 = error
pm.prt.avail(rob.idx, part.idx, count)
Abstract
Gets the number of available parts for the robot.
Input Parameters
rob.idx Index of the robot task
part.idx Part index to access
Output Parameters
count Number of items available in the queue
Example
.PROGRAM a.ex2.qlookup()
AUTO REAL rob.idx, part.idx, target.idx, count

AUTO $part, $target
; Identify the first robot task

rob.idx = 3
; Look up the queue number for a part in the workspace

$part = "/Process/Part - Spacing 2"
CALL pm.prt.get.idx(rob.idx, $part, part.idx)
; Get the number of parts available

CALL pm.prt.avail(rob.idx, part.idx, count)
; Look up the queue number for a target in the workspace

$target = "/Process/Target 2 - Static"
CALL pm.trg.get.idx(rob.idx, $target, target.idx)
; Get the number of partstargets available

CALL pm.trg.avail(rob.idx, target.idx, count)
.END
pm.prt.done(rob.idx, part.idx, obj.idx, sts)
Abstract
Page 783
Indicate a part has been processed.
Input Parameters
obj.idx Index of the instance/object to mark as done
Was the part processed by the robot:
sts TRUE = part was processed
FALSE = part was not processed
Output Parameters
None
pm.prt.get(rob.idx, part.idx, obj.idx, $id, position, reference, pal.idx)
Abstract
Gets a part from the buffer.
Input Parameters
obj.idx Index of the object/instance to extract
Output Parameters
$id Unique identifier of the part
position Position of the part
reference Reference position of the part
pal.idx Pallet index associated with the instance
Example
.PROGRAM a.ex2.queues()
AUTO REAL i, rob.idx, inst.idx

AUTO REAL reference, pal.idx, sts, time, pct
AUTO LOC position
AUTO $id, $source
Page 784

rob.idx = 3
; Go through all part queues

FOR i = 0 TO pm.prt.count[rob.idx]-1
TYPE "Part Queue Name: ", $pm.prt.type[rob.idx,i]
; Go through all instances in the queue

inst.idx = pm.prt.rob.idx[rob.idx,i]
WHILE (inst.idx <> pm.prt.pc.idx[rob.idx,i]) DO
CALL pm.prt.get(rob.idx, i, inst.idx, $id, position, reference, pal.idx)

CALL pm.prt.get.stat(rob.idx, i, inst.idx, sts, time, $source)
CALL pm.prt.getloc(rob.idx, i, inst.idx, pct)
TYPE " ID = ", $id

TYPE " Position = ", DX(position), ", ", DY(position), ", ", DZ(position)
TYPE " Reference = ", reference
TYPE " Pallet Index = ", pal.idx
TYPE " Status = ", sts
TYPE " Time = ", time
TYPE " Source = ", $source
TYPE " Location % = ", pct
TYPE ""
CALL pm.prt.move.ptr(inst.idx)
END
END
; Go through all target queues

FOR i = 0 TO pm.trg.count[rob.idx]-1
TYPE "Target Queue Name: ", $pm.trg.type[rob.idx,i]

inst.idx = pm.trg.rob.idx[rob.idx,i]
WHILE (inst.idx <> pm.trg.pc.idx[rob.idx,i]) DO
CALL pm.trg.get(rob.idx, i, inst.idx, $id, position, reference, pal.idx)

CALL pm.trg.get.stat(rob.idx, i, inst.idx, sts, time, $source)
CALL pm.trg.getloc(rob.idx, i, inst.idx, pct)
TYPE " ID = ", $id

TYPE ""
CALL pm.trg.move.ptr(inst.idx)
Page 785
END
END
.END
pm.prt.get.idx(rob.idx, $part, part.idx)
Abstract
Get the index of the part buffer for a given robot task.
Input Parameters
$part Part name to search for
Output Parameters
Part index in the robot part buffer. -1 = No matching part was
part.idx
found
Example

AUTO $part, $target

rob.idx = 3



; Get the number of targets available

.END
pm.prt.getloc(rob.idx, part.idx, obj.idx, pct)
Abstract
Get the location of a given part in the belt window.
Page 786
Input Parameters
obj.idx Index of the object/instance to access
Output Parameters
pct Percentage of travel along the belt
Example

AUTO LOC position
AUTO $id, $source

rob.idx = 3



TYPE " ID = ", $id

TYPE ""
END
END
Page 787



TYPE " ID = ", $id

TYPE ""
END
END
.END
pm.prt.move.ptr(ptr)
Abstract
Increment the pointer to the next slot in the buffer.
Input Parameters
ptr The pointer to increment
Output Parameters
ptr The incremented pointer
Example

AUTO LOC position
AUTO $id, $source
Page 788

rob.idx = 3



TYPE " ID = ", $id

TYPE ""
END
END



TYPE " ID = ", $id

TYPE ""
Page 789
END
END
.END
pm.ps.error(tsk.idx, code, resp.mask, resp)
Abstract
Report an error and wait for a response.
Input Parameters
tsk.idx Index associated with the error report.
code Error code/status of the operation
resp.mask Mask of available response options
Output Parameters
resp The user response to the error
pm.ps.map.idx(proc.idx, map.idx)
Abstract
Converts a process index from the PC to a robot-relative index.
Input Parameters
proc.idx Process index from the PC
Output Parameters
map.idx Robot relative index for the process
Example
.PROGRAM cu.robot2()
; Process Strategy.
AUTO REAL task.idx, i, sts

AUTO REAL proc.idx.1, proc.idx.2
tsk.idx = TASK()

CALL pm.rob.idlemd(tsk.idx, TRUE)
Page 790
; Get the index associated with the first two processes in the process manager
CALL pm.ps.map.idx(0, proc.idx.1)
; Control loop
DO
; Execute the first process 3 time

FOR i = 1 TO 3
CALL pm.rob.process(tsk.idx, proc.idx.1, sts)
END
; Execute the second process

; Check process status

RETURN
.END
pm.ps.power(tsk.idx, enable)
Abstract
Change the power status of the system. If power is enabled, issue a calibration request, if needed. If power
cannot be enabled, it will report an error. Because of this, this method is not intended to be used from
within a custom error program. It may lead to a recursive call and a stack overflow.
Input Parameters
tsk.idx The task index for error reporting
enable Enable the power.
Output Parameters
None
pm.rob.chkidle(rob.idx, part.type, grip.idx, excl[], is.reset, sts)
Abstract
Check the status when the robot is idle, including checking for the robot cycle stop condition.
Input Parameters
tsk.idx Index of the robot task
start.time Type of part to pick
Page 791
in.idle The reference time when the robot entered idle mode
at.wait Is the robot at the waiting position
Output Parameters
in.idle Is the robot in idle mode
at.wait Is the robot at the waiting position
pm.rob.clear(rob.idx)
Abstract
Move the robot to the idle position and clear the robot gripper.
Input Parameters
Output Parameters
None
Example
.PROGRAM cu.robot()
; Process Strategy.

tsk.idx = TASK()


; Control loop
DO
; Perform a pick
; Perform a place

Page 792


WAIT.EVENT , 3

END



RETURN
.END
pm.rob.gettag(rob.idx, $tag)
Abstract
Returns the tag associated with the part or target instance currently being operated on by the robot.
Typically, this would be called from within a custom motion sequence program to access information that
was associated with a VisionTransform Tag associated with a custom vision tool or the Tag associated with a
LocatedInstance set by a custom allocation script.
Input Parameters
tsk.idx Index of the robot
Output Parameters
$tag Tag associated with the instance being processed
Example
.PROGRAM cu.mv.sequence(tsk.idx, $type, blt.idx, reference, pal.idx, grip.idx, grip.state, pos, vals[], sts)
AUTO REAL at.wait, belt.win.idx, code, distance, offset

AUTO REAL resp, rob.num
AUTO $cust.program, $tag
AUTO LOC appro.pos, depart.pos, grip.trans, position
Page 793
sts = pm.tsk.success
CALL pm.rob.gettag(tsk.idx, $tag)

TYPE "Tag = "+$tag
; Calculate the position, factoring in the gripper transformations
; Initiate the gripper selection

CALL pm.gr.select(tsk.idx, grip.idx)
; Get the gripper transformation

CALL pm.gr.trans(tsk.idx, grip.idx, grip.trans, sts)
pm.rob.idlemd(rob.tsk, in.idle, code, $info)
Abstract
Change the idle status of the robot. This program sets the status in global memory. It expects the process
strategy background program to perform the sending of the status to the PC.
Input Parameters
rob.tsk Index of the robot
Is the robot in idle mode? True = Robot is idle False = Robot is
in.idle
running
Error code associated with the idle mode state. If non-zero, an
code
error will be reported
Additional information to send with the error code.
$info This is used by 'pm.err.no.inst' to send the name of the part or
target the robot is waiting for.
Output Parameters
None
Example
.PROGRAM cu.robot()
; Process Strategy.

tsk.idx = TASK()

Page 794

; Control loop
DO
; Perform a pick
; Perform a place



WAIT.EVENT , 3
END



RETURN
.END
pm.rob.init(rob.idx)
Abstract
Initialize the robot by attaching the robot, clearing the TOOL, moving to the idle position, and turning off all
gripper signals.
Input Parameters
Output Parameters
None
Page 795
Example
.PROGRAM cu.robot()
; Process Strategy.

tsk.idx = TASK()


; Control loop
DO
; Perform a pick
; Perform a place



WAIT.EVENT , 3

END



RETURN
.END
Page 796
pm.rob.monque(rob.tsk, part.idx, trg.idx)
Abstract
Process the active part and targets queues and mark any out-of-range instances as done. This method
should only be called on a robot task when the robot is waiting for some operation to complete. This
ensures any instances that go out of range of the robot are properly released and sent back to the PC.
If the robot is currently processing a part or target, the index of the associated queue should be passed as a
parameter to the method.
Input Parameters
Index of a part queue to not check. -1 indicates all queues will be
part.idx
checked
Index of a target queue to not check. -1 indicates all queues will
trg.idx
be checked
Output Parameters
None
Example
CALL pm.rob.monque(rob.tsk, -1, -1)
pm.rob.pick(rob.idx, part.type, grip.idx, excl[], is.reset, sts)
Abstract
Perform a single pick operation with the robot in the current task.
Input Parameters
part.idx Type of part to pick
grip.idx The index of the gripper tip to use -1 = All tips
Page 797
The move segment type:
pm.ms.mv.norm - Normal Move
pm.ms.mv.iad - Pick / place motion with intra approach and

intra depart
ms.type
pm.ms.mv.iand - Pick / place with intra approach and normal
depart
pm.ms.mv.naid - Pick / place with normal approach and intra

depart
excl[] The exclusions used when picking
Output Parameters
is.reset Was the queue reset during the operation
Status code:
sts pm.tsk.success = Successful operation
pm.tsk.abort = Abort the operation
Example
.PROGRAM cu.robot()
; Process Strategy.

tsk.idx = TASK()


; Control loop
DO
; Perform a pick
CALL pm.rob.pick(tsk.idx, part.idx, -1, pm.ms.mv.norm, , is.reset, sts)
; Perform a place
CALL pm.rob.place(tsk.idx, target.idx, part.idx, -1, pm.ms.mv.norm, , is.reset, sts)

Page 798


WAIT.EVENT , 3

END



RETURN
.END
pm.rob.place(rob.idx, target.type, part.type, grip.idx, ms.type, excl[], is.reset,

sts)
Abstract
Perform a single place operation with the robot in the current task.
Input Parameters
target.type The type of target to place
part.type The type of part being placed
The move segment type:
pm.ms.mv.norm - Normal Move
pm.ms.mv.iad - Pick / place motion with intra approach and

intra depart
ms.type
pm.ms.mv.iand - Pick / place with intra approach and normal
depart
pm.ms.mv.naid - Pick / place with normal approach and intra

depart
Page 799
Output Parameters
is.reset Was the queue reset during the operation
Status code:
sts pm.tsk.success = Successful operation
Example
.PROGRAM cu.robot()
; Process Strategy.

tsk.idx = TASK()


; Control loop
DO
; Perform a pick
CALL pm.rob.pick(tsk.idx, part.idx, -1, pm.ms.mv.norm, , is.reset, sts)
; Perform a place
CALL pm.rob.place(tsk.idx, target.idx, part.idx, -1, pm.ms.mv.norm, , is.reset, sts)



WAIT.EVENT , 3

END
Page 800



RETURN
.END
pm.rob.process(rob.idx, proc.idx, sts)
Abstract
Converts a process index from the PC to a robot-relative index.
Input Parameters
rob.idx Index of the robot to drive
proc.idx Process to operate with
Output Parameters
sts Status code
pm.tsk.success = Successful operation

pm.tsk.skip = Skip the operation
Example
.PROGRAM cu.robot2()
; Process Strategy.
AUTO REAL task.idx, i, sts

AUTO REAL proc.idx.1, proc.idx.2
tsk.idx = TASK()

CALL pm.rob.idlemd(tsk.idx, TRUE)
; Get the index associated with the first two processes in the process manager
; Control loop
DO
Page 801
; Execute the first process 3 time

FOR i = 1 TO 3
END
; Execute the second process

; Check process status


RETURN
.END
pm.rob.refine(rob.idx, refine.idx, grip.idx, sts)
Abstract
Refine the part in the robot gripper using vision.
Input Parameters
refine.idx Index of the refinement station
Output Parameters
sts Status code:
pm.tsk.success = Successful operation

pm.tsk.retry = Retry the operation
pm.rob.settag(tsk.idx, $tag)
Abstract
Sets the tag associated with the part or target instance currently being operated on by the robot. Typically,
this would be called from within a custom motion sequence program to set a string for the Tag associated
with a LocatedInstance set by a custom allocation script.
Input Parameters
tsk.tsk Index of the robot
Page 802
$tag Tag associated with the instance
Output Parameters
None
Example
.PROGRAM cu.mv.sequence(tsk.idx, $type, blt.idx, reference, pal.idx, grip.idx, grip.state, pos, vals[], sts)
AUTO REAL at.wait, belt.win.idx, code, distance, offset

AUTO REAL resp, rob.num
AUTO $cust.program, $tag
AUTO LOC appro.pos, depart.pos, grip.trans, position
sts = pm.tsk.success
$tag = "My Tag String"
CALL pm.rob.settag(tsk.idx, $tag)
; Calculate the position, factoring in the gripper transformations

; Initiate the gripper selection
CALL pm.gr.select(tsk.idx, grip.idx)
; Get the gripper transformation

CALL pm.gr.trans(tsk.idx, grip.idx, grip.trans, sts)
pm.sig.check(sig, time, is.valid)
Abstract
Checks for the status of a digital signal ensuring the state is valid for the specified amount of time. This
method does not block execution.
Input Parameters
sig Signal to be checked
time Amount of time the signal is expected to be in the state
Output Parameters
is.valid Is the signal in the specified state
Example
.PROGRAM a.ex2.debounce()
AUTO REAL sig, is.on, debounce.time
; Define the signal and the amount of time we want the signal
; to remain on before we recognize it is on
Page 803
sig = 2100
debounce.time = 2.5
is.on = FALSE
; Clear the tracking structures for the signal

CALL pm.sig.clear(sig)
; Trun the signal on

SIGNAL sig
TYPE $TIME()
; Wait until the signal has been on for the required amount of time
WHILE (is.on == FALSE) DO
CALL pm.sig.check(sig, debounce.time, is.on)
END
TYPE $TIME()
SIGNAL -sig
.END
pm.sig.clear(sig)
Abstract
Clears the variables used to track the status of a signal.
Input Parameters
sig Signal to clear
Output Parameters
None
Example
.PROGRAM a.ex2.debounce()
AUTO REAL sig, is.on, debounce.time
; Define the signal and the amount of time we want the signal
; to remain on before we recognize it is on
sig = 2100
debounce.time = 2.5
is.on = FALSE
; Clear the tracking structures for the signal

CALL pm.sig.clear(sig)
; Trun the signal on

SIGNAL sig
TYPE $TIME()
; Wait until the signal has been on for the required amount of time
WHILE (is.on == FALSE) DO
Page 804
CALL pm.sig.check(sig, debounce.time, is.on)

END
TYPE $TIME()
SIGNAL -sig
.END
pm.src.clear($manager, $source, sts)
Abstract
Clear the specified source
Input Parameters
$manager Name of the process manager
$source The name of the source to clear
Output Parameters
Example
.PROGRAM a.ex2.srcclr()
AUTO $manager
AUTO REAL sts
$manager = "/Process/PackXpert Process Manager"

$source = "Belt Handler: /Process/Belt"
; Clear the source with the specified name

CALL pm.src.clear($manager, $source, sts)
; Clear all source

CALL pm.src.clearall($manager, sts)
.END
pm.src.clearall($manager, sts)
Abstract
Clears all sources for the specified process manager
Input Parameters
$source The name of the source to clear
Page 805
Output Parameters
Example
.PROGRAM a.ex2.srcclr()
AUTO $manager
AUTO REAL sts
$manager = "/Process/PackXpert Process Manager"

$source = "Belt Handler: /Process/Belt"
; Clear the source with the specified name

CALL pm.src.clear($manager, $source, sts)
; Clear all source

CALL pm.src.clearall($manager, sts)
.END
pm.trg.avail(rob.idx, trg.idx, count)
Abstract
Gets the number of available targets for the robot.
Input Parameters
trg.idx Target index to access
Output Parameters
count Number of items available in the queue
Example

AUTO $part, $target

rob.idx = 3

Page 806


; Get the number of partstargets available

.END
pm.trg.done(rob.idx, trg.idx, obj.idx, sts)
Abstract
Indicate a target has been processed.
Input Parameters
obj.idx Index of the instance/object to mark as done
Was the instance processed by the robot:
sts TRUE = part was processed
FALSE = part was not processed
Output Parameters
None
pm.trg.get(rob.idx, trg.idx, obj.idx, $id, position, reference, pal.idx)
Abstract
Gets a target from the buffer.
Input Parameters
obj.idx Index of the object/instance to extract
Output Parameters
$id Unique identifier of the instance
Page 807
position Position of the instance

reference Reference position of the instance
pal.idx Pallet index associated with the instance
Example

AUTO LOC position
AUTO $id, $source

rob.idx = 3



TYPE " ID = ", $id

TYPE ""
END
END



Page 808
TYPE " ID = ", $id

TYPE ""
END
END
.END
pm.trg.get.idx(rob.idx, $target, target.idx)
Abstract
Get the index of the target buffer for a given robot task.
Input Parameters
$target Target name to search for
Output Parameters
Target index in the robot target buffer. -1 = No matching target
target.idx
was found
Example

AUTO $part, $target

rob.idx = 3



Page 809
; Get the number of targets available

.END
pm.trg.getloc(rob.idx, trg.idx, obj.idx, pct)
Abstract
Get the location of a given target in the belt window.
Input Parameters
obj.idx Index of the object/instance to access
Output Parameters
pct Percentage of travel along the belt
Example

AUTO LOC position
AUTO $id, $source

rob.idx = 3



TYPE " ID = ", $id

Page 810

TYPE " "
END
END



TYPE " ID = ", $id

TYPE ""
END
END
.END
pm.trg.move.ptr(ptr)
Abstract
Increment the pointer to the next slot in the buffer.
Input Parameters
ptr The pointer to increment
Output Parameters
ptr The incremented pointer
Example
Page 811

AUTO LOC position
AUTO $id, $source

rob.idx = 3



TYPE " ID = ", $id

TYPE ""
END
END



TYPE " ID = ", $id

TYPE ""
Page 812
END
END
.END
Page 813
V+ Remote Library Documentation

The V+ remote library allows a V+ application to access functionality on the PC. These programs are a sub-
set of the Ace Server program module.
Remote Library Error Codes

If a problem is encountered when executing a remote library method, the following error codes can be
returned:
Error
Description
Code
-1000 Unable to find the AceObject referenced in the remote command
A general error has occurred while processing the remote command.
-1001
See the AceServer event log for specific details.
The method referenced in a remote library execute command could
-1002
not be found
A general error has occurred while processing a remote execute
-1003 invocation or property access. See the AceServer event log for specific
details.
- Server has stopped executing and the connection to the remote PC
10000 has been lost
-
The request has timed out
10001
-
The referenced object does not exist
10002
-
The field referenced in the remote object does not exist
10003
- The type of the referenced field is not compatible with the requested
10004 operation
rm.app.event(value, wait.time, status)
Abstract
Generates an application event on the PC associated with this controller.
Input Parameters
value Numeric code representing the event.
wait.time The amount of time to wait for the operation to complete.
Page 814
Output Parameters
status Status of the operation: 0 = success, < 0 = error
Example
.PROGRAM ex1.rm.appevt()
AUTO REAL status
CALL rm.app.event(101, 1, status)

IF (status < 0) THEN
TYPE "Unable To Send Event Code: ", status
PAUSE
END
.END
rm.chk.server(is.alive)
Abstract
Check to see if the ACE server is running
Input Parameters
None
Output Parameters
is.alive Is the server alive
Example
.PROGRAM ex1.rm.ex()
AUTO REAL is.alive

AUTO REAL args[0], status
AUTO $object, $method
; Check to see if communications with the PC is active

CALL rm.chk.server(is.alive)
IF (is.alive == FALSE) THEN
TYPE "Not Communicating"
PAUSE
END
; Execute a script on the server and wait for 3 seconds for it to complete
$object = "/C# Program"
$method = "Execute"
CALL rm.execute($object, $method, 0, $args[], 3, status)
TYPE "Problem executing script: ", status
Page 815
PAUSE
END
.END
rm.execute($object, $method, num.args, $args[], wait.time, status)
Abstract
Execute a method on the PC and optionally wait until it has completed. The number of arguments must
match the arguments defined by the method signature of the specified method. Additionally, the
arguments must be convertable to the type expected in the method signature using a standard
TypeConverter on the PC.
Input Parameters
$object The name of the remote object to access. This must include the
full path name of the object to access. e.g. "/directory/Robot 1"
$method The name of the method to execute
num.args The number of arguments to send
$args[] The arguments to pass
wait.time The amount of time to wait for the execution to complete. Units
are in seconds. A value less than or equal to 0 indicates no
waiting.
Output Parameters
Example
.PROGRAM ex1.rm.ex()
AUTO REAL is.alive

AUTO REAL status
AUTO $object, $method, $args[0]
; Check to see if communications with the PC is active

CALL rm.chk.server(is.alive)
IF (is.alive == FALSE) THEN
TYPE "Not Communicating"
PAUSE
END
; Execute a script on the server and wait for 3 seconds for it to complete
$object = "/C# Program"
$method = "Execute"
CALL rm.execute($object, $method, 0, $args[], 3, status)
Page 816
TYPE "Problem executing script: ", status

PAUSE
END
.END
rm.pc.fapp($file, $line, wait.time, status)
Abstract
Append a single line to a file on the PC
Input Parameters
$file The name of the file to append to on the PC.
$line The line to append to the file.
Output Parameters
Example
.PROGRAM ex1.rm.pc()
AUTO REAL i, num.items, status

AUTO $file, $to.file, $lines[3]
AUTO $file.spec
LOCAL REAL types[]
LOCAL $items[]
$file = "C:\log.txt"
; Write 3 lines in a file on the PC

FOR i = 1 TO 3
CALL rm.pc.fapp($file, $TIME(), 1, status)
TYPE "Failure to append line on file: ", status
END
END
; Append multiple lines in 1 call to the same file

$lines[0] = "Line 1"
CALL rm.pc.fapps($file, 4, $lines[], 1, status)
END
Page 817
; Append multiple lines in 1 call specifying the start index

CALL rm.pc.fapps2($file, 0, 4, $lines[], 1, status)
END
; Copy the file from the PC to the controller

$to.file = "DISK>D:\log.txt"
CALL rm.pc.fcopy($file, $to.file, 3, status)
TYPE "Unable to copy the file to the controller: ", status
END
; List all files on the PC

$file.spec = "C:\*.txt"
CALL rm.pc.fdir($file.spec, 3, num.items, $items[], types[], status)
TYPE "Unable to delete the file from the PC: ", status
END
FOR i = 1 TO num.items
TYPE $items[i-1]
IF (types[i-1] == 0) THEN
TYPE " Is a file"
ELSE
TYPE " Is a directory"
END
END
; Delete the file on the PC

CALL rm.pc.fdel($file, 3, status)
END
.END
rm.pc.fapps($file, num.lines, $lines[], wait.time, status)
Abstract
Append an array of lines to a file on the PC.
Input Parameters
num.lines The number of lines in the array to copy.
$lines[] The lines to append to the file, starting at index 0.
Page 818
Output Parameters
Example

AUTO $file.spec
LOCAL REAL types[]
LOCAL $items[]

FOR i = 1 TO 3

END
END

END

END

END

END
Page 819
TYPE $items[i-1]
TYPE " Is a file"
ELSE
END
END

END
.END
rm.pc.fapps2($file, start.idx, num.lines, $lines[], wait.time, status)
Abstract
Append an array of lines to a file on the PC.
Input Parameters
start.idx The starting index in the array
num.lines The number of lines in the array to copy.
$lines[] The lines to append to the file, starting at the start.index.
Output Parameters
Example

AUTO $file.spec
LOCAL REAL types[]
LOCAL $items[]
FOR i = 1 TO 3
Page 820

END
END

END

END

END

END
TYPE $items[i-1]
TYPE " Is a file"
ELSE
END
END

END
.END
rm.pc.fcopy($from.file, $to.file, wait.time, status)
Abstract
Copy a file between the controller and the PC.
When specifying the file, one of the files must start with the prefix of 'DISK>'. This is used to determine the
direction of the file copy. If neither of the files starts with 'DISK', then it is considered a file copy from 1 PC
file to another entirely on the PC.
Page 821
Input Parameters
$from.file The file to copy from.
$to.file The file to copy to.
Output Parameters
Example

AUTO $file.spec
LOCAL REAL types[]
LOCAL $items[]

FOR i = 1 TO 3
END
END

END

END

Page 822

END

END
TYPE $items[i-1]
TYPE " Is a file"
ELSE
END
END

END
.END
rm.pc.fdel($file, wait.time, status)
Abstract
Delete a file on the PC.
Input Parameters
$file name of the file to delete on the PC
Output Parameters
Example

AUTO $file.spec
LOCAL REAL types[]
LOCAL $items[]
Page 823

FOR i = 1 TO 3
END
END

END

END

END

END
TYPE $items[i-1]
TYPE " Is a file"
ELSE
END
END

END
.END
Page 824
rm.pc.fdir($file.spec, wait.time, num.items, $items[], types[], status)
Abstract
Perform a file and directory listing on the PC.
Input Parameters
$file.spec The file specification to match.
Output Parameters
num.items The number of items returned
$items[] The listing of files and directories found
types[] The types of the items found: 0 = File, 1 = Directory
Example

AUTO $file.spec
LOCAL REAL types[]
LOCAL $items[]

FOR i = 1 TO 3
END
END

END

Page 825

END

END

END
TYPE $items[i-1]
TYPE " Is a file"
ELSE
END
END

END
.END
rm.pc.log($source, $text, wait.time, status)
Abstract
Append text to the AceServer log on the PC.
Input Parameters
$source The source generating the log message.
$text The text to append to the log.
Output Parameters
Page 826
Example
.PROGRAM ex1.rm.log()
AUTO REAL status
CALL rm.pc.log("Robot 1", "Message To Log", 1, status)

TYPE "Failure to append to AceServer log: ", status
END
.END
rm.read.anums($objects[], $variables[], wait.time, values[], status)
Abstract
Read a list of numeric property variables associated with multiple objects on the PC. The variable referenced
must all be numeric types.
Input Parameters
The name of the remote objects to access. This must include the
$objects[]
$variables[] The name of the variables to access
wait.time The amount of time to wait for the execution to complete
Output Parameters
values[] The values of the variables
Example
.PROGRAM ex1.rm.vars.ns()
AUTO $object, $objects[1], $variables[1]

AUTO REAL values[1], status
; Read multiple values from multiple properties of the same object

$object = "/Numeric Variable"
$variables[0] = "Current Value"
$variables[1] = "IsBoolean"
CALL rm.read.nums($object, $variables[], 1, values[], status)
TYPE "Unable To Read Value: ", status
PAUSE
END
TYPE $variables[0], " = ", values[0]

Page 827
; Read multiple values from multiple objects

$objects[0] = "/Numeric Variable"
$objects[1] = "/Numeric Variable 2"
CALL rm.read.anums($objects[], $variables[], 1, values[], status)
PAUSE
END
TYPE $objects[0], ".", $variables[0], " = ", values[0]

.END
rm.read.num($object, $variable, wait.time, value, status)
Abstract
Read a numeric property variable associated with an object on the PC. The variable referenced must be a
numeric type.
Input Parameters
The name of the remote object to access. This must include the
$object
$variable The name of the variable to access
Output Parameters
value The value of the variables
Example
.PROGRAM ex1.rm.vars.n()
AUTO $object, $variable

AUTO REAL value, status
; Write a value of 10 to the numeric variable in the workspace

$variable = "CurrentValue"
value = 10
CALL rm.write.num($object, $variable, 1, value, status)
TYPE "Unable To Write Value: ", status
PAUSE
END
Page 828
; Read the variable and ensure it is the same value

CALL rm.read.num($object, $variable, 1, value, status)
TYPE "Unable To Read the Value: ", status
PAUSE
END
IF (value <> 10) THEN

TYPE "The update did not succeed"
PAUSE
END
.END
rm.read.nums($object, $variables[], wait.time, values[], status)
Abstract
Read a list of numeric property variables associated with an object on the PC. The variable referenced must
all be numeric types.
Input Parameters
$object
$variables[] The names of the variables to access
Output Parameters
Example
.PROGRAM ex1.rm.vars.ns()
AUTO $object, $objects[1], $variables[1]

; Read multiple values from multiple properties of the same object

$variables[1] = "IsBoolean"
CALL rm.read.nums($object, $variables[], 1, values[], status)
PAUSE
END

Page 829
; Read multiple values from multiple objects

$objects[1] = "/Numeric Variable 2"
CALL rm.read.anums($objects[], $variables[], 1, values[], status)
PAUSE
END

.END
rm.read.str($object, $variable, wait.time, $value, status)
Abstract
Read a string property variable associated with an object on the PC. The variable referenced must be a
string type.
Input Parameters
Output Parameters
$value The value of the variable
Example
.PROGRAM ex1.rm.vars.s()
AUTO $object, $variable, $value

AUTO REAL status
; Write a value of "Text" to the string variable in the workspace

$object = "/String Variable"
$value = "Text"
CALL rm.write.str($object, $variable, 1, $value, status)
PAUSE
END
Page 830

CALL rm.read.str($object, $variable, 1, $value, status)
PAUSE
END
IF $value <> "Text" THEN

PAUSE
END
.END
rm.read.strs($object, $variables[], wait.time, $values[], status)
Abstract
Read a list of string property variables associated with an object on the PC. The variable referenced must all
be string types.
Input Parameters
$object
Output Parameters
$values[] The values of the variables
Example
rm.read.trns($object, $variable, wait.time, value, status)
Abstract
Read a transform property variable associated with an object on the PC. The variable referenced must be a
Transform3D type.
Input Parameters
$object
Page 831

Output Parameters
value The value of the variable
Example
.PROGRAM ex1.rm.vars.t()

AUTO REAL status
AUTO LOC t.value
; Write a value of 10 to the transform variable in the workspace

$object = "/Box"
$variable = "OffsetFromParent"
SET t.value = TRANS(10,10,10,0,0,180)
CALL rm.write.trns($object, $variable, 1, t.value, status)
PAUSE
END

CALL rm.read.trns($object, $variable, 1, t.value, status)
PAUSE
END
.END
rm.read.trnss($object, $variables[], wait.time, values[], status)
Abstract
Read a list of transform property variables associated with an object on the PC. The variable referenced
must all be Transform3D types.
Input Parameters
Page 832
Output Parameters
rm.save($file, wait.time, status)
Abstract
Saves the workspace file on the PC.
Input Parameters
Name of the file on the PC to save. If empty, save to the current
$file
file
Output Parameters
Example
.PROGRAM ex1.rm.save()
AUTO REAL status
AUTO $file
$file = "C:\workspace.awp"
CALL rm.save($file, 10, status)
TYPE "Unable To Save Workspace: ", status
PAUSE
END
.END
rm.write.anums($objects[], $variables[], wait.time, values[], status)
Abstract
Set the values of an array of numeric properties associated with a collection of objects on the PC. The
property variables referenced must all be of a numeric type.
Input Parameters
Page 833
$objects[] The names of the remote objects to access. This must include
the full path name of the object to access. e.g. "/directory/Robot
1"
Output Parameters
Example
.PROGRAM ex1.rm.vars.nws()
AUTO $objects[0], $variables[0]

; Write multiple values from multiple properties of the same object

$variables[0] = "CurrentValue"
values[0] = 110
CALL rm.write.nums($objects[0], $variables[], 1, values[], status)
TYPE "Unable To Write Values: ", status
PAUSE
END
; Perform a multiple object write

CALL rm.write.anums($objects[], $variables[], 1, values[], status)
PAUSE
END
.END
rm.write.num($object, $variable, wait.time, value, status)
Abstract
Set the value of a numeric property associated with an object on the PC. The property variable referenced
must be of a numeric type.
Input Parameters
$object
Page 834

Output Parameters
Example
.PROGRAM ex1.rm.vars.n()

AUTO REAL value, status
; Write a value of 10 to the numeric variable in the workspace

value = 10
CALL rm.write.num($object, $variable, 1, value, status)
PAUSE
END

CALL rm.read.num($object, $variable, 1, value, status)
PAUSE
END
IF (value <> 10) THEN

PAUSE
END
.END
rm.write.nums($object, $variables[], wait.time, values[], status)
Abstract
Set the values of an array of numeric properties associated with an object on the PC. The property variables
referenced must all be of a numeric type.
Input Parameters
Page 835

Output Parameters
Example
.PROGRAM ex1.rm.vars.nws()
AUTO $objects[0], $variables[0]

; Write multiple values from multiple properties of the same object

$variables[0] = "CurrentValue"
values[0] = 110
CALL rm.write.nums($objects[0], $variables[], 1, values[], status)
PAUSE
END
; Perform a multiple object write

CALL rm.write.anums($objects[], $variables[], 1, values[], status)
PAUSE
END
.END
rm.write.str($object, $variable, wait.time, $value, status)
Abstract
Set the value of a string property associated with an object on the PC. The property variable referenced
must be of a string type.
Input Parameters
$value The value of the variable
Page 836
Output Parameters
Example
.PROGRAM ex1.rm.vars.s()
AUTO $object, $variable, $value

AUTO REAL status
; Write a value of "Text" to the string variable in the workspace

$object = "/String Variable"
$value = "Text"
CALL rm.write.str($object, $variable, 1, $value, status)
PAUSE
END

CALL rm.read.str($object, $variable, 1, $value, status)
PAUSE
END
IF $value <> "Text" THEN

PAUSE
END
.END
rm.write.strs($object, $variables[], wait.time, $values[], status)
Abstract
Set the values of an array of string properties associated with an object on the PC. The property variables
referenced must all be of a string type.
Input Parameters
$values[] The values of the variables
Page 837
Output Parameters
Example
rm.write.trns($object, $variable, wait.time, value, status)
Abstract
Set the value of a transformation property associated with an object on the PC. The property variable
referenced must be of a Transform3D type.
Input Parameters
$object
Output Parameters
Example
.PROGRAM ex1.rm.vars.t()

AUTO REAL status
AUTO LOC t.value
; Write a value of 10 to the transform variable in the workspace

$object = "/Box"
$variable = "OffsetFromParent"
SET t.value = TRANS(10,10,10,0,0,180)
CALL rm.write.trns($object, $variable, 1, t.value, status)
PAUSE
END

CALL rm.read.trns($object, $variable, 1, t.value, status)
PAUSE
Page 838
END
.END
rm.write.trnss($object, $variables[], wait.time, values[], status)
Abstract
Set the values of an array of transformation properties associated with an object on the PC. The property
variables referenced must all be of a Transform3D type.
Input Parameters
The name of the remote object to access This must include the
$object
$variables[] The name of the variables to access
Output Parameters
Page 839
OMRON Corporation Industrial Automation Company Authorized Distributor:
Kyoto, JAPAN
Contact: www.ia.omron.com
Regional Headquarters
OMRON EUROPE B.V. OMRON ELECTRONICS LLC
Wegalaan 67-69, 2132 JD Hoofddorp 2895 Greenspoint Parkway, Suite 200 Hoffman Estates,
The Netherlands IL 60169 U.S.A.
Tel: (31)2356-81-300/Fax: (31)2356-81-388 Tel: (1) 847-843-7900/Fax: (1) 847-843-7787
OMRON ASIA PACIFIC PTE. LTD. OMRON ADEPT TECHNOLOGIES, INC.

No. 438A Alexandra Road # 05-05/08 (Lobby 2), 4550 Norris Canyon Road, Suite 150, San Ramon, CA 94583 U.S.A.
Alexandra Technopark, Tel: (1) 925-245-3400/Fax: (1) 925-960-0590 © OMRON Corporation 2016 All Rights Reserved.
Singapore 119967 In the interest of product improvement,
Tel: (65) 6835-3011/Fax: (65) 6835-2711 OMRON (CHINA) CO., LTD. specifications are subject to change without notice.
Room 2211, Bank of China Tower, 200 Yin Cheng Zhong Road,
PuDong New Area, Shanghai, 200120, China Printed in USA
Tel: (86) 21-5037-2222/Fax: (86) 21-5037-2200 Cat. No. I609-E-01 0316

$CE Sight: Reference XLGH

Uploaded by

Copyright:

Available Formats

$CE Sight: Reference XLGH

Uploaded by

Document Information

Original Title

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

$CE Sight: Reference XLGH

Uploaded by

Copyright:

Available Formats

$CE Sight

Created in the United States of America

ACE Reference Guide, 18317-000 Rev A

ACE Reference Guide, 18317-000 Rev A

ACE Reference Guide, 18317-000 Rev A

ACE Reference Guide, 18317-000 Rev A

ACE Reference Guide, 18317-000 Rev A

ACE Reference Guide, 18317-000 Rev A

ACE Reference Guide, 18317-000 Rev A

ACE Reference Guide, 18317-000 Rev A

ACE Reference Guide, 18317-000 Rev A

Communication Tool Properties 597

Customizer Reference Guide 623

ACE Reference Guide, 18317-000 Rev A

ACE Reference Guide, 18317-000 Rev A

Default Allocation Script 675

V+ Module Documentation 722

ACE Reference Guide, 18317-000 Rev A

Input Parameters 724

ACE Reference Guide, 18317-000 Rev A

ACE Reference Guide, 18317-000 Rev A

Output Parameters 740

ACE Reference Guide, 18317-000 Rev A

End-Effector Library Error Codes 750

ACE Reference Guide, 18317-000 Rev A

Output Parameters 757

ACE Reference Guide, 18317-000 Rev A

ACE Reference Guide, 18317-000 Rev A

Input Parameters 771

ACE Reference Guide, 18317-000 Rev A

ACE Reference Guide, 18317-000 Rev A

Input Parameters 790

ACE Reference Guide, 18317-000 Rev A

pm.rob.process(rob.idx, proc.idx, sts) 801

ACE Reference Guide, 18317-000 Rev A

Input Parameters 809

ACE Reference Guide, 18317-000 Rev A

rm.pc.fdel($file, wait.time, status) 823

ACE Reference Guide, 18317-000 Rev A

rm.save($file, wait.time, status) 833

ACE Reference Guide, 18317-000 Rev A

getinstance reset_seq string2instance

Property Name Code Description of the Change

RobotConfiguration 10400 No longer supported.

Property Name Code

ACE Reference Guide, 18317-000 Rev A

Property Name Code

The following command codes are no longer supported.

Property Name Code

ACE Reference Guide, 18317-000 Rev A

Property Name Code

ACE Reference Guide, 18317-000 Rev A

Property Name Code

$ip IP address of the vision server

sequence Not used. Must be -1.

Tool The tip number

Index The robot number

Object The index of the signal number to access

ACE Reference Guide, 18317-000 Rev A