Merge pull request #243 from BCDA-APS/239-transform

add transform record support

apstools/synApps_ophyd/transform.py

@@ -0,0 +1,159 @@
+
+"""
+Ophyd support for the EPICS transform record
+
+
+Public Structures
+
+.. autosummary::
+   
+    ~UserTransformsDevice
+    ~TransformRecord
+"""
+
+#-----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2019, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+#-----------------------------------------------------------------------------
+
+from collections import OrderedDict
+from ophyd.device import (
+    Device,
+    Component as Cpt,
+    DynamicDeviceComponent as DDC,
+    FormattedComponent as FC)
+from ophyd import EpicsSignal, EpicsSignalRO
+
+from ._common import EpicsRecordDeviceCommonAll
+from .. import utils as APS_utils
+
+
+__all__ = [
+    "TransformRecord",
+    "UserTransformsDevice",
+    ]
+
+
+CHANNEL_LETTERS_LIST = "A B C D E F G H I J K L M N O P".split()
+
+
+class transformRecordChannel(Device):
+    """
+    channel of a synApps transform record: A-P
+
+	.. autosummary::
+	   
+		~reset
+    """
+    current_value = FC(EpicsSignal,         '{self.prefix}.{self._ch_letter}')
+    last_value = FC(EpicsSignalRO,          '{self.prefix}.L{self._ch_letter}')
+    input_pv = FC(EpicsSignal,              '{self.prefix}.INP{self._ch_letter}')
+    input_pv_valid = FC(EpicsSignalRO,      '{self.prefix}.I{self._ch_letter}V')
+    expression_invalid = FC(EpicsSignalRO,  '{self.prefix}.C{self._ch_letter}V')
+    comment = FC(EpicsSignal,               '{self.prefix}.CMT{self._ch_letter}')
+    expression = FC(EpicsSignal,            '{self.prefix}.CLC{self._ch_letter}')
+    output_pv = FC(EpicsSignal,             '{self.prefix}.OUT{self._ch_letter}')
+    output_pv_valid = FC(EpicsSignalRO,     '{self.prefix}.O{self._ch_letter}V')
+
+    read_attrs = ["current_value"]
+
+    def __init__(self, prefix, letter, **kwargs):
+        self._ch_letter = letter
+        super().__init__(prefix, **kwargs)
+
+    def reset(self):
+        """set all fields to default values"""
+        self.comment.put(self._ch_letter.lower())
+        self.input_pv.put("")
+        self.expression.put("")
+        self.current_value.put(0)
+        self.output_pv.put("")
+
+
+def _channels(channel_list):
+    defn = OrderedDict()
+    for chan in channel_list:
+        defn[chan] = (transformRecordChannel, '', {'letter': chan})
+    return defn
+
+
+class TransformRecord(EpicsRecordDeviceCommonAll):
+    """
+    EPICS transform record support in ophyd
+
+	.. autosummary::
+	   
+		~reset
+    
+    :see: https://htmlpreview.github.io/?https://raw.githubusercontent.com/epics-modules/calc/R3-6-1/documentation/TransformRecord.html#Fields
+    """
+    units = Cpt(EpicsSignal, ".EGU")
+    precision = Cpt(EpicsSignal, ".PREC")
+    version = Cpt(EpicsSignalRO, ".VERS")
+
+    calc_option = Cpt(EpicsSignal, ".COPT")
+    invalid_link_action = Cpt(EpicsSignalRO, ".IVLA")
+    input_bitmap = Cpt(EpicsSignalRO, ".MAP")
+
+    read_attrs = APS_utils.itemizer("channels.%s", CHANNEL_LETTERS_LIST)
+    hints = {'fields': read_attrs}
+
+    channels = DDC(_channels(CHANNEL_LETTERS_LIST))
+
+    def reset(self):
+        """set all fields to default values"""
+        self.scanning_rate.put("Passive")
+        self.description.put(self.description.pvname.split(".")[0])
+        self.units.put("")
+        self.calc_option.put(0)
+        self.precision.put("3")
+        self.forward_link.put("")
+        for letter in self.channels.read_attrs:
+            channel = getattr(self.channels, letter)
+            if isinstance(channel, transformRecordChannel):
+                channel.reset()
+        self.hints = {'fields': ["channels.%s" % c for c in CHANNEL_LETTERS_LIST]}
+        self.read_attrs = ["channels.%s" % c for c in CHANNEL_LETTERS_LIST]
+
+
+class UserTransformsDevice(Device):
+    """
+    synApps XXX IOC setup of userTransforms: $(P):userTran$(N)
+
+    .. autosummary::
+       
+        ~reset
+
+    """
+
+    enable = Cpt(EpicsSignal, 'userTranEnable')
+    transform1 = Cpt(TransformRecord, 'userTran1')
+    transform2 = Cpt(TransformRecord, 'userTran2')
+    transform3 = Cpt(TransformRecord, 'userTran3')
+    transform4 = Cpt(TransformRecord, 'userTran4')
+    transform5 = Cpt(TransformRecord, 'userTran5')
+    transform6 = Cpt(TransformRecord, 'userTran6')
+    transform7 = Cpt(TransformRecord, 'userTran7')
+    transform8 = Cpt(TransformRecord, 'userTran8')
+    transform9 = Cpt(TransformRecord, 'userTran9')
+    transform10 = Cpt(TransformRecord, 'userTran10')
+
+    def reset(self):
+        """set all fields to default values"""
+        self.transform1.reset()
+        self.transform2.reset()
+        self.transform3.reset()
+        self.transform4.reset()
+        self.transform5.reset()
+        self.transform6.reset()
+        self.transform7.reset()
+        self.transform8.reset()
+        self.transform9.reset()
+        self.transform10.reset()
+        self.read_attrs = ["transform%d" % (c+1) for c in range(10)]
+        self.read_attrs.insert(0, "enable")

docs/source/source/synApps/_transform.rst

@@ -0,0 +1,10 @@
+
+synApps transform record
+-------------------------
+
+The ``transform`` record is part of the ``calc`` module:
+    :see: https://htmlpreview.github.io/?https://raw.githubusercontent.com/epics-modules/calc/R3-6-1/documentation/TransformRecord.html#Fields
+
+.. automodule:: apstools.synApps_ophyd.transform
+    :members: 
+