Merge pull request #902 from lsst-ts/develop

XML v22.1 Release

.github/workflows/changelog.yaml

@@ -21,7 +21,7 @@ jobs:
 
       - name: Install towncrier
         run: |
-          $CONDA/bin/conda install -c conda-forge towncrier -y
+          $CONDA/bin/conda install -c conda-forge towncrier=23 -y
   
       - name: Run towncrier check command
         run: |

Jenkinsfile.conda

@@ -1,2 +1,2 @@
 @Library('JenkinsShared')_
-CondaPipeline([], "ts-xml", "lsst.ts.xml", "noarch")
+XmlPipeline("ts-xml", "lsst.ts.xml", "noarch")

doc/version-history.rst

@@ -15,6 +15,131 @@ Version History
 
 .. towncrier release notes start
 
+v22.1.0 (2024-08-23)
+====================
+Package Level
+-------------
+
+New Features
+~~~~~~~~~~~~
+
+- The XML Conda package build will now use the XmlPipeline.groovy script. (`DM-45496 <https://rubinobs.atlassian.net/browse/DM-45496>`_)
+
+
+Interface Changes
+-----------------
+
+ATBuilding
+~~~~~~~~~~
+
+- Make ATBuilding a configurable CSC. (`DM-45395 <https://rubinobs.atlassian.net/browse/DM-45395>`_)
+
+
+ATCamera
+~~~~~~~~
+
+- Remove obsolete ATCamera_logevent_shutterMotionProfile (`CAP-1050 <https://rubinobs.atlassian.net/browse/CAP-1050>`_)
+- Make initGuiders roiSpec length 1 (unlimited) (`CAP-1051 <https://rubinobs.atlassian.net/browse/CAP-1051>`_)
+- Update ATCamera xml for XML 22.1 (`CAP-1056 <https://rubinobs.atlassian.net/browse/CAP-1056>`_)
+
+
+ATMonochromator
+~~~~~~~~~~~~~~~
+
+- Updated grating enumeration for ATMonochromator (`DM-45475 <https://rubinobs.atlassian.net/browse/DM-45475>`_)
+
+
+CCCamera
+~~~~~~~~
+
+- Make initGuiders roiSpec length 1 (unlimited) (`CAP-1051 <https://rubinobs.atlassian.net/browse/CAP-1051>`_)
+- Update CCCamera xml for XML 22.1 (`CAP-1056 <https://rubinobs.atlassian.net/browse/CAP-1056>`_)
+
+
+Electrometer
+~~~~~~~~~~~~
+
+- Add Voltage and Resistance to UnitToRead enum. (`DM-45177 <https://rubinobs.atlassian.net/browse/DM-45177>`_)
+
+
+LEDProjector
+~~~~~~~~~~~~
+
+- Swapped the ON/OFF enumeration for the LEDProjector. They are currently switched (`DM-45766 <https://rubinobs.atlassian.net/browse/DM-45766>`_)
+
+
+LinearStage
+~~~~~~~~~~~
+
+- Included axis in the move commands (`DM-45754 <https://rubinobs.atlassian.net/browse/DM-45754>`_)
+
+
+MTAOS
+~~~~~
+
+- Add support for sparse zernike coefficients to MTAOS_command_addAberration, MTAOS_logevent_wavefrontError and MTAOS_logevent_rejectedWavefrontError. (`DM-45883 <https://rubinobs.atlassian.net/browse/DM-45883>`_)
+- Add pubEvent to publish calculated mirror stresses from MTAOS. (`DM-45890 <https://rubinobs.atlassian.net/browse/DM-45890>`_)
+
+
+MTCamera
+~~~~~~~~
+
+- Make initGuiders roiSpec length 1 (unlimited) (`CAP-1051 <https://rubinobs.atlassian.net/browse/CAP-1051>`_)
+- Update MTCamera xml for XML 22.1 (`CAP-1056 <https://rubinobs.atlassian.net/browse/CAP-1056>`_)
+
+
+MTHexapod
+~~~~~~~~~
+
+- Remove the MTHexapod_logevent_controllerState.offlineSubstate and add the MTHexapod_logevent_configuration.drivesEnabled.
+  Remove the OfflineSubstate enum in MTHexapod and MTRotator. (`DM-45566 <https://rubinobs.atlassian.net/browse/DM-45566>`_)
+
+
+MTM1M3
+~~~~~~
+
+- Changed and corrected M1M3's FCUTable. (`DM-45598 <https://rubinobs.atlassian.net/browse/DM-45598>`_)
+
+
+MTM2
+~~~~
+
+- Add the MTM2_command_enableLutTemperature. (`DM-45202 <https://rubinobs.atlassian.net/browse/DM-45202>`_)
+
+
+MTMount
+~~~~~~~
+
+- Update MTMount openMirrorCovers command to allow specifying a single leaf to open. (`DM-45874 <https://rubinobs.atlassian.net/browse/DM-45874>`_)
+- Update telemetry with the lastest version provided by Tekniker. (`DM-45874 <https://rubinobs.atlassian.net/browse/DM-45874>`_)
+
+
+MTRotator
+~~~~~~~~~
+
+- Add the MTRotator_logevent_lowFrequencyVibration. (`DM-45758 <https://rubinobs.atlassian.net/browse/DM-45758>`_)
+
+
+Scheduler
+~~~~~~~~~
+
+- Add civil, nautical and astronomical twilight information to the generalInfo event. (`DM-45499 <https://rubinobs.atlassian.net/browse/DM-45499>`_)
+- Add additional metadata to the target event. (`DM-45499 <https://rubinobs.atlassian.net/browse/DM-45499>`_)
+- Add support for execution id. (`DM-45686 <https://rubinobs.atlassian.net/browse/DM-45686>`_)
+
+
+Script
+~~~~~~
+
+- Add support for execution id. (`DM-45686 <https://rubinobs.atlassian.net/browse/DM-45686>`_)
+
+
+ScriptQueue
+~~~~~~~~~~~
+
+- Add support for execution id. (`DM-45686 <https://rubinobs.atlassian.net/browse/DM-45686>`_)
+
+
 v22.0.0 (2024-07-11)
 ====================
 Package Level

python/lsst/ts/xml/data/sal_interfaces/ATCamera/ATCamera_Commands.xml

@@ -62,9 +62,9 @@
     <EFDB_Topic>ATCamera_command_initGuiders</EFDB_Topic>
     <item>
       <EFDB_Name>roiSpec</EFDB_Name>
-      <Description>TBD specification for region of interest</Description>
+      <Description>Specification for region of interest</Description>
       <IDL_Type>string</IDL_Type>
-      <IDL_Size>256</IDL_Size>
+      <IDL_Size>1</IDL_Size>
       <Units>unitless</Units>
       <Count>1</Count>
     </item>

python/lsst/ts/xml/data/sal_interfaces/ATCamera/ATCamera_Events.xml

@@ -639,17 +639,6 @@
       <Count>1</Count>
     </item>
   </SALEvent>
-  <SALEvent>
-    <Subsystem>ATCamera</Subsystem>
-    <EFDB_Topic>ATCamera_logevent_shutterMotionProfile</EFDB_Topic>
-    <item>
-      <EFDB_Name>measuredExposureTime</EFDB_Name>
-      <Description>The measured average exposure time</Description>
-      <IDL_Type>double</IDL_Type>
-      <Units>second</Units>
-      <Count>1</Count>
-    </item>
-  </SALEvent>
   <SALEvent>
     <Subsystem>ATCamera</Subsystem>
     <EFDB_Topic>ATCamera_logevent_imageReadoutParameters</EFDB_Topic>

python/lsst/ts/xml/data/sal_interfaces/CCCamera/CCCamera_Commands.xml

@@ -62,9 +62,9 @@
     <EFDB_Topic>CCCamera_command_initGuiders</EFDB_Topic>
     <item>
       <EFDB_Name>roiSpec</EFDB_Name>
-      <Description>TBD specification for region of interest</Description>
+      <Description>Specification for region of interest</Description>
       <IDL_Type>string</IDL_Type>
-      <IDL_Size>256</IDL_Size>
+      <IDL_Size>1</IDL_Size>
       <Units>unitless</Units>
       <Count>1</Count>
     </item>

python/lsst/ts/xml/data/sal_interfaces/CCCamera/CCCamera_Events.xml

@@ -713,15 +713,15 @@
     <EFDB_Topic>CCCamera_logevent_availableFilters</EFDB_Topic>
     <item>
       <EFDB_Name>filterNames</EFDB_Name>
-      <Description>A list of names of available filters (: delimited, U-001,G-004,R-010,Z-012,Y-014, NONE), in the same order as the list of filter types.</Description>
+      <Description>A list of names of available filters (comma delimited, U-001,G-004,R-010,Z-012,Y-014, NONE), in the same order as the list of filter types.</Description>
       <IDL_Type>string</IDL_Type>
       <IDL_Size>256</IDL_Size>
       <Units>unitless</Units>
       <Count>1</Count>
     </item>
     <item>
       <EFDB_Name>filterTypes</EFDB_Name>
-      <Description>A list of types of available filters in the same order as the list of available filters  (: delimited)</Description>
+      <Description>A list of types of available filters in the same order as the list of available filters  (comma delimited)</Description>
       <IDL_Type>string</IDL_Type>
       <IDL_Size>256</IDL_Size>
       <Units>unitless</Units>

python/lsst/ts/xml/data/sal_interfaces/Electrometer/Electrometer_Commands.xml

@@ -54,11 +54,10 @@
   <SALCommand>
     <Subsystem>Electrometer</Subsystem>
     <EFDB_Topic>Electrometer_command_setMode</EFDB_Topic>
-    <Description>Set unit to measure. The modes are: Current, Voltage, Charge or Resistance. When the mode is changed to Current or Voltage, a zero correction will be performed. When the mode is set to Charge, a zero check will be performed. </Description>
+    <Description>Set unit to measure. The modes are: Current, Voltage, Charge or Resistance. When the mode is changed to Current or Voltage, a zero correction will be performed. When the mode is set to Charge, a zero check will be performed. Use the UnitToRead enum to send the correct value for each.</Description>
     <item>
       <EFDB_Name>mode</EFDB_Name>
-      <Description>Set electrometer to use different modes: Current (0), Voltage (1), Charge (2), Resistance (3). The units recorded will be Amps, Volts, Coulombs, and Ohms respectively.</Description>
-      <!-- Enumeration: UnitToRead -->
+      <Description>Set electrometer to use different modes: Current ('CURR'), Voltage ('VOLT'), Charge ('CHAR'), Resistance ('RES'). The units recorded will be Amps, Volts, Coulombs, and Ohms respectively.</Description>
       <IDL_Type>long</IDL_Type>
       <Units>unitless</Units>
       <Count>1</Count>

python/lsst/ts/xml/data/sal_interfaces/Electrometer/Electrometer_Events.xml

@@ -2,7 +2,12 @@
 <?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>DetailedState_DisabledState,DetailedState_EnabledState,DetailedState_FaultState,DetailedState_OfflineState,DetailedState_StandbyState,DetailedState_NotReadingState,DetailedState_ConfiguringState,DetailedState_ManualReadingState,DetailedState_ReadingBufferState,DetailedState_SetDurationReadingState</Enumeration>
-  <Enumeration>UnitToRead_Current,UnitToRead_Charge</Enumeration>
+  <Enumeration>
+    UnitToRead_Current,
+    UnitToRead_Charge,
+    UnitToRead_Voltage,
+    UnitToRead_Resistance
+  </Enumeration>
   <SALEvent>
     <Subsystem>Electrometer</Subsystem>
     <EFDB_Topic>Electrometer_logevent_detailedState</EFDB_Topic>
@@ -99,8 +104,7 @@
     <Description>Current mode selected to read from the photodiode. Options are Current, Charge, Voltage and Resistance. </Description>
     <item>
       <EFDB_Name>mode</EFDB_Name>
-      <Description>mode: 0- Current, 1- Charge, 2- Voltage, 3- Resistance</Description>
-      <!-- Enumeration: UnitToRead -->
+      <Description>mode: 'CURR'- Current, 'CHAR'- Charge, 'VOLT'- Voltage, 'RES'- Resistance</Description>
       <IDL_Type>long</IDL_Type>
       <Units>unitless</Units>
       <Count>1</Count>
@@ -147,9 +151,8 @@
     </item>
     <item>
       <EFDB_Name>mode</EFDB_Name>
-      <Description>Mode used in the configuration file, 0-Current, 1-Charge, 2-Voltage, 3-Resistance</Description>
-      <!-- Enumeration: UnitToRead -->
-      <IDL_Type>long</IDL_Type>
+      <Description>Mode used in the configuration file, CURR, CHAR, VOLT, RES</Description>
+      <IDL_Type>string</IDL_Type>
       <Units>unitless</Units>
       <Count>1</Count>
     </item>

python/lsst/ts/xml/data/sal_interfaces/LinearStage/LinearStage_Commands.xml

@@ -12,6 +12,13 @@
       <Units>mm</Units>
       <Count>1</Count>
     </item>
+    <item>
+      <EFDB_Name>axis</EFDB_Name>
+      <Description>Axis identifier for the device. Optional.</Description>
+      <IDL_Type>int</IDL_Type>
+      <Units>unitless</Units>
+      <Count>1</Count>
+    </item>
     <item>
       <EFDB_Name>timestamp</EFDB_Name>
       <Description>The timestamp for when the event occurred.</Description>
@@ -31,6 +38,13 @@
       <Units>mm</Units>
       <Count>1</Count>
     </item>
+    <item>
+      <EFDB_Name>axis</EFDB_Name>
+      <Description>Axis identifier for the device. Optional.</Description>
+      <IDL_Type>int</IDL_Type>
+      <Units>unitless</Units>
+      <Count>1</Count>
+    </item>
     <item>
       <EFDB_Name>timestamp</EFDB_Name>
       <Description>The timestamp for when the event occurred.</Description>
@@ -50,6 +64,13 @@
       <Units>unitless</Units>
       <Count>1</Count>
     </item>
+    <item>
+      <EFDB_Name>axis</EFDB_Name>
+      <Description>Axis identifier for the device. Optional.</Description>
+      <IDL_Type>int</IDL_Type>
+      <Units>unitless</Units>
+      <Count>1</Count>
+    </item>
     <item>
       <EFDB_Name>timestamp</EFDB_Name>
       <Description>The timestamp for when the event occurred.</Description>
@@ -69,6 +90,13 @@
       <Units>unitless</Units>
       <Count>1</Count>
     </item>
+    <item>
+      <EFDB_Name>axis</EFDB_Name>
+      <Description>Axis identifier for the device. Optional.</Description>
+      <IDL_Type>int</IDL_Type>
+      <Units>unitless</Units>
+      <Count>1</Count>
+    </item>
     <item>
       <EFDB_Name>timestamp</EFDB_Name>
       <Description>The timestamp for when the event occurred.</Description>

python/lsst/ts/xml/data/sal_interfaces/MTAOS/MTAOS_Commands.xml

@@ -147,11 +147,25 @@
     <Description>Utility command to add aberration to the system based on user provided wavefront errors. The command assume uniform aberration on all sensors.</Description>
     <item>
       <EFDB_Name>wf</EFDB_Name>
-      <Description>Array with z4-z22 terms of wavefront errors. Indexes are considered to be ANSI (https://en.wikipedia.org/wiki/Zernike_polynomials#OSA/ANSI_standard_indices).</Description>
+      <Description>Array with z4-z22 terms of wavefront errors. Indexes are considered to be ANSI (https://en.wikipedia.org/wiki/Zernike_polynomials#OSA/ANSI_standard_indices). This attribute will be deprecated in favor of nollZernikeIndices and nollZernikeValues.</Description>
       <IDL_Type>double</IDL_Type>
       <Units>micron</Units>
       <Count>19</Count>
     </item>
+    <item>
+      <EFDB_Name>nollZernikeIndices</EFDB_Name>
+      <Description>Array with zernike noll indices used for the wavefront errors. Indices can be any sparse list comprising zernikes above zk4.</Description>
+      <IDL_Type>int</IDL_Type>
+      <Units>unitless</Units>
+      <Count>100</Count>
+    </item>
+    <item>
+      <EFDB_Name>nollZernikeValues</EFDB_Name>
+      <Description>Array with wavefront errors expressed in the zernike coefficient values that map to the specified nollZernikeIndices. </Description>
+      <IDL_Type>double</IDL_Type>
+      <Units>micron</Units>
+      <Count>100</Count>
+    </item>
     <item>
       <EFDB_Name>config</EFDB_Name>
       <Description>Yaml configuration string with additional parameters to be passed to OFC. If options are invalid command will be rejected. If not given, use the standard configuration.</Description>