Chapter 5. Commands

The following document contains commands. Each command provides a brief description, full command path, positional arguments, keyword arguments, switch arguments, and sub-commands.

Table of Contents

General Commands
AcceptFindPeak
ArmDevice
Ask
Count
CountAndPrint
Data
Device
Die
DisarmDevice
DvScan
Expt
File
FindPeak
FindPeakSetPos
FindUser
FixDevice
FlushStack
Help
Hold
Instrument
Interface
Kill
KillAndPause
ListStack
Log
Login
Logout
Message
Move
Pause
Print
QueueSetPersistenceMode
Rate
Register
Resume
Sequnce Howlong
Settings
Stack
State
Status
StopAll
Talk
Transfer
Update
ValidFlipper
Version
Wait
XPeek
Command Shortcuts
CT
HF
RUN
VF
Triple Axis Commands
AcceptLattice
CalcLattice
CheckFit
CorrectLattice
Comment
DefineBragg
DisableUBMode
EnableUBMode
GetNewLattice
Home
Instrument
MoveBragg
Q
Qscan
Sample
Scan
UB

General Commands

AcceptFindPeak

Brief Description

Moves the device used in the last FindPeak command to the fitted peak position.

Syntax

AcceptFindPeak

ArmDevice

Brief Description

Arms a counter device. In the case of a detector, it starts accumulating. This command is similar to count, but without a preset. Since we do not wait for the armed device, the state machine does not become BUSY.

Syntax

ArmDevice Device [Reset]

Required Parameters

Device is the counter device to arm.

Optional Parameters

Reset, if equals 1, instructs the server to reset the counter before arming.

Ask

Brief Description

Wraps another command to allow communication with handshaking.

Syntax

Ask ResponseID Command

Required Parameters

ResponseID is a unique identifier used for proper routing of the response.

Command is a valid immediate command.

Count

Brief Description

Performs count using the given counter device.

Syntax

Count Device Counts [options]

Required Parameters

Device is the device to count.

Counts is the number the device is going to count.

Options

-timeout Tim device Tim counts

sets a counter device Tim device that will timeout after a number of counts reaches Tim counts. If Tim device timeouts, counting will be interrupted and counter Device will be disarmed.

-start Start device

allows to specify the device that will be armed before counting begins. This device will be disarmed after counting is finished.

-p

instructs the server to print values of all counter devices in the system after counting.

Additional Information

See also: CountAndPrint, CT

CountAndPrint

Brief Description

Performs count using the given counter device followed by printing of values of all counters.

Syntax

CountAndPrint Device Counts [options]

Required Parameters

Device is the device to count.

Counts is the number the device is going to count.

Options

-timeout Tim device Tim counts

sets a counter device Tim device that will timeout after a number of counts reaches Tim counts. If Tim device timeouts, counting will be interrupted and counter Device will be disarmed.

-start Start device

allows to specify the device that will be armed before counting begins. This device will be disarmed after counting is finished.

Additional Information

See also: Count, CT

Data

Brief Description

Writes a single data point to the current data file. This information includes current positions of all devices and values of counters.

Syntax

Data

Device

The following commands can be used to do manipulations on devices. Device Action
Device Add
Device Arm
Device Busy
Device Components
Device Configure
Device Destroy
Device Disarm
Device Enable
Device Fix
Device Free
Device GetDirection
Device GetHard
Device GetLimits
Device GetOverhead
Device GetParam
Device GetParent
Device GetPreset
Device GetRaw
Device GetSwitch
Device GetTolerance
Device GetZero
Device MoveHard
Device Preset
Device Read
Device Reset
Device Roi
Device Set
Device SetHard
Device SetLowerLimit
Device SetOverhead
Device SetParam
Device SetProperty
Device SetRaw
Device SetTolerance
Device SetUpperLimit
Device SetZero

Device Action

Brief Description

Calls the specified DALI action on a device.

Syntax

Device Action Device Command

Required Parameters

Device is the name of the device.

Command is the action to perform on a device.

Device Add

Brief Description

Adds a DALI representation of a device. When adding an Alias, the parent device must also be supplied.

Syntax

Device Add Type Device [options]

Required Parameters

Type is the type of device to add.

Device is a name of device to add.

Options

-d

Sets the dummy flag for the device. If set, the device will be a dummy.

-b BusyCheck

Determines whether the device is read when busy for status updates. Note that the system will still only check the hardware at most once in BusyUpdate seconds.

-u BusyUpdate

Sets the busy polling rate for the device.

-s SilentUpdate

Sets the polling rate for the device when idle. Note that only special devices such as environment controllers will be polled when idle.

-f

Sets the tofile attribute on the device. If toFile is set, some output formats, including those used for triple axis instruments, will include the device in the per-point data.

Examples

Device Add Alias Temp Lakeshore331

Adds an alias Temp that can be used to refer to Lakeshore331 device.

Device Arm

Brief Description

Arms the device. In the case of a counter, it would start counting. In the case of a detector, it would start accumulating. The state machine does not become BUSY.

Syntax

Device Arm Device

Required Parameters

Device is a name of the device.

Device Busy

Brief Description

Checks whether a specified device is busy.

Syntax

Device Busy Device

Required Parameters

Device is a name of the device.

Device Components

Brief Description

Pre-calculates positions of devices which will move if a given device moves to a certain position.

Syntax

Device Components Device Position

Required Parameters

Device is the device which will move.

Position is the destination to which the device will move.

Examples

Device Components GuideTable 1

Describes positions of all guides if GuideTable moves to position 1.

Device Configure

Brief Description

Configures a device.

Syntax

Device Configure Device

Required Parameters

Device is a name of the device.

Device Destroy

Brief Description

Destroys the ICE representation of the device.

Syntax

Device Destroy Device

Required Parameters

Device is a name of the device.

Device Disarm

Brief Description

Disarms a device.

Syntax

Device Disarm Device

Required Parameters

Device is a name of the device.

Device Enable

Brief Description

Enables a device.

Syntax

Device Enable Device

Required Parameters

Device is the name of the device.

Device Fix

Brief Description

Fixes a device. When a device is fixed, it cannot be moved during a scan. When not in a scan, the fixed device can still be moved.

Syntax

Device Fix Device

Required Parameters

Device is a name of the device.

Additional Information

See also: FIX, Device Free.

Execution behavior: Queued.

Device Free

Brief Description

Frees a fixed device.

Syntax

Device Free Device

Required Parameters

Device is a name of the device.

Additional Information

See also: REL, Device Fix.

Execution behavior: Queued.

Device GetDirection

Brief Description

Returns the direction (parity) of a given device.

Syntax

Device GetDirection Device

Required Parameters

Device is a name of the device.

Device GetHard

Brief Description

Returns the hardware position of the motor.

Syntax

Device GetHard Device

Required Parameters

Device is a name of the device.

Device GetLimits

Brief Description

Returns lower and upper software limits of a device.

Syntax

Device GetLimits Device

Required Parameters

Device is a name of the device.

Device GetOverhead

Brief Description

Returns the value of the time overhead, in seconds, constant currently set for the device. If the device is an alias, the overhead for the device which it aliases will be returned.

Syntax

Device GetOverhead Device

Required Parameters

Device is a name of the device to get the overhead for.

Device GetParam

Brief Description

Returns the value of an ICE parameter for the specified device.

Syntax

Device GetParam Device Parameter

Required Parameters

Device is a name of the device to get the parameter from.

Parameter is the parameter name to receive.

Device GetParent

Brief Description

Returns the name of the parent device of an alias.

Syntax

Device GetParent Device

Required Parameters

Device is the device to get its parent.

Device GetPreset

Brief Description

Returns the preset of a device.

Syntax

Device GetPreset Device

Required Parameters

Device is a name of the device.

Device GetRaw

Brief Description

Returns the raw position of a device.

Syntax

Device GetRaw Device Position

Required Parameters

Device is a name of the device.

Position is the value of the device.

Device GetSwitch

Brief Description

Returns the available labeled position of a switch-type device.

Syntax

Device GetSwitch Device

Required Parameters

Device is a name of the device.

Device GetTolerance

Brief Description

Returns the tolerance of a given device.

Syntax

Device GetTolerance Device

Required Parameters

Device is a device to lookup for the tolerance.

Device GetZero

Brief Description

Returns the zero of a device.

Syntax

Device GetZero Device

Required Parameters

Device is a name of the device.

Device MoveHard

Brief Description

Moves a device by specifying the hardware destination.

Syntax

Device MoveHard Device Position

Required Parameters

Device is a name of the device.

Position is a hardware position that the device is moved to.

Device Preset

Brief Description

Presets the specified counter.

Syntax

Device Preset Device Value Channel

Required Parameters

Device is the name of the device.

Value is the value to set the counter to.

Channel is the channel of the device.

Device Read

Brief Description

Reads a specified device.

Syntax

Device Read Device

Required Parameters

Device is a name of the device.

Device Reset

Brief Description

Resets a specified counter.

Syntax

Device Reset Device

Required Parameters

Device is a name of the device.

Device Roi

Brief Description

Creates a region of interest with a specified name for a given device.

Syntax

Device Roi Roiname Device X1 X2 Y1 Y2

Required Parameters

Roiname is a name of the roi.

Device is a name of the device.

X1 is the value of x1.

X2 is the value of x2.

Y1 is the value of y1.

Y2 is the value of y2.

Device Set

Brief Description

Adjusts zero of a given device so that its current software position is equal to a specified value.

Syntax

Device Set Device Position

Required Parameters

Device is a name of the device.

Position is a value to set the software value to.

Device SetHard

Brief Description

For a given device sets the hardware to a given value. The zero does not change and the software position will change.

Syntax

Device SetHard Device Position

Required Parameters

Device is a name of the device.

Position is a value to set the hardware position to.

Device SetLowerLimit

Brief Description

Changes the lower software limit of a device.

Syntax

Device SetLowerLimit Device Value

Required Parameters

Device is a name of the device.

Value is a value that the lower limit of a selected device will be reset to.

Device SetOverhead

Brief Description

Sets the time overhead constant, in seconds, for a device. The time overhead constant is used to calculate how long scans involving the device will run. If the device is an alias, the overhead for the device which it aliases will be returned.

Syntax

Device SetOverhead Device Overhead

Required Parameters

Device is a name of the device for which the overhead will be set.

Overhead is time constant, in seconds, to set for the overhead for device.

Device SetParam

Brief Description

Sets the value of a given device parameter.

Syntax

Device SetParam Device Parameter

Required Parameters

Device is a name of the device for which the parameter will be set.

Parameter is a name of the parameter to be set.

Device SetProperty

Brief Description

Sets the specified DALI property of a device.

Syntax

Device SetProperty Device Property Value

Required Parameters

Device is a name of the device.

Property is a name of the property of the device.

Value is a value of the device property to set.

Device SetRaw

Brief Description

Sets the raw position of a device.

Syntax

Device SetRaw Device Value

Required Parameters

Device is a name of the device.

Value is a value of the device.

Device SetTolerance

Brief Description

Sets the tolerance of a given device.

Syntax

Device SetTolerance Device Value

Required Parameters

Device is a name of the device to set the tolerance.

Value is a value to set the tolerance to.

Device SetUpperLimit

Brief Description

Changes the upper software limit of a device.

Syntax

Device SetUpperLimit Device Value

Required Parameters

Device is a name of the device.

Value is a value that the upper limit of a selected device will be reset to.

Device SetZero

Brief Description

Changes zero point of a given device.

Syntax

Device SetZero Device Value

Required Parameters

Device is a name of the device.

Value is a value that zero point of a selected device will be reset to.

Die

Brief Description

This command causes the ICE server to terminate immediately.

Syntax

Die

DisarmDevice

Brief Description

Disarms a device.

Syntax

DisarmDevice Device [Reset]

Required Parameters

Device is the device to disarm.

Optional Parameters

Reset, if equals 1, instructs the server to reset the device after disarming.

DvScan

Brief Description

Performs an increment scan assuming that we count against Monitor and measure the Detector counts.

Syntax

DvScan Device Start range End range Monitor Step

Required Parameters

Device is a device selected for the scan.

Start range is the beginning of the interval in which Device will be moved during the scan.

End range is the end of the interval in which Device will be moved during the scan.

Monitor is the number of monitor counts until which data is gathered at every scan point.

Step is the amount by which Device is to be changed at each scan point.

Expt

The following commands can be used to view and modify experiment properties.
Expt Get
Expt Info
Expt Set
Expt SetComment
Expt SetDetails
Expt SetName
Expt SetParticipants

Expt Get

Brief Description

Returns the current experiment ID.

Syntax

Expt Get

Expt Info

Brief Description

Returns a message with the experiment description including its ID, name, participants, details, and comments.

Syntax

Expt Info

Expt Set

Brief Description

Changes the experiment ID and clears the name, participants, details, comments, and other experiment-related properties of the instrument such as user directory.

Syntax

Expt Set ID

Required Parameters

ID is the unique identifier used to reference the experiment.

Expt SetComment

Brief Description

Sets any additional comments for the current experiment.

Syntax

Expt SetComment Comment

Required Parameters

Comment is any additional information about the experiment. This value accepts a multi-line field if necessary. Use double quotes "" to delimit a multi-line comment.

Expt SetDetails

Brief Description

Changes any details about the experiment.

Syntax

Expt SetDetails Details

Required Parameters

Details is any specific information about the experiment. This value accepts a multi-line field if necessary. Use double quotes "" to delimit a multi-line details.

Expt SetName

Brief Description

Sets a name of the current experiment.

Syntax

Expt SetName Name

Required Parameters

Name is a name given to the current experiment.

Expt SetParticipants

Brief Description

Sets the list of participants for the current experiment.

Syntax

Expt SetParticipants Participants

Required Parameters

Participants is a list of names of the people participating in the current experiment. The names of participants should be separated with spaces.

File

The following commands can be used to manipulate files.
File Copy
File Delete
File Dir
File Get
File Move

File Copy

Brief Description

Copies a file.

Syntax

File Copy Source Destination

Required Parameters

Source is a source file to copy.

Destination is a destination file to copy to.

Examples

File Copy EXPT:scanlist.txt USER:scanlist.txt

Copies a file scanlist.txt from the experiment directory EXPT to the user directory USER.

File Delete

Brief Description

Deletes a file with a given name.

Syntax

File Delete Filename

Required Parameters

Filename is a name (including special directory) of the file to delete.

Examples

File Delete EXPT:scanlist.txt

Deletes a file scanlist.txt from the experiment directory EXPT.

File Dir

Brief Description

Returns a list of the files in a given directory.

Syntax

File Dir Path

Required Parameters

Path is a name of the special directory where files are located.

Examples

File Dir EXPT:

Retreives a list of files in the experiment directory EXPT.

File Get

Brief Description

Retrieves the content of a given file.

Syntax

File Get Filename

Required Parameters

Filename is a name ((including special directory)) of the file which content will be retrieved.

Examples

File Get EXPT:scanlist.txt

Returns the content of a file scanlist.txt located in the experiment directory EXPT.

File Move

Brief Description

Moves a file with a given name. The source file will be deleted.

Syntax

File Move Source Destination

Required Parameters

Source is the source file to move.

Destination is the destination to move to.

Examples

File Move EXPT:scanlist.txt USER:scanlist.txt

Moves a file scanlist.txt from the experiment directory EXPT to the user directory USER.

FindPeak

Brief Description

Scans a device over a given range to find device position at which maximum intensity is reached. A number of options can be specified to facilitate curve fitting to data and device positioning at the center of the fit.

Syntax

FindPeak Device Range Step size Counter Preset Monitor [options]

Required Parameters

Device is a device selected for the scan.

Range is the device range centered at current device position. Option -start allows to specify a range using two values Start range and Stop range corresponding to the beginning and end of the range, respectively.

Step size is the length between two adjacent device positions in the scan. The number of points in the scan will be set to Range/Step size.

Counter allows to select Time or Monitor as a device for which Preset counts are measured.

Preset is a duration in seconds (if Time is a counter) or a number of counts (if Monitor is a counter) till which count is performed at every device position.

Monitor allows to select Monitor or Detector as a device which values are used to determine the fit.

Options

-start

allows the range to be supplied using two numeric values Start range and Stop range, for the start and the end points of the interval.

-lattice Correction

Deprecated replaced by CorrectLattice Calculates d-spacing of the sample as a product of fit result and a given correction. If correction is not specified, 1 is used by default. Use command AcceptLattice to redefine sample lattice parameters using calculated value.

-accept

instructs the server to automatically drive the selected device to the position where maximum intensity is reached, after the scan is completed.

-t Tolerance

specifies tolerance of the target device position. This option can be given only with -accept option.

-f Flipper

specifies a valid flipper.

-off FlipperValue

specifies flipper off value.

-func FunType

specifies the function type that will be fitted to the scan data. Possible functions: Gauss, GaussLinear, GaussQuadratic, POLY, POLY0, POLY1, POLY2, POLY3 (0-, 1-, 2-, 3-degree polynomial). By default, Gaussian curve is fitted.

-bragg BraggMotor

specifies a bragg motor that moves together with the device [Device] with a step size half of that of [Step size].

-hkl h k l

specifies an hkl position to calculate the peak around. With this option, instead of using the current instrument state as a starting point to rock the specified motor, the system uses the instrument state specified by the hkl coordinates specified.

-include Params

is a column-separated list of additional scan parameters and values.

Examples

FindPeak A3 5 0.1 Time 100 Detector -accept

Performs a scan of angle A3 around its current position. Counts will be measured for 5 degrees in both directions with a step size of 0.1. At each point it will count for 100 seconds and use detector counts to determine the fit. The -accept option causes the instrument to drive A3 to the fitted peak position after the scan is finished.

FindPeak A4 5 0.1 Time 100 Detector -bragg A3 -lattice

Performs a theta-2theta scan and calculates d-spacing using the peak position.

Troubleshooting

device Device not found

Selected device is not a part of current instrument configuration. Check the spelling of device name. Use Device Add command to add device to the instrument.

Additional Information

See also: FP, AP.

Execution behavior: Queued.

FindPeakSetPos

Brief Description

For a device used in last FindPeak command, changes zero so that current software position of that device is equal to the fitted peak position.

Syntax

FindPeakSetPos

FindUser

Brief Description

Returns the ID of the user with a given user name.

Syntax

FindUser Username

Required Parameters

Username is a name of the user whose ID is searched for.

FixDevice

Brief Description

Fixes or frees a device. When a device is fixed, it cannot be moved as a part of scan. Note that the fixed device can still be moved using move command.

Syntax

FixDevice Device Flag

Required Parameters

Device is the device to be fixed/freed.

If Flag is 1 device will be fixed. If Flag is 0, device will be freed.

FlushStack

Brief Description

Removes all commands from the stack. Note that execution of the current command is not affected.

Syntax

FlushStack

Help

Brief Description

Display help information for server commands.

Syntax

Help [Command]

Optional Parameters

Command is a command name for which help information will be displayed. If no command is given, a list of commands, grouped by type, will be displayed.

Hold

Brief Description

Causes the server to wait a given number of seconds before proceeding to the next command.

Syntax

Hold Time

Required Parameters

Time is a number of seconds the system will wait before proceeding to the next command in the queue.

Additional Information

See also: Wait, Pause.

Execution behavior: Queued.

Instrument

The following commands can be used to view and modify instrument state.
Instrument AddGroupEntry
Instrument DelGroups
Instrument DelGroupEntry
Instrument GetAliases
Instrument GetCounters
Instrument GetEnvs
Instrument GetGroups
Instrument Getmotors
Instrument GetVirtuals
Instrument ListDevices
Instrument ListEnvs
Instrument ListInterfaces
Instrument Print
Instrument ReadZeros
Instrument SetGroup
Instrument Status
Instrument WriteZeros

Instrument AddGroupEntry

Brief Description

Adds a specified device to a specific group at a given position. If position is not given, the device will be appended to the end of the group.

Syntax

Instrument AddGroupEntry Device Group [Position]

Required Parameters

Device is a name of the device to be added to the device group.

Group is a name of the group used to define the list of devices.

Optional Parameters

Position is the location to place the device in the device list.

Instrument DelGroups

Brief Description

Deletes the specified group of devices. The devices will not be destroyed.

Syntax

Instrument DelGroups

Instrument DelGroupEntry

Brief Description

Removes a specified device from a given group.

Syntax

Instrument DelGroupEntry Device Group

Required Parameters

Device is a name of the device to be removed from a group.

Group is a group name used to define the list of devices.

Instrument GetAliases

Brief Description

Returns a list of all aliases defined on the instrument.

Syntax

Instrument GetAliases

Instrument GetCounters

Brief Description

Returns a list of all counters available on the instrumnet.

Syntax

Instrument GetCounters

Instrument GetEnvs

Brief Description

Returns a list of all environment controllers on the instrument.

Syntax

Instrument GetEnvs

Instrument GetGroups

Brief Description

Returns a list of all groups of devices defined on the instrument.

Syntax

Instrument GetGroups

Instrument Getmotors

Brief Description

Returns a list of all motors available on the instrument.

Syntax

Instrument Getmotors

Instrument GetVirtuals

Brief Description

Returns a list of all virtual devices on the instrument.

Syntax

Instrument GetVirtuals

Instrument ListDevices

Brief Description

Returns a list of all available device drivers for this instrument.

Syntax

Instrument ListDevices

Instrument ListEnvs

Brief Description

Returns a list of all available environment controller drivers for this instrument.

Syntax

Instrument ListEnvs

Instrument ListInterfaces

Brief Description

Returns a list of all available interface drivers for the instrument.

Syntax

Instrument ListInterfaces

Instrument ReadZeros

Brief Description

Reads the device zeros and limits from a file and applies these values to all devices on the instrument.

Syntax

Instrument ReadZeros Filename

Required Parameters

Filename is a name of the valid file containing the device zeros.

Additional Information

See also: Instrument WriteZeros

Execution behavior: Immediate.

Instrument SetGroup

Brief Description

Defines a new group of devices.

Syntax

Instrument SetGroup Group Devices

Required Parameters

Group is a name of the group.

Devices is a space-separated list of devices to be added to the group name.

Instrument WriteZeros

Brief Description

Saves zeros and software limits to a file that can later be used to re-align the instrument.

Syntax

Instrument WriteZeros Filename

Required Parameters

Filename is the file name to write to.

Additional Information

See also: Instrument ReadZeros

Execution behavior: Immediate.

Interface

Brief Description

Open or close an interface.

Syntax

Interface [Open | Close] Tag

Required Parameters

Tag is an interface ID.

Additional Information

See also: Talk.

Execution behavior: Queued.

Kill

Brief Description

Kills the execution of the current command.

Syntax

Kill

Additional Information

See also: KillAndPause, StopAll.

Execution behavior: Immediate.

KillAndPause

Brief Description

Kills the current command and immediately pauses.

Syntax

KillAndPause

Additional Information

See also: Kill, Pause.

Execution behavior: Immediate.

ListStack

Brief Description

Returns a list of the commands presently in the command queue.

Syntax

ListStack

Log

Brief Description

Turns logging on or off.

Syntax

Log [On | Off]

Login

Brief Description

Logs the user in as Administrator.

Syntax

Login Admin Password

Required Parameters

Password is the administrator password for the server.

Logout

Brief Description

Logs the user out as Administrator.

Syntax

Logout Admin

Message

Brief Description

Sends a console message to a given user.

Syntax

Message Recipient Message

Required Parameters

Recipient is a tag used to identify the recipient of the message.

Message is the content of the message.

Move

Brief Description

Moves a given device to a specified position. Several devices can be moved in parallel.

Syntax

Move Device Position [options]

Move Device1 Position1 Device2 Position2 ... [options]

Required Parameters

Device is a name of a device to be moved.

Position is a value that the selected device will be moved to.

Options

-relative

moves Device by Position from its current position.

Examples

Move A4 56.5

Drives angle A4 to 56.5 degrees. Units of destination are device-specific.

Move A4 2.5 -relative

Drives angle A4 2.5 degrees in a positive direction from its current position.

Move Ei 14.7 Ef 14.8

Moves incident energy to 14.7 meV and final energy to 14.8 meV.

Move HKL [1,0,0]

Drives angles A3 and A4 to Q-vector (1, 0, 0). Note that lattice and orientation parameters and energy transfer are determined by previously executed Sample, Move and Scan commands.

Move Temp 150

Changes temperature to 150 degrees (Kelvin or Celcius depending on the settings of the temperature controller).

Additional Information

See also: MoveBragg, D, DE.

Execution behavior: Queued.

Pause

Brief Description

Puts the system in the PAUSE state in which currently armed counters will be paused and the user signal to resume will be required to proceed to the next point in the scan or the next command.

Syntax

Pause

Additional Information

See also: Resume.

Execution behavior: Immediate.

Print

Brief Description

Outputs specified properties of devices present at the system.

Syntax

Print Device

Print [Angles | SoftAngles | HardAngles | Limits | Zeros | Fixed | Counters]

Required Parameters

Device is a name of the device to be printed.

Angles prints software and hardware positions of all devices.

SoftAngles prints software positions of all devices.

HardAngles prints hardware positions of all devices.

Limits prints limits of all devices.

Zeros prints zero points of all devices.

Counters prints values of all counter devices.

QueueSetPersistenceMode

Brief Description

Queues a command to change the magnet's persistence mode.

Syntax

QueueSetPersistenceMode Flag

Required Parameters

Flag turns persistence mode off (if 0) or on (if 1).

Rate

Brief Description

Measures the monitor rate. ICE will store the measured monitor rate and the value of an instrument-specific device (A2 on triple-axes) at the time of the measurement. This command must be executed before estimating the duration of scans or sequences.

Syntax

Rate [[Monitor Timer] Duration].

Optional Parameters

Monitor is the monitor device to be measured.

Timer is the timer device to be counted against.

Duration is a time count in seconds (defaults to 5 seconds).

Register

Brief Description

Registers a user and stores all relevant information that is later used to determine user permissions.

Syntax

Register Username Hostname Terminal PID

Required Parameters

Username is a name of the user

Hostname is a name of the computer from which user is connecting

Terminal is a terminal id

PID is a process id

Resume

Brief Description

Puts the system in the state it was in before being paused.

Syntax

Resume

Additional Information

See also: Pause.

Execution behavior: Immediate.

Sequnce Howlong

Brief Description

Estimates the time it will take to run a sequence file. Four command types are assessed for time: Scans, Moves, Counts, and Waits. Scans are assessed using the scan howlong command. Moves are assessed using the overhead for the devices being moved or the overhead provided with the -o option (see below).

The Rate command should be run before running Sequence Howlong if a monitor count is being assessed. If it has not been run when Scan Howlong is run, it will be run automatically before a result is given, unless a scan is in progress, in which case the command will fail.

Syntax

Sequence Howlong Filename [options]

Required Parameters

Filename is the name of a sequence file in the experiment directory. The filename should contain the full extension .seq.txt.

Options

-s

indicates that the results should be returned in seconds (the default is hours).

-o MovementOverhead

tells ICE to use the specified overhead as a minimum overhead per point for instrument movement. The overhead is in seconds. If a device is set with a larger overhead, then that overhead will be used.

Settings

The following commands can be used to view and modify user settings.
Settings GetDataDir
Settings Print
Settings SetDataDir
Settings SetStatusFreq
Settings SetVerbose

Settings GetDataDir

Brief Description

Returns the data directory.

Syntax

Settings GetDataDir

Settings Print

Brief Description

Prints the current user settings.

Syntax

Settings Print

Settings SetDataDir

Brief Description

Sets the data directory to the directory specified.

Syntax

Settings SetDataDir Directory

Required Parameters

Directory is a directory to set the data directory to.

Settings SetStatusFreq

Brief Description

Sets the frequency of the status broadcasts.

Syntax

Settings SetStatusFreq Value

Required Parameters

Value is the number of times the status broadcasts.

Settings SetVerbose

Brief Description

Sets the verbose value.

Syntax

Settings SetVerbose Value

Required Parameters

Value is a number to set the verbose to.

Stack

The following commands can be used to do manipulations on command queue.
Stack AppendFile
Stack DeleteID
Stack DeleteIndex
Stack DryRun
Stack Flush
Stack Howlong
Stack Insert
Stack InsertIndex
Stack Move

Stack AppendFile

Brief Description

Appends the content of a file to the command queue.

Syntax

Stack AppendFile Filename

Required Parameters

Filename is a name of the file (including special directory) content of which will be appended to the command queue.

Examples

Stack AppendFile EXPT:mySequence.seq.txt

Appends the content of the sequence file mySequence.seq.txt in the experiment directory EXPT to the command queue.

Stack DeleteID

Brief Description

Deletes the command with a given identifier from the command queue.

Syntax

Stack DeleteID ID

Required Parameters

ID is an identifier of the command to be deleted.

Stack DeleteIndex

Brief Description

Deletes the command with a given index from the command queue.

This command is deprecated. Use Stack DeleteID instead.

Syntax

Stack DeteleIndex Index

Required Parameters

Index is the index of the command to be deleted.

Stack DryRun

Brief Description

Dry runs the content of a given file.

Syntax

Stack DryRun Filename

Required Parameters

Filename is a name of the file (including special directory) for which content the dry run will be performed.

Examples

Stack DryRun EXPT:mySequence.seq.txt

Dry runs the content of the file mySequence.seq.txt located in the experiment directory EXPT.

Stack Flush

Brief Description

Clear all commands from the command queue. Note that this will not affect the currently executing command.

Syntax

Stack Flush

Stack HowLong

Brief Description

Estimates the time it will take to run the commands in the command queue. Four command types are assessed for time: Scans, Moves, Counts, and Waits. Scans are assessed using the scan howlong command. Moves are assessed using the overhead for the devices being moved or the overhead provided with the -o option (see below).

Syntax

Stack Howlong [options]

Options

-s

allows to retrieve stack execution time in seconds.

-i ID

allows retrieve execution time for the command with a given ID.

Stack Insert

Brief Description

Inserts a command in the command queue so that it will be executed just before the command with a specified ID.

Syntax

Stack Insert ID Command [options]

Required Parameters

ID is the identifier of the command before which the new command should be inserted.

Command is a command which is to be inserted.

Options

-a

allows to insert a command after a specified index.

Stack InsertIndex

Brief Description

Inserts a given command at a specified index in the command queue.

This command is deprecated. Use Stack Insert instead.

Syntax

Stack InsertIndex Index Command

Required Parameters

Index is a location in the command queue where the command should be inserted.

Command is a command to be inserted into the queue.

Stack Move

Brief Description

Re-arranges command queue by moving a set of commands to be executed just before the command with a specified ID.

Syntax

Stack Move SourceID1, SourceID2, ... DestID

Required Parameters

SourceID1, SourceID2, ... is a comma-separated list of command identifiers that specifies to commands to move within the stack

DestID is a command ID after which the moved commands will be placed.

State

Brief Description

Returns the state of the instrument computer. The state BUSY indicates that the instrument is moving or counting, PAUSE indicates that the instrument was paused by the user, and IDLE indicates that the instrument is awaiting further instructions from the user.

Syntax

State

Status

Brief Description

Returns the status of the instrument which includes positions of all devices.

Syntax

Status

StopAll

Brief Description

Kills the current command, stops all devices and clears the command queue.

Syntax

StopAll

Additional Information

See also: Kill, Pause.

Execution behavior: Immediate.

Talk

Brief Description

Writes a given message to a specified interface.

Syntax

Talk Tag Message

Required Parameters

Tag is an interface ID.

Message is a text string to be written.

Additional Information

See also: Interface.

Execution behavior: Queued.

Transfer

Brief Description

Transfers a given sequence file to the server.

Syntax

Transfer Filename Content

Required Parameters

Filename is a file name that includes any special directory path. Filename containing spaces should be enclosed in double quotes ("").

Content is the content of the file enclosed in double quotes ("").

Examples

Transfer "test.seq.txt" "Move Temp 100
Scan Run 1
Move Temp 120
Scan Run 1"

Saves a sequence of temperature movement and scanning in a file named test.seq.txt.

Update

Brief Description

Updates the hardware state of one or all devices on the instrument.

Syntax

Update [Device]

Optional Parameters

Device is a name of the device that will be updated. If device name is omitted, all devices are updated.

ValidFlipper

Brief Description

Indicates whether flipper can be set for a specified device. In current implementation, ValidFlipper is true only for Ei and Ef devices.

Syntax

ValidFlipper Device

Required Parameters

Device is a name of the device for which the check is performed.

Version

Brief Description

Prints version information for the ICE server currently running. This information includes Subversion version number, last modification time, and the user who committed the last modification.

Syntax

Version [Files | Branch | Revision | Id | Codeversion]

Wait

Brief Description

Causes the server to wait a given number of seconds before proceeding to the next command.

Syntax

Wait Time

Required Parameters

Time is a number of seconds the system will wait before proceeding to the next command in the queue.

Additional Information

See also: Hold, Pause.

Execution behavior: Queued.

XPeek

Brief Description

Sends information about the current scan to XPeek server.

Syntax

XPeek