mxcubecore.HardwareObjects#

Modules

mxcubecore.HardwareObjects.Attenuators

mxcubecore.HardwareObjects.BeamInfo

[Name] BeamInfo

mxcubecore.HardwareObjects.Beamline

Beamline class serving as singleton container for links to top-level HardwareObjects

mxcubecore.HardwareObjects.BeamlineActions

mxcubecore.HardwareObjects.BeamlineTools

mxcubecore.HardwareObjects.BlissActuator

Use bliss to set different actuators in/out. If private_state not specified, True will be send to set in and False for out. Example xml file: <object class="BlissActuator"> <username>Detector Cover</username> <object href="/bliss" role="controller"/> </object>.

mxcubecore.HardwareObjects.BlissEnergy

Energy and Wavelength with bliss. Example xml file: - for tunable wavelength beamline: <object class="Energy"> <object href="/energy" role="energy_motor"/> <object href="/bliss" role="bliss"/> </object> The energy should have methods get_value, get_limits, get_state and move. If used, the controller should have method moveEnergy.

mxcubecore.HardwareObjects.BlissHutchTrigger

mxcubecore.HardwareObjects.BlissNState

bliss implementation of AbstartNState Example xml file: <object class="BlissNState"> <username>Detector Cover</username> <actuator_name>detcover</> <object href="/bliss" role="controller"/> <values>{"IN": "IN", "OUT": "OUT"}</values> </object>

mxcubecore.HardwareObjects.BlissRontecMCA

mxcubecore.HardwareObjects.BlissShutter

BlissShutter class - interface for shutter controlled by BLISS Implements _set_value, get_value methods Bliss states are: UNKNOWN, OPEN, CLOSED, FAULT "MOVING", "DISABLE", "STANDBY", "RUNNING" Example xml file: <devic class="BlissShutter"> <username>Safety Shutter</username> <name>safshut</name> <type>tango</type> <object href="/bliss" role="controller"/> </object>

mxcubecore.HardwareObjects.Camera

Class for cameras connected to framegrabbers run by Taco Device Servers

mxcubecore.HardwareObjects.CatsMaint

CATS maintenance commands hardware object.

mxcubecore.HardwareObjects.CentringMath

mxcubecore.HardwareObjects.DozorOnlineProcessing

mxcubecore.HardwareObjects.EDNACharacterisation

mxcubecore.HardwareObjects.EMBL

mxcubecore.HardwareObjects.EMBLFlexHCD

FlexHCD Linux Java implementation of sample changer. Example xml file: <object class = "EMBLFlexHCD"> <username>Sample Changer</username> <exporter_address>lid231flex1:9001</exporter_address> <object role="controller" href="/bliss"/> <puck_configuration>["SC3", "UNI", "SC3", "UNI", "UNI", "UNI", "UNI", "UNI"]< /puck_configuration> </object>.

mxcubecore.HardwareObjects.ESRF

mxcubecore.HardwareObjects.EdnaWorkflow

mxcubecore.HardwareObjects.Energy

mxcubecore.HardwareObjects.ExporterMotor

Example xml file: <object class="ExporterMotor"> <username>phiy</username> <exporter_address>wid30bmd2s:9001</exporter_address> <actuator_name>AlignmentY</actuator_name> <tolerance>1e-2</tolerance> </object> optional parameters, with default values. To be used only if the values differ from the default ones. The position attribute is actuator_name+position_suffix <position_suffix>Position</position_suffix> The state attribute is actuator_name+state_suffix <state_suffix>State</state_suffix> Use the global application state instead of the motor state. <use_global_state>False</use_global_state>.

mxcubecore.HardwareObjects.ExporterNState

Microdiff with Exporter implementation of AbstartNState Example xml file: <object class="ExporterNState"> <username>Fluorescence Detector</username> <exporter_address>wid30bmd2s:9001</exporter_address> <value_channel_name>FluoDetectorIsBack</value_channel_name> <state_channel_name>State</state_channel_name> <values>{"IN": False, "OUT": True}</values> <value_state>True</value_state> </object>

mxcubecore.HardwareObjects.FlexHCD

mxcubecore.HardwareObjects.FlexHCDMaintenance

FLEX HCD maintenance mockup.

mxcubecore.HardwareObjects.GenericDiffractometer

GenericDiffractometer

mxcubecore.HardwareObjects.Gphl

mxcubecore.HardwareObjects.GrobDiff

mxcubecore.HardwareObjects.GrobSampleChanger

Sample Changer Hardware Object

mxcubecore.HardwareObjects.Harvester

[Name] Harvester

mxcubecore.HardwareObjects.HarvesterMaintenance

Harvester Maintenance.

mxcubecore.HardwareObjects.ISARAMaint

mxcubecore.HardwareObjects.ISPyBClient

mxcubecore.HardwareObjects.ISPyBRestClient

A client for ISPyB Webservices.

mxcubecore.HardwareObjects.LdapAuthenticator

This module serves to connect to and Ldap server.

mxcubecore.HardwareObjects.LimaEigerDetector

LimaEigerDetector Class Lima Tango Device Server implementation of the Dectris Eiger2 Detector.

mxcubecore.HardwareObjects.LimaJungfrauDetector

mxcubecore.HardwareObjects.LimaPilatusDetector

mxcubecore.HardwareObjects.MAXIV

mxcubecore.HardwareObjects.MD2Motor

mxcubecore.HardwareObjects.MachCurrent

Machine Current Tango Hardware Object Example XML: <object class = "MachCurrent"> <username>label for users</username> <tangoname>orion:10000/fe/id(or d)/xx</tangoname> <channel type="tango" name="OperatorMsg" polling="2000">SR_Operator_Mesg</channel> <channel type="tango" name="Current" polling="2000">SR_Current</channel> <channel type="tango" name="FillingMode" polling="2000">SR_Filling_Mode</channel> <channel type="tango" name="RefillCountdown" polling="2000">SR_Refill_Countdown</channel> </object>

mxcubecore.HardwareObjects.Mar225

mxcubecore.HardwareObjects.Marvin

mxcubecore.HardwareObjects.MicrodiffActuator

Use the exporter to set different MD2 actuators in/out. If private_state not specified, True will be send to set in and False for out. Example xml file: <object class="MicrodiffActuator"> <username>Scintilator</username> <exporter_address>wid30bmd2s:9001</exporter_address> <cmd_name>ScintillatorPosition</cmd_name> <private_state>{"PARK":"out", "SCINTILLATOR":"in"}</private_state> <use_hwstate>True</use_hwstate> </object>.

mxcubecore.HardwareObjects.MicrodiffAperture

MicrodiffAperture.

mxcubecore.HardwareObjects.MicrodiffBeamstop

mxcubecore.HardwareObjects.MicrodiffInOut

mxcubecore.HardwareObjects.MicrodiffKappaMotor

mxcubecore.HardwareObjects.MicrodiffLight

mxcubecore.HardwareObjects.MicrodiffLightBeamstop

Combine setting the back light IN with moving the beamstop out. This is used to set the back light in/out faster, than using the phase CENTRING - the beamstop motor moves only if needed. Example xml file: <object class="MicrodiffLightBeamstop"> <username>Back Light</username> <exporter_address>wid30bmd2s:9001</exporter_address> <actuator_name>BackLightIsOn</actuator_name> <values>{"IN": True, "OUT": False}</values> <use_hwstate>True</use_hwstate> <object role="beamstop" href="/udiff_beamstop"/> </object>.

mxcubecore.HardwareObjects.MicrodiffMotor

mxcubecore.HardwareObjects.MicrodiffSamplePseudo

mxcubecore.HardwareObjects.MicrodiffZoom

MicrodiffZoom

mxcubecore.HardwareObjects.MiniDiff

mxcubecore.HardwareObjects.MiniKappaCorrection

mxcubecore.HardwareObjects.MinidiffAperture

mxcubecore.HardwareObjects.MotorsNPosition

mxcubecore.HardwareObjects.MultiplePositions

TITLE MultiplePositions Hardware Object

mxcubecore.HardwareObjects.NState

Concrete Implementation of AbstartNState - overloads the get_value and _set_value abstract methods.

mxcubecore.HardwareObjects.Native

mxcubecore.HardwareObjects.ObjectsController

mxcubecore.HardwareObjects.PlateManipulator

[Name] PlateManipulator

mxcubecore.HardwareObjects.PlateManipulatorMaintenance

Plate Manipulator maintenance.

mxcubecore.HardwareObjects.Q315dist

mxcubecore.HardwareObjects.QtInstanceServer

mxcubecore.HardwareObjects.QtLimaVideo

[Name] QtLimaVideo

mxcubecore.HardwareObjects.QtTangoLimaVideo

[Name] QtTangoLimaVideo

mxcubecore.HardwareObjects.QueueManager

QueueManager, handles the execution of the MxCuBE queue.

mxcubecore.HardwareObjects.QueueModel

Handels interaction with the data model(s).

mxcubecore.HardwareObjects.Resolution

Resolution concrete implementation. Example xml file: <object class="Resolution"> <username>Resolution</username> <actuator_name>resolution</actuator_name> <tolerance>1e-4</tolerance> <!-- optional --> <object href="/pilatus" role="detector"/> </object>.

mxcubecore.HardwareObjects.RobodiffController

mxcubecore.HardwareObjects.RobodiffFShut

mxcubecore.HardwareObjects.RobodiffMotor

mxcubecore.HardwareObjects.RobodiffMotorWPositions

mxcubecore.HardwareObjects.SOLEIL

mxcubecore.HardwareObjects.SampleStage

mxcubecore.HardwareObjects.SampleView

mxcubecore.HardwareObjects.SardanaMotor

mxcubecore.HardwareObjects.SecureXMLRpcRequestHandler

Secure XML RPC request handler for workflow execution based on tokens.

mxcubecore.HardwareObjects.Session

Session hardware object.

mxcubecore.HardwareObjects.SimpleHTML

mxcubecore.HardwareObjects.StateMachine

mxcubecore.HardwareObjects.TangoLimaMpegVideo

Class for streaming MPEG1 video with cameras connected to Lima Tango Device Servers

mxcubecore.HardwareObjects.TangoLimaVideo

Class for cameras connected to Lima Tango Device Servers

mxcubecore.HardwareObjects.TangoLimaVideoDevice

[Name] TangoLimaVideoDevice

mxcubecore.HardwareObjects.TangoMachineInfo

MachineInfo using Tango channels.

mxcubecore.HardwareObjects.TangoMotor

TangoMotor class defines motor in the Tango control system (used and tested in DESY/P11

mxcubecore.HardwareObjects.TangoShutter

TangoShutter class - interface for shutter controlled by TANGO Implements _set_value, get_value methods

mxcubecore.HardwareObjects.UnitTest

mxcubecore.HardwareObjects.XMLRPCServer

XMLRPC-Server that makes it possbile to access core features of MXCuBE like the queue from external applications.

mxcubecore.HardwareObjects.XRFSpectrum

mxcubecore.HardwareObjects.XSDataAutoprocv1_0

mxcubecore.HardwareObjects.XSDataCommon

mxcubecore.HardwareObjects.XSDataControlDozorv1_1

mxcubecore.HardwareObjects.XSDataMXCuBEv1_3

mxcubecore.HardwareObjects.XSDataMXCuBEv1_4

mxcubecore.HardwareObjects.XSDataMXv1

mxcubecore.HardwareObjects.abstract

mxcubecore.HardwareObjects.autoprocessing

mxcubecore.HardwareObjects.edna_test_data

mxcubecore.HardwareObjects.mockup

mxcubecore.HardwareObjects.sample_centring