Merge pull request #1274 from c-tsoi/hxr_diff

Adding base class for HxrDiffractometer

docs/source/upcoming_release_notes/1274-Adding_base_class_for_hxr_diffractometer..rst

@@ -0,0 +1,30 @@
+1274 Adding base class for hxr diffractometer.
+#################
+
+API Breaks
+----------
+- N/A
+
+Library Features
+----------------
+- N/A
+
+Device Features
+---------------
+- N/A
+
+New Devices
+-----------
+- Adding base class for hxr diffractometer, this class needs the base prefix to be passed in e.g. HXR:GON:MMS. The stage suffixes are hardcoded.
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- N/A
+
+Contributors
+------------
+- c-tsoi

pcdsdevices/gon.py

@@ -4,13 +4,14 @@
 import logging
 
 import numpy as np
+from ophyd import Device
 from ophyd import FormattedComponent as FCpt
 from ophyd.device import Component as Cpt
 from ophyd.status import DeviceStatus
 from prettytable import PrettyTable
 
 from .device import GroupDevice
-from .epics_motor import IMS
+from .epics_motor import IMS, BeckhoffAxis
 from .interface import BaseInterface
 from .pseudopos import (PseudoPositioner, PseudoSingleInterface,
                         pseudo_position_argument, real_position_argument)
@@ -657,6 +658,31 @@ def format_status_info(self, status_info):
 """
 
 
+class HxrDiffractometer(BaseInterface, Device):
+    """
+    Class for diffractometer.
+
+    Parameters
+    ----------
+    name : str
+        A name to refer to the device
+
+    prefix_base : str
+        The EPICS base PV of the diffractometer stages
+    """
+
+    base_h = Cpt(BeckhoffAxis, 'BASE_H', kind='normal')
+    base_v = Cpt(BeckhoffAxis, 'BASE_V', kind='normal')
+    th = Cpt(BeckhoffAxis, 'TH', kind='normal')
+    tth = Cpt(BeckhoffAxis, 'TTH', kind='normal')
+    chi = Cpt(BeckhoffAxis, 'CHI', kind='normal')
+
+    tab_component_names = True
+
+    def __init__(self, prefix, name, **kwargs):
+        super().__init__(prefix, name=name, **kwargs)
+
+
 class SimSampleStage(KappaXYZStage):
     x = Cpt(FastMotor, limits=(-100, 100))
     y = Cpt(FastMotor, limits=(-100, 100))