=================
FiberSpectrograph
=================
Commands
--------
expose
~~~~~~
**Description**: Capture an image from the spectrograph.

:Subsystem: FiberSpectrograph
:EFDB_Topic: FiberSpectrograph_command_expose
duration
********
:IDL_Type: float
:Units: second
:Count: 1

**Description**: The duration of the exposure to take.

numExposures
************
:IDL_Type: long
:Units: unitless
:Count: 1

**Description**: Number of consecutive exposures to take.

type
****
:IDL_Type: string
:IDL_Size: 256
:Units: unitless
:Count: 1

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

source
******
:IDL_Type: string
:IDL_Size: 256
:Units: unitless
:Count: 1

**Description**: Light source being measured.

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

:Subsystem: FiberSpectrograph
:EFDB_Topic: FiberSpectrograph_command_cancelExposure
Events
------
* ExposureState_Integrating
* ExposureState_Done
* ExposureState_Cancelled
* ExposureState_Timedout
* ExposureState_Failed

largeFileObjectAvailable
~~~~~~~~~~~~~~~~~~~~~~~~
**Description**: Spectrum fits file is publish as LFOA event

:Subsystem: FiberSpectrograph
:EFDB_Topic: FiberSpectrograph_logevent_largeFileObjectAvailable
url
***
:IDL_Type: string
:IDL_Size: 256
:Units: unitless
:Count: 1

**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
:Count: 1

**Description**: Name of the package which generated the file being announced

version
*******
:IDL_Type: float
:Units: unitless
:Count: 1

**Description**: A dotted x.y version number denoting the file format revision

byteSize
********
:IDL_Type: long
:Units: unitless
:Count: 1

**Description**: Size of file in bytes

checkSum
********
:IDL_Type: string
:IDL_Size: 256
:Units: unitless
:Count: 1

**Description**: Hexadecimal character string holding the checksum of the file

mimeType
********
:IDL_Type: string
:IDL_Size: 256
:Units: unitless
:Count: 1

**Description**: Mime Type code for the file

id
**
:IDL_Type: string
:IDL_Size: 256
:Units: unitless
:Count: 1

**Description**: A generic identifier field

exposureState
~~~~~~~~~~~~~
**Description**: Current state of the active exposure.

:Subsystem: FiberSpectrograph
:EFDB_Topic: FiberSpectrograph_logevent_exposureState
status
******
:IDL_Type: long
:Units: unitless
:Count: 1

**Description**: The state of the current exposure.

deviceInfo
~~~~~~~~~~
**Description**: Information about the spectrograph.

:Subsystem: FiberSpectrograph
:EFDB_Topic: FiberSpectrograph_logevent_deviceInfo
npixels
*******
:IDL_Type: long
:Units: unitless
:Count: 1

**Description**: The number of pixels in the spectrograph.

fpgaVersion
***********
:IDL_Type: string
:IDL_Size: 16
:Units: unitless
:Count: 1

**Description**: The FPGA software version.

firmwareVersion
***************
:IDL_Type: string
:IDL_Size: 16
:Units: unitless
:Count: 1

**Description**: The microcontroller software version.

libraryVersion
**************
:IDL_Type: string
:IDL_Size: 16
:Units: unitless
:Count: 1

**Description**: The AvaSpec Library software version.

Telemetry
---------
temperature
~~~~~~~~~~~
**Description**: Temperature of the FiberSpectrograph

:Subsystem: FiberSpectrograph
:EFDB_Topic: FiberSpectrograph_temperature
temperature
***********
:IDL_Type: double
:Units: deg_C
:Count: 1

**Description**: Measured internal spectrograph temperature.

setpoint
********
:IDL_Type: double
:Units: deg_C
:Count: 1

**Description**: Spectrograph temperature setpoint.