From b9da400e7796edf1ec40b45666d465aac6cd8857 Mon Sep 17 00:00:00 2001
From: gmegh <guillem.megias.homar@gmail.com>
Date: Wed, 2 Oct 2024 14:12:35 -0700
Subject: [PATCH] Add MOSS subsystem to XML

---
 doc/news/DM-46263.feature.rst                 |  1 +
 .../sal_interfaces/MOSS/MOSS_Commands.xml     | 88 +++++++++++++++++++
 .../data/sal_interfaces/MOSS/MOSS_Events.xml  | 66 ++++++++++++++
 .../xml/data/sal_interfaces/SALSubsystems.xml | 18 ++++
 python/lsst/ts/xml/enums/MOSS.py              | 33 +++++++
 python/lsst/ts/xml/enums/__init__.py          |  1 +
 python/lsst/ts/xml/testutils.py               |  1 +
 towncrier.toml                                |  5 ++
 8 files changed, 213 insertions(+)
 create mode 100644 doc/news/DM-46263.feature.rst
 create mode 100644 python/lsst/ts/xml/data/sal_interfaces/MOSS/MOSS_Commands.xml
 create mode 100644 python/lsst/ts/xml/data/sal_interfaces/MOSS/MOSS_Events.xml
 create mode 100644 python/lsst/ts/xml/enums/MOSS.py

diff --git a/doc/news/DM-46263.feature.rst b/doc/news/DM-46263.feature.rst
new file mode 100644
index 000000000..d249ea03b
--- /dev/null
+++ b/doc/news/DM-46263.feature.rst
@@ -0,0 +1 @@
+CSC for the Multi Beam Optical Seeing Sensor (MOSS)
\ No newline at end of file
diff --git a/python/lsst/ts/xml/data/sal_interfaces/MOSS/MOSS_Commands.xml b/python/lsst/ts/xml/data/sal_interfaces/MOSS/MOSS_Commands.xml
new file mode 100644
index 000000000..65d4b09f4
--- /dev/null
+++ b/python/lsst/ts/xml/data/sal_interfaces/MOSS/MOSS_Commands.xml
@@ -0,0 +1,88 @@
+<?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>MOSS</Subsystem>
+    <EFDB_Topic>MOSS_command_moveBeam</EFDB_Topic>
+    <Description>Move the beam by a relative angle.</Description>
+    <item>
+      <EFDB_Name>index</EFDB_Name>
+      <Description>Beam number</Description>
+      <IDL_Type>int</IDL_Type>
+      <Units>unitless</Units>
+      <Count>1</Count>
+    </item>
+    <item>
+      <EFDB_Name>tip</EFDB_Name>
+      <Description>Relative tip (azimuth) angle in degrees</Description>
+      <IDL_Type>float</IDL_Type>
+      <Units>degree</Units>
+      <Count>1</Count>
+    </item>
+    <item>
+      <EFDB_Name>tilt</EFDB_Name>
+      <Description>Relative tilt (elevation) angle in degrees</Description>
+      <IDL_Type>float</IDL_Type>
+      <Units>degree</Units>
+      <Count>1</Count>
+    </item>
+  </SALCommand>
+  <SALCommand>
+    <Subsystem>MOSS</Subsystem>
+    <EFDB_Topic>MOSS_command_runPulsedBeam</EFDB_Topic>
+    <Description>Run the commanded pulse beam with the given settings.</Description>
+    <item>
+      <EFDB_Name>intensity</EFDB_Name>
+      <Description>Intensity of the beam. The same intensity applies to all the beams and is not callibrated to a known IS units.</Description>
+      <IDL_Type>float</IDL_Type>
+      <Units>unitless</Units>
+      <Count>1</Count>
+    </item>
+    <item>
+      <EFDB_Name>number</EFDB_Name>
+      <Description>Number of pulses to be emitted</Description>
+      <IDL_Type>int</IDL_Type>
+      <Units>unitless</Units>
+      <Count>1</Count>
+    </item>
+    <item>
+      <EFDB_Name>frequency</EFDB_Name>
+      <Description>Frequency of the beam (number of pulses per second)</Description>
+      <IDL_Type>float</IDL_Type>
+      <Units>hertz</Units>
+      <Count>1</Count>
+    </item>
+    <item>
+      <EFDB_Name>pulseLength</EFDB_Name>
+      <Description>Length of the pulses</Description>
+      <IDL_Type>float</IDL_Type>
+      <Units>millisecond</Units>
+      <Count>1</Count>
+    </item>
+  </SALCommand>
+  <SALCommand>
+    <Subsystem>MOSS</Subsystem>
+    <EFDB_Topic>MOSS_command_stopPulsedBeam</EFDB_Topic>
+    <Description>Stop the commanded pulse beam.</Description>
+  </SALCommand>
+  <SALCommand>
+    <Subsystem>MOSS</Subsystem>
+    <EFDB_Topic>MOSS_command_insertFlipAttenuator</EFDB_Topic>
+    <Description>Insert the flip attenuator.</Description>
+  </SALCommand>
+  <SALCommand>
+    <Subsystem>MOSS</Subsystem>
+    <EFDB_Topic>MOSS_command_removeFlipAttenuator</EFDB_Topic>
+    <Description>Remove the flip attenuator.</Description>
+  </SALCommand>
+  <SALCommand>
+    <Subsystem>MOSS</Subsystem>
+    <EFDB_Topic>MOSS_command_powerOff</EFDB_Topic>
+    <Description>Turn off the PDU of MOSS.</Description>
+  </SALCommand>
+  <SALCommand>
+    <Subsystem>MOSS</Subsystem>
+    <EFDB_Topic>MOSS_command_powerOn</EFDB_Topic>
+    <Description>Turn on the PDU of MOSS.</Description>
+  </SALCommand>
+</SALCommandSet>
diff --git a/python/lsst/ts/xml/data/sal_interfaces/MOSS/MOSS_Events.xml b/python/lsst/ts/xml/data/sal_interfaces/MOSS/MOSS_Events.xml
new file mode 100644
index 000000000..34593c99b
--- /dev/null
+++ b/python/lsst/ts/xml/data/sal_interfaces/MOSS/MOSS_Events.xml
@@ -0,0 +1,66 @@
+<?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>AttenuatorState_inPlace,AttenuatorState_removed</Enumeration>
+  <Enumeration>BeamStatus_ON,BeamStatus_OFF</Enumeration>
+  <SALEvent>
+    <Subsystem>MOSS</Subsystem>
+    <EFDB_Topic>MOSS_logevent_beamIntensity</EFDB_Topic>
+    <Description>Report the intensity of the beam</Description>
+    <item>
+      <EFDB_Name>intensity</EFDB_Name>
+      <Description>Intensity of the beam. The same intensity applies to all the beams and is not calibrated to a known IS units.</Description>
+      <IDL_Type>int</IDL_Type>
+      <Units>unitless</Units>
+      <Count>1</Count>
+    </item>
+  </SALEvent>
+  <SALEvent>
+    <Subsystem>MOSS</Subsystem>
+    <EFDB_Topic>MOSS_logevent_pulseLength</EFDB_Topic>
+    <Description>Report the length of the pulse</Description>
+    <item>
+      <EFDB_Name>pulseLength</EFDB_Name>
+      <Description>Length of the pulse in seconds</Description>
+      <IDL_Type>float</IDL_Type>
+      <Units>millisecond</Units>
+      <Count>1</Count>
+    </item>
+  </SALEvent>
+  <SALEvent>
+    <Subsystem>MOSS</Subsystem>
+    <EFDB_Topic>MOSS_logevent_pulseFrequency</EFDB_Topic>
+    <Description>Report the frequency of the pulse</Description>
+    <item>
+      <EFDB_Name>frequency</EFDB_Name>
+      <Description>Frequency of the pulse (number of pulses per second)</Description>
+      <IDL_Type>float</IDL_Type>
+      <Units>hertz</Units>
+      <Count>1</Count>
+    </item>
+  </SALEvent>
+  <SALEvent>
+    <Subsystem>MOSS</Subsystem>
+    <EFDB_Topic>MOSS_logevent_beamState</EFDB_Topic>
+    <Description>Report the state of the beam</Description>
+    <item>
+      <EFDB_Name>state</EFDB_Name>
+      <Description>BeamStatus enumeration.</Description>
+      <IDL_Type>long</IDL_Type>
+      <Units>unitless</Units>
+      <Count>1</Count>
+    </item>
+  </SALEvent>
+  <SALEvent>
+    <Subsystem>MOSS</Subsystem>
+    <EFDB_Topic>MOSS_logevent_flipAttenuatorState</EFDB_Topic>
+    <Description>Report the state of the flip attenuator</Description>
+    <item>
+      <EFDB_Name>state</EFDB_Name>
+      <Description>AttenuatorState enumeration.</Description>
+      <IDL_Type>long</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
index bca8c9a14..d062cdb2a 100644
--- a/python/lsst/ts/xml/data/sal_interfaces/SALSubsystems.xml
+++ b/python/lsst/ts/xml/data/sal_interfaces/SALSubsystems.xml
@@ -748,6 +748,24 @@
     <Simulator>Internal to CSC</Simulator>
     <Configuration>https://github.com/lsst-ts/ts_config_mttcs</Configuration>
   </SALSubsystem>
+  <SALSubsystem>
+    <Name>MOSS</Name>
+    <Description>The CSC for the Multi Beam Optical Seeing Sensor</Description>
+    <IndexEnumeration>no</IndexEnumeration>
+    <AddedGenerics>csc, configurable</AddedGenerics>
+    <ActiveDevelopers>Guillem Megias</ActiveDevelopers>
+    <Github>https://github.com/lsst-ts/ts_moss</Github>
+    <JenkinsTestResults>https://tssw-ci.lsst.org/job/LSST_Telescope-and-Site/job/ts_moss/</JenkinsTestResults>
+    <RubinObsContact>Christopher Stubbs</RubinObsContact>
+    <CSCDocs>https://ts-moss.lsst.io</CSCDocs>
+    <ProductOwner>Sandrine Thomas</ProductOwner>
+    <RelatedDocuments/>
+    <SoftwareLanguage>Python</SoftwareLanguage>
+    <RuntimeLanguages>IDL</RuntimeLanguages>
+    <VendorContact>Not Applicable</VendorContact>
+    <Simulator>Internal to CSC</Simulator>
+    <Configuration>https://github.com/lsst-ts/ts_config_mttcs</Configuration>
+  </SALSubsystem>
   <SALSubsystem>
     <Name>MTAOS</Name>
     <Description>The CSC for the Main Telescope Active Optics System</Description>
diff --git a/python/lsst/ts/xml/enums/MOSS.py b/python/lsst/ts/xml/enums/MOSS.py
new file mode 100644
index 000000000..5282f5b95
--- /dev/null
+++ b/python/lsst/ts/xml/enums/MOSS.py
@@ -0,0 +1,33 @@
+# This file is part of ts_xml.
+#
+# Developed for Vera Rubin Observatory.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+
+__all__ = ["BeamStatus", "AttenuatorState"]
+
+import enum
+
+
+class BeamStatus(enum.IntEnum):
+    OFF = enum.auto()
+    ON = enum.auto()
+
+
+class AttenuatorState(enum.IntEnum):
+    inPlace = 1
+    removed = enum.auto()
diff --git a/python/lsst/ts/xml/enums/__init__.py b/python/lsst/ts/xml/enums/__init__.py
index e720bb71d..d6e1d42ae 100644
--- a/python/lsst/ts/xml/enums/__init__.py
+++ b/python/lsst/ts/xml/enums/__init__.py
@@ -25,6 +25,7 @@
     ESS,
     GIS,
     HVAC,
+    MOSS,
     MTAOS,
     MTM1M3,
     MTM2,
diff --git a/python/lsst/ts/xml/testutils.py b/python/lsst/ts/xml/testutils.py
index 32fd2db47..1cf060be0 100644
--- a/python/lsst/ts/xml/testutils.py
+++ b/python/lsst/ts/xml/testutils.py
@@ -69,6 +69,7 @@
     "LEDProjector",
     "LinearStage",
     "LOVE",
+    "MOSS",
     "MTAOS",
     "MTCamera",
     "MTDome",
diff --git a/towncrier.toml b/towncrier.toml
index e5d047ea7..9bae0b699 100644
--- a/towncrier.toml
+++ b/towncrier.toml
@@ -232,6 +232,11 @@ directory = "mtaos"
 name = "MTAOS"
 showcontent = true
 
+[[tool.towncrier.type]]
+directory = "moss"
+name = "MOSS"
+showcontent = true
+
 [[tool.towncrier.type]]
 directory = "mtaircompressor"
 name = "MTAirCompressor"