GenericCamera

Note

This page is generated by python script generate_cet.py.

Back to table

Commands

setFullFrame

EFDB_Topic:GenericCamera_command_setFullFrame

ignored

IDL_Type:boolean
Units:unitless

Description: This value is ignored.

setROI

EFDB_Topic:GenericCamera_command_setROI

topPixel

IDL_Type:int
Units:pixel

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

leftPixel

IDL_Type:int
Units:pixel

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

width

IDL_Type:int
Units:pixel

Description: This is the regions width in pixels.

height

IDL_Type:int
Units:pixel

Description: This is the regions height in pixels.

startLiveView

EFDB_Topic:GenericCamera_command_startLiveView

expTime

IDL_Type:double
Units:second

Description: Exposure time.

stopLiveView

EFDB_Topic:GenericCamera_command_stopLiveView

ignored

IDL_Type:boolean
Units:unitless

Description: This value is ignored.

takeImages

EFDB_Topic:GenericCamera_command_takeImages

numImages

IDL_Type:long
Units:unitless

Description: Number of consecutive images to take

expTime

IDL_Type:double
Units:second

Description: Exposure time

shutter

IDL_Type:boolean
Units:unitless

Description: True if the shutter should be opened/closed

sensors

IDL_Type:string
Units:unitless

Description: Sensors to be read out, if blank all configured sensors will be read out

keyValueMap

IDL_Type:string
Units:unitless

Description: Map of additional key value pairs to associate extra data with the image(s), e.g. imageType: XYZ, groupId: ABC

obsNote

IDL_Type:string
Units:unitless

Description: An arbitrary operator provided string, useful for informally flagging images

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

Events

calibrationDetailedState

EFDB_Topic:GenericCamera_logevent_calibrationDetailedState

substate

IDL_Type:long
Units:unitless
Enumeration:DISABLED,ENABLED,INTEGRATING

Description: Enumeration of valid substates

timestampTransition

IDL_Type:double
Units:second

Description: The time at which the state transition occurred

cameraInfo

EFDB_Topic:GenericCamera_logevent_cameraInfo

cameraMakeAndModel

IDL_Type:string
Units:unitless

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

cameraSpecificProperty

EFDB_Topic:GenericCamera_logevent_cameraSpecificProperty

propertyName

IDL_Type:string
Units:unitless

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

propertyValue

IDL_Type:string
Units:unitless

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

ccsCommandState

EFDB_Topic:GenericCamera_logevent_ccsCommandState

substate

IDL_Type:long
Units:unitless
Enumeration:IDLE,BUSY

Description: Substate of the CCS command.

timestampTransition

IDL_Type:double
Units:second

Description: The time at which the state transition occurred

ccsConfigured

EFDB_Topic:GenericCamera_logevent_ccsConfigured

endIntegration

EFDB_Topic:GenericCamera_logevent_endIntegration

ignored

IDL_Type:boolean
Units:unitless

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

endLiveView

EFDB_Topic:GenericCamera_logevent_endLiveView

ignored

IDL_Type:boolean
Units:unitless

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

endOfImageTelemetry

Description: Event sent once all telemetry correesponding to the image has been sent. (Typically ~300mS after the end of readout).
Note: all : delimited strings (aka string arrays) follow the escaping convention defined in CAP-572
EFDB_Topic:GenericCamera_logevent_endOfImageTelemetry

additionalKeys

IDL_Type:string
Units:unitless

Description: Additional keys passed to the takeImages command (: delimited)

additionalValues

IDL_Type:string
Units:unitless

Description: Additional values passed to the takeImages command (: delimited, in same order as additionalKeys)

imagesInSequence

IDL_Type:long
Units:unitless

Description: The total number of requested images in sequence

imageName

IDL_Type:string
IDL_Size:32
Units:unitless

Description: The imageName for this specific exposure, assigned by the camera

imageIndex

IDL_Type:long
Units:unitless

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

imageSource

IDL_Type:string
IDL_Size:2
Units:unitless

Description: The source component of the image name (AT/CC/MC)

imageController

IDL_Type:string
Units:unitless

Description: The controller for the image (O=OCS/C=CCS/…)

imageDate

IDL_Type:string
IDL_Size:8
Units:unitless

Description: The date component of the image name (YYYYMMDD)

imageNumber

IDL_Type:long
Units:unitless

Description: The image number (SEQNO) component of the image name

timestampAcquisitionStart

IDL_Type:double
Units:second

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

Description: The requested exposure time

imageTag

IDL_Type:string
IDL_Size:64
Units:unitless

Description: The DAQ assigned image tag (hex string)

timestampDateObs

IDL_Type:double
Units:second

Description: The observation date, as computed by CCS (as TAI)

timestampDateEnd

IDL_Type:double
Units:second

Description: The end observation date, as computed by CCS (as TAI)

measuredShutterOpenTime

IDL_Type:double
Units:second
Description: The measured shutter open time, as computed by CCS. This is a best estimate based on a summary of the full information provided
in the shutterBladeMotionProfile events.

darkTime

IDL_Type:double
Units:second

Description: The dark time, as computed by CCS

endReadout

Description: Event sent at end of readout. When this event is received the corresponding image should be complete
in the DAQ 2-day store. Note: all : delimited strings (aka string arrays) follow the escaping convention defined in CAP-572
EFDB_Topic:GenericCamera_logevent_endReadout

additionalKeys

IDL_Type:string
Units:unitless

Description: Additional keys passed to the takeImages command (: delimited)

additionalValues

IDL_Type:string
Units:unitless

Description: Additional values passed to the takeImages command (: delimited, in same order as additionalKeys)

imagesInSequence

IDL_Type:long
Units:unitless

Description: The total number of requested images in sequence

imageName

IDL_Type:string
IDL_Size:32
Units:unitless

Description: The imageName for this specific exposure, assigned by the camera

imageIndex

IDL_Type:long
Units:unitless

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

imageSource

IDL_Type:string
IDL_Size:2
Units:unitless

Description: The source component of the image name (AT/CC/MC)

imageController

IDL_Type:string
Units:unitless

Description: The controller for the image (O=OCS/C=CCS/…)

imageDate

IDL_Type:string
IDL_Size:8
Units:unitless

Description: The date component of the image name (YYYYMMDD)

imageNumber

IDL_Type:long
Units:unitless

Description: The image number (SEQNO) component of the image name

timestampAcquisitionStart

IDL_Type:double
Units:second

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

requestedExposureTime

IDL_Type:double
Units:second

Description: The requested exposure time (as specified in the takeImages command)

timestampEndOfReadout

IDL_Type:double
Units:second

Description: The time at which the readout was completed

endShutterClose

EFDB_Topic:GenericCamera_logevent_endShutterClose

endShutterOpen

EFDB_Topic:GenericCamera_logevent_endShutterOpen

endTakeImage

EFDB_Topic:GenericCamera_logevent_endTakeImage

fileCommandExecution

Description: Each time a command is executed on a single FITS file this event is generated

EFDB_Topic:GenericCamera_logevent_fileCommandExecution

imageName

IDL_Type:string
IDL_Size:32
Units:unitless

Description: The imageName for this specific exposure, assigned by the camera

timestampCommandComplete

IDL_Type:double
Units:second

Description: The time when the command completed.

command

IDL_Type:string
Units:unitless

Description: The comamnd executed included arguments.

rc

IDL_Type:int
Units:unitless

Description: The return code from the command execution.

fitsFilesWritten

Description: When this event is received, all of the CCS files on the diagnostic cluster have been written
Note: all : delimited strings (aka string arrays) follow the escaping convention defined in CAP-572
EFDB_Topic:GenericCamera_logevent_fitsFilesWritten

imageName

IDL_Type:string
IDL_Size:32
Units:unitless

Description: The imageName for this specific exposure, assigned by the camera

timestampFilesWritten

IDL_Type:double
Units:second

Description: The time when the (last) CCS FITS file was written.

rootFileName

IDL_Type:string
Units:unitless

Description: The common filesystem location of all files below.

relativeFileNames

IDL_Type:string
Units:unitless

Description: The file system location of each file, relative to rootFileName (: delimited).

fileNode

IDL_Type:string
Units:unitless

Description: The node on which each file is written (: delimited, in same order as above).

imageReadinessDetailedState

EFDB_Topic:GenericCamera_logevent_imageReadinessDetailedState

substate

IDL_Type:long
Units:unitless
Enumeration:READY,NOT_READY,GETTING_READY

Description: Enumeration of valid substates

timestampTransition

IDL_Type:double
Units:second

Description: The time at which the state transition occurred

imageStored

Description: When this event is received the corresponding image should be complete in the DAQ 2-day store.
Once in use this will allow endReadout event to go back to indicating that the readout is complete (sequencers finished). Note: all : delimited strings (aka string arrays) follow the escaping convention defined in CAP-572
EFDB_Topic:GenericCamera_logevent_imageStored

imageName

IDL_Type:string
IDL_Size:32
Units:unitless

Description: The imageName for this specific exposure, assigned by the camera

timestampImageStored

IDL_Type:double
Units:second

Description: The time when the DAQ image was store was complete.

imageVisualization

Description: Event sent when image visualization is ready

EFDB_Topic:GenericCamera_logevent_imageVisualization

imageName

IDL_Type:string
IDL_Size:32
Units:unitless

Description: The imageName for this specific exposure, assigned by the camera

timestampVisualizationAvailable

IDL_Type:double
Units:second

Description: The time when the command completed.

url

IDL_Type:string
Units:unitless

Description: The URL at which the full image visualization is available.

thumbnail

IDL_Type:string
Units:unitless

Description: The URL at which the image thumbnail is available.

notReadyToTakeImage

EFDB_Topic:GenericCamera_logevent_notReadyToTakeImage

offlineDetailedState

EFDB_Topic:GenericCamera_logevent_offlineDetailedState

substate

IDL_Type:long
Units:unitless
Enumeration:OFFLINE_AVAILABLE,OFFLINE_PUBLISH_ONLY

Description: Enumeration of valid substates

timestampTransition

IDL_Type:double
Units:second

Description: The time at which the state transition occurred

prepareToTakeImage

EFDB_Topic:GenericCamera_logevent_prepareToTakeImage

readyToTakeImage

EFDB_Topic:GenericCamera_logevent_readyToTakeImage

roi

EFDB_Topic:GenericCamera_logevent_roi

topPixel

IDL_Type:int
Units:pixel

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

leftPixel

IDL_Type:int
Units:pixel

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

width

IDL_Type:int
Units:pixel

Description: This is the regions width in pixels.

height

IDL_Type:int
Units:pixel

Description: This is the regions height in pixels.

shutterDetailedState

EFDB_Topic:GenericCamera_logevent_shutterDetailedState

substate

IDL_Type:long
Units:unitless
Enumeration:CLOSED,OPEN,CLOSING,OPENING

Description: Enumeration of valid substates

timestampTransition

IDL_Type:double
Units:second

Description: The time at which the state transition occurred

startIntegration

Description: Event sent at start of image integration.
Note: all : delimited strings (aka string arrays) follow the escaping convention defined in CAP-572
EFDB_Topic:GenericCamera_logevent_startIntegration

additionalKeys

IDL_Type:string
Units:unitless

Description: Additional keys passed to the takeImages command (: delimited)

additionalValues

IDL_Type:string
Units:unitless

Description: Additional values passed to the takeImages command (: delimited, in same order as additionalKeys)

imagesInSequence

IDL_Type:long
Units:unitless

Description: The total number of requested images in sequence

imageName

IDL_Type:string
IDL_Size:32
Units:unitless

Description: The imageName for this specific exposure, assigned by the camera

imageIndex

IDL_Type:long
Units:unitless

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

imageSource

IDL_Type:string
IDL_Size:2
Units:unitless

Description: The source component of the image name (AT/CC/MC)

imageController

IDL_Type:string
Units:unitless

Description: The controller for the image (O=OCS/C=CCS/…)

imageDate

IDL_Type:string
IDL_Size:8
Units:unitless

Description: The date component of the image name (YYYYMMDD)

imageNumber

IDL_Type:long
Units:unitless

Description: The image number (SEQNO) component of the image name

timestampAcquisitionStart

IDL_Type:double
Units:second

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

Description: The requested exposure time

startLiveView

EFDB_Topic:GenericCamera_logevent_startLiveView

ip

IDL_Type:string
Units:unitless

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

port

IDL_Type:int
Units:unitless

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

startReadout

Description: Event sent at start of readout.
Note: all : delimited strings (aka string arrays) follow the escaping convention defined in CAP-572
EFDB_Topic:GenericCamera_logevent_startReadout

additionalKeys

IDL_Type:string
Units:unitless

Description: Additional keys passed to the takeImages command (: delimited)

additionalValues

IDL_Type:string
Units:unitless

Description: Additional values passed to the takeImages command (: delimited, in same order as additionalKeys)

imagesInSequence

IDL_Type:long
Units:unitless

Description: The total number of requested images in sequence

imageName

IDL_Type:string
IDL_Size:32
Units:unitless

Description: The imageName for this specific exposure, assigned by the camera

imageIndex

IDL_Type:long
Units:unitless

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

imageSource

IDL_Type:string
IDL_Size:2
Units:unitless

Description: The source component of the image name (AT/CC/MC)

imageController

IDL_Type:string
Units:unitless

Description: The controller for the image (O=OCS/C=CCS/…)

imageDate

IDL_Type:string
IDL_Size:8
Units:unitless

Description: The date component of the image name (YYYYMMDD)

imageNumber

IDL_Type:long
Units:unitless

Description: The image number (SEQNO) component of the image name

timestampAcquisitionStart

IDL_Type:double
Units:second

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

Description: The requested exposure time

timestampStartOfReadout

IDL_Type:double
Units:second

Description: The time at which the readout was triggered

startShutterClose

EFDB_Topic:GenericCamera_logevent_startShutterClose

startShutterOpen

EFDB_Topic:GenericCamera_logevent_startShutterOpen

startTakeImage

EFDB_Topic:GenericCamera_logevent_startTakeImage

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

EFDB_Topic:GenericCamera_temperature

temperature

IDL_Type:double
Units:Celsius

Description: The temperature of the camera in degrees Celsius.