Page tree

Beamline Shutters and Interlock

Close Beamline Shutter

shclose
  • Closes the beamline shutter.
  • Syntax: shclose <area>
    • Optional Parameters:
      • <area> == The area of which you want to close the shutter. Available areas are: OH, EH1, and EH2.

Since <area> is an optional parameter one does not have to provide the area, the software will figure this one out by itself.

Please be patient. The shutters are slow devices. Depending on the state of other shutters it might take a while (10 seconds) until you get a confirmation that the shutter is actually closed.

Open Beamline Shutter

shopen
  • Opens the beamline shutter when allowed.
  • Syntax: shopen <area>
    • Optional Parameters:
      • <area> == The area of which you want to open the shutter. Available areas are: OH, EH1, and EH2.

Since <area> is an optional parameter one does not have to provide the area, the software will figure this one out by itself.

Please be patient. The shutters are slow devices. Depending on the state of other shutters it might take a while (10 seconds) until you get a confirmation that the shutter is open.

Beamline Shutter Status

shstate
  • Returns the beamline shutter state.
  • Syntax: shstate <area>
    • Optional Parameters:
      • <area> == The area of which you want to close the shutter. Available areas are: OH, EH1, and EH2.

Since <area> is an optional parameter one does not have to provide the area, the software will figure this one out by itself.

Open Experimental Hutch

openhutch
  • Opens the experimental hutch.
  • Syntax: openhutch <area>
    • Optional Parameters:
      • <area> == The area which you want to open. Available areas are: OH, EH1, and EH2.

Since <area> is an optional parameter one does not have to provide the area, the software will figure this one out by itself.

Shutters will be closes automatically if needed.

Please be patient. The shutters are slow devices. Depending on the state of other shutters it might take a while (10 seconds) until you get a confirmation that the interlock is broken.

Motor Stages

Current Position and Limits

wm
  • Prints the current position and the higher and lower limit of the stage
  • Syntax: wm <stage_name>
    • <stage_name> == Name of the stage to move.
  • Examples:
    • Input
      wm samy
      Output
      	               samy
      User               
       High               2.0
       Current            0.0
       Low                0.0

      The current position is 0.0. The upper limit is 2.0 and the lower limit is 0.0.

    • Get the information on multiple stages at once.

      Input
      wm samx samy samz
      Output
                    exp_dmy01      exp_dmy02      exp_dmy03
      User                                     
       High               2.0           10.0            1.0
       Current            0.0           0.35           -0.1
       Low                0.0            1.0           -1.0

Absolute Movements

mv
  • Moves a stage to an absolute coordinate
  • Syntax: mv <stage_name> <coordinate>
    • <stage_name> == Name of the stage to move.
    • <coordinate> == Coordinate where to move to.
  • Examples:
    • Move "samy" to 10

      mv samy 10 
    • Move "samy" to 10 and "samz" to 4

      mv samy 10 samz 4
umv
  • Moves a stage to an absolute coordinate and prints the current location to the terminal
  • Syntax: umv <stage_name> <coordinate>
    • <stage_name> == Name of the stage to move.
    • <coordinate> == Coordinate where to move to.
  • Examples:
    • Move "samy" to 10

      umv samy 10 
    • Move "samy" to 10 and "samz" to 4

      umv samy 10 samz 4

Relative Movements

mvr
  • Moves a stage to a relative coordinate
  • Syntax: mvr <stage_name> <coordinate>
    • <stage_name> == Name of the stage to move.
    • <coordinate> == Coordinate where to move to.
  • Examples:
    • Move "samy" by 10

      mvr samy 10 
    • Move "samy" by 10 and "samz" by 4

      mvr samy 10 samz 4
umvr
  • Moves a stage to a relative coordinate and prints the current location to the terminal
  • Syntax: umvr <stage_name> <coordinate>
    • <stage_name> == Name of the stage to move.
    • <coordinate> == Coordinate where to move to.
  • Examples:
    • Move "samy" by 10

      umvr samy 10 
    • Move "samy" by 10 and "samz" by 4

      umvr samy 10 samz 4
tw
  • Tweaks the position of a stage by the give step size. The stage will not move after the first enter but will enter an interactive mode. In interactive mode:
    • Each time one presses "enter", the stage moves by the selective relative coordinate.
    • One can change the direction by typing "+" or "-"
    • One can change the relative coordinate by typing the coordinate.
    • Exit interactive mode, type anything else, e.g. "q".
  • Syntax: tw <stage_name> <step_size>
    • <stage_name> == Name of the stage to move.
    • <step_size> == Step size.
  • Examples:
    • Tweak "samy" by 0.005

      tw samy 0.005 

      Each time you you press enter after executing the command the stage will move.

    • Change the direction without changing the step size.

      -
    • Change the step size

      -0.01
    • Exit interactive mode

      q

Saving and Restoring Positions

Save Stage Positions

save_pos
  • Saves the position of one or multiple stages for later use.
  • Syntax: save_pos <id_name> [  <stage_name> ] <destination>
    • <id_name> == The identifier used to identify the saved positions. 
    • <stage_name> == A list of stage names of which to store the position.
    • <destination> == Optional parameter on where to save the positions depending on their use.
      • Possible destinations are:
        • experiment: For all experiment related positions. The positions are saved with the experimental data and can not be accessed by another experiment.
        • endstation: For all endstation related positions.
        • beamline: For all beamline related positions.
      • Default value

        By default the positions are saved as "experiment" positions.

  • Examples:
    • 1 motor
      save_pos sample_in [samy]
    • multiple motors
      save_pos exchange [samy samx samz samphi]

Restore Stage Positions

restore_pos
  • Restores the position of one or multiple stages.
  • Syntax: restore_pos <id_name> <source> <interactive>
    • <id_name> == The identifier used to identify the saved positions. 
    • <source> == Optional parameter. From where to restore the positions.
      • Possible sources are:
        • experiment: For all experiment related positions. The positions are saved with the experimental data and can not be accessed by another experiment.
        • endstation: For all endstation related positions.
        • beamline: For all beamline related positions
    • <interactive> == Optional parameter, enables are disables the prompts for user input.
  • Examples:
    • Restore some positions

      Start the restore process of the ID "sample_in"

      restore_pos sample_in
      

      In interactive mode you will be prompted:

      0 - Restore the latest positions.
      1 - Show position history. [0]

      Upon selecting option 0:

      These are the positions that will be restored:
      0 - csamx: 62.400000 --> 62.39999999999999
      1 - csamy: 37.000000 -->       37.0
      Do you want to restore these positions (Y/N)

      It shows:

      • The index.
      • The stage name.
      • The current position.
      • The position that will be restored.

      One can select yes to restore all or use the index to restore one or more by using the index, which is show in front of the stage name. Below are some example of the fancy indexing:

      Indexing examples
      1 --> will restore the position of stage 1.
      [0,1, 66] --> will restore stages 0, 1, and 66
      [0:3,9] --> will restore stages stages 0, 1, 2, and 9

      The prompt on which stages need to be restored is recursive so you will always see which stages will be restored if you reply "yes".

    • History view

      Start the restore process of the ID "sample_in"

      restore_pos sample_in
      

      In interactive mode you will be prompted:

      0 - Restore the latest positions.
      1 - Show position history. [0]

      Upon selecting option 0:

        --             csamx --             csamy --        time saved
      0 -- 42.39999999999999 --              27.0 -- 2020-03-02 15:01:51
      1 -- 42.39999999999999 --              27.0 -- 2020-03-10 07:40:43
      2 -- 62.39999999999999 --              37.0 -- 2020-03-10 10:59:02
      3 -- 62.39999999999999 --              37.0 -- 2020-03-10 11:01:35
      Which positions would you like to restore?

      It shows:

      • The index.
      • The stage names.
      • The position that was saved.
      • The time it was saved.

      You can use the index again to select which time point you want to restore. The prompt will resume as shown in the previous example.

    • Show the stored tags

      Call restore_pos without any arguments and you will get a list of all saved positions of this source.

      restore_pos
      
      sample_out
      sample_in
      detector_in
      detector_out
Content

  • No labels