GenericCamera#

Note

This page is generated by python script generate_cet.py.

Back to table

Commands#

setFullFrame#

Description: Set the active area on the camera to the full sensor size.

EFDB_Topic:

GenericCamera_command_setFullFrame

ignored#

IDL_Type:

boolean

Units:

unitless

Description: This value is ignored.

setROI#

Description: Set the active area on the camera to a region-of-interest.

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.

setValue#

Description: Allow camera parameters to be adjusted

EFDB_Topic:

GenericCamera_command_setValue

parametersAndValues#

IDL_Type:

string

Units:

unitless

Description: List of parameters and their values as a Json string

startAutoExposure#

Description: Start automatic exposure taking

EFDB_Topic:

GenericCamera_command_startAutoExposure

minExpTime#

IDL_Type:

float

Units:

second

Description: Minimum exposure time

maxExpTime#

IDL_Type:

float

Units:

second

Description: Maximum exposure time

configuration#

IDL_Type:

string

Units:

unitless

Description: Additional parameters in YAML format

startLiveView#

Description: Start the live view mode.

EFDB_Topic:

GenericCamera_command_startLiveView

expTime#

IDL_Type:

double

Units:

second

Description: Exposure time.

startStreamingMode#

Description: Start streaming mode operation of the camera.

EFDB_Topic:

GenericCamera_command_startStreamingMode

expTime#

IDL_Type:

double

Units:

second

Description: The exposure time requested for streaming.

stopAutoExposure#

Description: Stop automatic exposure taking

EFDB_Topic:

GenericCamera_command_stopAutoExposure

stopLiveView#

Description: Stop the live view mode.

EFDB_Topic:

GenericCamera_command_stopLiveView

ignored#

IDL_Type:

boolean

Units:

unitless

Description: This value is ignored.

stopStreamingMode#

Description: Stop streaming mode operation of the camera.

EFDB_Topic:

GenericCamera_command_stopStreamingMode

takeImages#

Description: Command the camera to take an image.

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

disable#

Description: Transition from state Enabled to Disabled.

EFDB_Topic:

SALGeneric_command_disable

Category:

csc

enable#

Description: Transition from state Disabled to Enabled.

EFDB_Topic:

SALGeneric_command_enable

Category:

csc

exitControl#

Description: Transition from state Standby to Offline. Most CSCs will quit, but CSCs that support the enterControl command will keep running.

EFDB_Topic:

SALGeneric_command_exitControl

Category:

csc

setAuthList#

Description: Specify who can command this CSC.

EFDB_Topic:

SALGeneric_command_setAuthList

Category:

csc

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

Category:

csc

level#

IDL_Type:

int

Units:

unitless

Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.

subsystem#

IDL_Type:

string

Units:

unitless

Description: If this CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to this CSC itself.

standby#

Description: Transition from state Offline/Available, Disabled or Fault to Standby.

EFDB_Topic:

SALGeneric_command_standby

Category:

csc

start#

Description: Transition from state Standby to Disable, in a specified configuration.

EFDB_Topic:

SALGeneric_command_start

Category:

csc

configurationOverride#

IDL_Type:

string

Units:

unitless

Description:

Configuration override in the form [{name}][:{version}]. For salobj-based CSCs: name is a filename with “.yaml” suffix and version is a git hash; for example:

  • “foo.yaml” specifies just a file. Two or three config files are loaded: “_init.yaml”, “_{site}.yaml” (if present), and “foo.yaml”.

  • “:37bf936” specifies just a git hash. One or two config files are loaded from the specified git commit: “_init.yaml” and “_{site}.yaml” (if present.

  • “bar.yaml:HEAD~2” specifies both a file and a git hash. Two or three config files are read from the specified git commit: “_init.yaml”, “_{site}.yaml” (if present), and “bar.yaml”.

Events#

autoExposureStarted#

Description: Notification event that the camera has started auto exposure mode

EFDB_Topic:

GenericCamera_logevent_autoExposureStarted

minExpTime#

IDL_Type:

float

Units:

second

Description: Minimum exposure time

maxExpTime#

IDL_Type:

float

Units:

second

Description: Maximum exposure time

configuration#

IDL_Type:

string

Units:

unitless

Description: Additional parameters in YAML format

autoExposureStopped#

Description: Notification event that the camera has stopped auto exposure mode

EFDB_Topic:

GenericCamera_logevent_autoExposureStopped

calibrationDetailedState#

Description: Information about the camera’s calibration state

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#

Description: Collection of camera and/or optical system related information

EFDB_Topic:

GenericCamera_logevent_cameraInfo

cameraMakeAndModel#

IDL_Type:

string

Units:

unitless

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

lensAperture#

IDL_Type:

string

Units:

unitless

Description: This is the aperture or f-stop of the lens attached to the camera. Format is f/N.

lensFocalLength#

IDL_Type:

float

Units:

mm

Description: The focal length of the lens attached to the camera.

lensDiameter#

IDL_Type:

float

Units:

mm

Description: This is the diameter of the lens attached to the camera.

plateScale#

IDL_Type:

float

Units:

arcsec/pix

Description: This is effective plate scale of the lens/camera system.

iso#

IDL_Type:

string

Units:

unitless

Description: This is the ISO setting for the camera. Format is ISO[N]

cameraSpecificProperty#

Description: Information about a specific camera property

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#

Description: Information about the camera control systems’ command state

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#

Description: Information about the camera control systems’ configured state

EFDB_Topic:

GenericCamera_logevent_ccsConfigured

endIntegration#

Description: Event sent at end of image integration.

Note: all : delimited strings (aka string arrays) follow the escaping convention defined in CAP-572

EFDB_Topic:

GenericCamera_logevent_endIntegration

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)

timestampAcquisitionEnd#

IDL_Type:

double

Units:

second

Description: The effective time at which the image acquisition ended.

endLiveView#

Description: Notification event about the ending of the live view mode

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

Units:

unitless

Description: The source component of the image name (GC[index])

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

endOfStreaming#

Description: Notification event that camera has stopped streaming, but construction of image file(s) still pending.

EFDB_Topic:

GenericCamera_logevent_endOfStreaming

imageName#

IDL_Type:

string

IDL_Size:

32

Units:

unitless

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

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

Units:

unitless

Description: The source component of the image name (GC[index])

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#

Description: Notification event about the camera ending the closing of the shutter

EFDB_Topic:

GenericCamera_logevent_endShutterClose

endShutterOpen#

Description: Notification event about the camera ending the shutter opening

EFDB_Topic:

GenericCamera_logevent_endShutterOpen

endTakeImage#

Description: Notification event about the camera ending the process of taking an image

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#

Description: Information about the readiness of the camera image system

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#

Description: Notification event that the camera is not ready to take an image.

EFDB_Topic:

GenericCamera_logevent_notReadyToTakeImage

offlineDetailedState#

Description: Information regarding the camera substate in OFFLINE state

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#

Description: Notification event that the camera is preparing to take an image

EFDB_Topic:

GenericCamera_logevent_prepareToTakeImage

readyToTakeImage#

Description: Notification event that the camera is ready to take an image

EFDB_Topic:

GenericCamera_logevent_readyToTakeImage

roi#

Description: Information about the region-of-interest

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#

Description: Information about the camera’s shutter state

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

Units:

unitless

Description: The source component of the image name (GC[index])

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#

Description: Notification event about the starting of the live view mode

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

Units:

unitless

Description: The source component of the image name (GC[index])

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#

Description: Notification event about the camera starting to close the shutter

EFDB_Topic:

GenericCamera_logevent_startShutterClose

startShutterOpen#

Description: Notification event about the camera starting to open the shutter

EFDB_Topic:

GenericCamera_logevent_startShutterOpen

startTakeImage#

Description: Notification event about the camera starting to take an image

EFDB_Topic:

GenericCamera_logevent_startTakeImage

streamingModeStarted#

Description: Notification event that streaming mode started

EFDB_Topic:

GenericCamera_logevent_streamingModeStarted

expTime#

IDL_Type:

double

Units:

second

Description: The exposure time requested for streaming

imageName#

IDL_Type:

string

IDL_Size:

32

Units:

unitless

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

streamingModeStopped#

Description: Notification event that streaming mode stopped.

EFDB_Topic:

GenericCamera_logevent_streamingModeStopped

expTime#

IDL_Type:

double

Units:

second

Description: The exposure time requested for streaming.

numFrames#

IDL_Type:

long

Units:

unitless

Description: The number of frames captured during streaming mode.

avgFrameRate#

IDL_Type:

double

Units:

Hz

Description: The average frame rate during streaming mode acquisition.

imageName#

IDL_Type:

string

IDL_Size:

32

Units:

unitless

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

authList#

Description: Who can command this CSC.

EFDB_Topic:

SALGeneric_logevent_authList

Category:

csc

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.

configurationApplied#

Description: Information about this CSC’s current configuration overrides.

EFDB_Topic:

SALGeneric_logevent_configurationApplied

Category:

configurable

configurations#

IDL_Type:

string

Units:

unitless

Description: A comma-separated list of configurations applied. If configuration comes from a clone of a git repo, or similar directory, then it will be a list of file names, without the file extension. Ignore whitespace after commas.

version#

IDL_Type:

string

Units:

unitless

Description: Version of the configuration source. For a clone of a git repo it will be a git hash.

url#

IDL_Type:

string

Units:

unitless

Description: URL of the configuration source. For a clone of a git repo this will be a file URL. For a database it will be a standard database URL. This should always match the same-named field in configurationsAvailable.

schemaVersion#

IDL_Type:

string

Units:

unitless

Description: Version of config schema used by this CSC. For a configuration git repo, this is the name of a folder in the config package, and is typically something like “v1”. This should always match the same-named field in configurationsAvailable.

otherInfo#

IDL_Type:

string

Units:

unitless

Description: A comma-separated list of event topics (without the logevent prefix) used to publish the entire set of configuration parameters loaded by this CSC, and any other pertinent information. Ignore whitespace after commas.

configurationsAvailable#

Description: Available configuration overrides for this CSC.

EFDB_Topic:

SALGeneric_logevent_configurationsAvailable

Category:

configurable

overrides#

IDL_Type:

string

Units:

unitless

Description: Available overrides as a comma-separated list. Each entry is a possible value of the configurationOverride field of the start command. Ignore whitespace after commas.

version#

IDL_Type:

string

Units:

unitless

Description: Version of the configuration source. For a clone of a git repo it will be a git hash.

url#

IDL_Type:

string

Units:

unitless

Description: URL of the configuration source. For a clone of a git repo this will be a file URL. For a database it will be a standard database URL.

schemaVersion#

IDL_Type:

string

Units:

unitless

Description: Version of config schema used by this CSC. For a configuration git repo, this is the name of a folder in the config package, and is typically something like “v1”.

errorCode#

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

EFDB_Topic:

SALGeneric_logevent_errorCode

Category:

csc

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#

Description: Event output at regular intervals (typcally once per second) to show that the SAL component is alive.

EFDB_Topic:

SALGeneric_logevent_heartbeat

Category:

mandatory

heartbeat#

IDL_Type:

boolean

Units:

unitless

Description: Deprecated field that you should ignore.

largeFileObjectAvailable#

Description: A new large file object is available.

EFDB_Topic:

SALGeneric_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.

logLevel#

Description: Current logging level.

EFDB_Topic:

SALGeneric_logevent_logLevel

Category:

mandatory

level#

IDL_Type:

int

Units:

unitless

Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.

subsystem#

IDL_Type:

string

Units:

unitless

Description: If this CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to this CSC itself.

logMessage#

Description: A log message.

EFDB_Topic:

SALGeneric_logevent_logMessage

Category:

mandatory

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.

timestamp#

IDL_Type:

double

Units:

second

Description: The time at which the condition being reported was observed (TAI unix seconds). 0 if unspecified.

simulationMode#

Description: Current simulation mode.

EFDB_Topic:

SALGeneric_logevent_simulationMode

Category:

csc

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

Category:

mandatory

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: The software version of this 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 this CSC.

statusCode#

Description: Output when this CSC experiences a non-optimal condition that is important to a user but insufficient to raise an error condition.

EFDB_Topic:

SALGeneric_logevent_statusCode

mask#

IDL_Type:

int

Units:

unitless

Description: An integer representing a bitmask defined in LSE-209.

summaryState#

Description: Current summary state of this CSC.

EFDB_Topic:

SALGeneric_logevent_summaryState

Category:

csc

summaryState#

IDL_Type:

long

Units:

unitless

Description: High level state machine state identifier.

Telemetry#

temperature#

Description: Report the temperature of the camera or sensor.

EFDB_Topic:

GenericCamera_temperature

temperature#

IDL_Type:

double

Units:

Celsius

Description: The temperature of the camera in degrees Celsius.