:tocdepth: 3 ### CBP ### .. note:: This page is generated by python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- .. _CBP:Commands:changeMask: changeMask ~~~~~~~~~~ **Description**: Change the mask. :EFDB_Topic: CBP_command_changeMask .. _CBP:Commands:changeMask:mask: mask **** :IDL_Type: string :Units: unitless **Description**: The name of the mask to change to. .. _CBP:Commands:move: move ~~~~ **Description**: Move to the desired Azimuth and Elevation. :EFDB_Topic: CBP_command_move .. _CBP:Commands:move:azimuth: azimuth ******* :IDL_Type: float :Units: degree **Description**: The desired Azimuth angle. .. _CBP:Commands:move:elevation: elevation ********* :IDL_Type: float :Units: degree **Description**: The desired elevation angle. .. _CBP:Commands:park: park ~~~~ **Description**: Park the CBP. Moves the elevation to -70, locks the motors. :EFDB_Topic: CBP_command_park .. _CBP:Commands:setFocus: setFocus ~~~~~~~~ **Description**: Set the focus. :EFDB_Topic: CBP_command_setFocus .. _CBP:Commands:setFocus:focus: focus ***** :IDL_Type: float :Units: millimeter **Description**: The desired focus. .. _CBP:Commands:unpark: unpark ~~~~~~ **Description**: Unpark the CBP. :EFDB_Topic: CBP_command_unpark 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 .. _CBP: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. .. _CBP: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 .. _CBP: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 .. _CBP: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 .. _CBP:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Events ------ .. _CBP:Events:inPosition: inPosition ~~~~~~~~~~ **Description**: Reports the motion status of the encoders :EFDB_Topic: CBP_logevent_inPosition .. _CBP:Events:inPosition:elevation: elevation ********* :IDL_Type: boolean :Units: unitless **Description**: The motion status for elevation .. _CBP:Events:inPosition:azimuth: azimuth ******* :IDL_Type: boolean :Units: unitless **Description**: The motion status for azimuth .. _CBP:Events:inPosition:focus: focus ***** :IDL_Type: boolean :Units: unitless **Description**: The motion status for focus .. _CBP:Events:inPosition:mask: mask **** :IDL_Type: boolean :Units: unitless **Description**: The motion status for mask .. _CBP:Events:inPosition:mask_rotation: mask_rotation ************* :IDL_Type: boolean :Units: unitless **Description**: The motion status for mask rotation .. _CBP:Events:target: target ~~~~~~ **Description**: Reports the commanded movement. :EFDB_Topic: CBP_logevent_target .. _CBP:Events:target:elevation: elevation ********* :IDL_Type: double :Units: degree **Description**: The commanded elevation .. _CBP:Events:target:azimuth: azimuth ******* :IDL_Type: double :Units: degree **Description**: The commanded azimuth .. _CBP:Events:target:focus: focus ***** :IDL_Type: double :Units: millimeter **Description**: The commanded focus .. _CBP:Events:target:mask: mask **** :IDL_Type: string :Units: unitless **Description**: The commanded mask .. _CBP:Events:target:mask_rotation: mask_rotation ************* :IDL_Type: double :Units: degree **Description**: The commanded mask rotation appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _CBP:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _CBP:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _CBP: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 .. _CBP:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _CBP:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _CBP:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _CBP:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _CBP: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 .. _CBP:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _CBP:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _CBP:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _CBP:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _CBP:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _CBP:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _CBP:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _CBP: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 .. _CBP:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _CBP:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _CBP: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 .. _CBP:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _CBP: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 .. _CBP: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 .. _CBP:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of SAL generation .. _CBP:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of CSC XML .. _CBP:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of OpenSplice .. _CBP:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the top-level version of the CSC .. _CBP: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 .. _CBP:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _CBP:Telemetry:azimuth: azimuth ~~~~~~~ :EFDB_Topic: CBP_azimuth .. _CBP:Telemetry:azimuth:azimuth: azimuth ******* :IDL_Type: float :Units: degree **Description**: The azimuth of the CBP. .. _CBP:Telemetry:elevation: elevation ~~~~~~~~~ :EFDB_Topic: CBP_elevation .. _CBP:Telemetry:elevation:elevation: elevation ********* :IDL_Type: float :Units: degree **Description**: The elevation of the CBP .. _CBP:Telemetry:focus: focus ~~~~~ :EFDB_Topic: CBP_focus .. _CBP:Telemetry:focus:focus: focus ***** :IDL_Type: float :Units: millimeter **Description**: The focus of the CBP. .. _CBP:Telemetry:mask: mask ~~~~ :EFDB_Topic: CBP_mask .. _CBP:Telemetry:mask:mask: mask **** :IDL_Type: string :Units: unitless **Description**: The mask of the CBP. .. _CBP:Telemetry:mask:mask_rotation: mask_rotation ************* :IDL_Type: float :Units: degree **Description**: The mask rotation of the CBP. .. _CBP:Telemetry:parked: parked ~~~~~~ :EFDB_Topic: CBP_parked .. _CBP:Telemetry:parked:autoparked: autoparked ********** :IDL_Type: boolean :Units: unitless **Description**: Whether the CBP has been autoparked or not. .. _CBP:Telemetry:parked:parked: parked ****** :IDL_Type: boolean :Units: unitless **Description**: Whether the CBP is parked or not. .. _CBP:Telemetry:status: status ~~~~~~ :EFDB_Topic: CBP_status .. _CBP:Telemetry:status:panic: panic ***** :IDL_Type: boolean :Units: unitless **Description**: Is the CBP panicking? .. _CBP:Telemetry:status:azimuth: azimuth ******* :IDL_Type: boolean :Units: unitless **Description**: Does the azimuth encoder have a problem? .. _CBP:Telemetry:status:elevation: elevation ********* :IDL_Type: boolean :Units: unitless **Description**: Does the elevation encoder have a problem? .. _CBP:Telemetry:status:mask: mask **** :IDL_Type: boolean :Units: unitless **Description**: Does the mask encoder have a problem? .. _CBP:Telemetry:status:mask_rotation: mask_rotation ************* :IDL_Type: boolean :Units: unitless **Description**: Does the mask rotation encoder have a problem? .. _CBP:Telemetry:status:focus: focus ***** :IDL_Type: boolean :Units: unitless **Description**: Does the focus encoder have a problem?