:tocdepth: 3 ##### DREAM ##### .. note:: This page is generated by python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- .. _DREAM:Commands:getDataProduct: getDataProduct ~~~~~~~~~~~~~~ **Description**: Request a data product from DREAM. :EFDB_Topic: DREAM_command_getDataProduct .. _DREAM:Commands:getDataProduct:product_name: product_name ************ :IDL_Type: string :Units: unitless **Description**: The name of the DREAM data product. .. _DREAM:Commands:getDataProduct:timestamp: timestamp ********* :IDL_Type: string :Units: unitless **Description**: The TAI timestamp of observation producing the DREAM data product. .. _DREAM:Commands:operate: operate ~~~~~~~ **Description**: Operate DREAM, meaning taking images, or not. :EFDB_Topic: DREAM_command_operate .. _DREAM:Commands:operate:operating: operating ********* :IDL_Type: boolean :Units: unitless **Description**: DREAM operating, meaning taking images, or not. .. _DREAM:Commands:setEnabled: setEnabled ~~~~~~~~~~ **Description**: Enable or disable DREAM. :EFDB_Topic: DREAM_command_setEnabled .. _DREAM:Commands:setEnabled:enabled: enabled ******* :IDL_Type: boolean :Units: unitless **Description**: DREAM enabled or disabled. .. _DREAM:Commands:setWeatherInfo: setWeatherInfo ~~~~~~~~~~~~~~ **Description**: Send the weather information to DREAM. :EFDB_Topic: DREAM_command_setWeatherInfo .. _DREAM:Commands:setWeatherInfo:weatherInfo: weatherInfo *********** :IDL_Type: string :Units: unitless **Description**: The weather info for DREAM in JSON format. .. _DREAM:Commands:status: status ~~~~~~ **Description**: Request a full DREAM system status. :EFDB_Topic: DREAM_command_status 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 .. _DREAM:setAuthList:authorizedUsers: 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. .. _DREAM:setAuthList:nonAuthorizedCSCs: 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 .. _DREAM:setLogLevel:level: 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 .. _DREAM:setValue:parametersAndValues: 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 .. _DREAM:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Events ------ appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _DREAM:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _DREAM:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _DREAM:authList:nonAuthorizedCSCs: 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 .. _DREAM:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _DREAM:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _DREAM:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _DREAM:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _DREAM:logLevel:level: 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 .. _DREAM:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _DREAM:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _DREAM:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _DREAM:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _DREAM:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _DREAM:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _DREAM:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _DREAM:logMessage:process: 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 .. _DREAM:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _DREAM:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _DREAM:settingVersions:settingsUrl: 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 .. _DREAM:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _DREAM:settingsApplied:otherSettingsEvents: 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 .. _DREAM:simulationMode:mode: 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 .. _DREAM:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of SAL generation .. _DREAM:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of CSC XML .. _DREAM:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of OpenSplice .. _DREAM:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the top-level version of the CSC .. _DREAM:softwareVersions:subsystemVersions: 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 .. _DREAM:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _DREAM:Telemetry:dataProduct: dataProduct ~~~~~~~~~~~ **Description**: The name and value of the DREAM data product. :EFDB_Topic: DREAM_dataProduct .. _DREAM:Telemetry:dataProduct:product_name: product_name ************ :IDL_Type: string :Units: unitless **Description**: The name of the DREAM data product. .. _DREAM:Telemetry:dataProduct:value: value ***** :IDL_Type: string :Units: unitless **Description**: The value of the DREAM data product. .. _DREAM:Telemetry:status: status ~~~~~~ **Description**: The full DREAM system status. :EFDB_Topic: DREAM_status .. _DREAM:Telemetry:status:status: status ****** :IDL_Type: string :Units: unitless **Description**: The full DREAM system status in JSON format.