:tocdepth: 3 ###### Script ###### .. note:: This page is generated by the following python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- .. _Script:Commands:configure: configure ~~~~~~~~~ **Description**: Configure a script. :EFDB_Topic: Script_command_configure .. _Script:Commands:configure:config: 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. .. _Script:Commands:configure:logLevel: 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. .. _Script:Commands:configure:pauseCheckpoint: pauseCheckpoint *************** :IDL_Type: string :Units: unitless **Description**: Checkpoint(s) at which to pause, as a regular expression. No checkpoints if blank; all checkpoints if ".*". .. _Script:Commands:configure:stopCheckpoint: stopCheckpoint ************** :IDL_Type: string :Units: unitless **Description**: Checkpoint(s) at which to stop, as a regular expression. No checkpoints if blank; all checkpoints if ".*". .. _Script:Commands:resume: resume ~~~~~~ **Description**: Resume a paused script. :EFDB_Topic: Script_command_resume .. _Script:Commands:run: run ~~~ **Description**: Run a script. :EFDB_Topic: Script_command_run .. _Script:Commands:setCheckpoints: 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 .. _Script:Commands:setCheckpoints:pause: pause ***** :IDL_Type: string :Units: unitless **Description**: Checkpoint(s) at which to pause, as a regular expression. No checkpoints if blank; all checkpoints if ".*". .. _Script:Commands:setCheckpoints:stop: stop **** :IDL_Type: string :Units: unitless **Description**: Checkpoint(s) at which to stop, as a regular expression. No checkpoints if blank; all checkpoints if ".*". .. _Script:Commands:setGroupId: setGroupId ~~~~~~~~~~ **Description**: Set the group ID for this script. :EFDB_Topic: Script_command_setGroupId .. _Script:Commands:setGroupId:groupId: groupId ******* :IDL_Type: string :Units: unitless **Description**: Group ID for images taken by the script. .. _Script:Commands:stop: stop ~~~~ **Description**: Stop the script immediately. :EFDB_Topic: Script_command_stop setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _Script:setAuthList:authorizedUsers: 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. .. _Script:setAuthList:nonAuthorizedCSCs: 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 .. _Script:setLogLevel:level: level ***** :IDL_Type: int :Units: unitless **Description**: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10. 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 ------ .. _Script:Events:checkpoints: checkpoints ~~~~~~~~~~~ **Description**: Pause and stop checkpoints. :EFDB_Topic: Script_logevent_checkpoints .. _Script:Events:checkpoints:pause: pause ***** :IDL_Type: string :Units: unitless **Description**: Checkpoint(s) at which to pause, as a regular expression. No checkpoints if blank; all checkpoints if ".*". .. _Script:Events:checkpoints:stop: stop **** :IDL_Type: string :Units: unitless **Description**: Checkpoint(s) at which to stop, as a regular expression. No checkpoints if blank; all checkpoints if ".*". .. _Script:Events:description: description ~~~~~~~~~~~ **Description**: Script, class name, description and a list of the remotes it uses -- basically metadata that does not usually depend on configuration. :EFDB_Topic: Script_logevent_description .. _Script:Events:description:classname: classname ********* :IDL_Type: string :Units: unitless **Description**: Name of script class. .. _Script:Events:description:description: description *********** :IDL_Type: string :Units: unitless **Description**: Brief description of the script. .. _Script:Events:description:remotes: 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 : if the component is indexed (and possibly with :0 if not indexed). .. _Script:Events:metadata: metadata ~~~~~~~~ **Description**: Script metadata that may depend on configuration. :EFDB_Topic: Script_logevent_metadata .. _Script:Events:metadata:coordinateSystem: 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. .. _Script:Events:metadata:position: position ******** :IDL_Type: double :Units: degree :Count: 2 **Description**: Longitude, latitude axes of position in coordinateSystem .. _Script:Events:metadata:rotationSystem: 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. .. _Script:Events:metadata:cameraAngle: cameraAngle *********** :IDL_Type: double :Units: degree **Description**: Camera angle in rotationSystem .. _Script:Events:metadata:filters: filters ******* :IDL_Type: string :Units: unitless **Description**: Comma-separated names of acceptable filters, or blank for any filter. .. _Script:Events:metadata:dome: dome **** :IDL_Type: short :Units: unitless **Description**: Desired dome state; a MetadataDome enum. .. _Script:Events:metadata:duration: duration ******** :IDL_Type: double :Units: second **Description**: Estimated duration of the script, excluding slewing to the initial position required by the script. .. _Script:Events:metadata:nimages: nimages ******* :IDL_Type: int :Units: unitless **Description**: Predicted number of images to take; 0 if unknown. .. _Script:Events:metadata:survey: survey ****** :IDL_Type: string :Units: unitless **Description**: Survey name. .. _Script:Events:state: state ~~~~~ **Description**: Script state. :EFDB_Topic: Script_logevent_state .. _Script:Events:state: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. .. _Script:Events:state:reason: reason ****** :IDL_Type: string :Units: unitless **Description**: More information about the state change; typically a reason for failure if the state is FAILED. .. _Script:Events:state:groupId: groupId ******* :IDL_Type: string :Units: unitless **Description**: Group ID; none if "". .. _Script:Events:state:lastCheckpoint: lastCheckpoint ************** :IDL_Type: string :Units: unitless **Description**: Name of most recently seen checkpoint. authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _Script:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _Script:authList:nonAuthorizedCSCs: 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 .. _Script:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _Script:logLevel:level: 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 .. _Script:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _Script:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _Script:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _Script:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _Script:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _Script:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _Script:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _Script:logMessage:process: process ******* :IDL_Type: long :Units: unitless **Description**: Process ID.