ScriptQueue¶

Note

This page is generated by the following 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 “.*”.

move¶

Description: Move a script elsewhere in the queue. This will fail if the script is already running.

EFDB_Topic:	ScriptQueue_command_move

salIndex¶

IDL_Type:	int
Units:	unitless

Description: Index of Script SAL component to move.

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.

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

salIndex¶

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

salIndex¶

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.

abort¶

EFDB_Topic:	SALGeneric_command_abort

value¶

IDL_Type:	boolean
Units:	unitless

Description: Not used

disable¶

Description: Transition from state Enabled to Disabled.

EFDB_Topic:	SALGeneric_command_disable

value¶

IDL_Type:	boolean
Units:	unitless

Description: Not used

enable¶

Description: Transition from state Disabled to Enabled.

EFDB_Topic:	SALGeneric_command_enable

value¶

IDL_Type:	boolean
Units:	unitless

Description: Not used

enterControl¶

Description: Transition from state Offline to Standby. Only “externally commandable” CSCs support this command; other CSCs start in Standby state and quit when they go to Offline.

EFDB_Topic:	SALGeneric_command_enterControl

value¶

IDL_Type:	boolean
Units:	unitless

Description: Not used

exitControl¶

Description: Transition from state Standby to Offline. For CSCs that are not “externally commandable” this makes the CSC quit.

EFDB_Topic:	SALGeneric_command_exitControl

value¶

IDL_Type:	boolean
Units:	unitless

Description: Not used

setAuthList¶

EFDB_Topic:	SALGeneric_command_setAuthList

authorizedUsers¶

IDL_Type:	string
Units:	unitless

Description: Comma seperated list of authorized users currently allowed to command this CSC,: in the form user@host. If the first character is +/- then the specified users are added/removed. Duplicates are silently ignored. The CSC’s own user@host is silently ignored, because it is always authorized. For removal, CSCs that are not in the list are silently ignored. Whitespace is allowed after the optional initial +/- and after each comma.

nonAuthorizedCSCs¶

IDL_Type:	string
Units:	unitless

Description: Comma seperated list of CSC’s not currently allowed to command this CSC,: in the form name[:index]. An index of 0 is stripped (name:0 becomes name). If the first character is +/- then the specified CSCs are added/removed. Duplicates are silently ignored. For removal, CSCs that are not in the list are silently ignored. Whitespace is allowed after the optional initial +/- and after each comma.

setLogLevel¶

Description: Set the logging level.

EFDB_Topic:	SALGeneric_command_setLogLevel

level¶

IDL_Type:	int
Units:	unitless

Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.

setValue¶

EFDB_Topic:	SALGeneric_command_setValue

parametersAndValues¶

IDL_Type:	string
IDL_Size:	256
Units:	unitless

Description: List of parameters and their values as a Json string

standby¶

Description: Transition from state Offline, Disabled or Fault to Standby.

EFDB_Topic:	SALGeneric_command_standby

value¶

IDL_Type:	boolean
Units:	unitless

Description: Not used

start¶

Description: Transition from state Standby to Disable, in a specified configuration.

EFDB_Topic:	SALGeneric_command_start

settingsToApply¶

IDL_Type:	string
IDL_Size:	256
Units:	unitless

Description: Name of the selected settings set

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

salIndex¶

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

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.

survey¶

IDL_Type:	string
Units:	unitless

Description: Survey name.

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

salIndex¶

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.

salIndex¶

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.

appliedSettingsMatchStart¶

EFDB_Topic:	SALGeneric_logevent_appliedSettingsMatchStart

appliedSettingsMatchStartIsTrue¶

IDL_Type:	boolean
Units:	unitless

Description: True when the configuration matches the start conditions

authList¶

EFDB_Topic:	SALGeneric_logevent_authList

authorizedUsers¶

IDL_Type:	string
Units:	unitless

Description: Comma seperated list of authorized users currently allowed to command this CSC.

nonAuthorizedCSCs¶

IDL_Type:	string
Units:	unitless

Description: Comma seperated list of CSC’s not currently allowed to command this CSC.

errorCode¶

Description: Output when a CSC goes into the Fault state as an explanation of the problem.

EFDB_Topic:	SALGeneric_logevent_errorCode

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¶

EFDB_Topic:	SALGeneric_logevent_heartbeat

heartbeat¶

IDL_Type:	boolean
Units:	unitless

Description: Beats the drum.

logLevel¶

Description: Current logging level.

EFDB_Topic:	SALGeneric_logevent_logLevel

level¶

IDL_Type:	int
Units:	unitless

Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.

logMessage¶

Description: A log message.

EFDB_Topic:	SALGeneric_logevent_logMessage

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.

settingVersions¶

Description: Information about settings which can be specified in the start command.

EFDB_Topic:	SALGeneric_logevent_settingVersions

recommendedSettingsVersion¶

IDL_Type:	string
Units:	unitless

Description: List of comma seperated recomended versions of settings sets

recommendedSettingsLabels¶

IDL_Type:	string
Units:	unitless

Description: List of comma seperated names of settings sets

settingsUrl¶

IDL_Type:	string
Units:	unitless

Description: The URL where the settings sets definitions can be found

settingsApplied¶

Description: Base settings applied.

EFDB_Topic:	SALGeneric_logevent_settingsApplied

settingsVersion¶

IDL_Type:	string
IDL_Size:	256
Units:	unitless

Description: The SHA or name corresponding to the published configuration

otherSettingsEvents¶

IDL_Type:	string
Units:	unitless

Description: A comma delimited list of other specific CSC configuration events. This may be blank if no other CSC specific events are necessary

simulationMode¶

Description: Current simulation mode.

EFDB_Topic:	SALGeneric_logevent_simulationMode

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

salVersion¶

IDL_Type:	string
IDL_Size:	16
Units:	unitless

Description: This is the current version of SAL generation

xmlVersion¶

IDL_Type:	string
IDL_Size:	16
Units:	unitless

Description: This is the current version of CSC XML

openSpliceVersion¶

IDL_Type:	string
IDL_Size:	16
Units:	unitless

Description: This is the current version of OpenSplice

cscVersion¶

IDL_Type:	string
IDL_Size:	16
Units:	unitless

Description: This is the top-level version of the 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 a CSC

summaryState¶

Description: Current summary state of the CSC

EFDB_Topic:	SALGeneric_logevent_summaryState

summaryState¶

IDL_Type:	long
Units:	unitless

Description: High level state machine state identifier

Navigation

ScriptQueue¶

Commands¶

add¶

isStandard¶

path¶

config¶

descr¶

location¶

locationSalIndex¶

logLevel¶

pauseCheckpoint¶

stopCheckpoint¶

move¶

salIndex¶

location¶

locationSalIndex¶

pause¶

requeue¶

salIndex¶

location¶

locationSalIndex¶

resume¶

showAvailableScripts¶

showQueue¶

showSchema¶

isStandard¶

path¶

showScript¶

salIndex¶

stopScripts¶

length¶

salIndices¶

terminate¶

abort¶

value¶

disable¶

value¶

enable¶

value¶

enterControl¶

value¶

exitControl¶

value¶

setAuthList¶

authorizedUsers¶

nonAuthorizedCSCs¶

setLogLevel¶

level¶

setValue¶

parametersAndValues¶

standby¶

value¶

start¶

settingsToApply¶

Enumerations¶

Events¶

availableScripts¶

standard¶

external¶

configSchema¶

isStandard¶

path¶

configSchema¶

nextVisit¶

salIndex¶

groupId¶

coordinateSystem¶

position¶

rotationSystem¶

cameraAngle¶

filters¶

dome¶

duration¶

nimages¶

survey¶

nextVisitCanceled¶

salIndex¶

groupId¶

queue¶