The Pseudo Motor Entry

A pseudo motor is device that can be moved like a regular motor, but does not necessarily control a single real motor. The pseudo motor may actually move several motors in combination, or perform additional functions and checks while moving the motor. A pseudo motor controlled by the scripting engine is called a scripted device.

An entry for a Pseudo Motor definition should be in the following generic format:

Line 1:motorName
Line 2:2
Line 3:responsibleDHS externalMotorName
Line 4:position upperLimit lowerLimit lowerLimitOn upperLimitOn motorLockOn circleMode units
Line 5:0
Line 6:0
Line 7:passiveOk remoteOk localOk inHutchOk closedHutchOk
Line 8:passiveOk remoteOk localOk inHutchOk closedHutchOk

• The responsibleDHS must be the name of a DHS defined in separate entry as discussed in The DHS definition.

• The externalMotorName parameter can be the same name as the motorName, but is provided here for mapping the motor name to a DHS(s) that names the motor differently. This is common with the motors controlled by the ICS system.

  This parameter can also be used by the scripting engine to locate a specialized script for the motor. For example, using standardVirtualMotor would indicate to the self dhs that it should use the specialized standardVirtualMotor template when working with this motor.

• The position parameter is the current position of the motor.

• The upperLimit and lowerLimit parameters are the software limits for the motor. The limits are only used if the corresponding upperLimitOn and lowerLimitOn flags are enabled.

• The lowerLimitOn parameter can be 0 (for no software limit) or 1 (to enable the lowerLimit parameter).

• The upperLimitOn parameter can be 0 (for no software limit) or 1 (to enable the upperLimit parameter).

• The motorLockOn parameter can be 0 (which allows the motor to move) or 1 (prevents the motor from moving.)

• The circleMode should be always be 0. See bug 39.

• The two permissions lines (lines 7 and 8) are discussed in The Device Permission Bits.

• units is

   mm|deg|eV|counts