DREAM#

Note

This page is generated by python script generate_cet.py.

Back to table

Commands#

pause#

Description:

Operator triggered pause in the operations. If issued while the DREAM dome is opened, the dome shall close and observation either stopped or switched to acquire calibration data.

EFDB_Topic:

DREAM_command_pause

resume#

Description:

Operator triggered resume of the operations. If issued while dome is closed and weather is within limits for operations, dome shall open.

EFDB_Topic:

DREAM_command_resume

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#

Camera:

  • East=0

  • West=1

  • North=2

  • Central=3

  • South=4

CameraServerMode:

  • Auto=0

  • Idle=1

  • Standby=2

  • Blanks=3

  • Bias=4

  • Flats=5

  • Darks=6

  • Science=7

  • Shutdown=8

DomeTargetState:

  • Auto=0

  • Open=1

  • Closed=2

  • Stop=3

  • ForceOpen=4

DomeState:

  • Open=0

  • Closed=1

  • Opening=2

  • Closing=3

  • Stop=4

HeaterState:

  • Auto=0

  • On=1

  • Off=2

  • Unknown=3

PeltierState:

  • Auto=0

  • Cool=1

  • Heat=2

  • Off=3

  • Unknown=4

Warning:

  • PowersavingActivated=0x01

  • UpsOnBattery=0x02

  • DomeClosedByNogo=0x04

  • DomeClosedBySun=0x08

  • DomeClosedByEnv=0x10

  • DomeClosedByUps=0x20

  • DomeClosedByTimer=0x40

  • DomeStopped=0x80

  • DomeForcedOped=0x100

  • DomeClosedByDoor=0x200

  • RubinNoClient=0x400

  • RubinMultipleClients=0x800

  • RubinClientStale=0x1000

  • RubinWeatherTooOld=0x2000

  • RubinBadWeather=0x4000

  • RubinNogo=0x8000

  • ScriptClientActive=0x10000

  • InletHumWarning=0x20000

  • InletTempWarning=0x40000

  • CameraNNotConnected=0x80000

  • CameraSNotConnected=0x100000

  • CameraENotConnected=0x200000

  • CameraWNotConnected=0x400000

  • CameraCNotConnected=0x800000

  • SimulatedDome=0x1000000

  • SimulatedLeds=0x2000000

  • SimulatedUps=0x4000000

  • SimulatedPdu=0x8000000

  • SimulatedEnv=0x10000000

  • SimulatedSun=0x20000000

Error:

  • LimitSwitchError=0x01

  • DomeError=0x02

  • BackdoorOpen=0x04

  • DoorOpen=0x08

  • UpsError=0x10

  • Pdu1Error=0x20

  • Pdu2Error=0x40

  • TemphumError=0x80

  • PsuError=0x100

  • UpsBatteryNeedsReplace=0x200

  • CameraBayTempError=0x400

  • CameraBayHumError=0x800

  • ElectronicsHumidityError=0x1000

  • DomeHumidityError=0x2000

Weather:

  • WeatherBad=0x001

  • WindBad=0x002

  • HumidityBad=0x004

  • PrecipitationBad=0x008

Events#

alerts#

Description: DREAM alerts.

EFDB_Topic:

DREAM_logevent_alerts

outsideHumidity#

IDL_Type:

boolean

Units:

unitless

Description: True if outside humidity, reported by the observatory, is outside safe limits.

outsideTemperature#

IDL_Type:

boolean

Units:

unitless

Description: True if outside temperature, reported by the observatory, is outside safe limits.

camera#

Description: DREAM camera imaging events. Each event corresponds to an exposure.

EFDB_Topic:

DREAM_logevent_camera

source#

IDL_Type:

int

Units:

unitless

Description: The camera that is the source of this event. A Camera enumeration.

cameraMode#

IDL_Type:

int

Units:

unitless

Description: Current operating mode of the camera. A CameraServerMode enumeration.

nBlank#

IDL_Type:

int

Units:

unitless

Description:

Number of images of type “blank” collected by the camera. These images are not saved but their collection is recorded for completeness.

nDark#

IDL_Type:

int

Units:

unitless

Description: Number of dark images collected by the camera.

nBias#

IDL_Type:

int

Units:

unitless

Description: Number of bias images collected by the camera.

nFlat#

IDL_Type:

int

Units:

unitless

Description: Number of flat field images collected by the camera.

nScience#

IDL_Type:

int

Units:

unitless

Description: Number of science images collected by the camera.

nMissed#

IDL_Type:

int

Units:

unitless

Description: Number of images that were “missed” by the pipeline.

lastSequenceNumber#

IDL_Type:

int

Units:

unitless

Description: Sequence number of the most recent collected image.

lastTriggerTime#

IDL_Type:

double

Units:

second

Description: Trigger time (TAI) of the most recent collected image.

lastImageTimingLatency#

IDL_Type:

float

Units:

second

Description: Timing latency of the most recent collected image.

lastImageUSBLatency#

IDL_Type:

float

Units:

second

Description: USB latency of the most recent collected image.

lastImageArtificialLatency#

IDL_Type:

float

Units:

second

Description: Artificial latency of the most recent collected image.

lastImageType#

IDL_Type:

int

Units:

unitless

Description: Image type of the most recent collected image. A CameraServerMode enumeration.

lastImagePixelMedian#

IDL_Type:

float

Units:

unitless

Description: Median pixel value of the most recent collected image.

errors#

Description: DREAM alerts.

EFDB_Topic:

DREAM_logevent_errors

domeHumidity#

IDL_Type:

boolean

Units:

unitless

Description: True if dome humidity is outside safe range.

enclosureTemperature#

IDL_Type:

boolean

Units:

unitless

Description: True if enclosure temperature is outside safe range.

enclosureHumidity#

IDL_Type:

boolean

Units:

unitless

Description: True if enclosure humidity is outside safe range.

electronicsBoxCommunication#

IDL_Type:

boolean

Units:

unitless

Description: True if electronics box cannot be reached.

temperatureSensorCommunication#

IDL_Type:

boolean

Units:

unitless

Count:

3

Description: True if given temperature sensor doesn’t provide temperature updates.

domePositionUnknown#

IDL_Type:

boolean

Units:

unitless

Description: True if dome position as reported by the absolute encoder is unknown, and therefore system cannot operate the dome.

daqCommunication#

IDL_Type:

boolean

Units:

unitless

Description: True if communication with DAQ (Data Acquisition) is lost.

pduCommunication#

IDL_Type:

boolean

Units:

unitless

Description: True if communication with the Power Distribution Unit (PDU) is lost.

powerSupply#

Description: Power supply error events.

EFDB_Topic:

DREAM_logevent_powerSupply

temperatureError#

IDL_Type:

boolean

Units:

unitless

Description:

If true, the temperature status feedback channel for the power supply has become active.

inputVoltageError#

IDL_Type:

boolean

Units:

unitless

Description:

If true, the input voltage status feedback channel for the power supply has become active.

setRoof#

Description: Most recent setRoof command from the CSC to the DREAM controller.

EFDB_Topic:

DREAM_logevent_setRoof

roof#

IDL_Type:

boolean

Units:

unitless

Description:

Most recent data sent to DREAM with the setRoof command, indicating whether DREAM should proceed with observing.

setWeather#

Description: Most recent setWeather command from the CSC to the DREAM controller.

EFDB_Topic:

DREAM_logevent_setWeather

weather#

IDL_Type:

boolean

Units:

unitless

Description:

Most recent data sent to DREAM with the setWeather command, indicating that it is okay to open.

status#

Description: DREAM subsystem status.

EFDB_Topic:

DREAM_logevent_status

paused#

IDL_Type:

boolean

Units:

unitless

Description: If true, DREAM observations are paused by operator, using pause command.

observingMode#

IDL_Type:

int

Units:

unitless

Description:

The current observing mode for DREAM. A CameraServerMode enumeration.

targetObservingMode#

IDL_Type:

int

Units:

unitless

Description:

The desired mode for DREAM, which DREAM should be working to enter. A CameraServerMode enumeration.

dome#

IDL_Type:

int

Units:

unitless

Description:

The current state of the enclosure. A DomeState enumeration.

targetDome#

IDL_Type:

int

Units:

unitless

Description:

The desired state of the enclosure, which DREAM should be working to enter. A DomeTargetState enumeration.

heater#

IDL_Type:

int

Units:

unitless

Description:

The current state of the heater. A HeaterState enumeration.

targetHeater#

IDL_Type:

int

Units:

unitless

Description:

The desired state of the heater, which DREAM should be working to enter. A HeaterState enumeration.

peltier#

IDL_Type:

int

Units:

unitless

Description:

The current state of the peltier regulator. A PeltierState enumeration.

targetPeltier#

IDL_Type:

int

Units:

unitless

Description:

The desired state of the peltier regulator, which DREAM should be working to enter. A PeltierState enumeration.

power#

IDL_Type:

boolean

Units:

unitless

Count:

15

Description:

For each of the devices controlled by the power distribution unit, true if the PDU is supplying power to that device. The devices are:

  1. Switch

  2. USB hub

  3. PSU 1

  4. PSU 2

  5. Central Camera

  6. North Camera

  7. East Camera

  8. South Camera

  9. West Camera

  10. Command Server

  11. Central Server

  12. North Server

  13. East Server

  14. South Server

  15. West Server

relayState#

IDL_Type:

boolean

Units:

unitless

Count:

5

Description:

Whether each of DREAM’s relays are switched. The relay controls are:

  1. Motor power

  2. Motor direction

  3. Peltier power

  4. Peltier direction

  5. Window heater power

errorFlags#

IDL_Type:

long long

Units:

unitless

Description:

A bit flag indicating errors reported by DREAM, defined by the Error enumeration.

warningFlags#

IDL_Type:

long long

Units:

unitless

Description:

A bit flag indicating warnings reported by DREAM, defined by the Warning enumeration.

additionalErrors#

IDL_Type:

string

Units:

unitless

Description:

Any errors reported by DREAM that are not in the Error enumeration. The string contains a brief text description of the each error, with the errors separated by semicolons.

additionalWarnings#

IDL_Type:

string

Units:

unitless

Description:

Any warnings reported by DREAM that are not in the Warning enumeration. The string contains a brief text description of the each warning, with the warnings separated by semicolons.

temperatureControl#

Description: DREAM temperature control status.

EFDB_Topic:

DREAM_logevent_temperatureControl

heatingOn#

IDL_Type:

boolean

Units:

unitless

Description: Heating on/off. True for on.

coolingOn#

IDL_Type:

boolean

Units:

unitless

Description: Cooling on/off. True for on.

ups#

Description: DREAM Uninterruptible Power Supply (UPS) status.

EFDB_Topic:

DREAM_logevent_ups

online#

IDL_Type:

boolean

Units:

unitless

Description: True when UPS is online. False when UPS is offline.

batteryLow#

IDL_Type:

boolean

Units:

unitless

Description: True when UPS battery charge is low.

batteryNeedsReplacing#

IDL_Type:

boolean

Units:

unitless

Description: True when UPS reports that it needs a new battery.

inputLastError#

IDL_Type:

string

Units:

unitless

Description: The last reason reported by the UPS for switching to battery.

notOnMains#

IDL_Type:

boolean

Units:

unitless

Description: True when UPS commercial power isn’t running, the UPS is providing power from its battery.

communicationError#

IDL_Type:

boolean

Units:

unitless

Description: True for communication error.

weather#

Description:

Current weather status inferred from the ESS CSC for the weather station. This is a bitmask, with each set bit indicating that the corresponding weather parameter is NOT acceptable for operation of DREAM. Flags are documented by the Weather enum and may be extended as needed.

EFDB_Topic:

DREAM_logevent_weather

weatherFlags#

IDL_Type:

long

Units:

unitless

Description: Bitmask indicating good weather to open DREAM.

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.

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#

camera#

Description: Telemetry for the DREAM cameras. Each attribute has five values, one for each camera:

  1. East

  2. West

  3. North

  4. Central

  5. South

EFDB_Topic:

DREAM_camera

lastCameraHeartbeatTimestamp#

IDL_Type:

double

Units:

second

Count:

5

Description: Time (TAI) of last camera server heartbeat.

ccdTemperature#

IDL_Type:

float

Units:

deg_C

Count:

5

Description: CCD temperature.

dome#

Description: DREAM dome telemetry.

EFDB_Topic:

DREAM_dome

encoder#

IDL_Type:

int

Units:

unitless

Description: Dome encoder readout.

environment#

Description: Ambient environment measured in various locations within DREAM. Indexed by location:

  1. Electronics top

  2. Camera bay

  3. Electronics box

  4. Rack top

  5. Rack bottom

  6. DREAM inlet

EFDB_Topic:

DREAM_environment

temperature#

IDL_Type:

float

Units:

deg_C

Count:

6

Description: Measured temperature.

humidity#

IDL_Type:

float

Units:

%

Count:

6

Description: Measured humidity.

powerSupply#

Description: DREAM power supply status.

EFDB_Topic:

DREAM_powerSupply

voltage#

IDL_Type:

float

Units:

V

Count:

2

Description: Power supply output voltage (0) feedback and (1) setpoint.

current#

IDL_Type:

float

Units:

A

Count:

2

Description: Power supply output current (0) feedback and (1) setpoint.

ups#

Description: DREAM UPS telemetry.

EFDB_Topic:

DREAM_ups

batteryCharge#

IDL_Type:

float

Units:

%

Description: Battery charge percentage. Reported by the UPS, 100 means the battery is fully charged.

batteryTemperature#

IDL_Type:

float

Units:

deg_C

Description: Battery temperature reported by the UPS.

batteryVoltage#

IDL_Type:

float

Units:

V

Description: Battery voltage reported by the UPS.

timeRemaining#

IDL_Type:

float

Units:

min

Description: Estimated run time remaining, reported by the UPS.

outputLoad#

IDL_Type:

float

Units:

%

Description: Output load currently reported by the UPS as a percent of total capacity.

outputCurrent#

IDL_Type:

float

Units:

amp

Description: Output current reported by the UPS.

lastOnline#

IDL_Type:

double

Units:

second

Description: Timestamp (TAI) of the most recent information update from the UPS.