:tocdepth: 3 #### Test #### .. note:: This page is generated by the following python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- .. _Test:Commands:fault: fault ~~~~~ **Description**: Enter the Fault summary state. :EFDB_Topic: Test_command_fault .. _Test:Commands:setArrays: setArrays ~~~~~~~~~ **Description**: Set array values. :EFDB_Topic: Test_command_setArrays .. _Test:Commands:setArrays:boolean0: boolean0 ******** :IDL_Type: boolean :Units: unitless :Count: 5 **Description**: Array of boolean. .. _Test:Commands:setArrays:byte0: byte0 ***** :IDL_Type: byte :Units: unitless :Count: 5 **Description**: Array of byte. .. _Test:Commands:setArrays:short0: short0 ****** :IDL_Type: short :Units: unitless :Count: 5 **Description**: Array of short. .. _Test:Commands:setArrays:int0: int0 **** :IDL_Type: int :Units: unitless :Count: 5 **Description**: Array of int. .. _Test:Commands:setArrays:long0: long0 ***** :IDL_Type: long :Units: unitless :Count: 5 **Description**: Array of long. .. _Test:Commands:setArrays:longLong0: longLong0 ********* :IDL_Type: long long :Units: unitless :Count: 5 **Description**: Array of long long. .. _Test:Commands:setArrays:octet0: octet0 ****** :IDL_Type: octet :Units: unitless :Count: 5 **Description**: Array of octet. .. _Test:Commands:setArrays:unsignedShort0: unsignedShort0 ************** :IDL_Type: unsigned short :Units: unitless :Count: 5 **Description**: Array of unsigned short. .. _Test:Commands:setArrays:unsignedInt0: unsignedInt0 ************ :IDL_Type: unsigned int :Units: unitless :Count: 5 **Description**: Array of unsigned int. .. _Test:Commands:setArrays:unsignedLong0: unsignedLong0 ************* :IDL_Type: unsigned long :Units: unitless :Count: 5 **Description**: Array of unsigned long. .. _Test:Commands:setArrays:float0: float0 ****** :IDL_Type: float :Units: unitless :Count: 5 **Description**: Array of float. .. _Test:Commands:setArrays:double0: double0 ******* :IDL_Type: double :Units: unitless :Count: 5 **Description**: Array of double. .. _Test:Commands:setScalars: setScalars ~~~~~~~~~~ **Description**: Set scalar values. :EFDB_Topic: Test_command_setScalars .. _Test:Commands:setScalars:boolean0: boolean0 ******** :IDL_Type: boolean :Units: unitless **Description**: A boolean. .. _Test:Commands:setScalars:byte0: byte0 ***** :IDL_Type: byte :Units: unitless **Description**: A byte. .. _Test:Commands:setScalars:char0: char0 ***** :IDL_Type: char :Units: unitless **Description**: A char, which is a synonym for string. .. _Test:Commands:setScalars:short0: short0 ****** :IDL_Type: short :Units: unitless **Description**: A short. .. _Test:Commands:setScalars:int0: int0 **** :IDL_Type: int :Units: unitless **Description**: An int. .. _Test:Commands:setScalars:long0: long0 ***** :IDL_Type: long :Units: unitless **Description**: A long. .. _Test:Commands:setScalars:longLong0: longLong0 ********* :IDL_Type: long long :Units: unitless **Description**: A long long. .. _Test:Commands:setScalars:octet0: octet0 ****** :IDL_Type: octet :Units: unitless **Description**: A octet. .. _Test:Commands:setScalars:unsignedShort0: unsignedShort0 ************** :IDL_Type: unsigned short :Units: unitless **Description**: An unsigned short. .. _Test:Commands:setScalars:unsignedInt0: unsignedInt0 ************ :IDL_Type: unsigned int :Units: unitless **Description**: An unsigned int. .. _Test:Commands:setScalars:unsignedLong0: unsignedLong0 ************* :IDL_Type: unsigned long :Units: unitless **Description**: An unsigned long. .. _Test:Commands:setScalars:float0: float0 ****** :IDL_Type: float :Units: unitless **Description**: A float. .. _Test:Commands:setScalars:double0: double0 ******* :IDL_Type: double :Units: unitless **Description**: A double. .. _Test:Commands:setScalars:string0: string0 ******* :IDL_Type: string :IDL_Size: 20 :Units: unitless **Description**: A string. .. _Test:Commands:wait: wait ~~~~ **Description**: Wait for the specified period. :EFDB_Topic: Test_command_wait .. _Test:Commands:wait:ack: ack *** :IDL_Type: int :Units: unitless **Description**: Final ack code, typically a SAL__CMD constant. .. _Test:Commands:wait:duration: duration ******** :IDL_Type: double :Units: second **Description**: Desired command duration. abort ~~~~~ :EFDB_Topic: SALGeneric_command_abort .. _Test:abort:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used disable ~~~~~~~ **Description**: Transition from state Enabled to Disabled. :EFDB_Topic: SALGeneric_command_disable .. _Test:disable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enable ~~~~~~ **Description**: Transition from state Disabled to Enabled. :EFDB_Topic: SALGeneric_command_enable .. _Test:enable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enterControl ~~~~~~~~~~~~ **Description**: Transition from state Offline to Standby. Only "externally commandable" CSCs support this command; other CSCs start in Standby state and quit when they go to Offline. :EFDB_Topic: SALGeneric_command_enterControl .. _Test:enterControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used exitControl ~~~~~~~~~~~ **Description**: Transition from state Standby to Offline. For CSCs that are not "externally commandable" this makes the CSC quit. :EFDB_Topic: SALGeneric_command_exitControl .. _Test:exitControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _Test: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. .. _Test: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 .. _Test: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 .. _Test: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 .. _Test:standby:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used start ~~~~~ **Description**: Transition from state Standby to Disable, in a specified configuration. :EFDB_Topic: SALGeneric_command_start .. _Test:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Enumerations ------------ :Enum: * One * Two * Three :ValueEnum: * Zero=0 * Two=2 * Four=04 * Five=0x05 Events ------ .. _Test:Events:arrays: arrays ~~~~~~ **Description**: Array values. :EFDB_Topic: Test_logevent_arrays .. _Test:Events:arrays:boolean0: boolean0 ******** :IDL_Type: boolean :Units: unitless :Count: 5 **Description**: Array of boolean. .. _Test:Events:arrays:byte0: byte0 ***** :IDL_Type: byte :Units: unitless :Count: 5 **Description**: Array of byte. .. _Test:Events:arrays:short0: short0 ****** :IDL_Type: short :Units: unitless :Count: 5 **Description**: Array of short. .. _Test:Events:arrays:int0: int0 **** :IDL_Type: int :Units: unitless :Count: 5 :Enumeration: Int0ValueEnum_Zero=0, Int0ValueEnum_Two=2, Int0ValueEnum_Four=04, Int0ValueEnum_Five=0x05 **Description**: Array of int. .. _Test:Events:arrays:long0: long0 ***** :IDL_Type: long :Units: unitless :Count: 5 **Description**: Array of long. .. _Test:Events:arrays:longLong0: longLong0 ********* :IDL_Type: long long :Units: unitless :Count: 5 **Description**: Array of long long. .. _Test:Events:arrays:octet0: octet0 ****** :IDL_Type: octet :Units: unitless :Count: 5 **Description**: Array of octet. .. _Test:Events:arrays:unsignedShort0: unsignedShort0 ************** :IDL_Type: unsigned short :Units: unitless :Count: 5 **Description**: Array of unsigned short. .. _Test:Events:arrays:unsignedInt0: unsignedInt0 ************ :IDL_Type: unsigned int :Units: unitless :Count: 5 **Description**: Array of unsigned int. .. _Test:Events:arrays:unsignedLong0: unsignedLong0 ************* :IDL_Type: unsigned long :Units: unitless :Count: 5 **Description**: Array of unsigned long. .. _Test:Events:arrays:float0: float0 ****** :IDL_Type: float :Units: unitless :Count: 5 **Description**: Array of float. .. _Test:Events:arrays:double0: double0 ******* :IDL_Type: double :Units: unitless :Count: 5 **Description**: Array of double. .. _Test:Events:scalars: scalars ~~~~~~~ **Description**: Scalar values. :EFDB_Topic: Test_logevent_scalars .. _Test:Events:scalars:boolean0: boolean0 ******** :IDL_Type: boolean :Units: unitless **Description**: A boolean. .. _Test:Events:scalars:byte0: byte0 ***** :IDL_Type: byte :Units: unitless **Description**: A byte. .. _Test:Events:scalars:char0: char0 ***** :IDL_Type: char :Units: unitless **Description**: A char, which is a synonym for string. .. _Test:Events:scalars:short0: short0 ****** :IDL_Type: short :Units: unitless **Description**: A short. .. _Test:Events:scalars:int0: int0 **** :IDL_Type: int :Units: unitless :Enumeration: Int0Enum_One, Int0Enum_Two, Int0Enum_Three **Description**: An int. .. _Test:Events:scalars:long0: long0 ***** :IDL_Type: long :Units: unitless **Description**: A long. .. _Test:Events:scalars:longLong0: longLong0 ********* :IDL_Type: long long :Units: unitless **Description**: A long long. .. _Test:Events:scalars:octet0: octet0 ****** :IDL_Type: octet :Units: unitless **Description**: An octet. .. _Test:Events:scalars:unsignedShort0: unsignedShort0 ************** :IDL_Type: unsigned short :Units: unitless **Description**: An unsigned short. .. _Test:Events:scalars:unsignedInt0: unsignedInt0 ************ :IDL_Type: unsigned int :Units: unitless **Description**: An unsigned int. .. _Test:Events:scalars:unsignedLong0: unsignedLong0 ************* :IDL_Type: unsigned long :Units: unitless **Description**: An unsigned long. .. _Test:Events:scalars:float0: float0 ****** :IDL_Type: float :Units: unitless **Description**: A float. .. _Test:Events:scalars:double0: double0 ******* :IDL_Type: double :Units: unitless **Description**: A double. .. _Test:Events:scalars:string0: string0 ******* :IDL_Type: string :IDL_Size: 20 :Units: unitless **Description**: A string. appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _Test:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _Test:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _Test: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 .. _Test:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _Test:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _Test:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _Test:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _Test: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 .. _Test:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _Test:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _Test:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _Test:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _Test:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _Test:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _Test:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _Test: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 .. _Test:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _Test:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _Test: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 .. _Test:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _Test: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 .. _Test: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 .. _Test:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of SAL generation .. _Test:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of CSC XML .. _Test:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of OpenSplice .. _Test:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the top-level version of the CSC .. _Test: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 .. _Test:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _Test:Telemetry:arrays: arrays ~~~~~~ **Description**: Array values. :EFDB_Topic: Test_arrays .. _Test:Telemetry:arrays:boolean0: boolean0 ******** :IDL_Type: boolean :Units: unitless :Count: 5 **Description**: Array of boolean. .. _Test:Telemetry:arrays:byte0: byte0 ***** :IDL_Type: byte :Units: unitless :Count: 5 **Description**: Array of byte. .. _Test:Telemetry:arrays:short0: short0 ****** :IDL_Type: short :Units: unitless :Count: 5 **Description**: Array of short. .. _Test:Telemetry:arrays:int0: int0 **** :IDL_Type: int :Units: unitless :Count: 5 **Description**: Array of int. .. _Test:Telemetry:arrays:long0: long0 ***** :IDL_Type: long :Units: unitless :Count: 5 **Description**: Array of long. .. _Test:Telemetry:arrays:longLong0: longLong0 ********* :IDL_Type: long long :Units: unitless :Count: 5 **Description**: Array of long long. .. _Test:Telemetry:arrays:octet0: octet0 ****** :IDL_Type: octet :Units: unitless :Count: 5 **Description**: Array of octet. .. _Test:Telemetry:arrays:unsignedShort0: unsignedShort0 ************** :IDL_Type: unsigned short :Units: unitless :Count: 5 **Description**: Array of unsigned short. .. _Test:Telemetry:arrays:unsignedInt0: unsignedInt0 ************ :IDL_Type: unsigned int :Units: unitless :Count: 5 **Description**: Array of unsigned int. .. _Test:Telemetry:arrays:unsignedLong0: unsignedLong0 ************* :IDL_Type: unsigned long :Units: unitless :Count: 5 **Description**: Array of unsigned long. .. _Test:Telemetry:arrays:float0: float0 ****** :IDL_Type: float :Units: unitless :Count: 5 **Description**: Array of float. .. _Test:Telemetry:arrays:double0: double0 ******* :IDL_Type: double :Units: unitless :Count: 5 **Description**: Array of double. .. _Test:Telemetry:scalars: scalars ~~~~~~~ **Description**: Scalar values. :EFDB_Topic: Test_scalars .. _Test:Telemetry:scalars:boolean0: boolean0 ******** :IDL_Type: boolean :Units: unitless **Description**: A boolean. .. _Test:Telemetry:scalars:byte0: byte0 ***** :IDL_Type: byte :Units: unitless **Description**: A byte. .. _Test:Telemetry:scalars:char0: char0 ***** :IDL_Type: char :Units: unitless **Description**: A char, which is a synonym for string. .. _Test:Telemetry:scalars:short0: short0 ****** :IDL_Type: short :Units: unitless **Description**: A short. .. _Test:Telemetry:scalars:int0: int0 **** :IDL_Type: int :Units: unitless **Description**: An int. .. _Test:Telemetry:scalars:long0: long0 ***** :IDL_Type: long :Units: unitless **Description**: A long. .. _Test:Telemetry:scalars:longLong0: longLong0 ********* :IDL_Type: long long :Units: unitless **Description**: A long long. .. _Test:Telemetry:scalars:octet0: octet0 ****** :IDL_Type: octet :Units: unitless **Description**: A octet. .. _Test:Telemetry:scalars:unsignedShort0: unsignedShort0 ************** :IDL_Type: unsigned short :Units: unitless **Description**: An unsigned short. .. _Test:Telemetry:scalars:unsignedInt0: unsignedInt0 ************ :IDL_Type: unsigned int :Units: unitless **Description**: An unsigned int. .. _Test:Telemetry:scalars:unsignedLong0: unsignedLong0 ************* :IDL_Type: unsigned long :Units: unitless **Description**: An unsigned long. .. _Test:Telemetry:scalars:float0: float0 ****** :IDL_Type: float :Units: unitless **Description**: A float. .. _Test:Telemetry:scalars:double0: double0 ******* :IDL_Type: double :Units: unitless **Description**: A double. .. _Test:Telemetry:scalars:string0: string0 ******* :IDL_Type: string :IDL_Size: 20 :Units: unitless **Description**: A string.