mxcubecore.HardwareObjects.DetectorCover#

Control the detector cover

Example xml file:

<object class="DetectorCover">
  <object href="/detcover" role="detector_cover"/>
  <object href="/handle_detcover" role="handle_detector_cover"/>
</object>

class DetectorCover.DetectorCover
configuration:
   username: Detector Cover
objects:
   detector_cover: detcover.yaml
   handle_detector_cover: handle_detcover.yaml

Classes

DetectorCover(name)

Detector Cover class

class mxcubecore.HardwareObjects.DetectorCover.DetectorCover(name)[source]#

Bases: HardwareObject

Detector Cover class

get_value()[source]#: Get the values for the detector cover only.

get_value_handle()[source]#: Get the handle detector cover option.

init()[source]#: Initialise properties and objects

set_value(value, timeout: float | None = None)[source]#

Set the detector cover. Check if you need to handle it. :param value: target value. :param timeout: optional - timeout [s].

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

Parameters:: timeout (float | None) –