====== Script ====== Commands -------- configure ~~~~~~~~~ **Description**: Configure a script. :Subsystem: Script :EFDB_Topic: Script_command_configure config ****** :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **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 :Count: 1 **Description**: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10, use default=0. pauseCheckpoint *************** :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Checkpoint(s) at which to pause, as a regular expression. No checkpoints if blank; all checkpoints if ".*". stopCheckpoint ************** :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Checkpoint(s) at which to stop, as a regular expression. No checkpoints if blank; all checkpoints if ".*". run ~~~ **Description**: Run a script. :Subsystem: Script :EFDB_Topic: Script_command_run ignored ******* :IDL_Type: byte :Units: unitless :Count: 1 **Description**: This field is ignored. resume ~~~~~~ **Description**: Resume a paused script. :Subsystem: Script :EFDB_Topic: Script_command_resume ignored ******* :IDL_Type: byte :Units: unitless :Count: 1 **Description**: This field is ignored. setGroupId ~~~~~~~~~~ **Description**: Set the group ID for this script. :Subsystem: Script :EFDB_Topic: Script_command_setGroupId groupId ******* :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Group ID for images taken by the script. 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. :Subsystem: Script :EFDB_Topic: Script_command_setCheckpoints pause ***** :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Checkpoint(s) at which to pause, as a regular expression. No checkpoints if blank; all checkpoints if ".*". stop **** :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Checkpoint(s) at which to stop, as a regular expression. No checkpoints if blank; all checkpoints if ".*". stop ~~~~ **Description**: Stop the script immediately. :Subsystem: Script :EFDB_Topic: Script_command_stop ignored ******* :IDL_Type: byte :Units: unitless :Count: 1 **Description**: This field is ignored. Events ------ * ScriptState_Unconfigured * ScriptState_Configured * ScriptState_Running * ScriptState_Paused * ScriptState_Ending * ScriptState_Stopping * ScriptState_Failing * ScriptState_Done * ScriptState_Stopped * ScriptState_Failed * MetadataCoordSys_None * MetadataCoordSys_ICRS * MetadataCoordSys_Observed * MetadataCoordSys_Mount * MetadataRotSys_None * MetadataRotSys_Sky * MetadataRotSys_Horizon * MetadataRotSys_Mount * MetadataDome_Closed * MetadataDome_Open * MetadataDome_Either checkpoints ~~~~~~~~~~~ **Description**: Pause and stop checkpoints. :Subsystem: Script :EFDB_Topic: Script_logevent_checkpoints pause ***** :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Checkpoint(s) at which to pause, as a regular expression. No checkpoints if blank; all checkpoints if ".*". stop **** :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Checkpoint(s) at which to stop, as a regular expression. No checkpoints if blank; all checkpoints if ".*". description ~~~~~~~~~~~ **Description**: Script, class name, description and a list of the remotes it uses -- basically metadata that does not usually depend on configuration. :Subsystem: Script :EFDB_Topic: Script_logevent_description classname ********* :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Name of script class. description *********** :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Brief description of the script. remotes ******* :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **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). metadata ~~~~~~~~ **Description**: Script metadata that may depend on configuration. :Subsystem: Script :EFDB_Topic: Script_logevent_metadata coordinateSystem **************** :IDL_Type: short :Units: unitless :Count: 1 :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 :Count: 1 **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. cameraAngle *********** :IDL_Type: double :Units: degree :Count: 1 **Description**: Camera angle in rotationSystem filters ******* :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Comma-separated names of acceptable filters, or blank for any filter. dome **** :IDL_Type: short :Units: unitless :Count: 1 **Description**: Desired dome state; a MetadataDome enum. duration ******** :IDL_Type: double :Units: second :Count: 1 **Description**: Estimated duration of the script, excluding slewing to the initial position required by the script. nimages ******* :IDL_Type: int :Units: unitless :Count: 1 **Description**: Predicted number of images to take; 0 if unknown. survey ****** :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Survey name. state ~~~~~ **Description**: Script state. :Subsystem: Script :EFDB_Topic: Script_logevent_state state ***** :IDL_Type: byte :Units: unitless :Count: 1 :Enumeration: Unconfigured,Configured,Running,Paused,Ending,Stopping,Failing,Done,Stopped,Failed **Description**: A ScriptState enum indicating the script state. reason ****** :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: More information about the state change; typically a reason for failure if the state is FAILED. groupId ******* :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Group ID; none if "". lastCheckpoint ************** :IDL_Type: string :IDL_Size: 1 :Units: unitless :Count: 1 **Description**: Name of most recently seen checkpoint.