mxcubecore.HardwareObjects.ESRF.OxfordCryostream#

Oxford Cryostream, controlled by bliss. Example xml_ configuration:

<object class="ESRF.OxfordCryostream">
  <username>Cryostream</username>
  <object role="controller" href="/bliss"/>
  <cryostat>cryostream</cryostat>
  <interval>120</interval>
  <object role="monitor_temperature" href="/monitor_temperature"/>
</object>

Classes

OxfordCryostream(name)

Control of the Oxford Cryostream model 700, 800 and 1000

class mxcubecore.HardwareObjects.ESRF.OxfordCryostream.OxfordCryostream(name)[source]#

Bases: AbstractActuator

Control of the Oxford Cryostream model 700, 800 and 1000

check_temperature(threshold=None)[source]#

Check if the temperature is under the threshold. :param threshold: Temperature threshold (optional) :type threshold: float

Returns:: True if under the threshold, False otherwise.
Return type:: (bool)

force_emit_signals()[source]#: Forces to emit all signals.

get_params()[source]#: Read from the controller. :returns: [target_temperature, ramp_rate, phase, run_mode] :rtype: (list)

get_specific_state()[source]#: Read the state of the controller. :returns: The state. :rtype: (str)

get_static_parameters()[source]#: Get predefined parameters. :returns: Predefimed parameters. :rtype: {list)

get_temperature()[source]#: Read the temperature. :returns: The temperature [deg K] :rtype: (float)

get_value()[source]#: Read the actuator position. :returns: Actuator position. :rtype: value

init()[source]#: Initialisation

pause(execute=True)[source]#: Pause the ramping. :param execute: True to pause, False to resume. :type execute: bool

rampstate()[source]#: Read the state of the ramping. :returns: Ramping state. :rtype: (str)

start_action(phase='RAMP', target=None, rate=None)[source]#: Run phase action action. :param phase: The phase action. Default value - RAMP :type phase: str :param target: Target temperature. :type target: float :param rate: (float): Ramp rate.

stop_action(phase='HOLD')[source]#: Stop action. :param phase: Phase action. :type phase: str

wait_temperature(threshold=None, timeout=None)[source]#

Wait until the temperature is under the threshold. :param threshold: Temperature threshold (optional) :type threshold: float :param timeout: optional - timeout [s],

If timeout == 0: return at once and do not wait
(default);

if timeout is None: wait forever.