Scheduler¶
Note
This page is generated by python script generate_cet.py.
Commands¶
addBlock¶
Description: Add new block to the scheduling queue.
- EFDB_Topic:
Scheduler_command_addBlock
id¶
- IDL_Type:
string
- Units:
unitless
Description: Block name (e.g., OBS-123).
executionId¶
- IDL_Type:
string
- Units:
unitless
Description: ID generated by the OCS for the block execution.
override¶
- IDL_Type:
string
- Units:
unitless
Description: Override information in the block with those provided here.
failureStrategy¶
- IDL_Type:
long
- Units:
unitless
Description: What strategy to employ when there is a script failure?
computePredictedSchedule¶
Description: This command causes the scheduler to compute and publish the predicted schedule. It can only run if the scheduler is idle (resume command not sent). This runs automatically as part of the advance operation mode so this command is only useful when users want to estimate what is ahead when the scheduler is not running.
- EFDB_Topic:
Scheduler_command_computePredictedSchedule
getBlockStatus¶
Description: Publish status information for a block.
- EFDB_Topic:
Scheduler_command_getBlockStatus
id¶
- IDL_Type:
string
- Units:
unitless
Description: Block id to get status from (e.g., OBS-123).
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.
removeBlock¶
Description: Remove blocks from the scheduling queue.
- EFDB_Topic:
Scheduler_command_removeBlock
ids¶
- IDL_Type:
string
- Units:
unitless
Description: Comma-separated list of block ids to be removed (e.g., OBS-123,OBS-124).
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¶
- IDL_Type:
boolean
- Units:
unitless
Description: Abort current observation.
validateBlock¶
Description: Validate block.
- EFDB_Topic:
Scheduler_command_validateBlock
id¶
- IDL_Type:
string
- Units:
unitless
Description: The name of the block (e.g., OBS-123).
override¶
- IDL_Type:
string
- Units:
unitless
Description: Override information in the block with those provided here.
disable¶
Description: Transition from state Enabled to Disabled.
- EFDB_Topic:
SALGeneric_command_disable
- Category:
csc
enable¶
Description: Transition from state Disabled to Enabled.
- EFDB_Topic:
SALGeneric_command_enable
- Category:
csc
exitControl¶
Description: Transition from state Standby to Offline. Most CSCs will quit, but CSCs that support the enterControl command will keep running.
- EFDB_Topic:
SALGeneric_command_exitControl
- Category:
csc
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 this 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 this CSC itself.
standby¶
Description: Transition from state Offline/Available, Disabled or Fault to Standby.
- EFDB_Topic:
SALGeneric_command_standby
- Category:
csc
start¶
Description: Transition from state Standby to Disable, in a specified configuration.
- EFDB_Topic:
SALGeneric_command_start
- Category:
csc
configurationOverride¶
- IDL_Type:
string
- Units:
unitless
- Description:
Configuration override in the form [{name}][:{version}]. For salobj-based CSCs: name is a filename with “.yaml” suffix and version is a git hash; for example:
“foo.yaml” specifies just a file. Two or three config files are loaded: “_init.yaml”, “_{site}.yaml” (if present), and “foo.yaml”.
“:37bf936” specifies just a git hash. One or two config files are loaded from the specified git commit: “_init.yaml” and “_{site}.yaml” (if present.
“bar.yaml:HEAD~2” specifies both a file and a git hash. Two or three config files are read from the specified git commit: “_init.yaml”, “_{site}.yaml” (if present), and “bar.yaml”.
Enumerations¶
- DetailedState:
IDLE
RUNNING
WAITING_NEXT_TARGET_TIMER_TASK
GENERATING_TARGET_QUEUE
COMPUTING_PREDICTED_SCHEDULE
QUEUEING_TARGET
- FailureStrategy:
NONE
ON_SCRIPT_FAILURE
KEEP_GOING
Events¶
blockInventory¶
Description: Inventory of all the available blocks.
- EFDB_Topic:
Scheduler_logevent_blockInventory
ids¶
- IDL_Type:
string
- Units:
unitless
Description: Comma-separated list of block ids.
status¶
- IDL_Type:
string
- Units:
unitless
Description: Comma-separated list of status for each individual block.
blockStatus¶
Description: Status of an individual block.
- EFDB_Topic:
Scheduler_logevent_blockStatus
id¶
- IDL_Type:
string
- Units:
unitless
Description: Id of the block (e.g. OBS-123).
statusId¶
- IDL_Type:
long
- Units:
unitless
Description: Id of the status as an enumeration.
status¶
- IDL_Type:
string
- Units:
unitless
Description: Status of the block, as a human readable string.
executionsCompleted¶
- IDL_Type:
long
- Units:
unitless
Description: Number of successful executions.
executionsTotal¶
- IDL_Type:
long
- Units:
unitless
Description: Total number of executions to be completed.
hash¶
- IDL_Type:
string
- Units:
unitless
Description: A unique identifier for this block.
definition¶
- IDL_Type:
string
- Units:
unitless
Description: The full block definition.
failureStrategy¶
- IDL_Type:
long
- Units:
unitless
Description: Strategy used when there is a script failure.
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.
generalInfo¶
Description: Event with general information about the Scheduler.
- EFDB_Topic:
Scheduler_logevent_generalInfo
isNight¶
- IDL_Type:
boolean
- Units:
unitless
Description: Track if the scheduler conditions determine if it is night time or not.
night¶
- IDL_Type:
long
- Units:
unitless
Description: How many nights since the start of the survey.
sunset¶
- IDL_Type:
double
- Units:
second
Description: Sunset UTC timestamp (seconds).
sunrise¶
- IDL_Type:
double
- Units:
second
Description: Sunrise UTC timestamp (seconds).
twilightCivilEvening¶
- IDL_Type:
double
- Units:
second
Description: Evening civil twilight (sun alt=-6deg, after sunset) in UTC timestamp (seconds).
twilightCivilMorning¶
- IDL_Type:
double
- Units:
second
Description: Morning civil twilight (sun alt=-6deg, before sunrise) in UTC timestamp (seconds).
twilightNauticalEvening¶
- IDL_Type:
double
- Units:
second
Description: Evening nautical twilight (sun alt=-12deg, after sunset) in UTC timestamp (seconds).
twilightNauticalMorning¶
- IDL_Type:
double
- Units:
second
Description: Morning nautical twilight (sun alt=-12deg, before sunrise) in UTC timestamp (seconds).
twilightAstronomicalEvening¶
- IDL_Type:
double
- Units:
second
Description: Evening astronomical twilight (sun alt=-18deg, after sunset) in UTC timestamp (seconds).
twilightAstronomicalMorning¶
- IDL_Type:
double
- Units:
second
Description: Morning astronomical twilight (sun alt=-18deg, before sunrise) in UTC timestamp (seconds).
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.
observation¶
Description: Observation executed by the scheduler. This event is published soon after the observation is registered as successfully executed, usually when the Script sent by the CSC to the ScriptQueue finishes executing successfully.
- EFDB_Topic:
Scheduler_logevent_observation
targetId¶
- IDL_Type:
long
- Units:
unitless
Description: Unique target id.
ra¶
- IDL_Type:
double
- Units:
deg
Description: Right Ascension of the target.
decl¶
- IDL_Type:
double
- Units:
deg
Description: Declination of the target.
rotSkyPos¶
- IDL_Type:
double
- Units:
deg
Description: The rotation angle of the camera relative to the sky E of N (degrees).
mjd¶
- IDL_Type:
double
- Units:
day
Description: Modified Julian Date at the start of the observation.
exptime¶
- IDL_Type:
double
- Units:
second
Description: Total exposure time of the visit.
filter¶
- IDL_Type:
string
- Units:
unitless
Description: The filter used. Should be one of u, g, r, i, z, y.
nexp¶
- IDL_Type:
long
- Units:
unitless
Description: Number of exposures.
additionalInformation¶
- IDL_Type:
string
- Units:
unitless
Description: Any additional information produced by the Scheduler or scheduling algorithm in a yaml format.
observingMode¶
Description: Information about the current observing mode.
- EFDB_Topic:
Scheduler_logevent_observingMode
modeId¶
- IDL_Type:
long
- Units:
unitless
Description: Current observing mode id.
mode¶
- IDL_Type:
string
- Units:
unitless
Description: Current observing mode as a human-readable string.
typeValue¶
- IDL_Type:
long
- Units:
unitless
Description: Id of the type of observation.
type¶
- IDL_Type:
string
- Units:
unitless
Description: Type of observation as a human-readable string.
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.
predictedSchedule¶
Description: Predicted schedule. This topic contains information about the future targets the scheduler will likely observe.
- EFDB_Topic:
Scheduler_logevent_predictedSchedule
numberOfTargets¶
- IDL_Type:
long
- Units:
unitless
Description: Number of targets in the predicted scheduler. Maximum is 1000.
ra¶
- IDL_Type:
double
- Units:
deg
- Count:
1000
Description: List of Right Ascension for the targets.
decl¶
- IDL_Type:
double
- Units:
deg
- Count:
1000
Description: List of Declination for the targets.
rotSkyPos¶
- IDL_Type:
double
- Units:
deg
- Count:
1000
Description: List of rotation angle of the camera relative to the sky E of N (degrees).
mjd¶
- IDL_Type:
double
- Units:
day
- Count:
1000
Description: List of Modified Julian Date at the start of the observations.
exptime¶
- IDL_Type:
double
- Units:
second
- Count:
1000
Description: List of total exposure time for each visit.
instrumentConfiguration¶
- IDL_Type:
string
- Units:
unitless
Description: Comma-separated List of filters/instrument configuration used for each observation.
nexp¶
- IDL_Type:
double
- Units:
unitless
- Count:
1000
Description: List of number of exposures for each visit.
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.
blockId¶
- IDL_Type:
long
- Units:
unitless
Description: Target block 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.
alt¶
- IDL_Type:
double
- Units:
deg
Description: Altitude of the target.
az¶
- IDL_Type:
double
- Units:
deg
Description: Azimuth 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.
schedulerNote¶
- IDL_Type:
string
- Units:
unitless
Description: Note about the target.
targetName¶
- IDL_Type:
string
- Units:
unitless
Description: Target name.
snapshotUri¶
- IDL_Type:
string
- Units:
unitless
Description: The uri of the most recent scheduler snapshopt.
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.
timeToNextTarget¶
Description: Publish estimated time until the next target.
- EFDB_Topic:
Scheduler_logevent_timeToNextTarget
currentTime¶
- IDL_Type:
double
- Units:
second
Description: UTC timestamp when the estimation was done (seconds).
waitTime¶
- IDL_Type:
double
- Units:
second
Description: How long until the next target.
ra¶
- IDL_Type:
double
- Units:
deg
Description: Estimated Right Ascension of the target.
decl¶
- IDL_Type:
double
- Units:
deg
Description: Estimated Declination of the target.
rotSkyPos¶
- IDL_Type:
double
- Units:
deg
Description: Estimated rotation angle of the camera relative to the sky E of N (degrees).
configurationApplied¶
Description: Information about this CSC’s current configuration overrides.
- EFDB_Topic:
SALGeneric_logevent_configurationApplied
- Category:
configurable
configurations¶
- IDL_Type:
string
- Units:
unitless
Description: A comma-separated list of configurations applied. If configuration comes from a clone of a git repo, or similar directory, then it will be a list of file names, without the file extension. Ignore whitespace after commas.
version¶
- IDL_Type:
string
- Units:
unitless
Description: Version of the configuration source. For a clone of a git repo it will be a git hash.
url¶
- IDL_Type:
string
- Units:
unitless
Description: URL of the configuration source. For a clone of a git repo this will be a file URL. For a database it will be a standard database URL. This should always match the same-named field in configurationsAvailable.
schemaVersion¶
- IDL_Type:
string
- Units:
unitless
Description: Version of config schema used by this CSC. For a configuration git repo, this is the name of a folder in the config package, and is typically something like “v1”. This should always match the same-named field in configurationsAvailable.
otherInfo¶
- IDL_Type:
string
- Units:
unitless
Description: A comma-separated list of event topics (without the logevent prefix) used to publish the entire set of configuration parameters loaded by this CSC, and any other pertinent information. Ignore whitespace after commas.
configurationsAvailable¶
Description: Available configuration overrides for this CSC.
- EFDB_Topic:
SALGeneric_logevent_configurationsAvailable
- Category:
configurable
overrides¶
- IDL_Type:
string
- Units:
unitless
Description: Available overrides as a comma-separated list. Each entry is a possible value of the configurationOverride field of the start command. Ignore whitespace after commas.
version¶
- IDL_Type:
string
- Units:
unitless
Description: Version of the configuration source. For a clone of a git repo it will be a git hash.
url¶
- IDL_Type:
string
- Units:
unitless
Description: URL of the configuration source. For a clone of a git repo this will be a file URL. For a database it will be a standard database URL.
schemaVersion¶
- IDL_Type:
string
- Units:
unitless
Description: Version of config schema used by this CSC. For a configuration git repo, this is the name of a folder in the config package, and is typically something like “v1”.
errorCode¶
Description: Output when this CSC goes into the Fault state as an explanation of the problem.
- EFDB_Topic:
SALGeneric_logevent_errorCode
- Category:
csc
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¶
Description: Event output at regular intervals (typcally once per second) to show that the SAL component is alive.
- EFDB_Topic:
SALGeneric_logevent_heartbeat
- Category:
mandatory
heartbeat¶
- IDL_Type:
boolean
- Units:
unitless
Description: Deprecated field that you should ignore.
largeFileObjectAvailable¶
Description: A new large file object is available.
- 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.
byteSize¶
- IDL_Type:
long
- Units:
unitless
Description: Size of file in bytes.
checkSum¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: Hexadecimal character string holding the checksum of the file.
mimeType¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: Mime Type code for the file.
id¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: A generic identifier field.
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 this 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 this CSC itself.
logMessage¶
Description: A log message.
- EFDB_Topic:
SALGeneric_logevent_logMessage
- Category:
mandatory
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.
timestamp¶
- IDL_Type:
double
- Units:
second
Description: The time at which the condition being reported was observed (TAI unix seconds). 0 if unspecified.
simulationMode¶
Description: Current simulation mode.
- EFDB_Topic:
SALGeneric_logevent_simulationMode
- Category:
csc
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
- 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: The software version of this 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 this CSC.
summaryState¶
Description: Current summary state of this CSC.
- EFDB_Topic:
SALGeneric_logevent_summaryState
- Category:
csc
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.