Scheduler¶
Note
This page is generated by python script generate_cet.py
.
Commands¶
load¶
Description: Load Scheduler driver configuration from URI. File must be compatible with current scheduler configuratiton (as specified in the Driver), or the operation will fail.
- EFDB_Topic
Scheduler_command_load
resume¶
Description: Resume operations. This will cause the Scheduler to start computing an observing queue and feeding it to the ScriptQueue.
- EFDB_Topic
Scheduler_command_resume
stop¶
Description: Stop Scheduler operation and clear all pending observations. By default leave current observation in the queue. If abort is set to True, the current observation will be interrupted.
- EFDB_Topic
Scheduler_command_stop
abort¶
- EFDB_Topic
SALGeneric_command_abort
disable¶
Description: Transition from state Enabled to Disabled.
- EFDB_Topic
SALGeneric_command_disable
enable¶
Description: Transition from state Disabled to Enabled.
- EFDB_Topic
SALGeneric_command_enable
enterControl¶
Description: Transition from state Offline to Standby. Only that start in Offline state CSCs support this command; other CSCs start in Standby state and quit when they go to Offline.
- EFDB_Topic
SALGeneric_command_enterControl
exitControl¶
Description: Transition from state Standby to Offline. For CSCs that start in Standby state this makes the CSC quit. CSCs that start in Offline state, they remain active.
- EFDB_Topic
SALGeneric_command_exitControl
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
Events¶
cameraConfig¶
Description: Observatory model: camera configuration.
- EFDB_Topic
Scheduler_logevent_cameraConfig
filterMountTime¶
- IDL_Type
double
- Units
s
Description: How long does it take to replace a filter in the camera?
filterMounted¶
- IDL_Type
string
- Units
unitless
Description: Comma separated string with the name of the mounted filters
filterRemovable¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated list of filters to be considered for removal/swapping.
filterUnmounted¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated list of filters that are not mounted on the camera but are available for the instrument.
dependenciesVersions¶
Description: Specify the versions of various packages used by the scheduler.
- EFDB_Topic
Scheduler_logevent_dependenciesVersions
detailedState¶
Description: The substate or extra states of the CSC.
- EFDB_Topic
Scheduler_logevent_detailedState
domeConfig¶
Description: Observatory model: dome configuration.
- EFDB_Topic
Scheduler_logevent_domeConfig
driverConfig¶
Description: Basic Scheduler driver configuration.
- EFDB_Topic
Scheduler_logevent_driverConfig
nightBoundary¶
- IDL_Type
double
- Units
deg
Description: Sun altitude that marks the beginning/end of the night.
newMoonPhaseThreshold¶
- IDL_Type
double
- Units
unitless
Description: Moon illumination that marks the beginning/end of dark nights
startupType¶
- IDL_Type
string
- Units
unitless
Description: What type of startup should the scheduler do? COLD, WARM or HOT?
startupDatabase¶
- IDL_Type
string
- Units
unitless
Description: If WARM or HOT start, give the path to the startup database.
invalidateTarget¶
Description: Information about a target that was excluded from the queue.
- EFDB_Topic
Scheduler_logevent_invalidateTarget
needFilterSwap¶
Description: Scheduler request a filter swap.
- EFDB_Topic
Scheduler_logevent_needFilterSwap
needSwap¶
- IDL_Type
boolean
- Units
unitless
Description: Does the scheduler need a new filter mounted on the camera?
obsSiteConfig¶
Description: Observatory model: site configuration.
- EFDB_Topic
Scheduler_logevent_obsSiteConfig
opticsLoopCorrConfig¶
Description: Obbservatory model: Optics loop correction configuration.
- EFDB_Topic
Scheduler_logevent_opticsLoopCorrConfig
telOpticsOlSlope¶
- IDL_Type
double
- Units
second/deg
Description: Multiplication factor to account the time it takes to align the optics given the size of a slew.
telOpticsClAltLimit¶
- IDL_Type
double
- Units
deg
- Count
3
Description: How much can altitude change without the need to perform closed loop correction?
telOpticsClDelay¶
- IDL_Type
double
- Units
second
- Count
2
Description: How long does it take to perform a closed loop?
parkConfig¶
Description: Observatory model: park configuration.
- EFDB_Topic
Scheduler_logevent_parkConfig
rotatorConfig¶
Description: Observatory model: camera rotator configuration.
- EFDB_Topic
Scheduler_logevent_rotatorConfig
positionFilterChange¶
- IDL_Type
double
- Units
deg
Description: Camera rotator position for changing the filter.
followSky¶
- IDL_Type
boolean
- Units
unitless
Description: Should rotator aways align north with camera y-axis?
resumeAngle¶
- IDL_Type
boolean
- Units
unitless
Description: After a filter change, should rotator move back to original position?
schedulerConfig¶
Description: Base Scheduler configuration.
- EFDB_Topic
Scheduler_logevent_schedulerConfig
slewConfig¶
Description: Observatory model: slew configuration.
- EFDB_Topic
Scheduler_logevent_slewConfig
prereqDomalt¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for dome to start moving in altitude. Will wait for these actions before moving.
prereqDomaz¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for dome to start moving in azimuth. Will wait for these actions before moving.
prereqDomazSettle¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for dome to settle in azimuth.
prereqTelalt¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for telescope to start moving in altitude. Will wait for these actions before moving.
prereqTelaz¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for telescope to start moving in azimuth. Will wait for these actions before moving.
prereqTelOpticsOpenLoop¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for telescope optics open loop to start adjusting. Will wait for these actions before moving.
prereqTelOpticsClosedLoop¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for telescope optics closed loop to start adjusting. Will wait for these actions before moving.
prereqTelSettle¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for telescope to settle. Will wait for these actions before moving.
prereqTelRot¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for camera rotator to start moving. Will wait for these actions before moving.
prereqFilter¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for filter change. Will wait for these actions before moving.
prereqExposures¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for exposure to start. Will wait for these actions before moving.
prereqReadout¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for exposure readout to start. Will wait for these actions before moving.
prereqInsOptics¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for optics alignment. Will wait for these actions before moving.
prereqGuiderPos¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites for positioning guider. Will wait for these actions before moving.
prereqGuiderAdq¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated prerequisites guider to start operating. Will wait for these actions before moving.
surveyTopology¶
Description: Contains a general description of the configured surveys.
- EFDB_Topic
Scheduler_logevent_surveyTopology
generalPropos¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated string with the ids of the general proposals.
sequencePropos¶
- IDL_Type
string
- Units
unitless
Description: Comma-separated string with the ids of the sequence proposals.
target¶
Description: Scheduler current target information.
- EFDB_Topic
Scheduler_logevent_target
numProposals¶
- IDL_Type
long
- Units
unitless
Description: Number of science proposals this target is part of.
proposalId¶
- IDL_Type
long
- Units
unitless
- Count
5
Description: Id of the proposals this target is part of.
isSequence¶
- IDL_Type
boolean
- Units
unitless
Description: Is this target part of a sequence of observations for the same target?
sequenceNVisits¶
- IDL_Type
long
- Units
unitless
Description: If isSequence=True, number of visits in this sequence.
sequenceVisits¶
- IDL_Type
long
- Units
unitless
Description: If isSequence=True, which visit is this (1-sequenceNVisits)?
skyBrightness¶
- IDL_Type
double
- Units
unitless
Description: Expected sky brightness of the observation.
telescopeConfig¶
Description: Observatory model: telescope configuration.
- EFDB_Topic
Scheduler_logevent_telescopeConfig
altitudeMinpos¶
- IDL_Type
double
- Units
deg
Description: Telescope minimum reachable altitude position.
altitudeMaxpos¶
- IDL_Type
double
- Units
deg
Description: Telescope maximum reachable altitude position.
altitudeMaxspeed¶
- IDL_Type
double
- Units
deg/s
Description: Telescope maximum speed of the altitude axis.
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
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
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
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.
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
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