DOC #567

apstools/devices/tests/test_xia_slit.py

@@ -0,0 +1,35 @@
+from ..xia_slit import XiaSlitController
+# from ...utils import SlitGeometry
+
+import pytest
+
+IOC = "gp:"
+
+# Full testing requires two XIA Slit controllers (a 2D H & V set)
+# We don't have that for unit testing.  Proceed with best efforts.
+
+
+def test_XiaSlit(capsys):
+    slit1 = XiaSlitController("gp:hsc1:", name="slit1")
+    assert slit1 is not None
+
+    # slit1.wait_for_connection()
+    assert not slit1.connected
+    cns = """
+        inb out bot top
+        hsize vsize hcenter vcenter
+        hID horientation hbusy
+        vID vorientation vbusy
+        enable
+        error_code error_message message1 message2 message3
+        calibrate initialize locate stop_button
+        precision
+    """.split()
+    assert slit1.component_names == tuple(cns)
+
+    with pytest.raises(TypeError):
+        print(slit1.geometry)
+
+    captured = capsys.readouterr()
+    assert captured.out.split("\n") == [""]
+    assert captured.err.split("\n") == [""]

apstools/synApps/db_2slit.py

@@ -128,3 +128,14 @@ def geometry(self):
         ]
 
         return SlitGeometry(*pppp)
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, 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.
+# -----------------------------------------------------------------------------

docs/source/api/_devices.rst

@@ -86,6 +86,18 @@ Shutters
     ~apstools.devices.shutters.ShutterBase
     ~apstools.devices.shutters.SimulatedApsPssShutterWithStatus
 
+.. _devices.slits:
+
+Slits
+++++++++
+
+.. autosummary::
+
+    ~apstools.synApps.db_2slit.Optics2Slit1D
+    ~apstools.synApps.db_2slit.Optics2Slit2D_HV
+    ~apstools.synApps.db_2slit.Optics2Slit2D_InbOutBotTop
+    ~apstools.devices.xia_slit.XiaSlitController
+
 synApps Support
 ++++++++++++++++++++