CBP¶

Note

This page is generated by python script generate_cet.py.

Back to table

Commands¶

changeMask¶

Description: Change the mask.

EFDB_Topic:: CBP_command_changeMask

mask¶

IDL_Type:: string
Units:: unitless

Description: The name of the mask to change to.

changeMaskRotation¶

Description: Change the mask rotation for the current mask.

EFDB_Topic:: CBP_command_changeMaskRotation

mask_rotation¶

IDL_Type:: float
Units:: degree

Description: The rotation value for the current mask, between 1 and 360 degrees.

move¶

Description: Move to the desired Azimuth and Elevation.

EFDB_Topic:: CBP_command_move

azimuth¶

IDL_Type:: float
Units:: degree

Description: The desired Azimuth angle.

elevation¶

IDL_Type:: float
Units:: degree

Description: The desired elevation angle.

park¶

Description: Park the CBP. Moves the elevation to -70, locks the motors.

EFDB_Topic:: CBP_command_park

setFocus¶

Description: Set the focus.

EFDB_Topic:: CBP_command_setFocus

focus¶

IDL_Type:: float
Units:: millimeter

Description: The desired focus.

unpark¶

Description: Unpark the CBP.

EFDB_Topic:: CBP_command_unpark

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

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¶

inPosition¶

Description: Reports the motion status of the encoders

EFDB_Topic:: CBP_logevent_inPosition

elevation¶

IDL_Type:: boolean
Units:: unitless

Description: The motion status for elevation

azimuth¶

IDL_Type:: boolean
Units:: unitless

Description: The motion status for azimuth

focus¶

IDL_Type:: boolean
Units:: unitless

Description: The motion status for focus

mask¶

IDL_Type:: boolean
Units:: unitless

Description: The motion status for mask

mask_rotation¶

IDL_Type:: boolean
Units:: unitless

Description: The motion status for mask rotation

target¶

Description: Reports the commanded movement.

EFDB_Topic:: CBP_logevent_target

elevation¶

IDL_Type:: double
Units:: degree

Description: The commanded elevation

azimuth¶

IDL_Type:: double
Units:: degree

Description: The commanded azimuth

focus¶

IDL_Type:: double
Units:: millimeter

Description: The commanded focus

mask¶

IDL_Type:: string
Units:: unitless

Description: The commanded mask

mask_rotation¶

IDL_Type:: double
Units:: degree

Description: The commanded mask rotation

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.

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.

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¶

azimuth¶

Description: The azimuth of the CBP.

EFDB_Topic:: CBP_azimuth

azimuth¶

IDL_Type:: float
Units:: degree

Description: The azimuth of the CBP.

elevation¶

Description: The elevation of the CBP.

EFDB_Topic:: CBP_elevation

elevation¶

IDL_Type:: float
Units:: degree

Description: The elevation of the CBP

focus¶

Description: The focus of the CBP.

EFDB_Topic:: CBP_focus

focus¶

IDL_Type:: float
Units:: millimeter

Description: The focus of the CBP.

mask¶

Description: The mask of the CBP.

EFDB_Topic:: CBP_mask

mask¶

IDL_Type:: string
Units:: unitless

Description: The mask of the CBP.

mask_rotation¶

IDL_Type:: float
Units:: degree

Description: The mask rotation of the CBP.

parked¶

Description: Is the CBP parked?

EFDB_Topic:: CBP_parked

autoparked¶

IDL_Type:: boolean
Units:: unitless

Description: Whether the CBP has been autoparked or not.

parked¶

IDL_Type:: boolean
Units:: unitless

Description: Whether the CBP is parked or not.

status¶

Description: The status array of the CBP.

EFDB_Topic:: CBP_status

panic¶

IDL_Type:: boolean
Units:: unitless

Description: Is the CBP panicking?

azimuth¶

IDL_Type:: boolean
Units:: unitless

Description: Does the azimuth encoder have a problem?

elevation¶

IDL_Type:: boolean
Units:: unitless

Description: Does the elevation encoder have a problem?

mask¶

IDL_Type:: boolean
Units:: unitless

Description: Does the mask encoder have a problem?

mask_rotation¶

IDL_Type:: boolean
Units:: unitless

Description: Does the mask rotation encoder have a problem?

focus¶

IDL_Type:: boolean
Units:: unitless

Description: Does the focus encoder have a problem?