MTEEC: Add topics descriptions.

lsst-ts · Jun 21, 2024 · 6917042 · 6917042
1 parent 920035b
commit 6917042
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/doc/news/interface_changes/DM-43817.mteec.rst b/doc/news/interface_changes/DM-43817.mteec.rst
@@ -0,0 +1 @@
+Add topics descriptions.
diff --git a/python/lsst/ts/xml/data/sal_interfaces/MTEEC/MTEEC_Commands.xml b/python/lsst/ts/xml/data/sal_interfaces/MTEEC/MTEEC_Commands.xml
@@ -4,6 +4,7 @@
   <SALCommand>
     <Subsystem>MTEEC</Subsystem>
     <EFDB_Topic>MTEEC_command_setToDayTime</EFDB_Topic>
+    <Description>Set to day time.</Description>
     <item>
       <EFDB_Name>setDayTime</EFDB_Name>
       <Description>Ignored.</Description>
@@ -15,6 +16,7 @@
   <SALCommand>
     <Subsystem>MTEEC</Subsystem>
     <EFDB_Topic>MTEEC_command_setToNightTime</EFDB_Topic>
+    <Description>Set to night time.</Description>
     <item>
       <EFDB_Name>setNightTime</EFDB_Name>
       <Description>Ignored.</Description>
@@ -26,6 +28,7 @@
   <SALCommand>
     <Subsystem>MTEEC</Subsystem>
     <EFDB_Topic>MTEEC_command_disableControl</EFDB_Topic>
+    <Description>Disable control.</Description>
     <item>
       <EFDB_Name>disableControl</EFDB_Name>
       <Description>Ignored</Description>
@@ -37,6 +40,7 @@
   <SALCommand>
     <Subsystem>MTEEC</Subsystem>
     <EFDB_Topic>MTEEC_command_applyTemperatureSetpoint</EFDB_Topic>
+    <Description>Apply temperature setpoint.</Description>
     <item>
       <EFDB_Name>setpoint</EFDB_Name>
       <Description>Ignored</Description>

diff --git a/python/lsst/ts/xml/data/sal_interfaces/MTEEC/MTEEC_Events.xml b/python/lsst/ts/xml/data/sal_interfaces/MTEEC/MTEEC_Events.xml
@@ -4,6 +4,7 @@
   <SALEvent>
     <Subsystem>MTEEC</Subsystem>
     <EFDB_Topic>MTEEC_logevent_detailedState</EFDB_Topic>
+    <Description>Log event for the detailed state.</Description>
     <item>
       <EFDB_Name>detailedState</EFDB_Name>
       <Description>Detailed state.</Description>

diff --git a/tests/test_TopicDescription.py b/tests/test_TopicDescription.py
@@ -17,8 +17,6 @@ def check_for_issues(csc: str, topic: str) -> str:
             return "DM-43804"
         case "MTCamera-Telemetry" | "MTCamera-Commands" | "MTCamera-Events":
             return "DM-43816"
-        case "MTEEC-Commands" | "MTEEC-Events":
-            return "DM-43817"
         case "MTMount-Events" | "MTMount-Telemetry":
             return "DM-43821"
         case _: