bec/ophyd_devices
0
0
Fork 0
mirror of https://github.com/bec-project/ophyd_devices.git synced 2025-06-24 11:41:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat: add docstring to detector base class; closes #12

Browse Source
This commit is contained in:
appel_c
2023-11-13 15:13:01 +01:00
parent 79cfaf6dc0
commit 225277949d
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
ophyd_devices/epics/devices/sls_detector_baseclass.py
View File

@ -53,6 +53,23 @@ class TriggerSource(enum.IntEnum):
class SLSDetectorBase(ABC, Device): class SLSDetectorBase(ABC, Device):
""" """
Abstract base class for SLS detectors Abstract base class for SLS detectors
Args:
prefix (str): EPICS PV prefix for component (optional)
name (str): name of the device, as will be reported via read()
kind (str): member of class 'ophydobj.Kind', defaults to Kind.normal
omitted -> readout ignored for read 'ophydobj.read()'
normal -> readout for read
config -> config parameter for 'ophydobj.read_configuration()'
hinted -> which attribute is readout for read
read_attrs (list): sequence of attribute names to read
configuration_attrs (list): sequence of attribute names via config_parameters
parent (object): instance of the parent device
device_manager (object): bec device manager
sim_mode (bool): simulation mode, if True, no device manager is required
**kwargs: keyword arguments
attributes: lazy_wait_for_connection : bool
""" """
def __init____init__( def __init____init__(