mxcubeweb.core.adapter.actuator_adapter

Classes

ActuatorAdapter(ho, role, app[, ...])

Adapter for Energy Hardware Object, a web socket is used to communicate information on longer running processes.

class mxcubeweb.core.adapter.actuator_adapter.ActuatorAdapter(ho, role, app, resource_handler_config=ResourceHandlerConfigModel(url_prefix='', exports=[], commands=['get_value', 'set_value', 'stop'], attributes=['data']))

Bases: ActuatorAdapterBase

Adapter for Energy Hardware Object, a web socket is used to communicate information on longer running processes.

get_value() → FloatValueModel

Read the energy. :returns: Energy [keV]. :rtype: (float as str)

Raises:

ValueError – When value for any reason can’t be retrieved.

Return type:

FloatValueModel

read_only()

Check if the energy is tunable or not. Retuns:

(bool): True if tunable, False if not.

set_value(value: HOActuatorValueChangeModel)

Execute the sequence to set the value. :param value: Target energy [keV]. :type value: float

Returns:

The actual value set.

Return type:

(float as str)

Raises:

• ValueError – Value not valid or attemp to set a non-tunable energy.

• RuntimeError – Timeout while setting the value.

• StopItteration – When a value change was interrupted (abort/cancel).

Parameters:

value (HOActuatorValueChangeModel) –

stop()

Stop the execution.