=============
GenericCamera
=============
Commands
--------
setROI
~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_command_setROI
:Explanation: http://sal.lsst.org
topPixel
********
:IDL_Type: int
:Units: pixel
:Count: 1

**Description**: This is the regions top most pixel number (base 0).

leftPixel
*********
:IDL_Type: int
:Units: pixel
:Count: 1

**Description**: This is the regions left most pixel number (base 0).

width
*****
:IDL_Type: int
:Units: pixel
:Count: 1

**Description**: This is the regions width in pixels.

height
******
:IDL_Type: int
:Units: pixel
:Count: 1

**Description**: This is the regions height in pixels.

setFullFrame
~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_command_setFullFrame
:Explanation: http://sal.lsst.org
ignored
*******
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: This value is ignored.

startLiveView
~~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_command_startLiveView
:Explanation: http://sal.lsst.org
expTime
*******
:IDL_Type: double
:Units: second
:Count: 1

**Description**: Exposure time.

stopLiveView
~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_command_stopLiveView
:Explanation: http://sal.lsst.org
ignored
*******
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: This value is ignored.

takeImages
~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_command_takeImages
:Explanation: http://project.lsst.org/ts/sal_objects/help
numImages
*********
:IDL_Type: long
:Units: unitless
:Count: 1

**Description**: Number of images to be taken.

expTime
*******
:IDL_Type: double
:Units: second
:Count: 1

**Description**: Exposure time.

shutter
*******
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: Activate shutter?

science
*******
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: Activate science detectors?

guide
*****
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: Activate guider detectors?

wfs
***
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: Activate wave front sensing detectors?

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

**Description**: Image sequence name (obsolete)

Events
------
cameraInfo
~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_cameraInfo
:Explanation: http://sal.lsst.org
cameraMakeAndModel
******************
:IDL_Type: string
:IDL_Size: 1
:Units: unitless
:Count: 1

**Description**: This is the make and model of the current camera.

cameraSpecificProperty
~~~~~~~~~~~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_cameraSpecificProperty
:Explanation: http://sal.lsst.org
propertyName
************
:IDL_Type: string
:IDL_Size: 1
:Units: unitless
:Count: 1

**Description**: This is the name of the property specific to this camera.

propertyValue
*************
:IDL_Type: string
:IDL_Size: 1
:Units: unitless
:Count: 1

**Description**: This is the value of the property specific to this camera.

roi
~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_roi
:Explanation: http://sal.lsst.org
topPixel
********
:IDL_Type: int
:Units: pixel
:Count: 1

**Description**: This is the regions top most pixel number (base 0).

leftPixel
*********
:IDL_Type: int
:Units: pixel
:Count: 1

**Description**: This is the regions left most pixel number (base 0).

width
*****
:IDL_Type: int
:Units: pixel
:Count: 1

**Description**: This is the regions width in pixels.

height
******
:IDL_Type: int
:Units: pixel
:Count: 1

**Description**: This is the regions height in pixels.

startLiveView
~~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_startLiveView
:Explanation: http://sal.lsst.org
ip
**
:IDL_Type: string
:IDL_Size: 1
:Units: unitless
:Count: 1

**Description**: This is the ip address for the live view data.

port
****
:IDL_Type: int
:Units: unitless
:Count: 1

**Description**: This is the TCP port for the live view data.

endLiveView
~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_endLiveView
:Explanation: http://sal.lsst.org
ignored
*******
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: Attribute required by the SAL API, but is unused.

startTakeImage
~~~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_startTakeImage
:Explanation: http://sal.lsst.org
ignored
*******
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: Attribute required by the SAL API, but is unused.

startShutterOpen
~~~~~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_startShutterOpen
:Explanation: http://sal.lsst.org
ignored
*******
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: Attribute required by the SAL API, but is unused.

endShutterOpen
~~~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_endShutterOpen
:Explanation: http://sal.lsst.org
ignored
*******
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: Attribute required by the SAL API, but is unused.

startIntegration
~~~~~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_startIntegration
:Explanation: http://sal.lsst.org
imageSequenceName
*****************
:IDL_Type: string
:IDL_Size: 256
:Units: unitless
:Count: 1

**Description**: The imageSequenceName as passed to the takeImages command

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

**Description**: The total number of requested images in sequence

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

**Description**: The imageName for this specific exposure

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

**Description**: The zero based index number for this specific exposure within the sequence

timeStamp
*********
:IDL_Type: double
:Units: second
:Count: 1

**Description**: The effective time at which the image acquisition started (i.e. the end of the previous clear or readout)

exposureTime
************
:IDL_Type: double
:Units: second
:Count: 1

**Description**: The requested exposure time

endIntegration
~~~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_endIntegration
:Explanation: http://sal.lsst.org
ignored
*******
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: Attribute required by the SAL API, but is unused.

startShutterClose
~~~~~~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_startShutterClose
:Explanation: http://sal.lsst.org
ignored
*******
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: Attribute required by the SAL API, but is unused.

endShutterClose
~~~~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_endShutterClose
:Explanation: http://sal.lsst.org
ignored
*******
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: Attribute required by the SAL API, but is unused.

startReadout
~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_startReadout
:Explanation: http://sal.lsst.org
imageSequenceName
*****************
:IDL_Type: string
:IDL_Size: 256
:Units: unitless
:Count: 1

**Description**: The imageSequenceName as passed to the takeImages command

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

**Description**: The total number of requested images in sequence

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

**Description**: The imageName for this specific exposure

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

**Description**: The zero based index number for this specific exposure within the sequence

timeStamp
*********
:IDL_Type: double
:Units: second
:Count: 1

**Description**: The effective time at which the image acquisition started (i.e. the end of the previous clear or readout)

exposureTime
************
:IDL_Type: double
:Units: second
:Count: 1

**Description**: The requested exposure time

endReadout
~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_endReadout
:Explanation: http://sal.lsst.org
imageSequenceName
*****************
:IDL_Type: string
:IDL_Size: 256
:Units: unitless
:Count: 1

**Description**: The imageSequenceName as passed to the takeImages command

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

**Description**: The total number of requested images in sequence

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

**Description**: The imageName for this specific exposure

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

**Description**: The zero based index number for this specific exposure within the sequence

timeStamp
*********
:IDL_Type: double
:Units: second
:Count: 1

**Description**: The effective time at which the image acquisition started (i.e. the end of the previous clear or readout)

exposureTime
************
:IDL_Type: double
:Units: second
:Count: 1

**Description**: The requested exposure time

endTakeImage
~~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_logevent_endTakeImage
:Explanation: http://sal.lsst.org
ignored
*******
:IDL_Type: boolean
:Units: unitless
:Count: 1

**Description**: Attribute required by the SAL API, but is unused.

Telemetry
---------
temperature
~~~~~~~~~~~
:Subsystem: GenericCamera
:Version: 3.9.0
:Author: None
:EFDB_Topic: GenericCamera_temperature
temperature
***********
:IDL_Type: double
:Units: Celsius
:Count: 1

**Description**: The temperature of the camera in degrees Celsius.