Add j120k flowswitch, insert flow switch in appropriate classes.

docs/source/upcoming_release_notes/1189-flow-switch.rst

@@ -0,0 +1,32 @@
+1189 flow-switch
+#################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- pcdsdevices now has a `digital_signals` module for simple digital io.
+
+Device Updates
+--------------
+- added `J120K` to `SxrTestAbsorber`, `XPIM`, `IM2K0`, `PowerSlits`
+
+New Devices
+-----------
+- `PPMCoolSwitch` ppms with cooling switch not a meter.
+- `WaveFrontSensorTargetCool` WaveFrontSensors with a cooling switch.
+- `J120K` a device class for a cooling switch.
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- N/A
+
+Contributors
+------------
+- nrwslac

pcdsdevices/digital_signals.py

@@ -0,0 +1,20 @@
+from ophyd import Component as Cpt
+from ophyd import Device
+
+from .interface import BaseInterface
+from .signal import PytmcSignal
+
+
+class J120K(BaseInterface, Device):
+    """
+    A class representing the J120K 24V dry contact cooling flow switch.
+    """
+    flow_ok = Cpt(PytmcSignal, ':FSW:FLOW_OK', io='i',
+                  kind='normal', doc='flow rate nominal')
+
+    @property
+    def get_flow_ok(self):
+        """
+        returns True if flow rate is nominal
+        """
+        return bool(self.flow_ok.get())

pcdsdevices/pim.py

@@ -20,6 +20,7 @@
                                      PCDSAreaDetectorTyphosTrigger)
 from .device import GroupDevice
 from .device import UpdateComponent as UpCpt
+from .digital_signals import J120K
 from .epics_motor import IMS, BeckhoffAxisNoOffset
 from .inout import InOutRecordPositioner
 from .interface import BaseInterface, LightpathInOutCptMixin
@@ -541,6 +542,8 @@ class XPIM(LCLS2ImagerBase):
     filter_wheel = Cpt(XPIMFilterWheel, ':MFW', kind='config',
                        doc='Optical filter wheel in front of the camera '
                            'to prevent saturation.')
+    flow_switch = Cpt(J120K, '', kind='normal',
+                      doc='Device that indicates nominal PCW Flow Rate.')
 
     set_metadata(zoom_lock, dict(variety='command-enum'))
     set_metadata(focus_lock, dict(variety='command-enum'))
@@ -557,6 +560,8 @@ class IM2K0(LCLS2ImagerBase):
     # XPIM illuminator
     led = Cpt(XPIMLED, ':CIL', kind='config',
               doc='LED for viewing the reticle.')
+    flow_switch = Cpt(J120K, '', kind='normal',
+                      doc='Device that indicates nominal PCW Flow Rate.')
     # Nothing else! No power meter, no zoom/focus, no filter wheel...
 
 
@@ -580,3 +585,11 @@ class PPMCOOL(PPM):
     """
     flow_meter = Cpt(FDQ, '', kind='normal',
                      doc='Device that measures PCW Flow Rate.')
+
+
+class PPMCoolSwitch(PPM):
+    """
+    L2SI's Power and Profile Monitor design with cooling switch.
+    """
+    flow_switch = Cpt(J120K, '', kind='normal',
+                      doc='Device that indicates nominal PCW Flow Rate.')

pcdsdevices/slits.py

@@ -29,12 +29,13 @@
 from .areadetector.detectors import PCDSAreaDetectorTyphosTrigger
 from .device import GroupDevice
 from .device import UpdateComponent as UpCpt
+from .digital_signals import J120K
 from .epics_motor import BeckhoffAxis, BeckhoffAxisNoOffset, PCDSMotorBase
 from .interface import (BaseInterface, FltMvInterface, LightpathInOutCptMixin,
                         LightpathMixin, MvInterface)
 from .pmps import TwinCATStatePMPS
 from .sensors import RTD, TwinCATTempSensor
-from .signal import NotImplementedSignal, PytmcSignal
+from .signal import PytmcSignal
 from .sim import FastMotor
 from .utils import get_status_float, get_status_value, schedule_task
 from .variety import set_metadata
@@ -622,7 +623,8 @@ class PowerSlits(BeckhoffSlits):
     """
 
     rtds = DDCpt(_rtd_fields(RTD, 'rtd', range(1, 9)))
-    fsw = Cpt(NotImplementedSignal, ':FSW', kind='normal')
+    flow_switch = Cpt(J120K, '', kind='normal',
+                      doc='Device that indicates nominal PCW Flow Rate.')
 
 
 class ExitSlitTarget(TwinCATStatePMPS):

pcdsdevices/sxr_test_absorber.py

@@ -7,6 +7,7 @@
 
 from ophyd.device import Component as Cpt
 
+from .digital_signals import J120K
 from .epics_motor import BeckhoffAxisNoOffset
 from .inout import TwinCATInOutPositioner
 from .interface import BaseInterface, LightpathInOutCptMixin
@@ -59,5 +60,7 @@ class SxrTestAbsorber(BaseInterface, LightpathInOutCptMixin):
 
     state = Cpt(SxrTestAbsorberStates, ':MMS:STATE', kind='hinted')
     absorber_vert = Cpt(BeckhoffAxisNoOffset, ':MMS:01', kind='normal')
+    flow_switch = Cpt(J120K, '', kind='normal',
+                      doc='Device that indicates nominal PCW Flow Rate.')
 
     lightpath_cpts = ['state']

pcdsdevices/wfs.py

@@ -2,6 +2,7 @@
 
 from .device import GroupDevice
 from .device import UpdateComponent as UpCpt
+from .digital_signals import J120K
 from .epics_motor import BeckhoffAxisNoOffset
 from .interface import BaseInterface, LightpathInOutCptMixin
 from .pmps import TwinCATStatePMPS
@@ -43,3 +44,13 @@ class WaveFrontSensorTarget(BaseInterface, GroupDevice,
                         doc='First thermocouple.')
     thermocouple2 = Cpt(TwinCATTempSensor, ':STC:02', kind='normal',
                         doc='Second thermocouple.')
+
+
+class WaveFrontSensorTargetCool(WaveFrontSensorTarget):
+    """
+    An array of targets used to determine the beam's wavefront.
+
+    This array has a cooling indication switch.
+    """
+    flow_switch = Cpt(J120K, '', kind='normal',
+                      doc='Device that indicates nominal PCW Flow Rate.')