mxcubecore.HardwareObjects.LNLS.EPICS.EPICSActuator

Classes

EPICSActuator(name)
EPICSActuatorBluesky(name)	This class alters the _set_value function of EPICSActuator for cases when the set is done via bluesky rather than directly by MXCuBE.

class mxcubecore.HardwareObjects.LNLS.EPICS.EPICSActuator.EPICSActuator(name)

Bases: AbstractActuator

abort()

Immediately terminate HardwareObject action.

Should not happen in state READY.

get_value()

Read the actuator position.

Returns:

Actuator position.

init()

Init properties: actuator_name, username, read_only and default_value.

set_value(value, timeout: float = 0)

Set actuator to value.

If timeout == 0: return at once and do not wait (default). If timeout is None: wait forever.

Parameters:

• value – target value

• timeout (float) – Optional timeout in seconds. Default is 0: do not wait.

Raises:

• ValueError – Invalid value or attempt to set read only actuator.

• RuntimeError – Timeout waiting for status ready (from wait_ready):

wait_ready(timeout: float | None = None)

Wait timeout seconds till object is ready.

If timeout is None: wait forever.

Parameters:

timeout (Optional[float], optional) – Timeout (seconds). Defaults to None.

class mxcubecore.HardwareObjects.LNLS.EPICS.EPICSActuator.EPICSActuatorBluesky(name)

Bases: EPICSActuator

This class alters the _set_value function of EPICSActuator for cases when the set is done via bluesky rather than directly by MXCuBE. The plan’s name and parameter must be specified at the configuration file. Because wait_ready function works the same way as EPICSActuator, frontend functionality remains the same.

YAML Example

%YAML 1.2 — class: LNLS.EPICS.EPICSActuator.EPICSActuatorBluesky epics: “MNC:A:DCM01:”:

channels: rbv:

suffix: “GonRx_Energy_RBV” polling_period: 200

val:

suffix: “Energy_SP”

configuration: tolerance: 0.01 plan_name: “move_energy_and_phase” plan_parameter: “energy” default_limits: (5, 20)

init()

Init properties: actuator_name, username, read_only and default_value.