Scripting Commands

This page lists every built-in scriptable command and the corresponding function that is called.

For example Command → function().

See the Scripting guide for how to write and run scripts.

Timing and messaging

• SleepCommand (duration: float) → start_sleep() Pause script execution for the given duration in seconds.

• ShowMessageCommand (text: str, details: str | None = None) → print() Display an information dialog in the GUI. Optional details are shown in the dialog’s expandable details area.

Acquisition

• SetAcquisitionOnCommand (value: bool) → set_acquisition_on() Enable or disable acquisition and processing across all managers.

• SetAcquisitionDirOnCommand (value: bool) → set_acquisition_dir_on() Toggle writing acquisitions to disk. Combine with SetAcquisitionDirCommand to choose the directory.

• SetAcquisitionDirCommand (value: str | None) → set_acquisition_dir() Set the directory used to save acquisitions. Pass None to clear the current directory.

• SetAcquisitionModeCommand (mode: AcquisitionMode) → set_acquisition_mode() Switch the acquisition mode. Valid AcquisitionMode values: TRACK, TRACK_AND_CROP_VIDEO, TRACK_AND_FULL_VIDEO, CROP_VIDEO, FULL_VIDEO, ZLUT.

XYZ-Lock

• ExecuteXYLockCommand (now: float | None = None) → do_xy_lock() Run a single XY lock pass to re-center bead ROIs based on the latest tracked positions. now overrides the timestamp used for rate limiting and is usually left as None.

• SetXYLockOnCommand (value: bool) → set_xy_lock_on() Enable or disable continuous XY locking. Enabling resets the cutoff time so only new track data is considered.

• SetXYLockIntervalCommand (value: float) → set_xy_lock_interval() Set the delay (seconds) between XY lock iterations.

• SetXYLockMaxCommand (value: float) → set_xy_lock_max() Limit the maximum per-axis movement applied during XY lock. Values below 1 are clamped up.

• SetXYLockWindowCommand (value: int) → set_xy_lock_window() Control how many of the most recent track positions are averaged when computing the XY correction. The window is clamped to a minimum of 1 sample.

• SetZLockOnCommand (value: bool) → set_z_lock_on() Enable or disable Z locking.

• SetZLockBeadCommand (value: int) → set_z_lock_bead() Select the bead id used for Z locking.

• SetZLockTargetCommand (value: float) → set_z_lock_target() Set the target Z value for the lock controller. The value should match the units used in the active Z-LUT/profile.

• SetZLockIntervalCommand (value: float) → set_z_lock_interval() Set the cadence (seconds) between Z lock updates.

• SetZLockMaxCommand (value: float) → set_z_lock_max() Limit the maximum Z adjustment applied per update.