From 35e4ea0916be87b490940e393ac53040f6b8599e Mon Sep 17 00:00:00 2001 From: ci_update_bot Date: Thu, 16 May 2024 15:23:14 +0000 Subject: [PATCH] docs: Update device list --- csaxs_bec/devices/device_list.md | 37 ++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 csaxs_bec/devices/device_list.md diff --git a/csaxs_bec/devices/device_list.md b/csaxs_bec/devices/device_list.md new file mode 100644 index 0000000..3d058e8 --- /dev/null +++ b/csaxs_bec/devices/device_list.md @@ -0,0 +1,37 @@ +// This file was autogenerated. Do not edit it manually. +## Device List +### Ophyd Devices (gitlab.psi.ch/bec/ophyd_devices) +| Device | Documentation | Module | +| :----- | :------------- | :------ | +| InsertionDevice | Python wrapper for the CSAXS insertion device control

This wrapper provides a positioner interface for the ID control.
is completely custom XBPM with templates directly in the
VME repo. Thus it needs a custom ophyd template as well...

WARN: The x and y are not updated by the IOC
| InsertionDevice | +| XbpmBase | Python wrapper for X-ray Beam Position Monitors

XBPM's consist of a metal-coated diamond window that ejects
photoelectrons from the incoming X-ray beam. These electons
are collected and their current is measured. Effectively
they act as four quadrant photodiodes and are used as BPMs
at the undulator beamlines of SLS.

Note: EPICS provided signals are read only, but the user can
change the beam position offset.
| XbpmBase | +| XbpmCsaxsOp | Python wrapper for custom XBPMs in the cSAXS optics hutch

This is completely custom XBPM with templates directly in the
VME repo. Thus it needs a custom ophyd template as well...

WARN: The x and y are not updated by the IOC
| XbpmBase | +| XbpmSim | Python wrapper for simulated X-ray Beam Position Monitors

XBPM's consist of a metal-coated diamond window that ejects
photoelectrons from the incoming X-ray beam. These electons
are collected and their current is measured. Effectively
they act as four quadrant photodiodes and are used as BPMs
at the undulator beamlines of SLS.

Note: EPICS provided signals are read only, but the user can
change the beam position offset.

This simulation device extends the basic proxy with a script that
fills signals with quasi-randomized values.
| XbpmBase | +| DelayGeneratorcSAXS |
DG645 delay generator at cSAXS (multiple can be in use depending on the setup)

Default values for setting up DDG.
Note: checks of set calues are not (only partially) included, check manual for details on possible settings.
https://www.thinksrs.com/downloads/pdfs/manuals/DG645m.pdf

- delay_burst : (float >=0) Delay between trigger and first pulse in burst mode
- delta_width : (float >= 0) Add width to fast shutter signal to make sure its open during acquisition
- additional_triggers : (int) add additional triggers to burst mode (mcs card needs +1 triggers per line)
- polarity : (list of 0/1) polarity for different channels
- amplitude : (float) amplitude voltage of TTLs
- offset : (float) offset for ampltitude
- thres_trig_level : (float) threshold of trigger amplitude

Custom signals for logic in different DDGs during scans (for custom_prepare.prepare_ddg):

- set_high_on_exposure : (bool): if True, then TTL signal should go high during the full acquisition time of a scan.
# TODO trigger_width and fixed_ttl could be combined into single list.
- fixed_ttl_width : (list of either 1 or 0), one for each channel.
- trigger_width : (float) if fixed_ttl_width is True, then the width of the TTL pulse is set to this value.
- set_trigger_source : (TriggerSource) specifies the default trigger source for the DDG.
- premove_trigger : (bool) if True, then a trigger should be executed before the scan starts (to be implemented in on_pre_scan).
- set_high_on_stage : (bool) if True, then TTL signal should go high already on stage.
| delay_generator_csaxs | +| Eiger9McSAXS |
Eiger9M detector for CSAXS

Parent class: PSIDetectorBase

class attributes:
custom_prepare_cls (FalconSetup) : Custom detector setup class for cSAXS,
inherits from CustomDetectorMixin
PSIDetectorBase.set_min_readout (float) : Minimum readout time for the detector
Various EpicsPVs for controlling the detector
| eiger9m_csaxs | +| SLSDetectorCam | SLS Detector Camera - Pilatus

Base class to map EPICS PVs to ophyd signals.
| pilatus_csaxs | +| EpicsDXPFalcon |
DXP parameters for Falcon detector

Base class to map EPICS PVs from DXP parameters to ophyd signals.
| falcon_csaxs | +| FalconHDF5Plugins |
HDF5 parameters for Falcon detector

Base class to map EPICS PVs from HDF5 Plugin to ophyd signals.
| falcon_csaxs | +| FalconcSAXS |
Falcon Sitoro detector for CSAXS

Parent class: PSIDetectorBase

class attributes:
custom_prepare_cls (FalconSetup) : Custom detector setup class for cSAXS,
inherits from CustomDetectorMixin
PSIDetectorBase.set_min_readout (float) : Minimum readout time for the detector
dxp (EpicsDXPFalcon) : DXP parameters for Falcon detector
mca (EpicsMCARecord) : MCA parameters for Falcon detector
hdf5 (FalconHDF5Plugins) : HDF5 parameters for Falcon detector
MIN_READOUT (float) : Minimum readout time for the detector
| falcon_csaxs | +| FlomniSampleStorage | | flomni_sample_storage | +| MCScSAXS | MCS card for cSAXS for implementation at cSAXS beamline | mcs_csaxs | +| SIS38XX | SIS38XX card for access to EPICs PVs at cSAXS beamline | mcs_csaxs | +| OMNYSampleStorage | | omny_sample_storage | +| PilatuscSAXS | Pilatus_2 300k detector for CSAXS

Parent class: PSIDetectorBase

class attributes:
custom_prepare_cls (Eiger9MSetup) : Custom detector setup class for cSAXS,
inherits from CustomDetectorMixin
cam (SLSDetectorCam) : Detector camera
MIN_READOUT (float) : Minimum readout time for the detector

| pilatus_csaxs | +| Bpm4i | | specMotors | +| GirderMotorPITCH | Girder YAW pseudo motor | specMotors | +| GirderMotorROLL | Girder ROLL pseudo motor | specMotors | +| GirderMotorX1 | Girder X translation pseudo motor | specMotors | +| GirderMotorY1 | Girder Y translation pseudo motor | specMotors | +| GirderMotorYAW | Girder YAW pseudo motor | specMotors | +| PmDetectorRotation | Detector rotation pseudo motor

Small wrapper to convert detector pusher position to rotation angle.
| specMotors | +| PmMonoBender | Monochromator bender

Small wrapper to combine the four monochromator bender motors.
| specMotors | +| Xeye | | xeye | +| SmaractMotor | | smaract_ophyd | +| Eiger1p5MDetector | | eiger1p5m | +| FlomniGalilMotor | | fgalil_ophyd | +| FuprGalilMotor | | fupr_ophyd | +| LamniGalilMotor | | lgalil_ophyd | +| SGalilMotor | "SGalil Motors at cSAXS have a
DC motor (y axis - vertical) - implemented as C
and a step motor (x-axis horizontal) - implemented as E
that require different communication for control
| sgalil_ophyd | +| RtFlomniMotor | | rt_flomni_ophyd | +| RtLamniMotor | | rt_lamni_ophyd |