Scheduler

Note

This page is generated by python script generate_cet.py.

Back to table

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

uri

IDL_Type:string
Units:unitless

Description: URI of the configuration.

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

value

IDL_Type:boolean
Units:unitless

Description: Not used

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

IDL_Type:boolean
Units:unitless

Description: Abort current observation.

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

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

Events

cameraConfig

Description: Observatory model: camera configuration.

EFDB_Topic:Scheduler_logevent_cameraConfig

readoutTime

IDL_Type:double
Units:s

Description: Camera readout time

shutterTime

IDL_Type:double
Units:s

Description: Camera open/close shutter time.

filterMountTime

IDL_Type:double
Units:s

Description: How long does it take to replace a filter in the camera?

filterChangeTime

IDL_Type:double
Units:s

Description: How long does it take to change the filter?

filterMounted

IDL_Type:string
Units:unitless

Description: Comma separated string with the name of the mounted filters

filterPos

IDL_Type:string
Units:unitless

Description: Current filter position.

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

version

IDL_Type:string
Units:unitless

Description: Applied settings version.

scheduler

IDL_Type:string
Units:unitless

Description: Scheduler version

cloudModel

IDL_Type:string
Units:unitless

Description: Cloud model version

downtimeModel

IDL_Type:string
Units:unitless

Description: Downtime model version

seeingModel

IDL_Type:string
Units:unitless

Description: Seeing model version

skybrightnessModel

IDL_Type:string
Units:unitless

Description: Skybrightness model version

observatoryModel

IDL_Type:string
Units:unitless

Description: Observatory model version.

observatoryLocation

IDL_Type:string
Units:unitless

Description: Observatory location version

detailedState

Description: The substate or extra states of the CSC.

EFDB_Topic:Scheduler_logevent_detailedState

substate

IDL_Type:long
Units:unitless

Description: The substate or extra states of the CSC

domeConfig

Description: Observatory model: dome configuration.

EFDB_Topic:Scheduler_logevent_domeConfig

altitudeMaxspeed

IDL_Type:double
Units:deg/s

Description: Dome altitude maximum speed.

altitudeAccel

IDL_Type:double
Units:deg/s2

Description: Dome acceleration in altitude.

altitudeDecel

IDL_Type:double
Units:deg/s2

Description: Dome deceleration in altitude

altitudeFreerange

IDL_Type:double
Units:deg

Description: Dome free range in altitude.

azimuthMaxspeed

IDL_Type:double
Units:deg/s

Description: Dome maximum speed in azimuth.

azimuthAccel

IDL_Type:double
Units:deg/s2

Description: Dome acceleration in azimuth.

azimuthDecel

IDL_Type:double
Units:deg/s2

Description: Dome deceleration in azimuth.

azimuthFreerange

IDL_Type:double
Units:deg

Description: Dome free range in azimuth.

settleTime

IDL_Type:double
Units:second

Description: Dome settle time.

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

targetId

IDL_Type:long
Units:unitless

Description: Unique target id.

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?

filterToMount

IDL_Type:string
Units:unitless

Description: Which filter to add.

filterToUnmount

IDL_Type:string
Units:unitless

Description: Which filter to remove.

obsSiteConfig

Description: Observatory model: site configuration.

EFDB_Topic:Scheduler_logevent_obsSiteConfig

observatoryName

IDL_Type:string
Units:unitless

Description: Name of the observatory.

latitude

IDL_Type:double
Units:deg

Description: Latitude of the observatory.

longitude

IDL_Type:double
Units:deg

Description: Longitude of the observatory.

height

IDL_Type:double
Units:m

Description: Height of the observatory.

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

telescopeAltitude

IDL_Type:double
Units:deg

Description: Telescope parking altitude.

telescopeAzimuth

IDL_Type:double
Units:deg

Description: Telescope parking azimuth

telescopeRotator

IDL_Type:double
Units:deg

Description: Telescope parking rotator position.

domeAltitude

IDL_Type:double
Units:deg

Description: Dome parking altitude.

domeAzimuth

IDL_Type:double
Units:deg

Description: Dome parking azimuth.

filterPosition

IDL_Type:string
Units:unitless

Description: Parking filter.

rotatorConfig

Description: Observatory model: camera rotator configuration.

EFDB_Topic:Scheduler_logevent_rotatorConfig

positionMin

IDL_Type:double
Units:deg

Description: Camera rotator minimum position.

positionMax

IDL_Type:double
Units:deg

Description: Camera rotator maximum position.

positionFilterChange

IDL_Type:double
Units:deg

Description: Camera rotator position for changing the filter.

speedMax

IDL_Type:double
Units:deg/s

Description: Camera rotator maximum speed.

accel

IDL_Type:double
Units:deg/s2

Description: Camera rotator acceleration.

decel

IDL_Type:double
Units:deg/s2

Description: Camera rotator deceleration.

manualRotator

IDL_Type:boolean
Units:unitless

Description: Is rotator in manual mode?

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

surveyDuration

IDL_Type:double
Units:year

Description: Survey duration.

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.

prereqAdc

IDL_Type:string
Units:unitless

Description: Not sure what this is about.

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

numGeneralProps

IDL_Type:long
Units:unitless

Description: Number of general proposals.

generalPropos

IDL_Type:string
Units:unitless

Description: Comma-separated string with the ids of the general proposals.

numSeqProps

IDL_Type:long
Units:unitless

Description: Number of time-series 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

targetId

IDL_Type:long
Units:unitless

Description: Unique target id.

requestTime

IDL_Type:double
Units:second

Description: Time on target.

requestMjd

IDL_Type:double
Units:day

Description: MJD of the start of the observation

ra

IDL_Type:double
Units:deg

Description: Right Ascention of the target.

decl

IDL_Type:double
Units:deg

Description: Declination of the target.

skyAngle

IDL_Type:double
Units:deg

Description: Sky position angle.

filter

IDL_Type:string
Units:unitless

Description: Filter name.

numExposures

IDL_Type:long
Units:unitless

Description: Number of exposures.

exposureTimes

IDL_Type:double
Units:second
Count:10

Description: Exposure time.

slewTime

IDL_Type:double
Units:second

Description: Expected slew time.

offsetX

IDL_Type:double
Units:arcsec

Description: Offset in X direction (sensor).

offsetY

IDL_Type:double
Units:arcsec

Description: Offset in Y direction (sensor).

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)?

sequenceDuration

IDL_Type:double
Units:unitless

Description: Total duration of the sequence.

airmass

IDL_Type:double
Units:unitless

Description: Expected airmass of the observation

skyBrightness

IDL_Type:double
Units:unitless

Description: Expected sky brightness of the observation.

cloud

IDL_Type:double
Units:unitless

Description: Expected cloud extintion for this observation

seeing

IDL_Type:double
Units:arcsec

Description: Expected seeing of this observation.

moonRa

IDL_Type:double
Units:deg

Description: Expected RA of the moon.

moonDec

IDL_Type:double
Units:deg

Description: Expected Dec of the moon

moonAlt

IDL_Type:double
Units:deg

Description: Expected altitude of the moon.

moonAz

IDL_Type:double
Units:deg

Description: Expected azimuth of the moon

moonDistance

IDL_Type:double
Units:deg

Description: Expected distance to the moon.

moonPhase

IDL_Type:double
Units:unitless

Description: Expected moon phase/illumination (0-1).

sunRa

IDL_Type:double
Units:deg

Description: Expected sun RA.

sunDec

IDL_Type:double
Units:deg

Description: Expected sun dec.

sunAlt

IDL_Type:double
Units:deg

Description: Expected sun altitude.

sunAz

IDL_Type:double
Units:deg

Description: Expected sun Az.

solarElong

IDL_Type:double
Units:deg

Description: Expected solar elongation.

note

IDL_Type:string
Units:unitless

Description: Note about the target.

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.

azimuthMinpos

IDL_Type:double
Units:deg

Description: Telescope minimum reachable azimuth position.

azimuthMaxpos

IDL_Type:double
Units:deg

Description: Telescope maximum reachable azimuth position.

altitudeMaxspeed

IDL_Type:double
Units:deg/s

Description: Telescope maximum speed of the altitude axis.

altitudeAccel

IDL_Type:double
Units:deg/s2

Description: Telescope altitude acceleration.

altitudeDecel

IDL_Type:double
Units:deg/s2

Description: Telescope altitude deceleration.

azimuthMaxspeed

IDL_Type:double
Units:deg/s

Description: Telescope maximum speed in azimuth

azimuthAccel

IDL_Type:double
Units:deg/s2

Description: Telescope azimuth acceleration.

azimuthDecel

IDL_Type:double
Units:deg/s2

Description: Telescope azimuth deceleration.

settleTime

IDL_Type:double
Units:second

Description: Telescope settle time.

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: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

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

Telemetry

observatoryState

Description: Information about the current state of the observatory, as seen by the Scheduler.

EFDB_Topic:Scheduler_observatoryState

timestamp

IDL_Type:double
Units:second

Description: Current timestamp at the observatory

ra

IDL_Type:double
Units:deg

Description: Current pointing RA.

declination

IDL_Type:double
Units:deg

Description: Current pointing Declination

positionAngle

IDL_Type:double
Units:deg

Description: Current pointing sky position angle

parallacticAngle

IDL_Type:double
Units:deg

Description: Current parallactic angle.

tracking

IDL_Type:boolean
Units:unitless

Description: Is the telescope tracking?

telescopeAltitude

IDL_Type:double
Units:deg

Description: Telescope altitude.

telescopeAzimuth

IDL_Type:double
Units:deg

Description: telescope azimuth

telescopeRotator

IDL_Type:double
Units:deg

Description: telescope rotator position

domeAltitude

IDL_Type:double
Units:deg

Description: Dome altitude position

domeAzimuth

IDL_Type:double
Units:deg

Description: dome azimuth position

filterPosition

IDL_Type:string
Units:unitless

Description: Current filter.

filterMounted

IDL_Type:string
Units:unitless

Description: Current mounted/available filters.

filterUnmounted

IDL_Type:string
Units:unitless

Description: Current unmounted/unavailable filters.