standard

This is the standard macro module

class wa(*args, **kwargs)

Show all motor positions

prepare(filter, **opts)

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

run(filter)

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

Raises:RuntimeError

class pwa(*args, **kwargs)

Show all motor positions in a pretty table

run(filter)

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

Raises:RuntimeError

class set_lim(*args, **kwargs)

Sets the software limits on the specified motor hello

run(motor, low, high)

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

Raises:RuntimeError

class set_lm(*args, **kwargs)

Sets the dial limits on the specified motor

run(motor, low, high)

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

Raises:RuntimeError

class set_pos(*args, **kwargs)

Sets the position of the motor to the specified value

run(motor, pos)

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

Raises:RuntimeError

class wm(*args, **kwargs)

Show the position of the specified motors.

prepare(motor_list, **opts)

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

run(motor_list)

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

Raises:RuntimeError

class pwm(*args, **kwargs)

Show the position of the specified motors in a pretty table

run(motor_list)

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

Raises:RuntimeError

class mv(*args, **kwargs)

Move motor(s) to the specified position(s)

run(motor_pos_list)

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

Raises:RuntimeError

class mstate(*args, **kwargs)

Prints the state of a motor

run(motor)

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

Raises:RuntimeError

class umv(*args, **kwargs)

Move motor(s) to the specified position(s) and update

prepare(motor_pos_list, **opts)

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

run(motor_pos_list)

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

Raises:RuntimeError

class mvr(*args, **kwargs)

Move motor(s) relative to the current position(s)

run(motor_disp_list)

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

Raises:RuntimeError

class umvr(*args, **kwargs)

Move motor(s) relative to the current position(s) and update

run(motor_disp_list)

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

Raises:RuntimeError

class tw(*args, **kwargs)

Tweak motor by variable delta

run(motor, delta)

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

Raises:RuntimeError

class ct(*args, **kwargs)

Count for the specified time on the active measurement group

prepare(integ_time, **opts)

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

run(integ_time)

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

Raises:RuntimeError

class uct(*args, **kwargs)

Count on the active measurement group and update

prepare(integ_time, **opts)

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

run(integ_time)

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

Raises:RuntimeError

class settimer(*args, **kwargs)

Defines the timer channel for the active measurement group

run(timer)

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

Raises:RuntimeError

class logmacro(*args, **kwargs)

Turn on/off logging of the spock output.

Note

The logmacro class 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(offon, mode)

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

Raises:RuntimeError

class repeat(*args, **kwargs)

This macro executes as many repetitions of it’s body hook macros as specified by nr parameter. If nr parameter has negative value, repetitions will be executed until you stop repeat macro.

prepare(nr)

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

run(nr)

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

Raises:RuntimeError