.. _devices: ======= Devices ======= Ophyd-style Devices for the APS. Also consult the :ref:`Index ` under the *Ophyd* heading for links to the Devices, Exceptions, Mixins, Signals, and other support items described here. Categories ---------- See these categories: * :ref:`devices.aps_support` * :ref:`devices.area_detector` * :ref:`devices.flyers` * :ref:`devices.insertion_devices` * :ref:`devices.motors` * :ref:`devices.scalers` * :ref:`devices.shutters` * :ref:`devices.slits` * :ref:`devices.temperature_controllers` * :ref:`devices.other_support` .. _devices.aps_support: APS General Support +++++++++++++++++++ .. autosummary:: ~apstools.devices.aps_cycle.ApsCycleDM ~apstools.devices.aps_machine.ApsMachineParametersDevice ~apstools.devices.shutters.ApsPssShutter ~apstools.devices.shutters.ApsPssShutterWithStatus ~apstools.devices.shutters.SimulatedApsPssShutterWithStatus .. _devices.area_detector: Area Detector Support +++++++++++++++++++++ .. autosummary:: ~apstools.devices.area_detector_factory.ad_creator ~apstools.devices.area_detector_factory.ad_class_factory .. rubric: Plugins .. autosummary:: ~apstools.devices.area_detector_support.AD_EpicsFileNameHDF5Plugin ~apstools.devices.area_detector_support.AD_EpicsFileNameJPEGPlugin ~apstools.devices.area_detector_support.AD_EpicsFileNameTIFFPlugin .. rubric: Mix-in classes .. autosummary:: ~apstools.devices.area_detector_support.AD_EpicsFileNameMixin ~apstools.devices.area_detector_support.AD_EpicsHdf5FileName ~apstools.devices.area_detector_support.AD_EpicsHDF5IterativeWriter ~apstools.devices.area_detector_support.AD_EpicsJPEGFileName ~apstools.devices.area_detector_support.AD_EpicsJPEGIterativeWriter ~apstools.devices.area_detector_support.AD_EpicsTIFFFileName ~apstools.devices.area_detector_support.AD_EpicsTIFFIterativeWriter ~apstools.devices.area_detector_support.AD_setup_FrameType ~apstools.devices.area_detector_support.CamMixin_V34 ~apstools.devices.area_detector_support.CamMixin_V3_1_1 ~apstools.devices.area_detector_support.SingleTrigger_V34 .. rubric: Other support .. autosummary:: ~apstools.devices.area_detector_support.AD_full_file_name_local ~apstools.devices.area_detector_support.AD_plugin_primed ~apstools.devices.area_detector_support.AD_prime_plugin2 ~apstools.devices.area_detector_support.ensure_AD_plugin_primed .. _devices.scalers: Detector & Scaler Support +++++++++++++++++++++++++ .. autosummary:: ~apstools.devices.struck3820.Struck3820 ~apstools.devices.measComp_usb_ctr_support.MeasCompCtr ~apstools.devices.measComp_usb_ctr_support.MeasCompCtrMcs ~apstools.devices.scaler_support.use_EPICS_scaler_channels ~apstools.devices.synth_pseudo_voigt.SynPseudoVoigt .. tip:: The Measurement Computing USB-CTR08 EPICS support provides a compatible EPICS scaler record. .. _devices.flyers: Fly Scan Support +++++++++++++++++++++++ .. issue #763 .. autosummary:: ~apstools.devices.flyer_motor_scaler.FlyerBase ~apstools.devices.flyer_motor_scaler.ActionsFlyerBase ~apstools.devices.flyer_motor_scaler.ScalerMotorFlyer ``ScalerMotorFlyer()`` support withdrawn pending issue #763. .. _devices.insertion_devices: Insertion Devices +++++++++++++++++ .. autosummary:: ~apstools.devices.aps_undulator.PlanarUndulator ~apstools.devices.aps_undulator.Revolver_Undulator ~apstools.devices.aps_undulator.STI_Undulator ~apstools.devices.aps_undulator.Undulator2M ~apstools.devices.aps_undulator.Undulator4M .. note:: The ``ApsUndulator`` and ``ApsUndulatorDual`` device support classes have been removed. These devices are not used in the APS-U era. .. _devices.motors: Motors, Positioners, Axes, ... +++++++++++++++++++++++++++++++ .. autosummary:: ~apstools.devices.axis_tuner.AxisTunerException ~apstools.devices.axis_tuner.AxisTunerMixin ~apstools.devices.description_mixin.EpicsDescriptionMixin ~apstools.devices.motor_mixins.EpicsMotorDialMixin ~apstools.devices.motor_mixins.EpicsMotorEnableMixin ~apstools.devices.motor_mixins.EpicsMotorRawMixin ~apstools.devices.motor_mixins.EpicsMotorResolutionMixin ~apstools.devices.motor_mixins.EpicsMotorServoMixin ~apstools.devices.positioner_soft_done.PVPositionerSoftDone ~apstools.devices.positioner_soft_done.PVPositionerSoftDoneWithStop ~apstools.devices.shutters.EpicsMotorShutter ~apstools.devices.shutters.EpicsOnOffShutter ~apstools.devices.simulated_controllers.SimulatedSwaitControllerPositioner ~apstools.devices.simulated_controllers.SimulatedTransformControllerPositioner .. _devices.shutters: Shutters ++++++++ .. autosummary:: ~apstools.devices.shutters.ApsPssShutter ~apstools.devices.shutters.ApsPssShutterWithStatus ~apstools.devices.shutters.EpicsMotorShutter ~apstools.devices.shutters.EpicsOnOffShutter ~apstools.devices.shutters.OneSignalShutter ~apstools.devices.shutters.ShutterBase ~apstools.devices.shutters.SimulatedApsPssShutterWithStatus .. _devices.slits: Slits ++++++++ .. autosummary:: ~apstools.devices.hhl_slits.HHLSlits ~apstools.devices.xia_slit.XiaSlit2D ~apstools.synApps.db_2slit.Optics2Slit1D ~apstools.synApps.db_2slit.Optics2Slit2D_HV ~apstools.synApps.db_2slit.Optics2Slit2D_InbOutBotTop ~apstools.utils.slit_core.SlitGeometry synApps Support ++++++++++++++++++++ See separate :ref:`synApps` section. .. _devices.temperature_controllers: Temperature Support +++++++++++++++++++++++ Controllers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: ~apstools.devices.eurotherm_2216e.Eurotherm2216e ~apstools.devices.lakeshore_controllers.LakeShore336Device ~apstools.devices.lakeshore_controllers.LakeShore340Device ~apstools.devices.linkam_controllers.Linkam_CI94_Device ~apstools.devices.linkam_controllers.Linkam_T96_Device ~apstools.devices.ptc10_controller.PTC10AioChannel ~apstools.devices.ptc10_controller.PTC10RtdChannel ~apstools.devices.ptc10_controller.PTC10TcChannel ~apstools.devices.ptc10_controller.PTC10PositionerMixin ~apstools.devices.simulated_controllers.SimulatedSwaitControllerPositioner ~apstools.devices.simulated_controllers.SimulatedTransformControllerPositioner Readers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: ~apstools.devices.measComp_tc32_support.MeasCompTc32 .. _devices.other_support: Other Support +++++++++++++ .. autosummary:: ~apstools.devices.aps_bss_user.ApsBssUserInfoDevice ~apstools.devices.aps_data_management.DM_WorkflowConnector ~apstools.devices.xia_pf4.Pf4FilterSingle ~apstools.devices.xia_pf4.Pf4FilterDual ~apstools.devices.xia_pf4.Pf4FilterTriple ~apstools.devices.xia_pf4.Pf4FilterBank ~apstools.devices.xia_pf4.Pf4FilterCommon ~apstools.devices.xia_pf4.DualPf4FilterBox ~apstools.devices.description_mixin.EpicsDescriptionMixin ~apstools.devices.dict_device_support.dict_device_factory ~apstools.devices.dict_device_support.make_dict_device ~apstools.devices.epics_scan_id_signal.EpicsScanIdSignal ~apstools.devices.measComp_usb_ctr_support.MeasCompCtr ~apstools.devices.kohzu_monochromator.KohzuSeqCtl_Monochromator ~apstools.devices.simulated_controllers.SimulatedSwaitControllerPositioner ~apstools.devices.simulated_controllers.SimulatedTransformControllerPositioner ~apstools.devices.srs570_preamplifier.SRS570_PreAmplifier ~apstools.devices.struck3820.Struck3820 ~apstools.devices.delay.DG645Delay ~apstools.devices.labjack.LabJackBase ~apstools.devices.labjack.LabJackT4 ~apstools.devices.labjack.LabJackT7 ~apstools.devices.labjack.LabJackT7Pro ~apstools.devices.labjack.LabJackT8 .. issue #763 ~apstools.devices.flyer_motor_scaler.SignalValueStack Internal Routines +++++++++++++++++ .. autosummary:: ~apstools.devices.aps_machine.ApsOperatorMessagesDevice ~apstools.devices.tracking_signal.TrackingSignal ~apstools.devices.mixin_base.DeviceMixinBase All Submodules -------------- .. automodule:: apstools.devices.aps_bss_user :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.aps_cycle :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.aps_data_management :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.aps_machine :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.aps_undulator :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.area_detector_factory :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.area_detector_support :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.axis_tuner :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.delay :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.description_mixin :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.dict_device_support :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.epics_scan_id_signal :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.eurotherm_2216e :members: :private-members: :show-inheritance: :inherited-members: .. issue #763 .. automodule apstools.devices.flyer_motor_scaler :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.hhl_slits :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.kohzu_monochromator :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.labjack :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.lakeshore_controllers :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.linkam_controllers :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.measComp_tc32_support :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.measComp_usb_ctr_support :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.mixin_base :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.motor_mixins :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.positioner_soft_done :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.preamp_base :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.ptc10_controller :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.scaler_support :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.shutters :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.simulated_controllers :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.srs570_preamplifier :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.struck3820 :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.synth_pseudo_voigt :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.tracking_signal :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.xia_pf4 :members: :private-members: :show-inheritance: :inherited-members: .. automodule:: apstools.devices.xia_slit :members: :private-members: :show-inheritance: :inherited-members: