:tocdepth: 3 ############# GenericCamera ############# .. note:: This page is generated by python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- .. _GenericCamera:Commands:setFullFrame: setFullFrame ~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_command_setFullFrame .. _GenericCamera:Commands:setFullFrame:ignored: ignored ******* :IDL_Type: boolean :Units: unitless **Description**: This value is ignored. .. _GenericCamera:Commands:setROI: setROI ~~~~~~ :EFDB_Topic: GenericCamera_command_setROI .. _GenericCamera:Commands:setROI:topPixel: topPixel ******** :IDL_Type: int :Units: pixel **Description**: This is the regions top most pixel number (base 0). .. _GenericCamera:Commands:setROI:leftPixel: leftPixel ********* :IDL_Type: int :Units: pixel **Description**: This is the regions left most pixel number (base 0). .. _GenericCamera:Commands:setROI:width: width ***** :IDL_Type: int :Units: pixel **Description**: This is the regions width in pixels. .. _GenericCamera:Commands:setROI:height: height ****** :IDL_Type: int :Units: pixel **Description**: This is the regions height in pixels. .. _GenericCamera:Commands:startLiveView: startLiveView ~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_command_startLiveView .. _GenericCamera:Commands:startLiveView:expTime: expTime ******* :IDL_Type: double :Units: second **Description**: Exposure time. .. _GenericCamera:Commands:stopLiveView: stopLiveView ~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_command_stopLiveView .. _GenericCamera:Commands:stopLiveView:ignored: ignored ******* :IDL_Type: boolean :Units: unitless **Description**: This value is ignored. .. _GenericCamera:Commands:takeImages: takeImages ~~~~~~~~~~ :EFDB_Topic: GenericCamera_command_takeImages .. _GenericCamera:Commands:takeImages:numImages: numImages ********* :IDL_Type: long :Units: unitless **Description**: Number of consecutive images to take .. _GenericCamera:Commands:takeImages:expTime: expTime ******* :IDL_Type: double :Units: second **Description**: Exposure time .. _GenericCamera:Commands:takeImages:shutter: shutter ******* :IDL_Type: boolean :Units: unitless **Description**: True if the shutter should be opened/closed .. _GenericCamera:Commands:takeImages:sensors: sensors ******* :IDL_Type: string :Units: unitless **Description**: Sensors to be read out, if blank all configured sensors will be read out .. _GenericCamera:Commands:takeImages:keyValueMap: 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 .. _GenericCamera:Commands:takeImages:obsNote: 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 .. _GenericCamera:setAuthList:authorizedUsers: 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. .. _GenericCamera:setAuthList:nonAuthorizedCSCs: 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 .. _GenericCamera:setLogLevel:level: 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 .. _GenericCamera:setValue:parametersAndValues: 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 .. _GenericCamera:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Events ------ .. _GenericCamera:Events:calibrationDetailedState: calibrationDetailedState ~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_calibrationDetailedState .. _GenericCamera:Events:calibrationDetailedState:substate: substate ******** :IDL_Type: long :Units: unitless :Enumeration: DISABLED,ENABLED,INTEGRATING **Description**: Enumeration of valid substates .. _GenericCamera:Events:calibrationDetailedState:timestampTransition: timestampTransition ******************* :IDL_Type: double :Units: second **Description**: The time at which the state transition occurred .. _GenericCamera:Events:cameraInfo: cameraInfo ~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_cameraInfo .. _GenericCamera:Events:cameraInfo:cameraMakeAndModel: cameraMakeAndModel ****************** :IDL_Type: string :Units: unitless **Description**: This is the make and model of the current camera. .. _GenericCamera:Events:cameraSpecificProperty: cameraSpecificProperty ~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_cameraSpecificProperty .. _GenericCamera:Events:cameraSpecificProperty:propertyName: propertyName ************ :IDL_Type: string :Units: unitless **Description**: This is the name of the property specific to this camera. .. _GenericCamera:Events:cameraSpecificProperty:propertyValue: propertyValue ************* :IDL_Type: string :Units: unitless **Description**: This is the value of the property specific to this camera. .. _GenericCamera:Events:ccsCommandState: ccsCommandState ~~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_ccsCommandState .. _GenericCamera:Events:ccsCommandState:substate: substate ******** :IDL_Type: long :Units: unitless :Enumeration: IDLE,BUSY **Description**: Substate of the CCS command. .. _GenericCamera:Events:ccsCommandState:timestampTransition: timestampTransition ******************* :IDL_Type: double :Units: second **Description**: The time at which the state transition occurred .. _GenericCamera:Events:ccsConfigured: ccsConfigured ~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_ccsConfigured .. _GenericCamera:Events:endIntegration: endIntegration ~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_endIntegration .. _GenericCamera:Events:endIntegration:ignored: ignored ******* :IDL_Type: boolean :Units: unitless **Description**: Attribute required by the SAL API, but is unused. .. _GenericCamera:Events:endLiveView: endLiveView ~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_endLiveView .. _GenericCamera:Events:endLiveView:ignored: ignored ******* :IDL_Type: boolean :Units: unitless **Description**: Attribute required by the SAL API, but is unused. .. _GenericCamera:Events:endOfImageTelemetry: 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 .. _GenericCamera:Events:endOfImageTelemetry:additionalKeys: additionalKeys ************** :IDL_Type: string :Units: unitless **Description**: Additional keys passed to the takeImages command (: delimited) .. _GenericCamera:Events:endOfImageTelemetry:additionalValues: additionalValues **************** :IDL_Type: string :Units: unitless **Description**: Additional values passed to the takeImages command (: delimited, in same order as additionalKeys) .. _GenericCamera:Events:endOfImageTelemetry:imagesInSequence: imagesInSequence **************** :IDL_Type: long :Units: unitless **Description**: The total number of requested images in sequence .. _GenericCamera:Events:endOfImageTelemetry:imageName: imageName ********* :IDL_Type: string :IDL_Size: 32 :Units: unitless **Description**: The imageName for this specific exposure, assigned by the camera .. _GenericCamera:Events:endOfImageTelemetry:imageIndex: imageIndex ********** :IDL_Type: long :Units: unitless **Description**: The zero based index number for this specific exposure within the sequence .. _GenericCamera:Events:endOfImageTelemetry:imageSource: imageSource *********** :IDL_Type: string :IDL_Size: 2 :Units: unitless **Description**: The source component of the image name (AT/CC/MC) .. _GenericCamera:Events:endOfImageTelemetry:imageController: imageController *************** :IDL_Type: string :Units: unitless **Description**: The controller for the image (O=OCS/C=CCS/...) .. _GenericCamera:Events:endOfImageTelemetry:imageDate: imageDate ********* :IDL_Type: string :IDL_Size: 8 :Units: unitless **Description**: The date component of the image name (YYYYMMDD) .. _GenericCamera:Events:endOfImageTelemetry:imageNumber: imageNumber *********** :IDL_Type: long :Units: unitless **Description**: The image number (SEQNO) component of the image name .. _GenericCamera:Events:endOfImageTelemetry:timestampAcquisitionStart: 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) .. _GenericCamera:Events:endOfImageTelemetry:exposureTime: exposureTime ************ :IDL_Type: double :Units: second **Description**: The requested exposure time .. _GenericCamera:Events:endOfImageTelemetry:imageTag: imageTag ******** :IDL_Type: string :IDL_Size: 64 :Units: unitless **Description**: The DAQ assigned image tag (hex string) .. _GenericCamera:Events:endOfImageTelemetry:timestampDateObs: timestampDateObs **************** :IDL_Type: double :Units: second **Description**: The observation date, as computed by CCS (as TAI) .. _GenericCamera:Events:endOfImageTelemetry:timestampDateEnd: timestampDateEnd **************** :IDL_Type: double :Units: second **Description**: The end observation date, as computed by CCS (as TAI) .. _GenericCamera:Events:endOfImageTelemetry:measuredShutterOpenTime: 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. .. _GenericCamera:Events:endOfImageTelemetry:darkTime: darkTime ******** :IDL_Type: double :Units: second **Description**: The dark time, as computed by CCS .. _GenericCamera:Events:endReadout: 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 .. _GenericCamera:Events:endReadout:additionalKeys: additionalKeys ************** :IDL_Type: string :Units: unitless **Description**: Additional keys passed to the takeImages command (: delimited) .. _GenericCamera:Events:endReadout:additionalValues: additionalValues **************** :IDL_Type: string :Units: unitless **Description**: Additional values passed to the takeImages command (: delimited, in same order as additionalKeys) .. _GenericCamera:Events:endReadout:imagesInSequence: imagesInSequence **************** :IDL_Type: long :Units: unitless **Description**: The total number of requested images in sequence .. _GenericCamera:Events:endReadout:imageName: imageName ********* :IDL_Type: string :IDL_Size: 32 :Units: unitless **Description**: The imageName for this specific exposure, assigned by the camera .. _GenericCamera:Events:endReadout:imageIndex: imageIndex ********** :IDL_Type: long :Units: unitless **Description**: The zero based index number for this specific exposure within the sequence .. _GenericCamera:Events:endReadout:imageSource: imageSource *********** :IDL_Type: string :IDL_Size: 2 :Units: unitless **Description**: The source component of the image name (AT/CC/MC) .. _GenericCamera:Events:endReadout:imageController: imageController *************** :IDL_Type: string :Units: unitless **Description**: The controller for the image (O=OCS/C=CCS/...) .. _GenericCamera:Events:endReadout:imageDate: imageDate ********* :IDL_Type: string :IDL_Size: 8 :Units: unitless **Description**: The date component of the image name (YYYYMMDD) .. _GenericCamera:Events:endReadout:imageNumber: imageNumber *********** :IDL_Type: long :Units: unitless **Description**: The image number (SEQNO) component of the image name .. _GenericCamera:Events:endReadout:timestampAcquisitionStart: 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) .. _GenericCamera:Events:endReadout:requestedExposureTime: requestedExposureTime ********************* :IDL_Type: double :Units: second **Description**: The requested exposure time (as specified in the takeImages command) .. _GenericCamera:Events:endReadout:timestampEndOfReadout: timestampEndOfReadout ********************* :IDL_Type: double :Units: second **Description**: The time at which the readout was completed .. _GenericCamera:Events:endShutterClose: endShutterClose ~~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_endShutterClose .. _GenericCamera:Events:endShutterOpen: endShutterOpen ~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_endShutterOpen .. _GenericCamera:Events:endTakeImage: endTakeImage ~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_endTakeImage .. _GenericCamera:Events:fileCommandExecution: fileCommandExecution ~~~~~~~~~~~~~~~~~~~~ **Description**: Each time a command is executed on a single FITS file this event is generated :EFDB_Topic: GenericCamera_logevent_fileCommandExecution .. _GenericCamera:Events:fileCommandExecution:imageName: imageName ********* :IDL_Type: string :IDL_Size: 32 :Units: unitless **Description**: The imageName for this specific exposure, assigned by the camera .. _GenericCamera:Events:fileCommandExecution:timestampCommandComplete: timestampCommandComplete ************************ :IDL_Type: double :Units: second **Description**: The time when the command completed. .. _GenericCamera:Events:fileCommandExecution:command: command ******* :IDL_Type: string :Units: unitless **Description**: The comamnd executed included arguments. .. _GenericCamera:Events:fileCommandExecution:rc: rc ** :IDL_Type: int :Units: unitless **Description**: The return code from the command execution. .. _GenericCamera:Events:fitsFilesWritten: 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 .. _GenericCamera:Events:fitsFilesWritten:imageName: imageName ********* :IDL_Type: string :IDL_Size: 32 :Units: unitless **Description**: The imageName for this specific exposure, assigned by the camera .. _GenericCamera:Events:fitsFilesWritten:timestampFilesWritten: timestampFilesWritten ********************* :IDL_Type: double :Units: second **Description**: The time when the (last) CCS FITS file was written. .. _GenericCamera:Events:fitsFilesWritten:rootFileName: rootFileName ************ :IDL_Type: string :Units: unitless **Description**: The common filesystem location of all files below. .. _GenericCamera:Events:fitsFilesWritten:relativeFileNames: relativeFileNames ***************** :IDL_Type: string :Units: unitless **Description**: The file system location of each file, relative to rootFileName (: delimited). .. _GenericCamera:Events:fitsFilesWritten:fileNode: fileNode ******** :IDL_Type: string :Units: unitless **Description**: The node on which each file is written (: delimited, in same order as above). .. _GenericCamera:Events:imageReadinessDetailedState: imageReadinessDetailedState ~~~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_imageReadinessDetailedState .. _GenericCamera:Events:imageReadinessDetailedState:substate: substate ******** :IDL_Type: long :Units: unitless :Enumeration: READY,NOT_READY,GETTING_READY **Description**: Enumeration of valid substates .. _GenericCamera:Events:imageReadinessDetailedState:timestampTransition: timestampTransition ******************* :IDL_Type: double :Units: second **Description**: The time at which the state transition occurred .. _GenericCamera:Events:imageStored: 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 .. _GenericCamera:Events:imageStored:imageName: imageName ********* :IDL_Type: string :IDL_Size: 32 :Units: unitless **Description**: The imageName for this specific exposure, assigned by the camera .. _GenericCamera:Events:imageStored:timestampImageStored: timestampImageStored ******************** :IDL_Type: double :Units: second **Description**: The time when the DAQ image was store was complete. .. _GenericCamera:Events:imageVisualization: imageVisualization ~~~~~~~~~~~~~~~~~~ **Description**: Event sent when image visualization is ready :EFDB_Topic: GenericCamera_logevent_imageVisualization .. _GenericCamera:Events:imageVisualization:imageName: imageName ********* :IDL_Type: string :IDL_Size: 32 :Units: unitless **Description**: The imageName for this specific exposure, assigned by the camera .. _GenericCamera:Events:imageVisualization:timestampVisualizationAvailable: timestampVisualizationAvailable ******************************* :IDL_Type: double :Units: second **Description**: The time when the command completed. .. _GenericCamera:Events:imageVisualization:url: url *** :IDL_Type: string :Units: unitless **Description**: The URL at which the full image visualization is available. .. _GenericCamera:Events:imageVisualization:thumbnail: thumbnail ********* :IDL_Type: string :Units: unitless **Description**: The URL at which the image thumbnail is available. .. _GenericCamera:Events:notReadyToTakeImage: notReadyToTakeImage ~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_notReadyToTakeImage .. _GenericCamera:Events:offlineDetailedState: offlineDetailedState ~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_offlineDetailedState .. _GenericCamera:Events:offlineDetailedState:substate: substate ******** :IDL_Type: long :Units: unitless :Enumeration: OFFLINE_AVAILABLE,OFFLINE_PUBLISH_ONLY **Description**: Enumeration of valid substates .. _GenericCamera:Events:offlineDetailedState:timestampTransition: timestampTransition ******************* :IDL_Type: double :Units: second **Description**: The time at which the state transition occurred .. _GenericCamera:Events:prepareToTakeImage: prepareToTakeImage ~~~~~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_prepareToTakeImage .. _GenericCamera:Events:readyToTakeImage: readyToTakeImage ~~~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_readyToTakeImage .. _GenericCamera:Events:roi: roi ~~~ :EFDB_Topic: GenericCamera_logevent_roi .. _GenericCamera:Events:roi:topPixel: topPixel ******** :IDL_Type: int :Units: pixel **Description**: This is the regions top most pixel number (base 0). .. _GenericCamera:Events:roi:leftPixel: leftPixel ********* :IDL_Type: int :Units: pixel **Description**: This is the regions left most pixel number (base 0). .. _GenericCamera:Events:roi:width: width ***** :IDL_Type: int :Units: pixel **Description**: This is the regions width in pixels. .. _GenericCamera:Events:roi:height: height ****** :IDL_Type: int :Units: pixel **Description**: This is the regions height in pixels. .. _GenericCamera:Events:shutterDetailedState: shutterDetailedState ~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_shutterDetailedState .. _GenericCamera:Events:shutterDetailedState:substate: substate ******** :IDL_Type: long :Units: unitless :Enumeration: CLOSED,OPEN,CLOSING,OPENING **Description**: Enumeration of valid substates .. _GenericCamera:Events:shutterDetailedState:timestampTransition: timestampTransition ******************* :IDL_Type: double :Units: second **Description**: The time at which the state transition occurred .. _GenericCamera:Events:startIntegration: 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 .. _GenericCamera:Events:startIntegration:additionalKeys: additionalKeys ************** :IDL_Type: string :Units: unitless **Description**: Additional keys passed to the takeImages command (: delimited) .. _GenericCamera:Events:startIntegration:additionalValues: additionalValues **************** :IDL_Type: string :Units: unitless **Description**: Additional values passed to the takeImages command (: delimited, in same order as additionalKeys) .. _GenericCamera:Events:startIntegration:imagesInSequence: imagesInSequence **************** :IDL_Type: long :Units: unitless **Description**: The total number of requested images in sequence .. _GenericCamera:Events:startIntegration:imageName: imageName ********* :IDL_Type: string :IDL_Size: 32 :Units: unitless **Description**: The imageName for this specific exposure, assigned by the camera .. _GenericCamera:Events:startIntegration:imageIndex: imageIndex ********** :IDL_Type: long :Units: unitless **Description**: The zero based index number for this specific exposure within the sequence .. _GenericCamera:Events:startIntegration:imageSource: imageSource *********** :IDL_Type: string :IDL_Size: 2 :Units: unitless **Description**: The source component of the image name (AT/CC/MC) .. _GenericCamera:Events:startIntegration:imageController: imageController *************** :IDL_Type: string :Units: unitless **Description**: The controller for the image (O=OCS/C=CCS/...) .. _GenericCamera:Events:startIntegration:imageDate: imageDate ********* :IDL_Type: string :IDL_Size: 8 :Units: unitless **Description**: The date component of the image name (YYYYMMDD) .. _GenericCamera:Events:startIntegration:imageNumber: imageNumber *********** :IDL_Type: long :Units: unitless **Description**: The image number (SEQNO) component of the image name .. _GenericCamera:Events:startIntegration:timestampAcquisitionStart: 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) .. _GenericCamera:Events:startIntegration:exposureTime: exposureTime ************ :IDL_Type: double :Units: second **Description**: The requested exposure time .. _GenericCamera:Events:startLiveView: startLiveView ~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_startLiveView .. _GenericCamera:Events:startLiveView:ip: ip ** :IDL_Type: string :Units: unitless **Description**: This is the ip address for the live view data. .. _GenericCamera:Events:startLiveView:port: port **** :IDL_Type: int :Units: unitless **Description**: This is the TCP port for the live view data. .. _GenericCamera:Events:startReadout: 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 .. _GenericCamera:Events:startReadout:additionalKeys: additionalKeys ************** :IDL_Type: string :Units: unitless **Description**: Additional keys passed to the takeImages command (: delimited) .. _GenericCamera:Events:startReadout:additionalValues: additionalValues **************** :IDL_Type: string :Units: unitless **Description**: Additional values passed to the takeImages command (: delimited, in same order as additionalKeys) .. _GenericCamera:Events:startReadout:imagesInSequence: imagesInSequence **************** :IDL_Type: long :Units: unitless **Description**: The total number of requested images in sequence .. _GenericCamera:Events:startReadout:imageName: imageName ********* :IDL_Type: string :IDL_Size: 32 :Units: unitless **Description**: The imageName for this specific exposure, assigned by the camera .. _GenericCamera:Events:startReadout:imageIndex: imageIndex ********** :IDL_Type: long :Units: unitless **Description**: The zero based index number for this specific exposure within the sequence .. _GenericCamera:Events:startReadout:imageSource: imageSource *********** :IDL_Type: string :IDL_Size: 2 :Units: unitless **Description**: The source component of the image name (AT/CC/MC) .. _GenericCamera:Events:startReadout:imageController: imageController *************** :IDL_Type: string :Units: unitless **Description**: The controller for the image (O=OCS/C=CCS/...) .. _GenericCamera:Events:startReadout:imageDate: imageDate ********* :IDL_Type: string :IDL_Size: 8 :Units: unitless **Description**: The date component of the image name (YYYYMMDD) .. _GenericCamera:Events:startReadout:imageNumber: imageNumber *********** :IDL_Type: long :Units: unitless **Description**: The image number (SEQNO) component of the image name .. _GenericCamera:Events:startReadout:timestampAcquisitionStart: 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) .. _GenericCamera:Events:startReadout:exposureTime: exposureTime ************ :IDL_Type: double :Units: second **Description**: The requested exposure time .. _GenericCamera:Events:startReadout:timestampStartOfReadout: timestampStartOfReadout *********************** :IDL_Type: double :Units: second **Description**: The time at which the readout was triggered .. _GenericCamera:Events:startShutterClose: startShutterClose ~~~~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_startShutterClose .. _GenericCamera:Events:startShutterOpen: startShutterOpen ~~~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_startShutterOpen .. _GenericCamera:Events:startTakeImage: startTakeImage ~~~~~~~~~~~~~~ :EFDB_Topic: GenericCamera_logevent_startTakeImage appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _GenericCamera:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _GenericCamera:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _GenericCamera:authList:nonAuthorizedCSCs: 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 .. _GenericCamera:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _GenericCamera:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _GenericCamera:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _GenericCamera:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _GenericCamera:logLevel:level: 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 .. _GenericCamera:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _GenericCamera:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _GenericCamera:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _GenericCamera:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _GenericCamera:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _GenericCamera:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _GenericCamera:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _GenericCamera:logMessage:process: 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 .. _GenericCamera:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _GenericCamera:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _GenericCamera:settingVersions:settingsUrl: 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 .. _GenericCamera:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _GenericCamera:settingsApplied:otherSettingsEvents: 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 .. _GenericCamera:simulationMode:mode: 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 .. _GenericCamera:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of SAL generation .. _GenericCamera:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of CSC XML .. _GenericCamera:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of OpenSplice .. _GenericCamera:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the top-level version of the CSC .. _GenericCamera:softwareVersions:subsystemVersions: 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 .. _GenericCamera:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _GenericCamera:Telemetry:temperature: temperature ~~~~~~~~~~~ :EFDB_Topic: GenericCamera_temperature .. _GenericCamera:Telemetry:temperature:temperature: temperature *********** :IDL_Type: double :Units: Celsius **Description**: The temperature of the camera in degrees Celsius.