:tocdepth: 3 ########### Environment ########### .. note:: This page is generated by the following python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- abort ~~~~~ :EFDB_Topic: SALGeneric_command_abort .. _Environment:abort:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used disable ~~~~~~~ **Description**: Transition from state Enabled to Disabled. :EFDB_Topic: SALGeneric_command_disable .. _Environment:disable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enable ~~~~~~ **Description**: Transition from state Disabled to Enabled. :EFDB_Topic: SALGeneric_command_enable .. _Environment: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 .. _Environment: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 .. _Environment:exitControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _Environment: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. .. _Environment: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 .. _Environment: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 .. _Environment: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 .. _Environment: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 .. _Environment: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 .. _Environment:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _Environment:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _Environment: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 .. _Environment:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _Environment:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _Environment:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _Environment:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _Environment: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 .. _Environment:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _Environment:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _Environment:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _Environment:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _Environment:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _Environment:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _Environment:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _Environment: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 .. _Environment:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _Environment:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _Environment: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 .. _Environment:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _Environment: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 .. _Environment: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 .. _Environment:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of SAL generation .. _Environment:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of CSC XML .. _Environment:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of OpenSplice .. _Environment:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the top-level version of the CSC .. _Environment: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 .. _Environment:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _Environment:Telemetry:airPressure: airPressure ~~~~~~~~~~~ :EFDB_Topic: Environment_airPressure .. _Environment:Telemetry:airPressure:paAvg1M: paAvg1M ******* :IDL_Type: double :Units: pa **Description**: 1 minute average value .. _Environment:Telemetry:airPressure:patrValue3H: patrValue3H *********** :IDL_Type: double :Units: pa **Description**: Value for the last 3 hours for Air Pressure trend .. _Environment:Telemetry:airPressure:pateValue3H: pateValue3H *********** :IDL_Type: double :Units: pa **Description**: Value for the last 3 hours for Air Pressure Tendency .. _Environment:Telemetry:airPressure:sensorName: sensorName ********** :IDL_Type: string :Units: pa **Description**: Sensor model used to measure this parameters .. _Environment:Telemetry:airTemperature: airTemperature ~~~~~~~~~~~~~~ :EFDB_Topic: Environment_airTemperature .. _Environment:Telemetry:airTemperature:avg24H: avg24H ****** :IDL_Type: double :Units: degree **Description**: 24 hours average .. _Environment:Telemetry:airTemperature:avg1M: avg1M ***** :IDL_Type: double :Units: degree **Description**: 1 minute average value .. _Environment:Telemetry:airTemperature:max24H: max24H ****** :IDL_Type: double :Units: degree **Description**: Maximum value during the last 24 hours .. _Environment:Telemetry:airTemperature:min24H: min24H ****** :IDL_Type: double :Units: degree **Description**: Minimum value during the last 24 hours .. _Environment:Telemetry:airTemperature:sensorName: sensorName ********** :IDL_Type: string :Units: degree **Description**: Sensor model used to measure this parameters .. _Environment:Telemetry:dewPoint: dewPoint ~~~~~~~~ :EFDB_Topic: Environment_dewPoint .. _Environment:Telemetry:dewPoint:avg1M: avg1M ***** :IDL_Type: double :Units: unitless **Description**: 1 minute average value .. _Environment:Telemetry:dewPoint:sensorName: sensorName ********** :IDL_Type: string :Units: unitless **Description**: Sensor model used to measure this parameters .. _Environment:Telemetry:precipitation: precipitation ~~~~~~~~~~~~~ :EFDB_Topic: Environment_precipitation .. _Environment:Telemetry:precipitation:prSum1M: prSum1M ******* :IDL_Type: double :Units: unitless **Description**: 1 minute sum value .. _Environment:Telemetry:precipitation:prSum1H: prSum1H ******* :IDL_Type: double :Units: unitless **Description**: 1 hour sum value .. _Environment:Telemetry:precipitation:prfSum1M: prfSum1M ******** :IDL_Type: double :Units: unitless **Description**: 1 minute sum value for precipitation intensity .. _Environment:Telemetry:precipitation:sensorName: sensorName ********** :IDL_Type: string :Units: unitless **Description**: Sensor model used to measure this parameters .. _Environment:Telemetry:relativeHumidity: relativeHumidity ~~~~~~~~~~~~~~~~ :EFDB_Topic: Environment_relativeHumidity .. _Environment:Telemetry:relativeHumidity:avg24H: avg24H ****** :IDL_Type: double :Units: unitless **Description**: 24 hours average .. _Environment:Telemetry:relativeHumidity:avg1M: avg1M ***** :IDL_Type: double :Units: unitless **Description**: 1 minute average value .. _Environment:Telemetry:relativeHumidity:max24H: max24H ****** :IDL_Type: double :Units: unitless **Description**: Maximum value during the last 24 hours .. _Environment:Telemetry:relativeHumidity:min24H: min24H ****** :IDL_Type: double :Units: unitless **Description**: Minimum value during the last 24 hours .. _Environment:Telemetry:relativeHumidity:sensorName: sensorName ********** :IDL_Type: string :Units: unitless **Description**: Sensor model used to measure this parameters .. _Environment:Telemetry:snowDepth: snowDepth ~~~~~~~~~ :EFDB_Topic: Environment_snowDepth .. _Environment:Telemetry:snowDepth:avg1M: avg1M ***** :IDL_Type: double :Units: unitless **Description**: 1 minute average value .. _Environment:Telemetry:snowDepth:max24H: max24H ****** :IDL_Type: double :Units: unitless **Description**: Maximum value during the last 24 hours .. _Environment:Telemetry:snowDepth:min24H: min24H ****** :IDL_Type: double :Units: unitless **Description**: Minimum value during the last 24 hours .. _Environment:Telemetry:snowDepth:avg24H: avg24H ****** :IDL_Type: double :Units: unitless **Description**: 24 hours average .. _Environment:Telemetry:snowDepth:sensorName: sensorName ********** :IDL_Type: string :Units: unitless **Description**: Sensor model used to measure this parameters .. _Environment:Telemetry:soilTemperature: soilTemperature ~~~~~~~~~~~~~~~ :EFDB_Topic: Environment_soilTemperature .. _Environment:Telemetry:soilTemperature:avg24H: avg24H ****** :IDL_Type: double :Units: degree **Description**: 24 hours average .. _Environment:Telemetry:soilTemperature:avg1M: avg1M ***** :IDL_Type: double :Units: degree **Description**: 1 minute average value .. _Environment:Telemetry:soilTemperature:max24H: max24H ****** :IDL_Type: double :Units: degree **Description**: Maximum value during the last 24 hours .. _Environment:Telemetry:soilTemperature:min24H: min24H ****** :IDL_Type: double :Units: degree **Description**: Minimum value during the last 24 hours .. _Environment:Telemetry:soilTemperature:sensorName: sensorName ********** :IDL_Type: string :Units: unitless **Description**: Sensor model used to measure this parameters .. _Environment:Telemetry:solarNetRadiation: solarNetRadiation ~~~~~~~~~~~~~~~~~ :EFDB_Topic: Environment_solarNetRadiation .. _Environment:Telemetry:solarNetRadiation:avg1M: avg1M ***** :IDL_Type: double :Units: unitless **Description**: 1 minute average value .. _Environment:Telemetry:solarNetRadiation:max24H: max24H ****** :IDL_Type: double :Units: unitless **Description**: Maximum value during the last 24 hours .. _Environment:Telemetry:solarNetRadiation:min24H: min24H ****** :IDL_Type: double :Units: unitless **Description**: Minimum value during the last 24 hours .. _Environment:Telemetry:solarNetRadiation:avg24H: avg24H ****** :IDL_Type: double :Units: unitless **Description**: 24 hours average .. _Environment:Telemetry:solarNetRadiation:sensorName: sensorName ********** :IDL_Type: string :Units: unitless **Description**: Sensor model used to measure this parameters .. _Environment:Telemetry:weather: weather ~~~~~~~ :EFDB_Topic: Environment_weather .. _Environment:Telemetry:weather:ambient_temp: ambient_temp ************ :IDL_Type: double :Units: degree **Description**: The ambient temperature. .. _Environment:Telemetry:weather:humidity: humidity ******** :IDL_Type: double :Units: unitless **Description**: The humidity. .. _Environment:Telemetry:weather:pressure: pressure ******** :IDL_Type: double :Units: unitless **Description**: The pressure outside. .. _Environment:Telemetry:windDirection: windDirection ~~~~~~~~~~~~~ :EFDB_Topic: Environment_windDirection .. _Environment:Telemetry:windDirection:value: value ***** :IDL_Type: double :Units: unitless **Description**: Instantaneous value .. _Environment:Telemetry:windDirection:avg2M: avg2M ***** :IDL_Type: double :Units: unitless **Description**: 2 minutes average value .. _Environment:Telemetry:windDirection:max2M: max2M ***** :IDL_Type: double :Units: unitless **Description**: Maximum value during the last 2 minutes .. _Environment:Telemetry:windDirection:min2M: min2M ***** :IDL_Type: double :Units: unitless **Description**: Minimum value during the last 2 minutes .. _Environment:Telemetry:windDirection:avg10M: avg10M ****** :IDL_Type: double :Units: unitless **Description**: 10 minutes average value .. _Environment:Telemetry:windDirection:max10M: max10M ****** :IDL_Type: double :Units: unitless **Description**: Maximum value during the last 10 minutes .. _Environment:Telemetry:windDirection:sensorName: sensorName ********** :IDL_Type: string :Units: unitless **Description**: Sensor model used to measure this parameters .. _Environment:Telemetry:windGustDirection: windGustDirection ~~~~~~~~~~~~~~~~~ :EFDB_Topic: Environment_windGustDirection .. _Environment:Telemetry:windGustDirection:value10M: value10M ******** :IDL_Type: double :Units: unitless **Description**: value for the last 10 minutes .. _Environment:Telemetry:windGustDirection:sensorName: sensorName ********** :IDL_Type: string :Units: unitless **Description**: Sensor model used to measure this parameters .. _Environment:Telemetry:windSpeed: windSpeed ~~~~~~~~~ :EFDB_Topic: Environment_windSpeed .. _Environment:Telemetry:windSpeed:value: value ***** :IDL_Type: double :Units: unitless **Description**: Instantaneous value .. _Environment:Telemetry:windSpeed:avg2M: avg2M ***** :IDL_Type: double :Units: unitless **Description**: 2 minutes average value .. _Environment:Telemetry:windSpeed:max2M: max2M ***** :IDL_Type: double :Units: unitless **Description**: Maximum value during the last 2 minutes .. _Environment:Telemetry:windSpeed:min2M: min2M ***** :IDL_Type: double :Units: unitless **Description**: Minimum value during the last 2 minutes .. _Environment:Telemetry:windSpeed:avg10M: avg10M ****** :IDL_Type: double :Units: unitless **Description**: 10 minutes average value .. _Environment:Telemetry:windSpeed:max10M: max10M ****** :IDL_Type: double :Units: unitless **Description**: Maximum value during the last 10 minutes .. _Environment:Telemetry:windSpeed:sensorName: sensorName ********** :IDL_Type: string :Units: unitless **Description**: Sensor model used to measure this parameters