FiberSpectrograph

Note

This page is generated by python script generate_cet.py.

Back to table

Commands

cancelExposure

Description: Cancel an active exposure from the spectrograph. If there is no active exposure, this command does nothing.

EFDB_Topic

FiberSpectrograph_command_cancelExposure

expose

Description: Capture an image from the spectrograph.

EFDB_Topic

FiberSpectrograph_command_expose

duration

IDL_Type

float

Units

second

Description: The duration of the exposure to take.

numExposures

IDL_Type

long

Units

unitless

Description: Number of consecutive exposures to take.

type

IDL_Type

string

IDL_Size

256

Units

unitless

Description: Type of image; used for the FITS IMG_TYPE header value.

source

IDL_Type

string

IDL_Size

256

Units

unitless

Description: Light source being measured.

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

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

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

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

settingsToApply

IDL_Type

string

IDL_Size

256

Units

unitless

Description: Name of the selected settings set

Enumerations

ExposureState

• Integrating

• Done

• Cancelled

• Timedout

• Failed

Events

deviceInfo

Description: Information about the spectrograph.

EFDB_Topic

FiberSpectrograph_logevent_deviceInfo

npixels

IDL_Type

long

Units

unitless

Description: The number of pixels in the spectrograph.

fpgaVersion

IDL_Type

string

IDL_Size

16

Units

unitless

Description: The FPGA software version.

firmwareVersion

IDL_Type

string

IDL_Size

16

Units

unitless

Description: The microcontroller software version.

libraryVersion

IDL_Type

string

IDL_Size

16

Units

unitless

Description: The AvaSpec Library software version.

exposureState

Description: Current state of the active exposure.

EFDB_Topic

FiberSpectrograph_logevent_exposureState

status

IDL_Type

long

Units

unitless

Description: The state of the current exposure.

largeFileObjectAvailable

Description: Spectrum fits file is publish as LFOA event

EFDB_Topic

FiberSpectrograph_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

appliedSettingsMatchStart

EFDB_Topic

SALGeneric_logevent_appliedSettingsMatchStart

appliedSettingsMatchStartIsTrue

IDL_Type

boolean

Units

unitless

Description: True when the configuration matches the start conditions

authList

EFDB_Topic

SALGeneric_logevent_authList

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.

errorCode

Description: Output when a CSC goes into the Fault state as an explanation of the problem.

EFDB_Topic

SALGeneric_logevent_errorCode

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

EFDB_Topic

SALGeneric_logevent_heartbeat

heartbeat

IDL_Type

boolean

Units

unitless

Description: Beats the drum.

logLevel

Description: Current logging level.

EFDB_Topic

SALGeneric_logevent_logLevel

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

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.

settingVersions

Description: Information about settings which can be specified in the start command.

EFDB_Topic

SALGeneric_logevent_settingVersions

recommendedSettingsVersion

IDL_Type

string

Units

unitless

Description: List of comma seperated recomended versions of settings sets

recommendedSettingsLabels

IDL_Type

string

Units

unitless

Description: List of comma seperated names of settings sets

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

settingsVersion

IDL_Type

string

IDL_Size

256

Units

unitless

Description: The SHA or name corresponding to the published configuration

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

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

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: This is the top-level version of the 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 a CSC

summaryState

Description: Current summary state of the CSC

EFDB_Topic

SALGeneric_logevent_summaryState

summaryState

IDL_Type

long

Units

unitless

Description: High level state machine state identifier

Telemetry

temperature

Description: Temperature of the FiberSpectrograph

EFDB_Topic

FiberSpectrograph_temperature

temperature

IDL_Type

double

Units

deg_C

Description: Measured internal spectrograph temperature.

setpoint

IDL_Type

double

Units

deg_C

Description: Spectrograph temperature setpoint.