ENH: New devices

.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
         exclude: '^(conda-recipe/meta.yaml)$'
     -   id: debug-statements
 
--   repo: https://gitlab.com/pycqa/flake8
+-   repo: https://gitlab.com/pycqa/flake8.git
     rev: 3.7.9
     hooks:
     -   id: flake8

docs/source/api.rst

@@ -14,9 +14,11 @@ Full API
    ~pcdsdevices.epics_motor
    ~pcdsdevices.evr
    ~pcdsdevices.gauge
+   ~pcdsdevices.gon
    ~pcdsdevices.inout
    ~pcdsdevices.interface
    ~pcdsdevices.ipm
+   ~pcdsdevices.jet
    ~pcdsdevices.lens
    ~pcdsdevices.lodcm
    ~pcdsdevices.mirror
@@ -33,5 +35,6 @@ Full API
    ~pcdsdevices.sim
    ~pcdsdevices.slits
    ~pcdsdevices.state
+   ~pcdsdevices.timetool
    ~pcdsdevices.utils
    ~pcdsdevices.valve

docs/source/epics_types.rst

@@ -9,12 +9,14 @@ Common EPICS Devices
     Attenuator
     Acromag
     BeckhoffAxis
+    BeckhoffJet
     CCM
     DelayNewport
     EpicsMotor
     EventSequencer
     GateValve
     GaugeSet
+    Goniometer
     IMS
     IPM
     IonPump
@@ -28,11 +30,14 @@ Common EPICS Devices
     PMC100
     PointingMirror
     PPM
+    Prefocus
     PulsePicker
     Reflaser
     Slits
     Stopper
+    Timetool
     Trigger
     TTReflaser
+    VonHamos4Crystal
     XFLS
     XPIM

pcdsdevices/analog_signals.py

@@ -14,10 +14,10 @@ class Acromag(Device, BaseInterface):
 
     Parameters:
     -----------
-    prefix : str
+    prefix : ``str``
         The Epics base of the acromag
 
-    name : str
+    name : ``str``
         A name to prefer to the device
     """
     # Components for each channel
@@ -67,18 +67,18 @@ class Mesh(Device, BaseInterface):
 
     Parameters
     ----------
-    prefix : str
+    prefix : ``str``
         Prefix of Acromag to be used
 
-    sp_ch : int
+    sp_ch : ``int``
         Setpoint Acromag channel to which high voltage supply setpoint
         is connected. Range is 0 to 15
 
-    rb_ch : int
+    rb_ch : ``int``
         Read back Acromag channel to which high voltage readback is
         connected. Range is 0 to 15
 
-    scale : float, optional
+    scale : ``float``, optional
         Gain for high voltage supply to be controlled by the Acromag
 
     """
@@ -115,16 +115,16 @@ def set_mesh_voltage(self, hv_sp, wait=True):
 
         Parameters
         ----------
-        hv_sp : float
+        hv_sp : ``float``
             Desired power supply setpoint in V. Acromag will output
             necessary voltage such that the HV supply achieves the value
             passed to hv_sp
 
-        wait : bool, optional
+        wait : ``bool``, optional
             Indicates whether or not the program should pause when writing
             to a PV
 
-        do_print : bool, optional
+        do_print : ``bool``, optional
             Indicates whether or not the program should print it's
             setpoint and readback values
         """
@@ -144,7 +144,7 @@ def set_rel_mesh_voltage(self, delta_hv_sp, wait=True):
 
         Parameters
         ----------
-        delta_hv_sp : float
+        delta_hv_sp : ``float``
             Amount to increase/decrease the power supply setpoint (in V)
             from its current value. Use positive to increase and negative
             to decrease
@@ -162,15 +162,15 @@ def tweak_mesh_voltage(self, delta_hv_sp, test_flag=False):
 
         Parameters
         ----------
-        delta_hv_sp : float (V)
+        delta_hv_sp : ``float`` (V)
             Amount to change voltage from its current value at each step.
             After calling with specified step size, use arrow keys to keep
             changing. Use absolute value of increment size.
 
         ^C :
             exits tweak mode
 
-        test_flag : bool, opt
+        test_flag : ``bool``, opt
             flag used in testing functions to only run `while True` loop
             once - i.e single tweak mode
         """

pcdsdevices/device_types.py

@@ -2,20 +2,29 @@
 from .analog_signals import Acromag
 from .areadetector.detectors import PCDSAreaDetector
 from .attenuator import Attenuator
+from .beam_stats import BeamStats, SxrGmd
 from .ccm import CCM
+from .dc_devices import ICT
 from .epics_motor import (IMS, PMC100, BeckhoffAxis, DelayNewport, EpicsMotor,
                           Motor, Newport)
 from .evr import Trigger
 from .gauge import GaugeSet
+from .gon import BaseGon, Goniometer, GonWithDetArm, Kappa, SamPhi, XYZStage
 from .inout import Reflaser, TTReflaser
-from .ipm import IPM
-from .lens import XFLS
+from .ipm import IPM, IPM_IPIMB, IPM_Wave8
+from .jet import BeckhoffJet
+from .lens import XFLS, Prefocus
 from .lodcm import LODCM
 from .mirror import OffsetMirror, PointingMirror
 from .movablestand import MovableStand
-from .pim import PIM, PPM, XPIM
+from .mps import MPS
+from .pim import PIM, PPM, XPIM, PIMWithBoth, PIMWithFocus, PIMWithLED
+from .pseudopos import DelayBase
 from .pulsepicker import PulsePicker
 from .pump import IonPump
+from .sensors import RTD, TwinCATThermocouple
 from .sequencer import EventSequencer
 from .slits import Slits
+from .spectrometer import Kmono, VonHamos4Crystal
+from .timetool import TimeTool, TimeToolWithNav
 from .valve import GateValve, Stopper

pcdsdevices/doc_stubs.py

@@ -11,7 +11,7 @@
     settle_time: ``float``, optional
         The amount of extra time to wait before interpreting a move as done
 
-    timeout ``float``, optional
+    timeout: ``float``, optional
         The amount of time to wait before automatically marking a long
         in-progress move as failed.