Script¶
Note
This page is generated by python script generate_cet.py.
Commands¶
configure¶
Description: Configure a script.
- EFDB_Topic
Script_command_configure
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.
logLevel¶
- IDL_Type
int
- Units
unitless
Description: Logging level, 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, as a regular expression. No checkpoints if blank; all checkpoints if “.*”.
stopCheckpoint¶
- IDL_Type
string
- Units
unitless
Description: Checkpoint(s) at which to stop, as a regular expression. No checkpoints if blank; all checkpoints if “.*”.
setCheckpoints¶
Description: Set or clear checkpoints at which to pause and stop the script. This command is deprecated. Please specify log level as part of the configure command instead.
- EFDB_Topic
Script_command_setCheckpoints
pause¶
- IDL_Type
string
- Units
unitless
Description: Checkpoint(s) at which to pause, as a regular expression. No checkpoints if blank; all checkpoints if “.*”.
stop¶
- IDL_Type
string
- Units
unitless
Description: Checkpoint(s) at which to stop, as a regular expression. No checkpoints if blank; all checkpoints if “.*”.
setAuthList¶
- EFDB_Topic
SALGeneric_command_setAuthList
- Category
csc
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
- 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 the 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 the CSC itself.
Enumerations¶
- ScriptState
Unconfigured
Configured
Running
Paused
Ending
Stopping
Failing
Done
Stopped
Failed
- MetadataCoordSys
None
ICRS
Observed
Mount
- MetadataRotSys
None
Sky
Horizon
Mount
- MetadataDome
Closed
Open
Either
Events¶
checkpoints¶
Description: Pause and stop checkpoints.
- EFDB_Topic
Script_logevent_checkpoints
pause¶
- IDL_Type
string
- Units
unitless
Description: Checkpoint(s) at which to pause, as a regular expression. No checkpoints if blank; all checkpoints if “.*”.
stop¶
- IDL_Type
string
- Units
unitless
Description: Checkpoint(s) at which to stop, as a regular expression. No checkpoints if blank; all checkpoints if “.*”.
description¶
Description: Script, class name, description, help, and a list of the remotes it uses – basically metadata that does not usually depend on configuration.
- EFDB_Topic
Script_logevent_description
help¶
- IDL_Type
string
- Units
unitless
Description: Detailed help for the script. Markdown formatting is encouraged. This need not duplicate descriptions in the configuration schema.
remotes¶
- IDL_Type
string
- Units
unitless
Description: Names of remote SAL components used by the script as a comma-separated list. Each name is appended with :<index> if the component is indexed (and possibly with :0 if not indexed).
metadata¶
Description: Script metadata that may depend on configuration.
- EFDB_Topic
Script_logevent_metadata
coordinateSystem¶
- IDL_Type
short
- Units
unitless
- Enumeration
CSys_None, CSys_ICRS, CSys_Observed, CSys_Mount
Description: Coordinate system for position. A 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 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.
filters¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated names of acceptable filters, or blank for any filter.
duration¶
- IDL_Type
double
- Units
second
Description: Estimated duration of the script, excluding slewing to the initial position required by the script.
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.
state¶
Description: Script state.
- EFDB_Topic
Script_logevent_state
state¶
- IDL_Type
byte
- Units
unitless
- Enumeration
Unconfigured,Configured,Running,Paused,Ending,Stopping,Failing,Done,Stopped,Failed
Description: A ScriptState enum indicating the script state.
reason¶
- IDL_Type
string
- Units
unitless
Description: More information about the state change; typically a reason for failure if the state is FAILED.
numCheckpoints¶
- IDL_Type
int
- Units
unitless
Description: The number of checkpoints seen (including repetitions of repeated checkpoints).
authList¶
- EFDB_Topic
SALGeneric_logevent_authList
- Category
csc
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.
heartbeat¶
- EFDB_Topic
SALGeneric_logevent_heartbeat
- Category
mandatory
largeFileObjectAvailable¶
Description: Large file object available event.
- EFDB_Topic
SALGeneric_logevent_largeFileObjectAvailable
url¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: A Uniform Resource Locator which links to a Large File Object either for ingest into the EFD Large File Annex, or to announce the successful copy of same to the EFD Large File Annex.Protocols are those supported by the cURL library.
generator¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: Name of the package which generated the file being announced
version¶
- IDL_Type
float
- Units
unitless
Description: A dotted x.y version number denoting the file format revision
checkSum¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: Hexadecimal character string holding the checksum of the file
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 the 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 the CSC itself.
logMessage¶
Description: A log message.
- EFDB_Topic
SALGeneric_logevent_logMessage
- Category
mandatory
level¶
- IDL_Type
int
- Units
unitless
Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.
lineNumber¶
- IDL_Type
long
- Units
unitless
Description: Line number in the file specified by filePath.
timestamp¶
- IDL_Type
double
- Units
second
Description: The time at which the condition being reported was observed (TAI unix seconds). 0 if unspecified.
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: 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