ScriptQueue¶
Note
This page is generated by python script generate_cet.py.
Commands¶
- Location:
First
Last
Before
After
add¶
Description: Add a script to the queue and configure it.
- EFDB_Topic:
ScriptQueue_command_add
isStandard¶
- IDL_Type:
boolean
- Units:
unitless
Description: Is this a standard script (True) or an external script (False)?
path¶
- IDL_Type:
string
- Units:
unitless
Description: Path to script, relative to the root directory for standard or external scripts.
config¶
- IDL_Type:
string
- Units:
unitless
Description: Configuration as yaml text that is parsed to make a keyword argument dict for the script’s configure method.
descr¶
- IDL_Type:
string
- Units:
unitless
Description: Short description of why you are running this script.
location¶
- IDL_Type:
byte
- Units:
unitless
Description: Location in the queue; a Location enum.
locationSalIndex¶
- IDL_Type:
int
- Units:
unitless
Description: Index of Script SAL component referred to by location; ignored unless location is Before or After.
logLevel¶
- IDL_Type:
int
- Units:
unitless
Description: Logging level for the script, as a Python logging level: error=40, warning=30, info=20, debug=10, use default=0.
pauseCheckpoint¶
- IDL_Type:
string
- Units:
unitless
Description: Checkpoint(s) at which to pause the script, as a regular expression. No checkpoints if blank; all checkpoints if “.*”.
stopCheckpoint¶
- IDL_Type:
string
- Units:
unitless
Description: Checkpoint(s) at which to stop the script, as a regular expression. No checkpoints if blank; all checkpoints if “.*”.
block¶
- IDL_Type:
string
- Units:
unitless
Description: Name of the observing block the script is part of, e.g. BLOCK-000 (optional).
blockSize¶
- IDL_Type:
int
- Units:
unitless
Description: How many scripts are part of this block?
startBlock¶
- IDL_Type:
boolean
- Units:
unitless
Description: Is this the first script of a new block execution? If true, any currently executing block will be closed.
executionId¶
- IDL_Type:
string
- Units:
unitless
Description: The script execution ID. This is a metadata generated by the OCS when running a script as part of a test execution.
move¶
Description: Move a script elsewhere in the queue. This will fail if the script is already running.
- EFDB_Topic:
ScriptQueue_command_move
scriptSalIndex¶
- IDL_Type:
int
- Units:
unitless
Description: Index of Script SAL component to move.
location¶
- IDL_Type:
byte
- Units:
unitless
Description: New location in the queue; a Location enum.
locationSalIndex¶
- IDL_Type:
int
- Units:
unitless
Description: Index of Script SAL component referred to by location; ignored unless location is Before or After.
pause¶
Description: Pause the queue. If a script is executing it will continue, but once that script is done no new script will be run.
- EFDB_Topic:
ScriptQueue_command_pause
requeue¶
Description: Put a script back on the queue that has already run, is running or is queued.
- EFDB_Topic:
ScriptQueue_command_requeue
scriptSalIndex¶
- IDL_Type:
int
- Units:
unitless
Description: Index of Script SAL component to requeue.
location¶
- IDL_Type:
byte
- Units:
unitless
Description: Location in the queue; a Location enum.
locationSalIndex¶
- IDL_Type:
int
- Units:
unitless
Description: Index of Script SAL component referred to by the location field; ignored unless the location is Before or After.
resume¶
Description: Resume normal operation (unpause the queue).
- EFDB_Topic:
ScriptQueue_command_resume
showAvailableScripts¶
Description: List the scripts that are available.
- EFDB_Topic:
ScriptQueue_command_showAvailableScripts
showQueue¶
Description: Output the queue event.
- EFDB_Topic:
ScriptQueue_command_showQueue
showSchema¶
Description: Show the configuration schema for a given script.
- EFDB_Topic:
ScriptQueue_command_showSchema
isStandard¶
- IDL_Type:
boolean
- Units:
unitless
Description: Is this a standard script (True) or an external script (False)?
path¶
- IDL_Type:
string
- Units:
unitless
Description: Path to script, relative to the root directory for standard or external scripts.
showScript¶
Description: Output script event for a specified script.
- EFDB_Topic:
ScriptQueue_command_showScript
scriptSalIndex¶
- IDL_Type:
int
- Units:
unitless
Description: SAL index of Script for which you want information.
stopScripts¶
Description: Stop one or more queued scripts and/or the current script.
- EFDB_Topic:
ScriptQueue_command_stopScripts
length¶
- IDL_Type:
int
- Units:
unitless
Description: Number of valid entries in salIndices.
salIndices¶
- IDL_Type:
int
- Units:
unitless
- Count:
400
Description: Indices of Script SAL component to stop, 0 terminated.
terminate¶
- IDL_Type:
boolean
- Units:
unitless
Description: If True, terminate the current script without giving it a chance to clean up. If False, try sending a stop command first, and only terminate if if that doesn’t work in a timely fashion.
disable¶
Description: Transition from state Enabled to Disabled.
- EFDB_Topic:
SALGeneric_command_disable
- Category:
csc
enable¶
Description: Transition from state Disabled to Enabled.
- EFDB_Topic:
SALGeneric_command_enable
- Category:
csc
exitControl¶
Description: Transition from state Standby to Offline. Most CSCs will quit, but CSCs that support the enterControl command will keep running.
- EFDB_Topic:
SALGeneric_command_exitControl
- Category:
csc
setLogLevel¶
Description: Set the logging level.
- EFDB_Topic:
SALGeneric_command_setLogLevel
- Category:
csc
level¶
- IDL_Type:
int
- Units:
unitless
Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.
subsystem¶
- IDL_Type:
string
- Units:
unitless
Description: If this CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to this CSC itself.
standby¶
Description: Transition from state Offline/Available, Disabled or Fault to Standby.
- EFDB_Topic:
SALGeneric_command_standby
- Category:
csc
start¶
Description: Transition from state Standby to Disable, in a specified configuration.
- EFDB_Topic:
SALGeneric_command_start
- Category:
csc
configurationOverride¶
- IDL_Type:
string
- Units:
unitless
- Description:
Configuration override in the form [{name}][:{version}]. For salobj-based CSCs: name is a filename with “.yaml” suffix and version is a git hash; for example:
“foo.yaml” specifies just a file. Two or three config files are loaded: “_init.yaml”, “_{site}.yaml” (if present), and “foo.yaml”.
“:37bf936” specifies just a git hash. One or two config files are loaded from the specified git commit: “_init.yaml” and “_{site}.yaml” (if present.
“bar.yaml:HEAD~2” specifies both a file and a git hash. Two or three config files are read from the specified git commit: “_init.yaml”, “_{site}.yaml” (if present), and “bar.yaml”.
Enumerations¶
- ScriptProcessState:
Loading
Configured
Running
Done
LoadFailed
ConfigureFailed
Terminated
Events¶
availableScripts¶
Description: List of available scripts.
- EFDB_Topic:
ScriptQueue_logevent_availableScripts
standard¶
- IDL_Type:
string
- Units:
unitless
Description: Colon-separated paths to standard scripts, relative to the standard root directory.
external¶
- IDL_Type:
string
- Units:
unitless
Description: Colon-separated paths to external scripts, relative to the external root directory.
configSchema¶
Description: Configuration schema for a given script.
- EFDB_Topic:
ScriptQueue_logevent_configSchema
isStandard¶
- IDL_Type:
boolean
- Units:
unitless
Description: Is this a standard script (True) or an external script (False)?
path¶
- IDL_Type:
string
- Units:
unitless
Description: Path to script, relative to the root directory for standard or external scripts.
configSchema¶
- IDL_Type:
string
- Units:
unitless
Description: Configuration schema: jsonschema encoded as yaml.
nextVisit¶
Description: Group ID and other information about the next script to be run.
- EFDB_Topic:
ScriptQueue_logevent_nextVisit
scriptSalIndex¶
- IDL_Type:
int
- Units:
unitless
Description: Index of Script SAL component.
groupId¶
- IDL_Type:
string
- Units:
unitless
Description: Group ID for images taken by the script.
coordinateSystem¶
- IDL_Type:
short
- Units:
unitless
- Enumeration:
CSys_None, CSys_ICRS, CSys_Observed, CSys_Mount
Description: Coordinate system for position. A Script MetadataCoordSys enum. Observed is refracted apparent topocentric, e.g. similar to Mount but the telescope model is applied and the azimuth is wrapped. If None then position should be ignored.
position¶
- IDL_Type:
double
- Units:
degree
- Count:
2
Description: Longitude, latitude axes of position in coordinateSystem
startTime¶
- IDL_Type:
double
- Units:
second
Description: The expected start time for this visit (TAI).
rotationSystem¶
- IDL_Type:
short
- Units:
unitless
- Description: Rotation system for cameraAngle, a Script MetadataRotSys enum
None: The camera rotator is not used; ignore cameraAngle.
Sky: Position angle of focal plane +Y, measured from N through E. At 0 degrees, +Y is along N and +X is along E/W depending on handedness. At 90 degrees, +Y is along E and +X is along S/N depending on handedness.
Horizon: Position angle of focal plane +Y, measured from +Alt through +Az. At 0 degrees, +Y is along +Alt and +X is along +/-Az, depending on handedness. At 90 degrees, +Y is along +Az and +X is along -/+Alt, depending on handedness.
Mount: The position sent to the instrument rotator; the details depend on the rotator.
cameraAngle¶
- IDL_Type:
double
- Units:
degree
Description: Camera angle in rotationSystem
filters¶
- IDL_Type:
string
- Units:
unitless
Description: Comma-separated names of acceptable filters, or blank for any filter.
dome¶
- IDL_Type:
short
- Units:
unitless
Description: Desired dome state; a Script MetadataDome enum.
duration¶
- IDL_Type:
double
- Units:
second
Description: Estimated duration of the script, excluding slewing to the initial position required by the script.
nimages¶
- IDL_Type:
int
- Units:
unitless
Description: Predicted number of images to take; 0 if unknown.
instrument¶
- IDL_Type:
string
- Units:
unitless
Description: Instrument name (the short name used by middleware) used to take the data; blank if unknown or not relevant.
survey¶
- IDL_Type:
string
- Units:
unitless
Description: Survey name.
totalCheckpoints¶
- IDL_Type:
int
- Units:
unitless
Description: Predicted total number of checkpoints that will be seen (counting all repetitions of a repeated checkpoint); 0 if unknown.
nextVisitCanceled¶
Description: The group ID reported by a nextVisit event will not be used, because the script that was next to be run has been cancelled or rescheduled.
- EFDB_Topic:
ScriptQueue_logevent_nextVisitCanceled
scriptSalIndex¶
- IDL_Type:
int
- Units:
unitless
Description: Index of Script SAL component.
groupId¶
- IDL_Type:
string
- Units:
unitless
Description: Group ID for images taken by the script. This ID will not be used.
queue¶
Description: SAL indices of scripts on the queue.
- EFDB_Topic:
ScriptQueue_logevent_queue
enabled¶
- IDL_Type:
boolean
- Units:
unitless
Description: Is the ScriptQueue CSC enabled? New scripts will only be started if both running and enable are True.
running¶
- IDL_Type:
boolean
- Units:
unitless
Description: Is the queue running (True) or paused (False)? New scripts will only be started if both running and enable are True.
currentSalIndex¶
- IDL_Type:
int
- Units:
unitless
Description: SAL index of script being run; 0 if none.
length¶
- IDL_Type:
int
- Units:
unitless
Description: Number of valid entries in salIndices.
salIndices¶
- IDL_Type:
int
- Units:
unitless
- Count:
400
Description: SAL index of each Script on the queue. Item 0 is the next script to be run.
pastLength¶
- IDL_Type:
int
- Units:
unitless
Description: Number of valid entries in pastSalIndices.
pastSalIndices¶
- IDL_Type:
int
- Units:
unitless
- Count:
400
Description: SAL index of scripts that have been run. Item 0 is the script most recently run.
rootDirectories¶
Description: Root directories for scripts.
- EFDB_Topic:
ScriptQueue_logevent_rootDirectories
standard¶
- IDL_Type:
string
- Units:
unitless
Description: Root directory for standard scripts.
external¶
- IDL_Type:
string
- Units:
unitless
Description: Root directory for external scripts.
script¶
Description: Information about a queued script.
- EFDB_Topic:
ScriptQueue_logevent_script
cmdId¶
- IDL_Type:
int
- Units:
unitless
Description: ID of command which queued this script.
scriptSalIndex¶
- IDL_Type:
int
- Units:
unitless
Description: Index of Script SAL component.
isStandard¶
- IDL_Type:
boolean
- Units:
unitless
Description: True if this is a standard script, False if an external script.
path¶
- IDL_Type:
string
- Units:
unitless
Description: Path of script, relative to standard or external root directory.
timestampProcessStart¶
- IDL_Type:
double
- Units:
second
Description: When the script process started. 0 before the process is started.
timestampConfigureStart¶
- IDL_Type:
double
- Units:
second
Description: When script configuration began. 0 before configuration begins.
timestampConfigureEnd¶
- IDL_Type:
double
- Units:
second
Description: When script configuration finished (succeeded or failed). 0 before configuration ends.
timestampRunStart¶
- IDL_Type:
double
- Units:
second
Description: When the script was told to run. 0 before the script is told to run.
timestampProcessEnd¶
- IDL_Type:
double
- Units:
second
Description: When the script process ended. This is also approximately the time at which the script stopped running, if it was ever run. 0 before the script process ends.
processState¶
- IDL_Type:
byte
- Units:
unitless
Description: State of script process; a ScriptProcessState enum. Loading means the script is still being loaded and is not yet configured. Configured means the script has been configured and can be run. Running means the script has been commanded to run. Done means the script has finished (see scriptState to see whether it ran successfully). ConfigureFailed means the process was terminated because the configure command failed. Terminated means the process was terminated due to calling the terminate command, or due to calling the stop command when the script was not running or if running but stopping the script gently failed.
scriptState¶
- IDL_Type:
byte
- Units:
unitless
Description: State of the script; a ScriptState enum from Script_Events.xml; 0 if the script is not yet loaded.
blockId¶
- IDL_Type:
string
- Units:
unitless
Description: Id of the block this script is part of (optional).
scriptBlockIndex¶
- IDL_Type:
int
- Units:
unitless
Description: The position of this script the block (0-based).
blockSize¶
- IDL_Type:
int
- Units:
unitless
Description: The number of scripts in the block.
executionId¶
- IDL_Type:
string
- Units:
unitless
Description: ID generated by the OCS when running a script as part of a test execution (optional).
errorCode¶
Description: Output when this CSC goes into the Fault state as an explanation of the problem.
- EFDB_Topic:
SALGeneric_logevent_errorCode
- Category:
csc
errorCode¶
- IDL_Type:
long
- Units:
unitless
Description: A numeric error code.
errorReport¶
- IDL_Type:
string
- Units:
unitless
Description: An string providing detailed information about the error.
traceback¶
- IDL_Type:
string
- Units:
unitless
Description: An optional stack trace of the error condition.
heartbeat¶
Description: Event output at regular intervals (typcally once per second) to show that the SAL component is alive.
- EFDB_Topic:
SALGeneric_logevent_heartbeat
- Category:
mandatory
heartbeat¶
- IDL_Type:
boolean
- Units:
unitless
Description: Deprecated field that you should ignore.
logLevel¶
Description: Current logging level.
- EFDB_Topic:
SALGeneric_logevent_logLevel
- Category:
mandatory
level¶
- IDL_Type:
int
- Units:
unitless
Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.
subsystem¶
- IDL_Type:
string
- Units:
unitless
Description: If this CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to this CSC itself.
logMessage¶
Description: A log message.
- EFDB_Topic:
SALGeneric_logevent_logMessage
- Category:
mandatory
name¶
- IDL_Type:
string
- Units:
unitless
Description: Log name.
level¶
- IDL_Type:
int
- Units:
unitless
Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.
message¶
- IDL_Type:
string
- Units:
unitless
Description: Log message.
traceback¶
- IDL_Type:
string
- Units:
unitless
Description: Exception traceback; “” if not an exception.
filePath¶
- IDL_Type:
string
- Units:
unitless
Description: Path to source file.
functionName¶
- IDL_Type:
string
- Units:
unitless
Description: Function or method name.
lineNumber¶
- IDL_Type:
long
- Units:
unitless
Description: Line number in the file specified by filePath.
process¶
- IDL_Type:
long
- Units:
unitless
Description: Process ID.
timestamp¶
- IDL_Type:
double
- Units:
second
Description: The time at which the condition being reported was observed (TAI unix seconds). 0 if unspecified.
simulationMode¶
Description: Current simulation mode.
- EFDB_Topic:
SALGeneric_logevent_simulationMode
- Category:
csc
mode¶
- IDL_Type:
int
- Units:
unitless
Description: Current simulation mode; 0 for normal operation (no simulation); other supported values are specific to each CSC.
softwareVersions¶
Description: Current versions of software in use by CSC.
- EFDB_Topic:
SALGeneric_logevent_softwareVersions
- Category:
mandatory
salVersion¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: This is the current version of SAL generation.
xmlVersion¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: This is the current version of CSC XML.
openSpliceVersion¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: This is the current version of OpenSplice.
cscVersion¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: The software version of this CSC.
subsystemVersions¶
- IDL_Type:
string
- Units:
unitless
Description: A comma delimited list of key=value pairs relating subsystem name (key) to its version number (value). This may be left blank if there are no subsystems within this CSC.
summaryState¶
Description: Current summary state of this CSC.
- EFDB_Topic:
SALGeneric_logevent_summaryState
- Category:
csc
summaryState¶
- IDL_Type:
long
- Units:
unitless
Description: High level state machine state identifier.