This page describes various fields found within the motor-expert-screen. This screen is the user friendly interface for quickly changing motor parameters. Keep in mind that one must have permissions to access a hutch machine if you would like to edit. View permissions are wider (including e.g. psbuild-machines).
Please note that most fields are part of the EPICS motor record. LCLS is running a special version where some fields that are IMS specific have been added (similar for our Newport implementation).
To access a live(modifiable) motor-expert-screen, there are two ways :
- In a terminal, ssh into the appropriate hutch machine and run the command motor-expert-screen <PV name> (i.e. motor-expert-screen XPP:USR:MMS:17).
- In a terminal, ssh into the appropriate hutch machine and start a hutch python session (i.e. <hutch name>3).
- Type x.[tab] to bring up all user motors available in that session. Then x.<motor name>.screen().
Main Screen:
| EPICS PV | Field | Description | |
|---|---|---|---|
| Aux Settings | |||
| Error Codes | |||
| Re-initialize | |||
| .DESC | Description | modifiable | |
| .PORT | Digi: Port - | static | Serial Port |
| .RCMX | Run Current Max | modifiable | |
| .RC | Run Current | %, modifiable | |
| .HCMX | HC Max | modifiable | Max Holding Current |
| .HC | Holding C | modifiable | |
| .DLLM | Dial Minimum | modifiable | Dial Low Limit (EGU) |
| .DHLM | Dial Max | modifiable | Dial High Limit (EGU) |
| .LLM | User Minimum | modifiable | User Low Limit (EGU) |
| .HLM | User Max | modifiable | User High Limit (EGU) |
| .SBAS | Base Speed | modifiable | Base speed in revolution per second. This is the speed at the start of a motion. In general it is best practice to modify the velocity parameters, which are in engineering units. |
| .SMAX | Max Speed | modifiable | Maximum speed in revolution per second. This is the speed at the start of a motion. |
| .S | Speed | modifiable | Speed is the speed, in revolutions per second, at which the motor is moved after the acceleration phase of a motion is finished. |
| .VBAS | Base Velo | modifiable | Base velocity in engineering units. This is the speed at the start of a motion. |
| .VMAX | Max Velo | modifiable | Max velocity in engineering units. This is the speed at the start of a motion. |
| .VELO | Velocity | modifiable | Velocity is the speed, in engineering units per second, at which the motor is moved after the acceleration phase of a motion is finished. Must be bigger than the base velocity. |
| .ACCL | Acceleration | modifiable | The length, in seconds, of the acceleration and deceleration phases of a motor motion |
Status | Static | ||
| .RBV | Position RBV | Static | |
| Move To | Modifiable | ||
| .TWV | Move Delta | Modifiable | Tweak Step Size |
| .JOGF, .JOGR | Jogging(Forward, Reverse) | Modifiable | |
| Dial | Static/ Modifiable | ||
| .EGU/.RES | EGU/Res | EGU-Modifiable | Engineering Units/Step Size (EGU) |
| .MRES/.ERES | MRES/ERES | Modifiable | |
| .EE | Encoder | Toggle | |
| .EL | Position RBV | Toggle | |
| .MODE | Mode | Toggle | Running Mode |
| .DIR | Direction | Toggle | User Direction. |
| .OFF | Offset | Modifiable / Toggle | |
| Position | Toggle | ||
| Holding C | Static / Toggle | ||
| .SPG | Stop/Pause/Go | Toggle |
Aux Settings Screen:
"Parameter Manager Functions" is under review.
| EPICS PV | Field | ... | Description |
|---|---|---|---|
| .FREV | Full Steps/Full Steps Per Resolution | Modifiable | Specify the number of stepper motor steps required for a full rotation of the drive shaft. This value is specific to the motor. IMS Motors typically have 200. |
| .MS | Microsteps/Microstep Revolution | Modifiable | Specify the number of microsteps in between each individual motor step. This value is specific to the motor. IMS Motors typically have 256. |
| .SREV | MS/Revolution | Modifiable | Specify the number of microsteps per full rotation of the drive shaft. This value is Full Steps * Microsteps. IMS Motors typically have 51200. |
| .UREV | EGU/Rev | Modifiable | EGU's Per Revolution. |
| .HT | HC Delay | Modifiable | Holding Current Delay Time (ms |
| .EGU/.RES | EGU/Res | EGU - Modifiable | Engineering Units/Step Size (EGU) |
| MRES/ERES | Modifiable | Motor Micro Step Size/Encoder Step Size. MRES = UREV/SREV | |
| .BDST | Backlash Dist | Modifiable | The signed distance, in dial coordinates, used for backlash takeout. 1) If the motor is to move a distance greater than the magnitude of BDST, or if the motor is to move in a direction opposite to the sign of BDST, then the motor will move first to position (TARGET-BDST), at an acceleration specified by ACCL and speed VELO, and then to position TARGET, at an acceleration specified by BACC and speed BVEL. 2) If the motor is to move a distance smaller than the magnitude of BDST, and if the motor is to move in the same direction as the sign of BDST, then backlash is assumed already to have been taken out, and the motor will move to position TARGET at an acceleration specified by BACC and speed BVEL. |
| .RDBD | Retry Deadband | Modifiable | When the motor has finished a complete motion, possibly including backlash takeout, the motor record will compare its current position with the desired position. If the magnitude of the difference is greater than RDBD, the motor will try again, as if the user had requested a move from the now current position to the desired position. Only a limited number of retries will be performed (see max retries). |
| .PDBD | Slip Deadband | Modifiable | |
| .RTRY | Max Retires | Modifiable | The maximum number of times the motor record will try again to move to the desired position. When the retry limit is reached, the motor record will declare the motion finished. |
| .SBASE | Base Speed | Modifiable | |
| .SMAX | Max Speed | Modifiable | |
| .VBASE | Base Velo | Modifiable | |
| .VMAX | Max Velo | Modifiable | |
| .BS | Backlash Speed | Modifiable | Backlash speed is the speed, in revolutions per second, at which the motor is move after the acceleration phase of a backlash-takeout motion is finished. |
| .BVEL | Backlash V | modifiable | Backlash Velocity is the speed, in engineering units per second, at which the motor is move after the acceleration phase of a backlash-takeout motion is finished. |
| .HS | Home Speed | modifiable | |
| .HVEL | Home Velo | modifiable | |
| .S | Speed (Rev/s) | modifiable | |
| .VELO | Velocity | modifiable | |
| .BACC | Backlash Acc (s) | modifiable | |
| .ACCL | Acceleration (s) | modifiable | |
| .HACC | Home Acc | modifiable | |
| .S1/.S2 | S1 / S2 | modifiable | Positive Limit switch / Negative Limit Switch |
| .S3/.S4 | S3/S4 | modifiable | ? / Home Limit Switch |
| .LM | Limit Mode | modifiable | |
| .SM/.STSV | SM/Sevr | Stall Mode/Stall Severity | |
| .SF/.ERSV | SF/Error S | modifiable | Stall Factor/ |
| .EE | Encoder | modifiable | |
| .EL/.MT | EL/Setting T | modifiable | |
| .EGAG | Ext Gauge | modifiable | Use External Gauge. |
| .ERBL | Gauge PV | External Gauge Readback Link. | |
| .ESKL | Scale Factor | ||
| .HTYP | Home Type | ||
| .CMD/.RESP | Cmd/Resp | Modifiable/Static | Command To Controller/Response From Controller. |
| MCode Command Summary | |||
Overview
Content Tools