Skip to content

Commit 54179f0

Browse files
tony-johnsontony-johnson
authored
Merge pull request #927 from lsst-ts/tickets/CAP-1058
Add descriptions to all atcamera/mtcamera/cccamera items
2 parents b8d81c5 + 8d99775 commit 54179f0

File tree

13 files changed

+1420
-614
lines changed

13 files changed

+1420
-614
lines changed

‎doc/news/interface_changes/DM-43793.atcamera.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix missing descriptions.

‎doc/news/interface_changes/DM-43804.cccamera.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix missing descriptions.

‎doc/news/interface_changes/DM-43816.mtcamera.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix missing descriptions.

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<SALCommand>
44
<Subsystem>ATCamera</Subsystem>
55
<EFDB_Topic>ATCamera_command_discardRows</EFDB_Topic>
6+
<Description>LSE-71 discardRows command</Description>
67
<item>
78
<EFDB_Name>nRows</EFDB_Name>
89
<Description>Number of rows to discard</Description>
@@ -14,6 +15,7 @@
1415
<SALCommand>
1516
<Subsystem>ATCamera</Subsystem>
1617
<EFDB_Topic>ATCamera_command_startImage</EFDB_Topic>
18+
<Description>LSE-71 startImage command</Description>
1719
<item>
1820
<EFDB_Name>shutter</EFDB_Name>
1921
<Description>True if the shutter should be opened/closed</Description>
@@ -56,10 +58,12 @@
5658
<SALCommand>
5759
<Subsystem>ATCamera</Subsystem>
5860
<EFDB_Topic>ATCamera_command_disableCalibration</EFDB_Topic>
61+
<Description>LSE-71 disableCalibration command</Description>
5962
</SALCommand>
6063
<SALCommand>
6164
<Subsystem>ATCamera</Subsystem>
6265
<EFDB_Topic>ATCamera_command_initGuiders</EFDB_Topic>
66+
<Description>LSE-71 initGuiders command</Description>
6367
<item>
6468
<EFDB_Name>roiSpec</EFDB_Name>
6569
<Description>Specification for region of interest</Description>
@@ -72,10 +76,12 @@
7276
<SALCommand>
7377
<Subsystem>ATCamera</Subsystem>
7478
<EFDB_Topic>ATCamera_command_enableCalibration</EFDB_Topic>
79+
<Description>LSE-71 enableCalibration command</Description>
7580
</SALCommand>
7681
<SALCommand>
7782
<Subsystem>ATCamera</Subsystem>
7883
<EFDB_Topic>ATCamera_command_initImage</EFDB_Topic>
84+
<Description>LSE-71 initImage command</Description>
7985
<item>
8086
<EFDB_Name>deltaT</EFDB_Name>
8187
<Description>Estimate of time period before takeImages will be issued</Description>
@@ -87,10 +93,12 @@
8793
<SALCommand>
8894
<Subsystem>ATCamera</Subsystem>
8995
<EFDB_Topic>ATCamera_command_endImage</EFDB_Topic>
96+
<Description>LSE-71 endImage command</Description>
9097
</SALCommand>
9198
<SALCommand>
9299
<Subsystem>ATCamera</Subsystem>
93100
<EFDB_Topic>ATCamera_command_clear</EFDB_Topic>
101+
<Description>LSE-71 clear command</Description>
94102
<item>
95103
<EFDB_Name>nClears</EFDB_Name>
96104
<Description>Number of consecutive clear operations to perform</Description>
@@ -102,6 +110,7 @@
102110
<SALCommand>
103111
<Subsystem>ATCamera</Subsystem>
104112
<EFDB_Topic>ATCamera_command_takeImages</EFDB_Topic>
113+
<Description>LSE-71 takeImages command</Description>
105114
<item>
106115
<EFDB_Name>numImages</EFDB_Name>
107116
<Description>Number of consecutive images to take</Description>
@@ -151,11 +160,13 @@
151160
<SALCommand>
152161
<Subsystem>ATCamera</Subsystem>
153162
<EFDB_Topic>ATCamera_command_stop</EFDB_Topic>
163+
<Description>LSE-71 stop command</Description>
154164
</SALCommand>
155165
<!-- Playlist related commands, only valid when using emulated DAQ -->
156166
<SALCommand>
157167
<Subsystem>ATCamera</Subsystem>
158168
<EFDB_Topic>ATCamera_command_play</EFDB_Topic>
169+
<Description>Play specified playlist</Description>
159170
<item>
160171
<EFDB_Name>playlist</EFDB_Name>
161172
<Description>Name of an existing DAQ playlist to play</Description>
@@ -174,6 +185,7 @@
174185
<SALCommand>
175186
<Subsystem>ATCamera</Subsystem>
176187
<EFDB_Topic>ATCamera_command_playlist</EFDB_Topic>
188+
<Description>Define a new playlist</Description>
177189
<item>
178190
<EFDB_Name>playlist</EFDB_Name>
179191
<Description>Name of a DAQ playlist to be defined (replaced if exists)</Description>
@@ -200,6 +212,7 @@
200212
<SALCommand>
201213
<Subsystem>ATCamera</Subsystem>
202214
<EFDB_Topic>ATCamera_command_alert</EFDB_Topic>
215+
<Description>Experimental command -- not currently implemented</Description>
203216
<item>
204217
<EFDB_Name>alertId</EFDB_Name>
205218
<Description>The alertId for which this command applies (or *)</Description>

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

Lines changed: 194 additions & 90 deletions
Large diffs are not rendered by default.

‎python/lsst/ts/xml/data/sal_interfaces/ATCamera/ATCamera_Telemetry.xml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
<SALTelemetry>
66
<Subsystem>ATCamera</Subsystem>
77
<EFDB_Topic>ATCamera_focal_plane_Ccd</EFDB_Topic>
8+
<Description>subsystem ATCamera class ATCamera_focal_plane_Ccd</Description>
89
<!--CCS: Dictionary_Checksum: 3323840614L -->
910
<!--CCSMETA: Array gDV indexed by location-->
1011
<item>
@@ -73,6 +74,7 @@
7374
<SALTelemetry>
7475
<Subsystem>ATCamera</Subsystem>
7576
<EFDB_Topic>ATCamera_focal_plane_Reb</EFDB_Topic>
77+
<Description>subsystem ATCamera class ATCamera_focal_plane_Reb</Description>
7678
<!--CCS: Dictionary_Checksum: 3470282761L -->
7779
<!--CCSMETA: Array anaI indexed by location-->
7880
<item>
@@ -384,6 +386,7 @@
384386
<SALTelemetry>
385387
<Subsystem>ATCamera</Subsystem>
386388
<EFDB_Topic>ATCamera_focal_plane_RebTotalPower</EFDB_Topic>
389+
<Description>subsystem ATCamera class ATCamera_focal_plane_RebTotalPower</Description>
387390
<!--CCS: Dictionary_Checksum: 2608570576L -->
388391
<item>
389392
<EFDB_Name>rebTotalPower</EFDB_Name>
@@ -398,6 +401,7 @@
398401
<SALTelemetry>
399402
<Subsystem>ATCamera</Subsystem>
400403
<EFDB_Topic>ATCamera_focal_plane_RebsAverageTemp6</EFDB_Topic>
404+
<Description>subsystem ATCamera class ATCamera_focal_plane_RebsAverageTemp6</Description>
401405
<!--CCS: Dictionary_Checksum: 894432032L -->
402406
<item>
403407
<EFDB_Name>rebsAverageTemp6</EFDB_Name>
@@ -407,11 +411,12 @@
407411
<Count>1</Count>
408412
</item>
409413
</SALTelemetry>
410-
<!--Created by xmlmaker2 for subsystem ATCamera class ATCamera_daq_monitor_Reb_Trending using level 1 for category Trending-->
414+
<!--Created by xmlmaker2 for subsystem ATCamera class ATCamera_daq_monitor_Reb_Trending for category Trending using level 1-->
411415
<!--=======================================================================================================================-->
412416
<SALTelemetry>
413417
<Subsystem>ATCamera</Subsystem>
414418
<EFDB_Topic>ATCamera_daq_monitor_Reb_Trending</EFDB_Topic>
419+
<Description>subsystem ATCamera class ATCamera_daq_monitor_Reb_Trending for category Trending</Description>
415420
<!--CCS: Dictionary_Checksum: 2805192593L -->
416421
<!--CCSMETA: Array driver_errors indexed by location-->
417422
<item>
@@ -885,6 +890,7 @@
885890
<SALTelemetry>
886891
<Subsystem>ATCamera</Subsystem>
887892
<EFDB_Topic>ATCamera_daq_monitor_Store</EFDB_Topic>
893+
<Description>subsystem ATCamera class ATCamera_daq_monitor_Store</Description>
888894
<!--CCS: Dictionary_Checksum: 1170090743L -->
889895
<item>
890896
<EFDB_Name>capacity</EFDB_Name>
@@ -908,11 +914,12 @@
908914
<Count>1</Count>
909915
</item>
910916
</SALTelemetry>
911-
<!--Created by xmlmaker2 for subsystem ATCamera class ATCamera_daq_monitor_Sum_Trending using level 1 for category Trending-->
917+
<!--Created by xmlmaker2 for subsystem ATCamera class ATCamera_daq_monitor_Sum_Trending for category Trending using level 1-->
912918
<!--=======================================================================================================================-->
913919
<SALTelemetry>
914920
<Subsystem>ATCamera</Subsystem>
915921
<EFDB_Topic>ATCamera_daq_monitor_Sum_Trending</EFDB_Topic>
922+
<Description>subsystem ATCamera class ATCamera_daq_monitor_Sum_Trending for category Trending</Description>
916923
<!--CCS: Dictionary_Checksum: 385642950L -->
917924
<item>
918925
<EFDB_Name>driver_errors</EFDB_Name>
@@ -1074,6 +1081,7 @@
10741081
<SALTelemetry>
10751082
<Subsystem>ATCamera</Subsystem>
10761083
<EFDB_Topic>ATCamera_power</EFDB_Topic>
1084+
<Description>subsystem ATCamera class ATCamera_power</Description>
10771085
<!--CCS: Dictionary_Checksum: 1269524998L -->
10781086
<item>
10791087
<EFDB_Name>analog_I</EFDB_Name>
@@ -1221,6 +1229,7 @@
12211229
<SALTelemetry>
12221230
<Subsystem>ATCamera</Subsystem>
12231231
<EFDB_Topic>ATCamera_vacuum</EFDB_Topic>
1232+
<Description>subsystem ATCamera class ATCamera_vacuum</Description>
12241233
<!--CCS: Dictionary_Checksum: 1376639655L -->
12251234
<item>
12261235
<EFDB_Name>tempCCD</EFDB_Name>
@@ -1263,6 +1272,7 @@
12631272
<SALTelemetry>
12641273
<Subsystem>ATCamera</Subsystem>
12651274
<EFDB_Topic>ATCamera_bonn_shutter_Device</EFDB_Topic>
1275+
<Description>subsystem ATCamera class ATCamera_bonn_shutter_Device</Description>
12661276
<!--CCS: Dictionary_Checksum: 1759124350L -->
12671277
<item>
12681278
<EFDB_Name>bonn_V36</EFDB_Name>

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<SALCommand>
44
<Subsystem>CCCamera</Subsystem>
55
<EFDB_Topic>CCCamera_command_discardRows</EFDB_Topic>
6+
<Description>LSE-71 discardRows command</Description>
67
<item>
78
<EFDB_Name>nRows</EFDB_Name>
89
<Description>Number of rows to discard</Description>
@@ -14,6 +15,7 @@
1415
<SALCommand>
1516
<Subsystem>CCCamera</Subsystem>
1617
<EFDB_Topic>CCCamera_command_startImage</EFDB_Topic>
18+
<Description>LSE-71 startImage command</Description>
1719
<item>
1820
<EFDB_Name>shutter</EFDB_Name>
1921
<Description>True if the shutter should be opened/closed</Description>
@@ -56,10 +58,12 @@
5658
<SALCommand>
5759
<Subsystem>CCCamera</Subsystem>
5860
<EFDB_Topic>CCCamera_command_disableCalibration</EFDB_Topic>
61+
<Description>LSE-71 disableCalibration command</Description>
5962
</SALCommand>
6063
<SALCommand>
6164
<Subsystem>CCCamera</Subsystem>
6265
<EFDB_Topic>CCCamera_command_initGuiders</EFDB_Topic>
66+
<Description>LSE-71 initGuiders command</Description>
6367
<item>
6468
<EFDB_Name>roiSpec</EFDB_Name>
6569
<Description>Specification for region of interest</Description>
@@ -72,10 +76,12 @@
7276
<SALCommand>
7377
<Subsystem>CCCamera</Subsystem>
7478
<EFDB_Topic>CCCamera_command_enableCalibration</EFDB_Topic>
79+
<Description>LSE-71 enableCalibration command</Description>
7580
</SALCommand>
7681
<SALCommand>
7782
<Subsystem>CCCamera</Subsystem>
7883
<EFDB_Topic>CCCamera_command_initImage</EFDB_Topic>
84+
<Description>LSE-71 initImage command</Description>
7985
<item>
8086
<EFDB_Name>deltaT</EFDB_Name>
8187
<Description>Estimate of time period before takeImages will be issued</Description>
@@ -87,10 +93,12 @@
8793
<SALCommand>
8894
<Subsystem>CCCamera</Subsystem>
8995
<EFDB_Topic>CCCamera_command_endImage</EFDB_Topic>
96+
<Description>LSE-71 endImage command</Description>
9097
</SALCommand>
9198
<SALCommand>
9299
<Subsystem>CCCamera</Subsystem>
93100
<EFDB_Topic>CCCamera_command_setFilter</EFDB_Topic>
101+
<Description>LSE-71 setFilter command</Description>
94102
<item>
95103
<EFDB_Name>name</EFDB_Name>
96104
<Description>The filter name to install</Description>
@@ -103,6 +111,7 @@
103111
<SALCommand>
104112
<Subsystem>CCCamera</Subsystem>
105113
<EFDB_Topic>CCCamera_command_clear</EFDB_Topic>
114+
<Description>LSE-71 clear command</Description>
106115
<item>
107116
<EFDB_Name>nClears</EFDB_Name>
108117
<Description>Number of consecutive clear operations to perform</Description>
@@ -114,6 +123,7 @@
114123
<SALCommand>
115124
<Subsystem>CCCamera</Subsystem>
116125
<EFDB_Topic>CCCamera_command_takeImages</EFDB_Topic>
126+
<Description>LSE-71 takeImages command</Description>
117127
<item>
118128
<EFDB_Name>numImages</EFDB_Name>
119129
<Description>Number of consecutive images to take</Description>
@@ -163,11 +173,13 @@
163173
<SALCommand>
164174
<Subsystem>CCCamera</Subsystem>
165175
<EFDB_Topic>CCCamera_command_stop</EFDB_Topic>
176+
<Description>LSE-71 stop command</Description>
166177
</SALCommand>
167178
<!-- Playlist related commands, only valid when using emulated DAQ -->
168179
<SALCommand>
169180
<Subsystem>CCCamera</Subsystem>
170181
<EFDB_Topic>CCCamera_command_play</EFDB_Topic>
182+
<Description>Play specified playlist</Description>
171183
<item>
172184
<EFDB_Name>playlist</EFDB_Name>
173185
<Description>Name of an existing DAQ playlist to play</Description>
@@ -186,6 +198,7 @@
186198
<SALCommand>
187199
<Subsystem>CCCamera</Subsystem>
188200
<EFDB_Topic>CCCamera_command_playlist</EFDB_Topic>
201+
<Description>Define a new playlist</Description>
189202
<item>
190203
<EFDB_Name>playlist</EFDB_Name>
191204
<Description>Name of a DAQ playlist to be defined (replaced if exists)</Description>
@@ -212,6 +225,7 @@
212225
<SALCommand>
213226
<Subsystem>CCCamera</Subsystem>
214227
<EFDB_Topic>CCCamera_command_alert</EFDB_Topic>
228+
<Description>Experimental command -- not currently implemented</Description>
215229
<item>
216230
<EFDB_Name>alertId</EFDB_Name>
217231
<Description>The alertId for which this command applies (or *)</Description>

0 commit comments

Comments
 (0)