ESS¶
Note
This page is generated by python script generate_cet.py.
Commands¶
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
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”.
Events¶
highElectricField¶
Description: High electric field level. Emitted when the field level is higher than a configurable threshold. If all values are zero then this indicates that no high field level was detected for a configurable amount of time since the field level dropped below the threshold.
- EFDB_Topic:
ESS_logevent_highElectricField
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The user-defined name of the sensor (e.g. AuxTel LD-250).
strength¶
- IDL_Type:
float
- Units:
kV / m
Description: Strength of the electric field (range -20.00 to 20.00).
lightningStrike¶
Description: Lightning strike, if detected. If all values are zero then this indicates that no strike was detected for a configurable amount of time since the last strike.
- EFDB_Topic:
ESS_logevent_lightningStrike
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The user-defined name of the sensor (e.g. AuxTel LD-250).
correctedDistance¶
- IDL_Type:
float
- Units:
km
Description: Distance of the strike, corrected by the hardware.
uncorrectedDistance¶
- IDL_Type:
float
- Units:
km
Description: Distance of the strike, not corrected by the hardware.
bearing¶
- IDL_Type:
float
- Units:
degree
Description: Bearing of the strike.
precipitation¶
Description: Is it raining or snowing?
- EFDB_Topic:
ESS_logevent_precipitation
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The name of the sensor.
raining¶
- IDL_Type:
boolean
- Units:
unitless
Description: Is it raining? (true=yes)
snowing¶
- IDL_Type:
boolean
- Units:
unitless
Description: Is it snowing? (true=yes)
location¶
- IDL_Type:
string
- Units:
unitless
Description: The location of the sensor.
sensorStatus¶
Description: Status of a sensor and its data server.
- EFDB_Topic:
ESS_logevent_sensorStatus
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The name of the sensor.
sensorStatus¶
- IDL_Type:
int
- Units:
unitless
Description: Sensor status. The details depend on the sensor, but 0 always means that no problems have been detected.
serverStatus¶
- IDL_Type:
int
- Units:
unitless
Description: Data server status. The details depend on the server, but 0 always means that no problems have been detected.
authList¶
Description: Who can command this CSC.
- EFDB_Topic:
SALGeneric_logevent_authList
- Category:
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.
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¶
accelerometer¶
Description: Raw data from a 3-axis accelerometer.
- EFDB_Topic:
ESS_accelerometer
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The user-defined name of the accelerometer (e.g. AuxTel_accel1).
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Starting time of data acquisition (TAI unix seconds).
interval¶
- IDL_Type:
double
- Units:
second
Description: Data collection time interval. N-th (starting from 0) sample is assumed to be taken at “timestamp” + “interval” * N.
accelerationX¶
- IDL_Type:
float
- Units:
m/s2
- Count:
400
Description: Acceleration in x direction.
accelerationY¶
- IDL_Type:
float
- Units:
m/s2
- Count:
400
Description: Acceleration in y direction.
accelerationZ¶
- IDL_Type:
float
- Units:
m/s2
- Count:
400
Description: Acceleration in Z direction.
location¶
- IDL_Type:
string
- Units:
unitless
Description: Physical location of the sensor (e.g. AuxTel Truss).
accelerometerPSD¶
Description: PSD data from a 3-axis accelerometer.
- EFDB_Topic:
ESS_accelerometerPSD
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The user-defined name of the accelerometer (e.g. AuxTel_accel1).
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Starting time of data acqusition (TAI Unix seconds) used to compute PSDs.
maxPSDFrequency¶
- IDL_Type:
float
- Units:
Hz
Description: PSD maximum frequency.
accelerationPSDX¶
- IDL_Type:
float
- Units:
m2 / (Hz2 s4)
- Count:
201
Description: Acceleration PSD in x direction.
accelerationPSDY¶
- IDL_Type:
float
- Units:
m2 / (Hz2 s4)
- Count:
201
Description: Acceleration PSD in y direction.
accelerationPSDZ¶
- IDL_Type:
float
- Units:
m2 / (Hz2 s4)
- Count:
201
Description: Acceleration PSD in z direction.
location¶
- IDL_Type:
string
- Units:
unitless
Description: Physical location of the sensor (e.g. AuxTel Truss).
airFlow¶
Description: Wind speed and direction. The reported values are computed from data that is accumulated over a configurable period that is typically on the order of a minute.
- EFDB_Topic:
ESS_airFlow
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The name of the sensor.
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Time at which the most recent data was read (TAI unix seconds).
direction¶
- IDL_Type:
float
- Units:
degree
Description: Circular mean wind direction: 0 = north, 90 = east.
directionStdDev¶
- IDL_Type:
float
- Units:
degree
Description: Circular standard deviation of wind direction. Not available for all sensor types.
speed¶
- IDL_Type:
float
- Units:
m/s
Description: Median (mean for some sensors) wind speed.
speedStdDev¶
- IDL_Type:
float
- Units:
m/s
Description: Standard deviation of wind speed estimated from quartiles. Not available for all sensor types.
maxSpeed¶
- IDL_Type:
float
- Units:
m/s
Description: Maximum wind speed.
location¶
- IDL_Type:
string
- Units:
unitless
Description: The location of the sensor.
airTurbulence¶
Description: Air turbulence measured by a 3-dimensional anemometer. The reported values are computed from data that is accumulated over a configurable period that is typically on the order of a minute.
- EFDB_Topic:
ESS_airTurbulence
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The name of the sensor.
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Time at which the most recent data was read (TAI unix seconds).
speed¶
- IDL_Type:
float
- Units:
m/s
- Count:
3
Description: Median wind speed (x, y, z).
speedStdDev¶
- IDL_Type:
float
- Units:
m/s
- Count:
3
Description: Standard deviation of wind speed (x, y, z) estimated from quartiles.
speedMagnitude¶
- IDL_Type:
float
- Units:
m/s
Description: Median wind speed magnitude.
speedMaxMagnitude¶
- IDL_Type:
float
- Units:
m/s
Description: Maximum wind speed magnitude.
sonicTemperature¶
- IDL_Type:
float
- Units:
deg_C
Description: Median sonic temperature (air temperature measured sonically). Sonic temperature has poor absolute accuracy (it can be off by several degrees) but good time resolution.
sonicTemperatureStdDev¶
- IDL_Type:
float
- Units:
deg_C
Description: Standard devation of sonic temperature (air temperature measured sonically) estimated from quartiles.
location¶
- IDL_Type:
string
- Units:
unitless
Description: The location of the sensor.
dewPoint¶
Description: Dew point.
- EFDB_Topic:
ESS_dewPoint
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The name of the sensor.
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Time at which the data was read (TAI unix seconds).
dewPoint¶
- IDL_Type:
float
- Units:
deg_C
Description: Dew point.
location¶
- IDL_Type:
string
- Units:
unitless
Description: The location of the sensor.
electricFieldStrength¶
Description: Electric field strength. The reported values are computed from data that is accumulated over a configurable period that is typically on the order of a second.
- EFDB_Topic:
ESS_electricFieldStrength
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The user-defined name of the sensor (e.g. AuxTel EFM-100C).
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Time at which the most recent data was read (TAI unix seconds).
strength¶
- IDL_Type:
float
- Units:
kV / m
Description: Median electric field strength (range -20.00 to 20.00).
strengthStdDev¶
- IDL_Type:
float
- Units:
kV / m
Description: Standard deviation of electric field strength (range -20.00 to 20.00) estimated from quartiles.
strengthMax¶
- IDL_Type:
float
- Units:
kV / m
Description: Maximum electric field strength (range -20.00 to 20.00).
location¶
- IDL_Type:
string
- Units:
unitless
Description: Physical location of the sensor (e.g. AuxTel Truss).
lightningStrikeStatus¶
Description: Lightning strike status (once per second). This is a summary of the lightning strikes detected.
- EFDB_Topic:
ESS_lightningStrikeStatus
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The user-defined name of the sensor (e.g. AuxTel LD-250).
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Time of data acqusition (TAI Unix seconds).
closeStrikeRate¶
- IDL_Type:
float
- Units:
unitless
Description: Rate of close strikes (0 - 999 strikes/minute). The range, for which a strike is considered close, can be configured in ts_config_ocs.
totalStrikeRate¶
- IDL_Type:
float
- Units:
unitless
Description: Rate of total strikes (0 - 999 strikes/minute).
closeAlarmStatus¶
- IDL_Type:
boolean
- Units:
unitless
Description: Status of the close alarm (false: not active, true: active). The range, for which a close alarm is emitted, can be configured in the hardware sensor itself.
severeAlarmStatus¶
- IDL_Type:
boolean
- Units:
unitless
Description: Status of the close alarm (false: not active, true: active). The range, for which a severa alarm is emitted, can be configured in the hardware sensor itself.
heading¶
- IDL_Type:
float
- Units:
degree
Description: Current heading from GPS or compass. The sensor is at a fixed place so this is not likely to change.
location¶
- IDL_Type:
string
- Units:
unitless
Description: Physical location of the sensor (e.g. AuxTel Truss).
pressure¶
Description: Pressure sensors with up to 8 channels.
- EFDB_Topic:
ESS_pressure
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The name of the sensor.
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Time at which the data was read (TAI unix seconds).
numChannels¶
- IDL_Type:
short
- Units:
unitless
Description: The number of channels (minimum 1 and maximum 8).
pressure¶
- IDL_Type:
float
- Units:
Pa
- Count:
8
Description: The pressures.
location¶
- IDL_Type:
string
- Units:
unitless
Description: Comma-separated string with the locations of the sensors for each channel.
rainRate¶
Description: Rate of rainfall.
- EFDB_Topic:
ESS_rainRate
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The name of the sensor.
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Time at which the data was read (TAI unix seconds).
rainRate¶
- IDL_Type:
float
- Units:
mm/h
Description: Rainfall rate.
location¶
- IDL_Type:
string
- Units:
unitless
Description: The location of the sensor.
relativeHumidity¶
Description: Relative humidity.
- EFDB_Topic:
ESS_relativeHumidity
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The name of the sensor.
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Time at which the data was read (TAI unix seconds).
relativeHumidity¶
- IDL_Type:
float
- Units:
%
Description: Relative Humidity.
location¶
- IDL_Type:
string
- Units:
unitless
Description: The location of the sensor.
snowRate¶
Description: Rate of snowfall.
- EFDB_Topic:
ESS_snowRate
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The name of the sensor.
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Time at which the data was read (TAI unix seconds).
snowRate¶
- IDL_Type:
float
- Units:
mm/h
Description: Snowfall rate measured over a configurable period on the order of a minute.
location¶
- IDL_Type:
string
- Units:
unitless
Description: The location of the sensor.
solarRadiation¶
Description: Solar radiation.
- EFDB_Topic:
ESS_solarRadiation
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The name of the sensor.
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Time at which the data was read (TAI unix seconds).
solarRadiation¶
- IDL_Type:
float
- Units:
W/m2
Description: Median (mean for some sensors) solar radiation measured over a configurable period on the order of a minute.
location¶
- IDL_Type:
string
- Units:
unitless
Description: The location of the sensor.
spectrumAnalyzer¶
Description: Spectrum analyzer trace (once per second).
- EFDB_Topic:
ESS_spectrumAnalyzer
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The user-defined name of the sensor (e.g. AuxTel SSA3000X).
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Time of data acqusition (TAI Unix seconds).
startFrequency¶
- IDL_Type:
float
- Units:
Hz
Description: The start frequency of the spectrum trace.
stopFrequency¶
- IDL_Type:
float
- Units:
Hz
Description: The stop frequency of the spectrum trace.
spectrum¶
- IDL_Type:
float
- Units:
dB
- Count:
751
Description: The spectrum trace.
location¶
- IDL_Type:
string
- Units:
unitless
Description: Physical location of the sensor (e.g. AuxTel Truss).
temperature¶
Description: Temperature Sensors with up to 16 channels.
- EFDB_Topic:
ESS_temperature
sensorName¶
- IDL_Type:
string
- Units:
unitless
Description: The name of the sensor.
timestamp¶
- IDL_Type:
double
- Units:
second
Description: Time at which the data was read (TAI unix seconds).
numChannels¶
- IDL_Type:
short
- Units:
unitless
Description: The number of channels (minimum 1 and maximum 16).
temperature¶
- IDL_Type:
float
- Units:
deg_C
- Count:
16
Description: The temperatures.
location¶
- IDL_Type:
string
- Units:
unitless
Description: Comma-separated string with the locations of the sensors for each channel.