:tocdepth: 3 ### ESS ### .. note:: This page is generated by the following python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- abort ~~~~~ :EFDB_Topic: SALGeneric_command_abort .. _ESS:abort:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used disable ~~~~~~~ **Description**: Transition from state Enabled to Disabled. :EFDB_Topic: SALGeneric_command_disable .. _ESS:disable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enable ~~~~~~ **Description**: Transition from state Disabled to Enabled. :EFDB_Topic: SALGeneric_command_enable .. _ESS:enable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enterControl ~~~~~~~~~~~~ **Description**: Transition from state Offline to Standby. Only "externally commandable" CSCs support this command; other CSCs start in Standby state and quit when they go to Offline. :EFDB_Topic: SALGeneric_command_enterControl .. _ESS:enterControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used exitControl ~~~~~~~~~~~ **Description**: Transition from state Standby to Offline. For CSCs that are not "externally commandable" this makes the CSC quit. :EFDB_Topic: SALGeneric_command_exitControl .. _ESS:exitControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _ESS: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. .. _ESS: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 .. _ESS: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 .. _ESS: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 .. _ESS:standby:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used start ~~~~~ **Description**: Transition from state Standby to Disable, in a specified configuration. :EFDB_Topic: SALGeneric_command_start .. _ESS: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 .. _ESS:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _ESS:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _ESS: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 .. _ESS:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _ESS:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _ESS:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _ESS:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _ESS: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 .. _ESS:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _ESS:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _ESS:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _ESS:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _ESS:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _ESS:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _ESS:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _ESS: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 .. _ESS:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _ESS:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _ESS: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 .. _ESS:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _ESS: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 .. _ESS: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 .. _ESS:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of SAL generation .. _ESS:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of CSC XML .. _ESS:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of OpenSplice .. _ESS:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the top-level version of the CSC .. _ESS: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 .. _ESS:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _ESS:Telemetry:airFlow: airFlow ~~~~~~~ **Description**: AirFlow Sensor - Windsonic1-L (Bi-axial) Serial to Ethernet Converter :EFDB_Topic: ESS_airFlow .. _ESS:Telemetry:airFlow:timestamp: timestamp ********* :IDL_Type: double :Units: second :Conversion: None :Sensor_location: None **Description**: Time at which the data was determined (TAI unix seconds). .. _ESS:Telemetry:airFlow:direction: direction ********* :IDL_Type: short :Units: unitless :Conversion: None :Sensor_location: None **Description**: Wind direction Telemetry .. _ESS:Telemetry:airFlow:speed: speed ***** :IDL_Type: float :Units: m/s :Conversion: None :Sensor_location: None **Description**: Wind speed Telemetry .. _ESS:Telemetry:airFlow:status: status ****** :IDL_Type: unsigned short :Units: unitless :Conversion: None :Sensor_location: None **Description**: Status Code Telemetry .. _ESS:Telemetry:airTurbulence: airTurbulence ~~~~~~~~~~~~~ **Description**: Air Turbulence Instrument - CSAT3B (Tri-Axial) Serial to Ethernet Converter :EFDB_Topic: ESS_airTurbulence .. _ESS:Telemetry:airTurbulence:timestamp: timestamp ********* :IDL_Type: double :Units: second :Conversion: None :Sensor_location: None **Description**: Time at which the data was determined (TAI unix seconds). .. _ESS:Telemetry:airTurbulence:ux: ux ** :IDL_Type: float :Units: m/s :Conversion: None :Sensor_location: None **Description**: x-axis wind speed .. _ESS:Telemetry:airTurbulence:uy: uy ** :IDL_Type: float :Units: m/s :Conversion: None :Sensor_location: None **Description**: y-axis wind speed .. _ESS:Telemetry:airTurbulence:uz: uz ** :IDL_Type: float :Units: m/s :Conversion: None :Sensor_location: None **Description**: z-axis wind speed .. _ESS:Telemetry:airTurbulence:ts: ts ** :IDL_Type: float :Units: unitless :Conversion: None :Sensor_location: None **Description**: Sonic temperature .. _ESS:Telemetry:airTurbulence:diagWord: diagWord ******** :IDL_Type: short :Units: unitless :Conversion: None :Sensor_location: None **Description**: Diagnostic word .. _ESS:Telemetry:airTurbulence:recordCounter: recordCounter ************* :IDL_Type: short :Units: unitless :Conversion: None :Sensor_location: None **Description**: Record counter (0-63) .. _ESS:Telemetry:cloudRainLight: cloudRainLight ~~~~~~~~~~~~~~ **Description**: Cloud Rain Light Sensors Serial to Ethernet Converter :EFDB_Topic: ESS_cloudRainLight .. _ESS:Telemetry:cloudRainLight:timestamp: timestamp ********* :IDL_Type: double :Units: second :Conversion: None :Sensor_location: None **Description**: Time at which the data was determined (TAI unix seconds). .. _ESS:Telemetry:cloudRainLight:ambientTemperature: ambientTemperature ****************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Ambient Temperature Sensor Telemetry .. _ESS:Telemetry:cloudRainLight:skyTemperature: skyTemperature ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Sky Temperature Sensor Telemetry .. _ESS:Telemetry:cloudRainLight:lightLevel: lightLevel ********** :IDL_Type: float :Units: unitless :Conversion: None :Sensor_location: None **Description**: Light Level Telemetry .. _ESS:Telemetry:cloudRainLight:rainLevel: rainLevel ********* :IDL_Type: float :Units: mm :Conversion: None :Sensor_location: None **Description**: Rain Level Telemetry .. _ESS:Telemetry:temperature1Ch: temperature1Ch ~~~~~~~~~~~~~~ **Description**: Temperature Sensors (4-Channel) Serial to Ethernet Converter :EFDB_Topic: ESS_temperature1Ch .. _ESS:Telemetry:temperature1Ch:timestamp: timestamp ********* :IDL_Type: double :Units: second :Conversion: None :Sensor_location: None **Description**: Time at which the data was determined (TAI unix seconds). .. _ESS:Telemetry:temperature1Ch:temperatureC01: temperatureC01 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 1 Telemetry .. _ESS:Telemetry:temperature4Ch: temperature4Ch ~~~~~~~~~~~~~~ **Description**: Temperature Sensors (4-Channel) Serial to Ethernet Converter :EFDB_Topic: ESS_temperature4Ch .. _ESS:Telemetry:temperature4Ch:timestamp: timestamp ********* :IDL_Type: double :Units: second :Conversion: None :Sensor_location: None **Description**: Time at which the data was determined (TAI unix seconds). .. _ESS:Telemetry:temperature4Ch:temperatureC01: temperatureC01 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 1 Telemetry .. _ESS:Telemetry:temperature4Ch:temperatureC02: temperatureC02 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 2 Telemetry .. _ESS:Telemetry:temperature4Ch:temperatureC03: temperatureC03 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 3 Telemetry .. _ESS:Telemetry:temperature4Ch:temperatureC04: temperatureC04 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 4 Telemetry .. _ESS:Telemetry:temperature8Ch: temperature8Ch ~~~~~~~~~~~~~~ **Description**: Temperature Sensors (8-Channel) Serial to Ethernet Converter :EFDB_Topic: ESS_temperature8Ch .. _ESS:Telemetry:temperature8Ch:timestamp: timestamp ********* :IDL_Type: double :Units: second :Conversion: None :Sensor_location: None **Description**: Time at which the data was determined (TAI unix seconds). .. _ESS:Telemetry:temperature8Ch:temperatureC01: temperatureC01 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 1 Telemetry .. _ESS:Telemetry:temperature8Ch:temperatureC02: temperatureC02 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 2 Telemetry .. _ESS:Telemetry:temperature8Ch:temperatureC03: temperatureC03 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 3 Telemetry .. _ESS:Telemetry:temperature8Ch:temperatureC04: temperatureC04 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 4 Telemetry .. _ESS:Telemetry:temperature8Ch:temperatureC05: temperatureC05 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 5 Telemetry .. _ESS:Telemetry:temperature8Ch:temperatureC06: temperatureC06 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 6 Telemetry .. _ESS:Telemetry:temperature8Ch:temperatureC07: temperatureC07 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 7 Telemetry .. _ESS:Telemetry:temperature8Ch:temperatureC08: temperatureC08 ************** :IDL_Type: float :Units: deg_C :Conversion: None :Sensor_location: None **Description**: Temperature Sensor 8 Telemetry