env

Environment related macros

class dumpenv(*args, **kwargs)

Dumps the complete environment

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:

RuntimeError

class load_env(*args, **kwargs)

Read environment variables from config_env.xml file

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:

RuntimeError

class lsenv(*args, **kwargs)

Lists the environment in alphabetical order

param_def = [['macro_list', [['macro', 'MacroClass', None, 'macro name'], {'min': 0}], None, 'List of macros to show environment']]

This property holds the macro parameter description. It consists of a sequence of parameter information objects. A parameter information object is either:

1. a simple parameter object

2. a parameter repetition object

A simple parameter object is a sequence of:

1. a string representing the parameter name

2. a member of Macro.Type representing the parameter data type

3. a default value for the parameter or None if there is no default value

4. a string with the parameter description

Example:

param_def = ( ('value', Type.Float, None, 'a float parameter' ) )

A parameter repetition object is a sequence of:

1. a string representing the parameter repetition name

2. a sequence of parameter information objects

3. a dictionary representing the parameter repetition semantics or None to use the default parameter repetition semantics. Dictionary keys are:

   • min - integer representing minimum number of repetitions or None for no minimum.

   • max - integer representing maximum number of repetitions or None for no maximum.

   Default parameter repetition semantics is { 'min': 1, 'max' : None } (in other words, “at least one repetition” semantics)

Example:

param_def = (
    ( 'motor_list', ( ( 'motor', Type.Motor, None, 'motor name') ), None, 'List of motors')
)

prepare(macro_list, **opts)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(macro_list)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:

RuntimeError

class senv(*args, **kwargs)

Sets the given environment variable to the given value

param_def = [['name', 'Env', None, 'Environment variable name. Can be one of the following:\n - <name> - global variable\n - <full door name>.<name> - variable value for a specific door\n - <macro name>.<name> - variable value for a specific macro\n - <full door name>.<macro name>.<name> - variable value for a specific macro running on a specific door'], ['value_list', [['value', 'String', None, 'environment value item (string value which correspondsto a Python type e.g. int, float, Exception, etc. must be double enclosed in quotes e.g. "\'int\'"'], {'min': 1}], None, 'value(s). one item will eval to a single element. More than one item will eval to a tuple of elements']]

This property holds the macro parameter description. It consists of a sequence of parameter information objects. A parameter information object is either:

1. a simple parameter object

2. a parameter repetition object

A simple parameter object is a sequence of:

1. a string representing the parameter name

2. a member of Macro.Type representing the parameter data type

3. a default value for the parameter or None if there is no default value

4. a string with the parameter description

Example:

param_def = ( ('value', Type.Float, None, 'a float parameter' ) )

A parameter repetition object is a sequence of:

1. a string representing the parameter repetition name

2. a sequence of parameter information objects

3. a dictionary representing the parameter repetition semantics or None to use the default parameter repetition semantics. Dictionary keys are:

   • min - integer representing minimum number of repetitions or None for no minimum.

   • max - integer representing maximum number of repetitions or None for no maximum.

   Default parameter repetition semantics is { 'min': 1, 'max' : None } (in other words, “at least one repetition” semantics)

Example:

param_def = (
    ( 'motor_list', ( ( 'motor', Type.Motor, None, 'motor name') ), None, 'List of motors')
)

run(env, value)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:

RuntimeError

class usenv(*args, **kwargs)

Unsets the given environment variable

param_def = [['environment_list', [['env', 'Env', None, 'Environment variable name'], {'min': 1}], None, 'List of environment items to be removed']]

This property holds the macro parameter description. It consists of a sequence of parameter information objects. A parameter information object is either:

1. a simple parameter object

2. a parameter repetition object

A simple parameter object is a sequence of:

1. a string representing the parameter name

2. a member of Macro.Type representing the parameter data type

3. a default value for the parameter or None if there is no default value

4. a string with the parameter description

Example:

param_def = ( ('value', Type.Float, None, 'a float parameter' ) )

A parameter repetition object is a sequence of:

1. a string representing the parameter repetition name

2. a sequence of parameter information objects

3. a dictionary representing the parameter repetition semantics or None to use the default parameter repetition semantics. Dictionary keys are:

   • min - integer representing minimum number of repetitions or None for no minimum.

   • max - integer representing maximum number of repetitions or None for no maximum.

   Default parameter repetition semantics is { 'min': 1, 'max' : None } (in other words, “at least one repetition” semantics)

Example:

param_def = (
    ( 'motor_list', ( ( 'motor', Type.Motor, None, 'motor name') ), None, 'List of motors')
)

run(env)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:

RuntimeError

class genv(*args, **kwargs)

Gets the given environment variable

param_def = [['name', 'Env', None, 'Environment variable name. Can be one of the following:\n - <name> - global variable\n - <full door name>.<name> - variable value for a specific door\n - <macro name>.<name> - variable value for a specific macro\n - <full door name>.<macro name>.<name> - variable value for a specific macro running on a specific door']]

This property holds the macro parameter description. It consists of a sequence of parameter information objects. A parameter information object is either:

1. a simple parameter object

2. a parameter repetition object

A simple parameter object is a sequence of:

1. a string representing the parameter name

2. a member of Macro.Type representing the parameter data type

3. a default value for the parameter or None if there is no default value

4. a string with the parameter description

Example:

param_def = ( ('value', Type.Float, None, 'a float parameter' ) )

A parameter repetition object is a sequence of:

1. a string representing the parameter repetition name

2. a sequence of parameter information objects

3. a dictionary representing the parameter repetition semantics or None to use the default parameter repetition semantics. Dictionary keys are:

   • min - integer representing minimum number of repetitions or None for no minimum.

   • max - integer representing maximum number of repetitions or None for no maximum.

   Default parameter repetition semantics is { 'min': 1, 'max' : None } (in other words, “at least one repetition” semantics)

Example:

param_def = (
    ( 'motor_list', ( ( 'motor', Type.Motor, None, 'motor name') ), None, 'List of motors')
)

run(var)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:

RuntimeError

class lsvo(*args, **kwargs)

Lists the view options

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:

RuntimeError

class setvo(*args, **kwargs)

Sets the given view option to the given value.

Available view options:

• ShowDial: used by macro wm, pwm and wa. Default value False

• ShowCtrlAxis: used by macro wm, pwm and wa. Default value False

• PosFormat: used by macro wm, pwm, wa and umv. Default value -1

• OutputBlock: used by scan macros. Default value False

• DescriptionLength: used by lsdef. Default value 60

param_def = [['name', 'String', None, 'View option name'], ['value', 'String', None, 'View option value']]

This property holds the macro parameter description. It consists of a sequence of parameter information objects. A parameter information object is either:

1. a simple parameter object

2. a parameter repetition object

A simple parameter object is a sequence of:

1. a string representing the parameter name

2. a member of Macro.Type representing the parameter data type

3. a default value for the parameter or None if there is no default value

4. a string with the parameter description

Example:

param_def = ( ('value', Type.Float, None, 'a float parameter' ) )

A parameter repetition object is a sequence of:

1. a string representing the parameter repetition name

2. a sequence of parameter information objects

3. a dictionary representing the parameter repetition semantics or None to use the default parameter repetition semantics. Dictionary keys are:

   • min - integer representing minimum number of repetitions or None for no minimum.

   • max - integer representing maximum number of repetitions or None for no maximum.

   Default parameter repetition semantics is { 'min': 1, 'max' : None } (in other words, “at least one repetition” semantics)

Example:

param_def = (
    ( 'motor_list', ( ( 'motor', Type.Motor, None, 'motor name') ), None, 'List of motors')
)

run(name, value)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:

RuntimeError

class usetvo(*args, **kwargs)

Resets the value of the given view option.

Available view options:

• ShowDial: used by macro wm, pwm and wa. Default value False

• ShowCtrlAxis: used by macro wm, pwm and wa. Default value False

• PosFormat: used by macro wm, pwm, wa and umv. Default value -1

• OutputBlock: used by scan macros. Default value False

• DescriptionLength: used by lsdef. Default value 60

param_def = [['name', 'String', None, 'View option name']]

This property holds the macro parameter description. It consists of a sequence of parameter information objects. A parameter information object is either:

1. a simple parameter object

2. a parameter repetition object

A simple parameter object is a sequence of:

1. a string representing the parameter name

2. a member of Macro.Type representing the parameter data type

3. a default value for the parameter or None if there is no default value

4. a string with the parameter description

Example:

param_def = ( ('value', Type.Float, None, 'a float parameter' ) )

A parameter repetition object is a sequence of:

1. a string representing the parameter repetition name

2. a sequence of parameter information objects

3. a dictionary representing the parameter repetition semantics or None to use the default parameter repetition semantics. Dictionary keys are:

   • min - integer representing minimum number of repetitions or None for no minimum.

   • max - integer representing maximum number of repetitions or None for no maximum.

   Default parameter repetition semantics is { 'min': 1, 'max' : None } (in other words, “at least one repetition” semantics)

Example:

param_def = (
    ( 'motor_list', ( ( 'motor', Type.Motor, None, 'motor name') ), None, 'List of motors')
)

run(name)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:

RuntimeError

class lsgh(*args, **kwargs)

List general hooks.

Note

The lsgh macro has been included in Sardana on a provisional basis. Backwards incompatible changes (up to and including its removal) may occur if deemed necessary by the core developers.

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:

RuntimeError

class defgh(*args, **kwargs)

Define general hook:

>>> defgh "mv [[mot02 9]]" pre-scan
>>> defgh "ct 0.1" pre-scan
>>> defgh lsm pre-scan
>>> defgh "mv mot03 10" pre-scan
>>> defgh "Print 'Hello world'" pre-scan

Note

The defgh macro has been included in Sardana on a provisional basis. Backwards incompatible changes (up to and including its removal) may occur if deemed necessary by the core developers.

param_def = [['macro_name', 'String', None, 'Macro name with parameters. Ex.: "mv exp_dmy01 10"'], ['hookpos_list', [['position', 'String', None, 'macro name'], {'min': 1}], None, 'List of positions where the hook has to be executed']]

This property holds the macro parameter description. It consists of a sequence of parameter information objects. A parameter information object is either:

1. a simple parameter object

2. a parameter repetition object

A simple parameter object is a sequence of:

1. a string representing the parameter name

2. a member of Macro.Type representing the parameter data type

3. a default value for the parameter or None if there is no default value

4. a string with the parameter description

Example:

param_def = ( ('value', Type.Float, None, 'a float parameter' ) )

A parameter repetition object is a sequence of:

1. a string representing the parameter repetition name

2. a sequence of parameter information objects

3. a dictionary representing the parameter repetition semantics or None to use the default parameter repetition semantics. Dictionary keys are:

   • min - integer representing minimum number of repetitions or None for no minimum.

   • max - integer representing maximum number of repetitions or None for no maximum.

   Default parameter repetition semantics is { 'min': 1, 'max' : None } (in other words, “at least one repetition” semantics)

Example:

param_def = (
    ( 'motor_list', ( ( 'motor', Type.Motor, None, 'motor name') ), None, 'List of motors')
)

run(macro_name, position)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:

RuntimeError

class udefgh(*args, **kwargs)

Undefine general hook. Without arguments undefine all.

Note

The lsgh macro has been included in Sardana on a provisional basis. Backwards incompatible changes (up to and including its removal) may occur if deemed necessary by the core developers.

param_def = [['macro_name', 'String', 'all', 'General hook to be undefined'], ['hook_pos', 'String', 'all', 'Position to undefine the general hook from']]

This property holds the macro parameter description. It consists of a sequence of parameter information objects. A parameter information object is either:

1. a simple parameter object

2. a parameter repetition object

A simple parameter object is a sequence of:

1. a string representing the parameter name

2. a member of Macro.Type representing the parameter data type

3. a default value for the parameter or None if there is no default value

4. a string with the parameter description

Example:

param_def = ( ('value', Type.Float, None, 'a float parameter' ) )

A parameter repetition object is a sequence of:

1. a string representing the parameter repetition name

2. a sequence of parameter information objects

3. a dictionary representing the parameter repetition semantics or None to use the default parameter repetition semantics. Dictionary keys are:

   • min - integer representing minimum number of repetitions or None for no minimum.

   • max - integer representing maximum number of repetitions or None for no maximum.

   Default parameter repetition semantics is { 'min': 1, 'max' : None } (in other words, “at least one repetition” semantics)

Example:

param_def = (
    ( 'motor_list', ( ( 'motor', Type.Motor, None, 'motor name') ), None, 'List of motors')
)

run(macro_name, hook_pos)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:

RuntimeError