terapy.hardware.axes package

Submodules

terapy.hardware.axes.aguc8 module

Device driver for Newport Agilis AG-UC motion controller

class terapy.hardware.axes.aguc8.AGUC8

Bases: terapy.hardware.axes.base.AxisDevice

Device driver for Newport Agilis AG-UC motion controller

ask(cmd)

configure()

detect()

get_motion_status()

goTo(position, wait=False)

initialize()

jog(step)

pos()

reset()

stop()

write(cmd)

terapy.hardware.axes.ax_owis module

Device driver for OWIS PS10 motion controller

terapy.hardware.axes.base module

Generic axis device driver

class terapy.hardware.axes.base.AxisDevice

Bases: terapy.hardware.device.Device

Generic axis device driver

assign(address, ID, name, axis)

Configure device driver prior to initialization.

Parameters:

address - physical address as required by communication interface driver ID - device short name (str) name - device long name (str) axis - axis id (int)

configure()

Call device configuration dialog.

get_motion_status()

Return current state of device.

Output:

device response to status polling

get_units(idx=0)

Return infos and units on meaningful quantity

Output:

(description (str), units(quantities))

goTo(position, wait=False)

Set device position to given position.

Parameters:

position - position (float) wait - if True, wait that device reaches position before return

home()

Home device.

jog(step)

Jog device relative to current position by given amount.

Parameters:

step - movement size (float)

pos()

Return current position of device.

Output:

Device position (float)

prepareScan()

Prepare device for scanning.

state()

Return extended snapshot of device.

Output:

list of tuples, each qty as (name, value, units)

stop()

Stop device movement.

widget(parent=None)

Return widget for graphical device control.

Parameters:

parent - parent window (wx.Window)

Output:

widget (wx.Frame)

class terapy.hardware.axes.base.AxisWidget(parent=None, qtyname='Position', units='ps', title='', pos='0', axis=None, min=None, max=None)

Bases: wx._windows.ScrolledWindow

Axis device widget class

OnGo(event=None)

Actions triggered when Go button is pressed.

Parameters:

event - wx.Event

OnHome(event=None)

Actions triggered when Home button is pressed.

Parameters:

event - wx.Event

OnLeft(event=None)

Actions triggered when Jog left button is pressed.

Parameters:

event - wx.Event

OnReset(event=None)

Actions triggered when Reset button is pressed.

Parameters:

event - wx.Event

OnRight(event=None)

Actions triggered when Jog right button is pressed.

Parameters:

event - wx.Event

OnSet(event=None)

Actions triggered when widget value is changed.

Parameters:

event - wx.Event

OnStop(event=None)

Actions triggered when Stop button is pressed.

Parameters:

event - wx.Event

RefreshDisplay(event=None)

Refresh display.

Parameters:

event - wx.Event

SetValue(val)

Set device and widget values.

Parameters:

val - value (float)

terapy.hardware.axes.e3647a module

Device driver for Agilent E3647A power supply

class terapy.hardware.axes.e3647a.E3647A

Bases: terapy.hardware.axes.base.AxisDevice

Device driver for Agilent E3647A power supply

ask(cmd)

configure()

detect()

get_motion_status()

goTo(position, wait=False)

initialize()

jog(step)

pos()

reset()

write(cmd)

terapy.hardware.axes.esp300 module

Device driver for Newport ESP300 motion controller

class terapy.hardware.axes.esp300.ESP300

Bases: terapy.hardware.axes.base.AxisDevice

Device driver for Newport ESP300 motion controller

ask(cmd)

clear_errors()

configure()

detect()

get_motion_status()

goTo(position, wait=False)

home()

initialize()

jog(step)

pos()

reset()

stop()

write(cmd)

terapy.hardware.axes.smc100 module

Device driver for Newport SMC100 motion controller

class terapy.hardware.axes.smc100.SMC100

Bases: terapy.hardware.axes.base.AxisDevice

Device driver for Newport SMC100 motion controller

ask(cmd)

configure()

detect()

get_motion_status()

goTo(position, wait=False)

home()

initialize()

jog(step)

pos()

reset()

stop()

write(cmd)

Module contents

Functions and classes to handle motion controllers and various other devices that can be used for scanning something in some way.

Properties:

modules - list of available device drivers

Each device driver must be implemented as a AxisDevice class (see base.py). AxisDevice classes contained in Python scripts within this folder will be automatically recognized and added to axis device driver list.