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

setAuthList#

Description: Specify who can command this CSC.

EFDB_Topic:

SALGeneric_command_setAuthList

Category:

csc

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

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#

DREAMDome:
  • Closed=0

  • Opening=1

  • Opened=2

  • Closing=3

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.

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.

status#

Description: DREAM subsystrem status.

EFDB_Topic:

DREAM_logevent_status

paused#

IDL_Type:

boolean

Units:

unitless

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

environmentOK#

IDL_Type:

boolean

Units:

unitless

Count:

3

Description: DREAM environmental OK flag. Indexed by location - 0 Dome, 1 Electronics Box, 2 Enclosure. True means OK.

powerDistributionUnitOnline#

IDL_Type:

boolean

Units:

unitless

Count:

2

Description: Power distribution unit online flag. True is online.

domeStatus#

IDL_Type:

int

Units:

unitless

Description: DREAM dome status. Closed/Opening/Opened/Closing.

domeOpenLimitSwitch#

IDL_Type:

boolean

Units:

unitless

Description: Opened dome limit switch state. True for triggered, dome is opened.

domeCloseLimitSwitch#

IDL_Type:

boolean

Units:

unitless

Description: Closed dome limit switch state. True for triggered, dome is closed.

frontDoorOpen#

IDL_Type:

boolean

Units:

unitless

Description: Front door opened switch. True for triggered, front door is opened.

backDoorOpen#

IDL_Type:

boolean

Units:

unitless

Description: Back door opened switch. True for triggered, back door is opened.

daq#

IDL_Type:

boolean

Units:

unitless

Description: Digital Acquisition (DAQ) status. True if DAQ is working as expected.

cameraLEDStatus#

IDL_Type:

boolean

Units:

unitless

Count:

5

Description: Camera LED status. True when LED is on.

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

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.

authList#

Description: Who can command this CSC.

EFDB_Topic:

SALGeneric_logevent_authList

Category:

csc

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.

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#

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 - 0 Dome, 1 Electronics Box, 2 Enclosure.

EFDB_Topic:

DREAM_environment

temperature#

IDL_Type:

float

Units:

deg_C

Count:

3

Description: Measured temperature.

humidity#

IDL_Type:

float

Units:

%

Count:

3

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.

current#

IDL_Type:

float

Units:

A

Count:

2

Description: Power supply output current.

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.