MacroServer environment variables

The MacroServer environment stores various variables. Some of them have meaning only for user-written macros. Others have general meaning. They are listed below.

A list with variables used by Sardana itself can be found here.

• _GeneralHooks: data structure storing the hook classes.

• _ViewOptions: data structure storing ShowDial and ShowCtrlAxis.

• ActiveMntGrp: the active measurement group, 4.1.

• DiffractDevice, PSI: used by the diffractometer sofware, 9.1.

• FlagDisplayAll: used by SardanaMonitor.

• FlagFioWriteMotorPositions: A flag theat controlls whether the FIO files contain the motor position, 4.1

• JsonRecorder: JsonRecorder has to be set to True to generate json-encoded output on doors, used by pyspMonitor and SardanaMonitor, 4.1.

• LogMacroMode: With this environment variable it is possible to specify the number of backup files to be saved, def. 0.

• LogMacroDir: Directory where the macro logging file will be saved, def. /tmp.

• MacroServerRestartPostScript: points to a Python script being executed when SardanaRestartMacroServer3.py and SardanaRestartBoth3.py finish, e.g.:

  p09/door/haso107d10.01 [1]: senv MacroServerRestartPostScript "/home/p99user/temp/MSRestartPostScript.py"
  

• PreScanSnapshot: extends the header of spec files, 4.1.1.

• RegisteredPyspMonitors: stores all connected pyspMonitors, .

• ScanDir: the directory where the output files are written, 4.1.

• ScanFile: The prefix and the extension of the output file name, 4.1.

• ScanID: a number which is incremented for each scan, part of the output file name, 3.5.

• SequencyPath: where the sequency files are stored, 5.10.

• ShowCtrlAxis: whether the controller axis is displayed by 'wa', 3.3

• ShowDial: should be False, 3.3.

• SignalCounter: A MacroServer environment variable identifying the counter which produces the signal. SignalCounter is used by the mvsa Macro (move-by-signal-analysis) and in mesh scans for the signal image.

   
  p99/door/haspp99.01 [7]: senv SignalCounter exp_c01
  

• UndulatorDevice: The macro set_harmonic needs the variable UndulatorDevice:

   
  p99/door/haspp99.01 [7]: senv UndulatorDevice und_en