Instrument Operational Check

Executes a behavior on an instrument that is typically unique to that instrument or class of instruments.

 

Input Arguments

 

0

Collection Instrument ID

Instrument to Check

The instrument ID of the instrument in question.

1

String

Check Type

A string command indicating the type of check to perform.

 

Return Arguments

None.

 

Returned Status

 

SUCCESS

The check was performed successful.

FAILURE

The check was not successful.

 

Remarks

Command strings are listed below:

 

Laser Tracker Commands

 

Laser Trackers

 

 

Time Out []

[] is the time in seconds to wait for an MP command that sup- ports a time out period to be assigned as the maximum allowed time for the command to complete successfully before auto- matically failing at the expiration of the period. Initially, only the “Home” command supports Time Out. The Time Out can be disabled by issuing a command of “Time Out 0.0”.

Retry On

Enable retries for MP commands. If a command is specified

correctly but the instrument has not responded, it will retry after the “Retry Wait” period.

 

Retry Wait []

When “Retry On” is enabled, [] specifies the number of seconds after the command has failed before a retry attempt ([] not part of string).

Retry Off

Turns retries off for MP commands (Default behavior).

Set Targ []

Set active target to that designated by [] ([] not part of string).

 

Set Auto Meas []

Set SA requested discrete point acquisition to that specified by []. Any meas profile with a discrete acquisition can be referenced and its settings used to set the SA Interaction >Measurement Requests profile.

Motors On

Turn motors on.

Motors Off

Turn motors off.

AutoLock On

Turns on PowerLock, SmartFind, or i-Vision.

 

Laser Tracker

AutoLock Off

Turns off PowerLock, SmartFind, or i-Vision.

 

HoldPositionNoBeamLock On

Hold position on, but tracking off (tracker won’t lock if it sees a target).

For Leica emScon trackers, this turns PowerLock off.

For Faro trackers, when the tracker is pointed at a target, the tracker will not attempt a lock or search.

 

HoldPositionNoBeamLock Off

Hold position on, and tracking returns to default behavior (will lock on if it sees a target).

For Leica emScon trackers, this turns PowerLock on.

For Faro trackers, the tracker will attempt to lock on if pointed at a target.

Start

Re-start tracker (performs initialization as well).

Initialize

Initialize the tracker (NOTE: does not apply to API trackers).

Home

Home tracker.

Two Face Here

Perform a two-face ops check at the current location.

ADM/IFM Here

Perform ADM ops check (with respect to IFM) at current location.

IFM

Start an IFM ops check/cal. (two station or scale bar) at current location.

Closure

Perform closure check at current location with respect to current

home.

Drift

Start drift ops check.

ADM

Start ADM ops check/cal ui for multiple locations (with respect to IFM).

ADM Drive

Equivalent to pressing the “ADM Drive” button.

 

ADM Reset [d]

Equivalent to pressing the “ADM Reset” button. If [d] is included ([ ] not part of string), the seed distance will be set to the dis- tance d.

ADM Search Radius [r]

Sets the ADM search radius to the value in inches designated by

r ([] not part of string)

ADM Timeout [t]

Sets the ADM reset timeout to the amount in seconds desig- nated by t ([ ] not part of string).

Jog Up [d]

Jogs the tracker up by the amount in degrees designated by d ([

] not part of string).

Jog Down [d]

Jogs the tracker down by the amount in degrees designated by

d ([ ] not part of string).

Jog Left [d]

Jogs the tracker left by the amount in degrees designated by d ([

] not part of string).

Jog Right [d]

Jogs the tracker right by the amount in degrees designated by d

([ ] not part of string).

Camera View

Pops the tracker’s overview video camera view.

Ball Bar

Start Ball Bar ops check.

Reflector Center

Start Reflector Center ops check.

Is Laser Warmed Up

Return value indicates whether the laser is warmed up

Valid Distance

Return value indicates whether tracker is locked on a reflector.

Is Measuring

Return value indicates whether the tracker is measuring.

Change Face

Change face.

Measure Level

Initiate level measurement--sends frame to SA with Z-axis ‘up’.

Monitor Level

Initiate level monitor.

 

Level Compensator ON

Turn ON Level Compensation if this tacker is equipped. if not, this returns true so as not to interrupt the script. NOTE: This command will Re-Initialize the tracker if needed.

Level Compensator OFF

Turn OFF Level Compensation if this tacker is equipped. if not, this returns true so as not to interrupt the script. NOTE: This

command will Re-Initialize the tracker if needed.

 

Laser Trackers

 

Outdoor Mode On

For Leica 40x trackers only: Turns ON Outdoor measurement mode. If not a 40x tracker, this returns true so as not to interrupt the script.

Outdoor Mode Off

For Leica 40x trackers only: Turns OFF Outdoor measurement mode, and sets tracker to Fast Point mode. If not a 40x tracker,

this returns true so as not to interrupt the script.

Beam Break Auto-IFM

Set beam break behavior to automatically home to the last used home position (tracker mounted nest, or remote home).

Beam Break Auto-ADM

Set beam break behavior to automatically use ADM to reset the

distance.

Shut Down Tracker

For LMF (AT9x0, ATS) only – turns off the tracker and controller, and closes the interface

 

 

 

 

 

Go To Sleep, Wake Up From Now d, h::m::s

For LMF (930/960, ATS) only – turns off the laser, and turns it back on after the amount of time designated by d, h::m::s has passed, where d is the integer number of days, h is hours, m is minutes, and s is seconds. The comma and colons are required parts of the string, and the letters are to be replaced by the appropriate integer numbers. This time is FROM THE CURRENT LOCAL TIME of your PC. So the time to turn the laser back on is RELATIVE to the current time, therefore, the MP will always be valid. This command does not close the interface, but you can close it if you wish. The laser will still come back on after the designated time. You can in fact check the tracker controller, it

will tell you when it is scheduled to turn the laser back on.

Measure All You Can See

For LMF (930/960, ATS) only – tells tracker to measure all targets visible in the camera’s field of view

Spiral Search On

For Leica 901 – favors spiral search over power lock – no retry

Spiral Search Off

For Leica 901 – favors power lock over spiral search – no retry

Allow No Tip On

Allow tipless measurement (for Leica T-Products).

Allow No Tip Off

Disallow tipless measurement (for Leica T-Products).

 

Set External Trigger For TMAC-Touch Probe

Sets EmScon triggering to External, and makes related settings to ready the system for measuring with the TMAC-I touch probe. This MUST be called before doing touch-triggered measure- ment.

Set Internal Trigger

Sets EmScon triggering to Internal Application, the “normal” use case where measurements are initiated from the interface or

from MP commands.

 

Select Compensation []

Initially for Leica 930/960. Selects the tracker compensation by name, designated by [] ([] not part of string). Results logged to Inst. History.

Set Faro Internal Trigger

Sets tracker to the default “Internal” triggering, where the inter-

face controls measurement.

 

Set Faro External Trigger

Sets tracker to accept external trigger signal connected to tkr to control measurement. In main interface, go to General Settings

>> Faro Settings for detailed information.

Faro Beam Mode IFM Only

Set Faro tracker to IFM-only beam mode--disables ADM.

Faro Beam Mode ADM Only

Set Faro tracker to ADM-only beam mode--disables IFM.

Faro Beam Mode IFM Set By ADM

Set Faro tracker to set distances with ADM only, but count IFM fringes when measuring distance.

 

Enable Faro Camera Search

For Faro trackers that are video-capable: Enables the camera search such that an ADM target search will try the camera search before trying the spiral search (provided the target is within the

acceptable camera search range).

 

Disable Faro Camera Search

For Faro trackers that are video-capable: Disables the camera search such that an ADM target search will only try a spiral search.

 

Laser Tracker

Run Faro CompIT

Run Faro’s CompIT utility.

Run Faro Self Comp

Run Faro self-compensation directly (no Java Applet). Note: This command calls “Quick Comp” on Vantage trackers.

Run Faro Angular Accuracy Check

Run Faro angular accuracy check directly (no Java Applet).

Run Faro ADM/IFM Check

Run Faro ADM/IFM check directly (no Java Applet).

Run Faro Quick Comp

Runs Faro’s no-UI quick compensation on the currently-locked target.

Run Faro AAC

Runs Faro’s no-UI angular accuracy check on the currently-

locked target.

Run Faro Angular Accuracy Check

Run Faro Angular Accuracy Check directly (no Java Applet).

Run Faro ADM/IFM Check

Run Faro ADM/IFM Check directly (no Java Applet).

Run Faro Quick Comp

Run Faro No UI Quick Compensation (on the currently locked target)

Run Faro AAC

Run Faro No UI AAC (on the currently locked target, newer track-

ers)

Run Faro Angular Accuracy Check

Run Faro Direct Angular Accuracy Check (on the currently locked target, older trackers)

Add Remote Home []

Add a new remote home position with name designated by [] ([]

not part of string).

Go To Remote Home []

Go to and lock onto the remote home designated by [] ([] not part of string).

Delete Remote Home []

Delete the remote home designated by [] ([] not part of string).

API DI Virtual Level

Perform API Device Interface virtual level routine.

API DI iProbe Offset

Pop API Device Interface iProbe Offset Calibration window.

API DI iProbe Global

Pop API Device Interface iProbe Global Calibration window.

API DI iVision Dlg

Pop the API Device Interface iVision control/settings dialog.

 

API DI iVision Multi-SMR Timeout Seconds [t]

The automated Innovo multi-smr measurement has no error handling. This provides a maximum time to wait for the mea- surement to return success, so that the MP command can fail when appropriate. The time is designated by t ([ ] not part of string). 300 seconds is the default.

API DI iVision Measure Time Seconds [t]

This sets the acquisition time for each Innovo measured point. The time is designated by t ([ ] not part of string). 0.5 to 5.0 sec-

onds is recommended. 0.5 seconds is the default.

API DI Perform iVision Multi SMR Measurement

Enable the Innovo camera, and put it in multi-SMR measurement mode. Return success only if the measurement succeeds.

API DI Enable iVision

Enable the Innovo camera for catching the beam.

API DI Disable iVision

Disable the Innovo camera.

 

API DI Run iVision Teach

This causes the API iVision dialog to display, waiting for you to click on the SMRs in the camera’s field of view that you would like the Teach Measurement (see below) to measure.

API DI iVision Teach Meas Iterations []

Sets the number of iterations designated by [] which the iVision

Teach measurement will be performed.

API DI iVision Teach Meas XML Path [C:\\Temp\\TeachMeas.xml]

Sets the path for the iVision Teach measurement XML file desig- nated by []. (Path shown as an example).

API DI Run iVision Teach Meas

This will run the iVision-taught points (see above) and will use

the iterations and path set by the above commands.

Set Motor Mode Tracking

For API — put motors in “Tracking” mode. For the Radian, this can be used to tell the camera to lock onto the SMR.

API TTL Trigger ON

Set the external TTL trigger mode on for the next temporal scan

measurement to use it.

API TTL Trigger OFF

Set the external TTL trigger mode off, so that the next temporal scan measurement will not use it.

 

Laser Tracker

Show Big Group/Target Window

Pops the resizable group/target window. The window will persist its size and placement. Returns success if the dialog is already

showing.

Close Big Group/Target Window

Closes the group/target window if it is open. Returns success if

the dialog is already closed.

Hide UI

Hide the main tracker interface window and show the SA tracker

ToolBar (no retry).

Show UI

Hide the SAToolBar and show the main tracker interface window

(no retry).

Show RMS Monitor

Display the RMS Monitor window. Do nothing if it is already up.

Hide RMS Monitor

Close the RMS Monitor window. Do nothing if it is already

closed.

Close Camera View

Attempts to close an open overview video camera window if

one is open.

Set Scan Profile []

For Leica AS1 scanner. Sets the RDS scan profile by name, desig-

nated by [] ([] not part of string)

Start Scan

For Leica AS1 scanner. Begins scanning.

Stop Scan

For Leica AS1 scanner. Ends scanning.

Get Reflector Position

For Leica AS1 scanner. Gets the reflector center position as a

measurement, for a future auto-reset onto the scanner.

 

 

 

Set Profile ‘[1]’‘[2]’ to [3]”

Sets a measure profile’s parameter to stipulated value. (Profile name designated by [1], string in single quotes. Parameter name designated by [2], string in single quotes. Value [3], include the word “to” then the number without quotes.

Currently works for a spatial scan’s increment parameter, e.g. [Set Profile ‘Spatial Scan to SA’‘Increment’ to 0.125]

This was added for use with the arm controlled simultaneous arm and tracker measurement feature, to automate setting the

tracker’s spatial increment (in inches).

 

AT960 Automation With the AS1 Scanner

 

 

Connect LMF IO []

Establishes a connection to the CB21 (Control Box) at the IP address specified by [] ([] not part of string). This command, like all LMF_IO commands, will work whether connected to the AS1 via RDS, or to the AP21 via LMF. But the normal operating mode is with an RDS connection to the AS1 scanner. “AT960Simulator” can be used as an IP address to open the LMFIO simulator.

Disconnect LMF IO

Removes the connection to the CB21 Digital IO Interface.

 

Is Robot Program Active

Checks if a robot program is running. Returns “Success” if the Ro- botProgramActive I/O value is TRUE (1). Returns Partial success if RobotProgramActive I/O value is FALSE (0). Returns failure if SA cannot read the RobotProgramActive I/O value.

Send Robot Go [timeout]

Sets the RobotGo bit to 1. Waits for the robot program to set

RobotPositionReached to 0 (the timeout is expressed in seconds) Set RobotGo back to 0.

Wait For Robot Position Reached []

Waits for the robot program to set RobotPositionReached to 1 (the timeout is expressed in seconds, 0 = no timeout!)

 

 

Switch to LMF/RDS

This command forces a connection either to RDS or LMF (enter LMF or RDS). In addition to switching to the desired interface, this command will also deactivate the Auto Switching. If the connection to the specified interface is already established, this command will deactivate AutoSwitching and immediately return

as success.

 

AT960 Automation with the AS1 Scanner

Toggle LMF<>RDS AutoSwitching []

This command toggles the Auto switching between LMF and

RDS On and Off.

 

Get Reflector Position.

This command records the position of the prism of the currently locked on face of the AP21. This command will create a point on the tree view with the name defined on the interface. This is

normally used to define the lock-on positions.

AutoLock On/Off

Toggle Powerlock On/Off. It works while being connected with

either interface RDS/LMF.

Valid Distance

When locked on the AS1, this command will return success if the Scanner is Ready To Measure. Can be used before calling «Scan

Start» to ensure that the scanner is Ready.

Start Scan

Starts the measurement, this is equivalent to pressing the trigger

on the scanner.

Stop Scan

Stops the measurement, this is equivalent to releasing the trig-

ger on the scanner.

Set Scan Profile []

Sets the RDS scan Profile by name. The available profiles can be found on General Tracker Settings>Leica AT9x0>Available MP

Commands.

Set Line Scan Thinning Factor []

Sets the thinning factor for line scanners.

Toggle Line Scan Min Angle Filter On/Off

Turns the curvature based filter on and off.

Min Angle Filter [] Degrees [] Max Distance mm

Sets the parameters for the curvature based filter.

 

Leica Automation Interface

 

Set Automation Mode On

This puts the AIC Interface in Automation Mode. In this mode, the next ‘Measure’ command from MPs will cause the Interface to expect Digital I/O signals from the robot to drive scanning.

 

Set Automation Mode Off

This puts the AIC Interface in Manual Mode. In this mode, the next ‘Measure’ command from MP will simply turn the scanner on. The scanner will stay on until the next “Stop Active Measure- ment Mode” command from MP. NOTE: This is the default startup

mode of the AIC Interface.

Select Device Trigger Probe

Set AIC Device Selection to Trigger Probe (emScon).

Select Device T-Scan

Set AIC Device Selection to T-Scan.

 

Select Tracker 1

Set AIC to Tracker 1, Jump SA Instrument to designated Collection::Instrument Index (set in AIC Driver), Connect and Start Interface to T-Scan or emScon based on current MUX and AIC Device Selection

 

Select Tracker 2

Set AIC to Tracker 2, Jump SA Instrument to designated Collection::Instrument Index (set in AIC Driver), Connect and Start Interface to T-Scan or emScon based on current MUX and

AIC Device Selection

 

Select Tracker 3

Set AIC to Tracker 3, Jump SA Instrument to designated Collection::Instrument Index (set in AIC Driver), Connect and Start Interface to T-Scan or emScon based on current MUX and AIC Device Selection

 

Select Tracker 4

Set AIC to Tracker 4, Jump SA Instrument to designated Collection::Instrument Index (set in AIC Driver), Connect and Start Interface to T-Scan or emScon based on current MUX and

AIC Device Selection

 

Increment Group/Cloud Name

Increment the Current Group/Cloud Name by 1. This name is used for Point Group when measuring points, and Cloud Name when scanning with T-Scan.

Release Motors

Release motors if there is a current emScon or T-Scan connec-

tion.

 

Leica Automation Interface

 

Is Laser Locked

For the T-Mac or T-Scan: Returns success if the beam is locked, fail if not locked, and the status window shows what kind of target the laser is locked onto.

 

Is 6D Status Valid

Returns success if the 6D Status is valid, fail otherwise. NOTE: This command only works properly for the TMAC interface. The COM connection to TScan Collect does not have a working version of this function—it will return TRUE even if the laser is

locked on a 3D target (e.g. SMR).

Is Laser Locked on TScan

For use with TScan Collect. Added because “Is 6D Status Valid” does not work properly for TScan Collect.

Is Laser Locked on TMac

For use with TScan Collect. Added because “Is 6D Status Valid”

does not work properly for TScan Collect.

 

Is Laser Locked on TMac MultiSide

When called with T-Mac active, this will report whether the tracker is locked on the T-Mac MS, and if so, will also report the number of sides, and the locked side. When called with TScan Collect active, added because “Is 6D Status Valid” does not work properly for TScan Collect.

Set emScon Measure Time []

Set the Measure Time for Discrete measurements when Trigger Probe is the Current Device (emScon connection) to that desig-

nated by [] Seconds ([] not part of string)

Set Scan Point To Point Distance []

Set T-Scan Point to Point Distance to that designated by [] mm ([] not part of string)

Set Scan Line To Line Distance []

Set T-Scan Line to Line Distance to that designated by [] mm ([]

not part of string)

Set Scan Maximum Angle of Incidence []

Set T-Scan Maximum Angle of Incidence to that designated by [] degrees ([] not part of string)

Close Scan Gaps Up To []

Tell T-Scan Collect to close gaps in scan data up to that desig- nated by [] mm ([] not part of string). A setting of 0.0 means do

not close gaps.

AIC Move Robot

Perform the Go-Position Reached sequence without scanning.

Send Confirmed Go

Same as “AIC Move Robot”, but does not wait for position reached, only confirms that Go gets sent.

Wait For Position Reached

Only waits for the position reached signal from I/O.

Scanner Power On

Turn the T-Scan laser on.

Scanner Power Off

Turn the T-Scan laser off.

Set Alignment Sphere Radius []

Set the calibration sphere radius in mm for the Scanner Align- ment.

Set Alignment Iterations []

Set the number of iterations for the Scanner Alignment.

Set Alignment Use Auto Clipping On

Set the scanner alignment to use auto-clipping.

Set Alignment Use Auto Clipping Off

Set the scanner alignment to NOT use auto-clipping.

 

 

Start Scanner Alignment

Begin the Scanner Alignment data acquisition. Ensure that the scanner is on before calling this. Normally, you will insert an ‘Ask for User Decision’ step after this, so the user can tell the MP that the data collection is complete. NOTE: Use in ‘Manual’ mode with the trigger button, or ‘Automation’ mode with subsequent ‘Measure’ command(s).

 

 

Calculate Scanner Alignment

Once the data collection is complete from the ‘Start Scanner Alignment’ step, this will Calculate the alignment transform, and if successful, present the alignment error, and give the user a chance to accept the results and apply them, or reject the re- sults. If the alignment error is less than 1500, this step automati-

cally succeeds, and applies the alignment.

Reduce Scanner Waviness

Call the scanner ReduceWaviness function.

TPWizard Measurement Check 3D

Run automated TrackerPilot Wizard check.

TPWizard Measurement Check 6D

Run automated TrackerPilot Wizard check.

 

Leica Automation Interface

TPWizard Stylus Check

Run automated TrackerPilot Wizard check.

TPWizard Stylus Compensation

Run automated TrackerPilot Wizard compensation.

TPWizard Shank Compensation

Run automated TrackerPilot Wizard compensation.

TPWizard Create Virtual Stylus

Run automated TrackerPilot Wizard.

TPWizard Edit Virtual Stylus

Run automated TrackerPilot Wizard.

Start Instrument Interface

Start the Interface for the ‘Instrument’s ID’ in SA. ‘Interface Type’ 0 runs the SA Laser Tracker interface. ‘Interface Type’ 1 runs the

AIC interface.

Point At Target

Point the Instrument Designated by ‘Instrument ID’ at a ‘Point

Name’ in the Designated “Collection::Group::Target”

 

Set Instrument Group and Target

For the Instrument Designated by ‘Instrument ID’, this sets the current Collection::Group::Target designated by ‘Point Name’. NOTE: The Group name is used as the Cloud name when using

the T-Scan.

 

 

Measure

This causes the T-Scan connected to ‘Instrument ID’ to begin scanning if the AIC Interface is connected and NOT in Automa- tion Mode. In Automation Mode, this causes the AIC Interface to enter automated measurement with digital I/O handshaking. If the SA Laser Tracker interface is connected, this will cause the

current active Measure Profile to be run.

 

 

Stop Active Measurement Mode

This causes the T-Scan connected to ‘Instrument ID’ to end scan- ning if the AIC Interface is connected. If the SA Laser Tracker interface is connected, this will cause the current active Measure Profile to be stopped if measuring. NOTE: For the T-Scan, this command will be called by the robot using the digital I/O hand-

shaking when in Automation Mode.

Stop Instrument Interface

Stop the Interface for the ‘Instrument’s ID’ in SA.

 

Leica T-Scan

Start Scan

Begins a scan pass

Stop Scan

Ends a scan pass

Increment Group/Cloud Name

Increment the Current Group/Cloud Name by 1. This name is used for clouds when scanning.

Is Laser Locked

Succeeds if the laser is locked. Fails if not.

Release Motors

Releases torque on the tracking motors in order to lock the beam by hand.

Set Scan Point To Point Distance []

Set Point to Point Distance to that designated by [] mm ([] not

part of string)

Set Scan Line To Line Distance []

Set Line to Line Distance to that designated by [] mm ([] not part of string)

Set Scan Maximum Angle of Incidence []

Set Maximum Angle of Incidence to that designated by [] de-

grees ([] not part of string)

 

Set Scan Exposure Time []

Sets the scanner’s exposure time, where [] is in milliseconds ([] not part of string). Use 0.25-20.0ms for T-Scan Collect version 10 and higher, or 0.01-9.98 ms for PROBEscan.

Set Scan Width Iteration []

Sets the width of the scan line where [] is a value from 1-12 ([]

not part of string). 0=100%, 12=40% (decrements by 5%).

 

Set Scan Reflection Filter []

Sets the reflection filter type, where [] is a value between 1 and 4 ([] not part of string). 1 = Standard, 2 = Low, 3 = Medium, 4 = High.

Close Scan Gaps Up To []

Maximum allowable closed gap in mm ([] not part of string). Use

0.0 to disable this option.

Scanner Power On

Turns the scanner on.

Scanner Power Off

Turns the scanner off.

 

 

Portable CMMArmCommands

 

 

Portable CMM Arms

Send Measured Points

Send measured points with all measure modes

Don’t Send Measured Points

Don’t send measured points with any measure modes

Calibrate

Initiate arm calibration.

Auto-Prox with Scanner

For SA Auto-Correspond with Proximity Trigger

Auto-Prox with Probe

For SA Auto-Correspond with Proximity Trigger

Set Geom Name [ ]

Set the Geometry Name to text designated by [ ] ([ ] not part of

string)

Mouse Mode On

Put the arm in mouse mode

Mouse Mode Off

Take the arm out of mouse mode.

Set Stream Points Spatial Increment Inches []

Set the Spatial Probe Stream Increment to the amount desig-

nated by [] in inches.

 

Tracker Meas Control On

Set Stream Points measure mode to control simultaneous tracker measurement. (Same as right-clicking on the Stream Points measurement button and checking the “Control Tracker

Meas with Stream On/Off” check box.

 

Tracker Meas Control Off

Set Stream Points measure mode to NOT control simultaneous tracker measurement. (Same as right-clicking on the Stream Points measurement button and unchecking the “Control

Tracker Meas with Stream On/Off” check box.

 

 

“Stream Points Frequency [1] Increment [2] [3]”

Sets the Stream Points profile’s sampling frequency ([1] in Hz) and spatial increment ([2]). Units [3] can be “in” or “mm”. Example: [Stream Points Frequency 120 Increment 0.1 in]

The command also ensures Stream is set active and set to Spatial (not Temporal). This was added for use with the control for simultaneous measurement with a laser tracker, but can be used

any time.

 

Theodolite & Total Station Commands

 

Leica Total Station Interface

Set Laser On

Turns on the red laser pointer

Set Laser Off

Turns off the red laser pointer

PowerSearch

PowerSearch performs an automatic and rapid search for a prism.

Set Tracking On

Enables Tracking, an already targeted prism is followed auto-

matically.

Set Tracking Off

Disables Tracking

Set ATR On

Enables ATR (Automatic Target Aiming) for precision target centering

Set ATR Off

Disables ATR centering

 

Theodolite Manager

Set TwoFace ON

Enable two face measurement

Set TwoFace OFF

Disable two face measurement

Set SEPOBS ON

Enable Send Front/Back as Separate Observations

Set SEPOBS OFF

Disable Send Front/Back as Separate Observations

Set MeasMode Standard

Sets the measurement mode to “Standard” (Leica instruments).

Set MeasMode Precise

Sets the measurement mode to “Precise” (Leica instruments).

Set MeasMode Fast

Sets the measurement mode to “Fast” (Leica instruments).

 

Theodolite Manager

Set Laser On

Turns on the laser.

Set Laser Off

Turns off the laser.

Acquire

Attempts to acquire the target.

PowerSearch

Performs a PowerSearch for the target (Leica instruments).

Query Angles

Perform a query – angles only

Query Distance

Perform a query – angles + distance

Set Tracking Off

Turns off tracking mode.

Set Tracking TrackOnly

Puts the instrument in “track only” mode.

Set Tracking Updates

Tells the instrument to begin sending updates.

Set Tracking SpatialScan

Puts the instrument into a spatial scan mode (if applicable).

Set Tracking StablePoint

Puts the instrument into a stable point mode.

Camera Telescope

Sets the camera to telescope on supported scopes

Camera Overview

Sets the sets the camera to overview on supported scopes

* To change Targets use the “Set Instrument Targeting” command and specify the target by name.

 

Laser Radar Commands

 

Nikon Laser Radar

Linearization

Perform linearization test.

FlipTest

Perform a flip test.

SelfTest

Perform a self test.

StareTest

Perform a stare test.

LOSeparation <region>

MV200/300 Only - Perform an LO separation test. Region should be Region12, Region23, or Region34.

FullComp

Performs a full compensation.

QuickComp

Performs a quick compensation (currently functions the same as a full compensation).

MCMCalibration <ptgroup>

Performs an MCM calibration using a point group. (Point group

syntax is Collection::PtGroupName).

MCMCalibration <ptgroup1>, <ptgroup2>, ..., <ptgroupN>

Performs a relative MCM calibration using several point groups.

MCMCalibration <ptgroup1>, ..., <ptgroupN> TRUE

Validate a relative MCM calibration using several point groups.

AutoFocus

Initiates an autofocus operation.

SetFocusLimits <min> <max>

Sets the focus limits using the specified min and max distances.

IRPowerWindow <ON/OFF>

Open/Close IR Power Spectrum FFT Window

mirror on <mirror>

Set an active mirror, where <mirror> is the name of the mirror to use.

mirror off

Disable use of a mirror

Start Video

Starts the video display.

IsVideoOn?

Verify status of the video streaming

Stop Video

Stops the video display.

SaveVideoFrame <path and filename>

Save video frame as an image file (BMP, JPG, PNG, GIF, or TIFF)

 

HWCapability <capability>

Offers the ability to check if the LR supports hardware capa- bilities (SVIGrouping, ScanEngineLicense, HighSpeedScan, GaugingEngine, GaugingEngineLicensed, MCMDatabase, Net- workVideo, InternalAccelerometer, VibrationAnalysis, InstDop- plerCorrection, GEPartialScanProgress)

SetScanPowerThreshold [ ]

Provides a means to set the can power threshold for the active

target.

SetConfidenceThreshold [ ]

Provides a means to set the quality (confidence) threshold for the active target.

 

Aligned Vision LaserGuide Projector

Pause

Pause the current projection.

Resume

Resume the current projection.

Current

Project the current pattern (part) file.

Next

Project the next pattern file in the current file’s folder.

Previous

Project the previous pattern file in the current file’s folder.

Cross

Project the field of view and center crosshair for location.

Field Of View

Project the field of view and center crosshair for location.

Set Part Name []

Set active part PATH to that designated by [] ([] not part of string).

Add Patterns to Existing Part

Tell the interface to add projections from SA to the current

selected part file.

 

Make New Part

Tell the interface to make a new part file, located in the current part file’s directory, but carrying the name of the first projection object in the projection from SA.

 

 

 

Set Auto Align File []

Set the path to an alignment file, designated by [] ([] not part of string). This path will be updated in the UI, and will be used for the next Auto Alignment, whether commanded from MP, or from the Auto Align control in the UI. NOTE: The file must have the usual Aligned Vision Target File format: name, x, y, z, phi, theta, and the usual padding of 0’s at the end. This is not the same

as an ascii file exported from SA, as described in the “Manual Align…” command.

Auto Align

Perform and Auto Alignment using the file shown in the “Align”

section of the UI.

 

 

 

 

 

 

Manual Align from Exported File []

Start the Manual (mouse drive) Alignment with an ASCII file ex- ported from SA. The existing MP command, “Export ASCII Points”, can be used with all default settings, but populate ASCII File Path with the desired file path and name, the Group Name to Export, Data Delimiter of Space, Target Name Format of Target, and De- sired Coordinate System of Cartesian. Then, for this command, the [] is the ASCII File Path argument from above ([] not part

of string). NOTE: This command expects an ascii file of format “name x y z”, NOT a projector Target File as described in the “Set Auto Align File…” command. When this command is processed, the interface will create the AV Target File corresponding to the coordinates in the exported ascii file. The Target File will go to the same directory as the exported file, and will have the same name, but prepended with “AV_”.

 

Laser Projector Commands

 

Aligned Vision LaserGuide Projector

Pause

Pauses the current projection.

Resume

Resumes the current projection.

Current

Projects the current pattern (part) file.

Next

Projects the next pattern file in the current file’s folder.

Previous

Projects the previous pattern file in the current file’s folder.

Cross

Toggles the center cross (+) for aiming the projector.

Set Part Name []

Sets the active part PATH to that designated by [].

Add Patterns to Existing Part

Adds projections from SA to the current selected part file.

 

Make New Part

Makes a new part file, located in the current part file’s directory, but carrying the name of the first projection object in the projec- tion from SA.

 

LAP Laser Projector

 

Set Auto Align File []

Set the path to an alignment file, designated by [] ([] not part of string). This path will be updated in the UI, and will be used for the next Auto Alignment, whether commanded from MP, or from the Auto Align control in the UI. The file must have the usual

alignment file format: name, x, y, z, phi, theta, search radius.

Auto Align

Perform and Auto Alignment using the file shown in the “Align”

section of the UI.

Set Color Red

Sets the current projection color to red.

Set Color Green

Sets the current projection color to green.

Set Color Yellow

Sets the current projection color to Yellow.

 

LPT Projector

Pause

Pause the current projection.

Resume

Resume the current projection.

Current

Project the selected ply in the current part.

Next

Project the next ply in the current part.

Previous

Project the previous ply in the current part.

Cross

Project the center cross hair for location.

Field Of View

Project the projector’s field of view for location.

Set Part Name []

Set active part to that designated by [] ([] not part of string).

Add Plies to Projector Part

Tell the interface to add plies from SA to the current part in the database.

Add Plies to Offline Part

Tell the interface to add plies from SA to the current offline part.

 

Virtek Iris Projector

Pause

Pause the current projection.

Resume

Resume the current projection.

Current

Project the selected ply in the current part.

Next

Project the next ply in the current part.

Previous

Project the previous ply in the current part.

Cross

Project the center cross hair for location.

Field Of View

Project the projector’s field of view for location.

 

 

 

 

Select or Create Work Order []

Select Work Order if a folder is found which matches the name designated by [] ([] not part of string). Otherwise, create a new Work Order folder in the active Work Orders. The new Work Or- der will be highlighted in the interface’s Work Orders list, ready for a subsequent “Add Cal File from Exported File []” command. Also, that new Work Order will not be valid (and cannot be opened) until it contains a valid .cal file and a valid .ply file. These are requirements of Virtek’s Server Manager. NOTE: This com- mand will fail if you have not set up a valid Work Cell in Iris. See your Virtek representative for more info regarding initial setup.

 

Virtek Iris Projector

 

 

 

 

 

 

 

 

 

Add Cal File from Exported File []

Add the .cal file to the existing selected Work Order with the points from an ASCII file exported from SA. The existing MP command, “Export ASCII Points”, can be used with all default settings, but populate ASCII File Path with the desired file path and name, the Group Name to Export, Data Delimiter of Space, Target Name Format of Target, and Desired Coordinate System of Cartesian. Then, for this command, the [] is the ASCII File Path argument from above ([] not part of string). NOTE: This command expects an ascii file of format “name x y z”, NOT a projector .cal file defined in a Work Order.When this command is processed, the interface will create a .cal file corresponding to the coordinates in the exported ascii file. The .cal file will go to the current selected Work Order, and will have the same name, but will have the extension “.cal”. This commad will fail if there

is no current active Work Order. See your Virtek representative for more info regarding initial setup. Also note that until there is also a valid .ply file in the Work Order, Virtek will not allow the

Work Order to be Opened. So you will need to add a .ply BEFORE you will be able to run the initial Manual Align on the .cal file in a

new Work Order.

 

Auto Align

Perform and Auto Alignment. NOTE: This requires that you have defined and selected a valid Work Order, and that the work order has a valid .cal file in it. This alignment will be performed using

the targets defined in that file.

 

Photogrammetry System Commands

 

AICON MoveInspect

 

Set MeasureMode []

Set the mode to “Single”, “Continuous”, “Targeting”, or “Probing” in place of []. Note that there are two modes for each measure- ment type so you may need to call this command twice to switch between Single/Continuous, then Targeting/Probing.

Set Measure Mode []

Set the mode to “Probing” or “Tracking” in place of [].

 

Set Filter []

Sets the measurement action to “Coded”, “Noncoded”, “Adapter- Frames”, “AdapterPoints” followed by “True” or “False” in place of []. For example: “Set Filter AdapterFrames True”.

Connect

Connects to the server and connects SA to MoveInspect.

Stop Server

Disconnects the communication between the interface and the MoveInspect software

Measure

Initiates a Single Measurement.

Measure Continuous

Initiates a Continuous Measurement.

Stop

Stops the current measurement.

 

Snapshot

Toggles the current Adapter frame setting from updating an existing frames transform to recording separate frames with each measurement.

Set Reference []

Where [] is the Name of the desired existing dynamic reference

system. No name specified deactivates reference.

 

GSI V-STARS

Select Data: Probe

Set interface radio button data type to: Probe

Select Data: Targets

Set interface radio button data type to: Targets

Select Data: Cameras

Set interface radio button data type to: Cameras

Select Data: Cloud

Set interface radio button data type to: Cloud (Pro Spot)

 

GSI V-STARS

Select Data: Dream

Set interface radio button data type to: Dream Probe

Use VStars Target Label

TRUE or False (use the interface target name string)

Target Labels Use All []

Set Target Labels to use: replace [] with TRUE or FALSE

Target Labels CODE []

Set Target Labels to use: replace [] with TRUE or FALSE

Target Labels NUGGET []

Set Target Labels to use: replace [] with TRUE or FALSE

Target Labels TARGET []

Set Target Labels to use: replace [] with TRUE or FALSE

Target Labels _S []

Set Target Labels to use: replace [] with TRUE or FALSE

Target Labels _T []

Set Target Labels to use: replace [] with TRUE or FALSE

Target Labels SB []

Set Target Labels to use: replace [] with TRUE or FALSE

Cloud Labels Use All []

Set Cloud Labels to use: replace [] with TRUE or FALSE

Cloud Labels CODE []

Set Cloud Labels to use: replace [] with TRUE or FALSE

Cloud Labels NUGGET []

Set Cloud Labels to use: replace [] with TRUE or FALSE

Cloud Labels TARGET []

Set Cloud Labels to use: replace [] with TRUE or FALSE

Cloud Labels _S []

Set Cloud Labels to use: replace [] with TRUE or FALSE

Cloud Labels _T []

Set Cloud Labels to use: replace [] with TRUE or FALSE

Cloud Labels SB []

Set Cloud Labels to use: replace [] with TRUE or FALSE

Trigger

MMode Trigger function

Take Picture

SMode Data to SA function

Open Template

SMode operation used to open a Template file

Save Picture

SMode operation used to Save a picture

Process Data

SMode operation used to Process Data

Send Data

SMode operation used to Send Data

Close Project

SMode operation used to Close a Project

 

Metronor Portable Measurement System

Set MeasureMode Single

Set the measurement mode to discrete point measurement.

Set MeasureMode Continuous

Set the measurement mode to continuous point measurement.

Set Action Points

Sets the measurement action to send points to SA.

Set Action Updates

Sets the measurement action to send updates to SA.

Set Action Frames

Sets the measurement action to send frames to SA.

Set Action Batch

Sets the measurement action to send an LED batch of points to SA.

Set Action Unit

Sets the measurement action to send an LED target unit to SA.

Set Tip []

Sets the probe tip to [], where [] must match one of the names in the probe drop down ID list.

 

Nikon Surveyor

Measure []

Initiate measurement using the provided frame name.

6D Measure Mode On []

Turn on 6D streaming mode for the named frame.

6D Measure Mode Off []

Turn off 6D streaming mode for the named frame.

Stream 6D On []

Initiate 6D streaming for the named frame.

Stream 6D Off []

Stop 6D streaming for the named frame.

Listen On []

Starts listening to the named frame.

Listen Off []

Stops listening to the named frame.

 

Vicon Tracker

Get Objects

Gets all available Vicon objects, and populates the dropdown list. (Same as clicking the Set Objects button in the main dialog).

Set Active Object []

Set the Vicon object to measure, designated by [] ([] not part of

string).

Set Measure Mode []

Set the mode to “Discrete”, “Spatial”, or “Temporal” in place of [].

Set Measurement Time Out []

Set the time (in seconds) that the interface will wait for a Vicon object (frame) to come into view.

 

Vicon Tracker

Set Data Type []

Set type to “3D” or “6D” in place of [].

Set SA Data Type []

Set type to “Measurement” or “Update” in place of [].

Set Spatial Increment []

Sets the spatial increment for the temporal measure mode to the

amount in inches designated by [] ([] not part of string).

Set Temporal Increment []

Sets the temporal increment for the temporal measure mode to

the amount in seconds designated by [] ([] not part of string).

Get Unlabeled Markers

Gets unlabeled markers from the current active Vicon object (see

“Set Active Object []” above).

Get Labeled Markers

Gets labeled markers from the current active Vicon object (see

“Set Active Object []” above).

 

Room Scanner System Commands

 

Surphaser

Send Scan to SA []

Sends surphaser scan to SA, where [] is the full path of the ptx file, brackets are not to be included in the command string