Merge pull request #868 from lsst-ts/tickets/DM-43456

Initial addition of reflector
lsst-ts · Jul 9, 2024 · e2a97b8 · e2a97b8
2 parents e4709f3 + bd1177f
commit e2a97b8
Show file tree

Hide file tree

Showing 8 changed files with 94 additions and 0 deletions.
diff --git a/doc/news/interface_changes/DM-43456.mtreflector.rst b/doc/news/interface_changes/DM-43456.mtreflector.rst
@@ -0,0 +1 @@
+Adding MTReflector xml which allows opening and closing the flatfield reflector
diff --git a/python/lsst/ts/xml/data/sal_interfaces/MTReflector/MTReflector_Commands.xml b/python/lsst/ts/xml/data/sal_interfaces/MTReflector/MTReflector_Commands.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?xml-stylesheet type="text/xsl" href="http://lsst-sal.tuc.noao.edu/schema/SALCommandSet.xsl"?>
+<SALCommandSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://lsst-sal.tuc.noao.edu/schema/SALCommandSet.xsd">
+  <SALCommand>
+    <Subsystem>MTReflector</Subsystem>
+    <EFDB_Topic>MTReflector_command_open</EFDB_Topic>
+    <Description>Open reflector</Description>
+  </SALCommand>
+  <SALCommand>
+    <Subsystem>MTReflector</Subsystem>
+    <EFDB_Topic>MTReflector_command_close</EFDB_Topic>
+    <Description>Close reflector</Description>
+  </SALCommand>
+</SALCommandSet>
diff --git a/python/lsst/ts/xml/data/sal_interfaces/MTReflector/MTReflector_Events.xml b/python/lsst/ts/xml/data/sal_interfaces/MTReflector/MTReflector_Events.xml
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?xml-stylesheet type="text/xsl" href="http://lsst-sal.tuc.noao.edu/schema/SALEventSet.xsl"?>
+<SALEventSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://lsst-sal.tuc.noao.edu/schema/SALEventSet.xsd">
+  <Enumeration>
+    MTReflectorStatus_Connected=0,
+    MTReflectorStatus_Disconnected=1,
+    MTReflectorStatus_Open=2,
+    MTReflectorStatus_Close=3,
+    MTReflectorStatus_Unknown=4,
+    MTReflectorStatus_Connection_Error=5
+  </Enumeration>
+  <SALEvent>
+    <Subsystem>MTReflector</Subsystem>
+    <EFDB_Topic>MTReflector_logevent_reflectorStatus</EFDB_Topic>
+    <Description>MTReflector state change</Description>
+    <item>
+      <EFDB_Name>reflectorStatus</EFDB_Name>
+      <Description>MTReflector state; a ReflectorStatus enum.</Description>
+      <IDL_Type>int</IDL_Type>
+      <Units>unitless</Units>
+      <Count>1</Count>
+    </item>
+  </SALEvent>
+</SALEventSet>
diff --git a/python/lsst/ts/xml/data/sal_interfaces/SALSubsystems.xml b/python/lsst/ts/xml/data/sal_interfaces/SALSubsystems.xml
@@ -37,6 +37,24 @@
     <Simulator>Internal to CSC</Simulator>
     <Configuration>https://github.com/lsst-ts/ts_config_mtcalsys</Configuration>
   </SALSubsystem>
+  <SALSubsystem>
+    <Name>MTReflector</Name>
+    <Description>CSC for MTReflector</Description>
+    <IndexEnumeration>no</IndexEnumeration>
+    <AddedGenerics>csc, configurable</AddedGenerics>
+    <ActiveDevelopers>Joseph Parsons</ActiveDevelopers>
+    <Github>https://github.com/lsst-ts/ts_mtreflector</Github>
+    <JenkinsTestResults>https://tssw-ci.lsst.org/job/LSST_Telescope-and-Site/job/ts_mtreflector/</JenkinsTestResults>
+    <RubinObsContact>Parker Fagrelius</RubinObsContact>
+    <CSCDocs/>
+    <ProductOwner>Parker Fagrelius</ProductOwner>
+    <RelatedDocuments/>
+    <SoftwareLanguage>Python</SoftwareLanguage>
+    <RuntimeLanguages>IDL</RuntimeLanguages>
+    <VendorContact>Astronomical Consulting and Equipment</VendorContact>
+    <Simulator>Internal to CSC</Simulator>
+    <Configuration>https://github.com/lsst-ts/ts_config_mtcalsys</Configuration>
+  </SALSubsystem>
   <SALSubsystem>
     <Name>LinearStage</Name>
     <Description>CSC for the Linear Stage</Description>

diff --git a/python/lsst/ts/xml/enums/MTReflector.py b/python/lsst/ts/xml/enums/MTReflector.py
@@ -0,0 +1,30 @@
+__all__ = ["MTReflectorStatus"]
+import enum
+
+
+class MTReflectorStatus(enum.IntEnum):
+    """An enumeration class for handling the MTReflectorStatus's substates.
+
+    These enumerations listed here correspond to the ones found in the
+    detailedState enum located in ts_xml under the MTReflectorStatus
+    folder within the MTReflectorStatus_Events.xml.
+
+    Attributes
+    ----------
+    CONNECTED: `int`
+        Corresponds to the state when labjack controller is connected
+    DISCONNECTED: `int`
+        Corresponds to the state when labjack controller is disconnected
+    UNKNOWN : `int`
+        Corresponds to the state when labjack controller state is not known
+    CONNECTION_ERROR : `int`
+        Corresponds to the state when labjack controller has errored
+
+    """
+
+    CONNECTED = 0
+    DISCONNECTED = 1
+    OPEN = 2
+    CLOSE = 3
+    UNKNOWN = 4
+    CONNECTION_ERROR = 5
diff --git a/python/lsst/ts/xml/enums/__init__.py b/python/lsst/ts/xml/enums/__init__.py
@@ -51,6 +51,7 @@
     MTHexapod,
     MTMount,
     MTPtg,
+    MTReflector,
     MTRotator,
     Scheduler,
     Script,

diff --git a/python/lsst/ts/xml/testutils.py b/python/lsst/ts/xml/testutils.py
@@ -86,6 +86,7 @@
     "MTVMS",
     "OCPS",
     "PMD",
+    "MTReflector",
     "Scheduler",
     "Script",
     "ScriptQueue",

diff --git a/towncrier.toml b/towncrier.toml
@@ -317,6 +317,11 @@ directory = "pmd"
 name = "PMD"
 showcontent = true
 
+[[tool.towncrier.type]]
+directory = "mtreflector"
+name = "MTReflector"
+showcontent = true
+
 [[tool.towncrier.type]]
 directory = "scheduler"
 name = "Scheduler"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Adding MTReflector xml which allows opening and closing the flatfield reflector