# Applied Scientific Instrumentation

### Products

 Custom Optics diSPIM FTP FW-1000: Filter Wheel Hardware MPPI MS2000, MFC2000, and RM2000 Controller Piezo Systems RAMM, MIM and VTS Portal Serial Commands Software TG-1000/Tiger Controller Tracking & Stabilization XY Stage Z-Drive and Focus Stage

commands:lockrg

# Command:LOCKRG (LR)

This commands function changes if the system has a Phototrack module or CRISP/SERVOLOCK_TTL module.

On CRISP systems
Tiger Syntax
MS2000 and RM2000 Syntax
Shortcut LR LR [X=cal_gain] [Y=objective_na] [Z=lock_range] [F=cal_range] [T=loop_gain] Using SS Z

The LOCKRG command allows the user to control of several system variables.

X [cal_gain]: The X parameter, cal_gain, is the gain variable normally obtained from running the calibration sequence. Although not recommended, it can be changed with this command, but it will be reset upon running the calibration sequence.

Y [objective_na]: The Y parameter sets both the cal_range focus depth (LR F) and also the in_focus_mm range (AFLIM Z) appropriately for the specified numerical aperture of the objective. The computed values can be read and/or overridden using the LR F and AFLIM Z commands respectively.

Z [lock_range]: The Z parameter controls the maximum excursion (in either direction) of the stage from the position where the Lock state was initiated before the system generates an error condition and unlocks. The value lock_range is in units of millimeters. The default value is 1.0 mm.

F [cal_range]: The F parameter controls the excursion of the stage when going through the calibration sequence. The default value for cal_range is 0.005 mm. Setting the objective's NA using LR Y will override this value.

T [loop_gain]: The T parameter controls the gain multiplier or loop gain. The default value is 4.

Note: Firmware with a compile date prior to November 2016 used the KADC command to the set loop gain. Firmware builds from November 2016 to March 2018 have both KADC and LR T commands which have an identical effect. Note: with LR T the axis character does not need to be specified.

With SERVOLOCK_TTL
Tiger Syntax

The SERVOLOCK_TTL module uses the LOCKRG Z command to set the maximum excursion. If CRISP is also present then the same setting is shared by both modules.

The Z parameter controls the maximum excursion of the stage from the position where it was initially locked before the system generates an error condition and unlocks. The value lock_range is in units of millimeters. The default value is 1.0 mm.

On Phototrack system
Shortcut LR LR [X=cal_value] [Y=xy_lock_range] [Z=z_ lock_range] [F=cal_range] Using SS Z

This command sets range limits for tracking and autofocus systems. For XY tracking systems, the excursion from the point of lock for both the X and Y axes in millimeters is set with the lock_range value using the Y parameter. If the system encounters a lock_range or focus_range limit, servo tracking is terminated.

Cal_range is the distance in millimeters of the stage movement for automatic calibration of the Tracking or Focus system, set using the F parameter. The result of such a calibration is the cal_value, which can be set explicitly with the X parameter or queried using LR X?. The tracking parameters can be displayed on the serial terminal using LR Z.

Query: LR X? Y? F? returns the current value of the parameters.

Address: 29391 W Enid Rd. Eugene, OR 97402, USA | Phone: +1 (541) 461-8181