pymodaq.control_modules.daq_move.DAQ_Move([...])

Main PyMoDAQ class to drive actuators

pymodaq.control_modules.daq_move.DAQ_Move_Hardware(...)

pymodaq.control_modules.move_utility_classes.params

Built-in mutable sequence.

6.1.5. The DAQ_Move Class

This documentation highlights the useful entry and output points that you may use in your applications.

class pymodaq.control_modules.daq_move.DAQ_Move(parent=None, title='DAQ Move')[source]

Main PyMoDAQ class to drive actuators

Qt object and generic UI to drive actuators.

init_signal

This signal is emitted when the chosen actuator is correctly initialized

Type

Signal[bool]

move_done_signal

This signal is emitted when the chosen actuator finished its action. It gives the actuator’s name and current value

Type

Signal[str, float]

bounds_signal

This signal is emitted when the actuator reached defined limited boundaries.

Type

Signal[bool]

See also

ControlModule, ParameterManager

Attributes
actuator

str: the selected actuator’s type

initialized_state

bool: status of the actuator’s initialization (init or not)

move_done_bool

bool: status of the actuator’s action (done or not)

Methods

get_actuator_value()

Get the current actuator value via the "get_actuator_value" command send to the hardware

get_continuous_actuator_value([get_value])

Start the continuous getting of the actuator's value

grab()

Programmatic entry to grab data from detectors or current value from actuator

init_hardware_ui([do_init])

Programmatic actuator's Initialization

move(move_command)

Generic method to trigger the correct action on the actuator

move_abs(value[, send_to_tcpip])

Move the connected hardware to the absolute value

move_home([send_to_tcpip])

Move the connected actuator to its home value (if any)

move_rel(rel_value[, send_to_tcpip])

Move the connected hardware to the relative value

quit_fun()

Programmatic quitting of the current instance of DAQ_Move

stop_motion()

Stop any motion

get_actuator_value()[source]

Get the current actuator value via the “get_actuator_value” command send to the hardware

Returns nothing but the move_done_signal will be send once the action is done

get_continuous_actuator_value(get_value=True)[source]

Start the continuous getting of the actuator’s value

Parameters

get_value (bool) – if True start the timer to periodically fetch the actuator’s value, else stop it

Notes

The current timer period is set by the refresh value ‘refresh_timeout’ in the actuator main settings.

grab()[source]

Programmatic entry to grab data from detectors or current value from actuator

init_hardware_ui(do_init=True)[source]

Programmatic actuator’s Initialization

Programmatic way to simulate a click on the init button of the UI to initialize the communication with the hardware

Parameters

do_init (bool) – if the init or des-init should be performed

move(move_command: MoveCommand)[source]

Generic method to trigger the correct action on the actuator

Parameters

move_command (MoveCommand) – MoveCommand with move_type attribute either: * ‘abs’: performs an absolute action * ‘rel’: performs a relative action * ‘home’: find the actuator’s home

See also

move_abs(), move_rel(), move_home(), utility_classes.MoveCommand

move_abs(value, send_to_tcpip=False)[source]

Move the connected hardware to the absolute value

Returns nothing but the move_done_signal will be send once the action is done

Parameters
  • value (float) – The value the actuator should reach

  • send_to_tcpip (bool) – if True, this position is send through the TCP/IP communication canal

move_home(send_to_tcpip=False)[source]

Move the connected actuator to its home value (if any)

Parameters

send_to_tcpip (bool) – if True, this position is send through the TCP/IP communication canal

move_rel(rel_value, send_to_tcpip=False)[source]

Move the connected hardware to the relative value

Returns nothing but the move_done_signal will be send once the action is done

Parameters
  • value (float) – The relative value the actuator should reach

  • send_to_tcpip (bool) – if True, this position is send through the TCP/IP communication canal

quit_fun()[source]

Programmatic quitting of the current instance of DAQ_Move

Des-init the actuator then close the UI parent widget

stop_motion()[source]

Stop any motion

property actuator

the selected actuator’s type

Type

str

property initialized_state

status of the actuator’s initialization (init or not)

Type

bool

property move_done_bool

status of the actuator’s action (done or not)

Type

bool