Test¶

Note

This page is generated by python script generate_cet.py.

Back to table

Commands¶

fault¶

Description: Enter the Fault summary state.

EFDB_Topic: Test_command_fault

setArrays¶

Description: Set array values.

EFDB_Topic: Test_command_setArrays

boolean0¶

IDL_Type: boolean
Units: unitless
Count: 5

Description: Array of boolean.

byte0¶

IDL_Type: byte
Units: unitless
Count: 5

Description: Array of byte.

short0¶

IDL_Type: short
Units: unitless
Count: 5

Description: Array of short.

int0¶

IDL_Type: int
Units: unitless
Count: 5

Description: Array of int.

long0¶

IDL_Type: long
Units: unitless
Count: 5

Description: Array of long.

longLong0¶

IDL_Type: long long
Units: unitless
Count: 5

Description: Array of long long.

unsignedShort0¶

IDL_Type: unsigned short
Units: unitless
Count: 5

Description: Array of unsigned short.

unsignedInt0¶

IDL_Type: unsigned int
Units: unitless
Count: 5

Description: Array of unsigned int.

unsignedLong0¶

IDL_Type: unsigned long
Units: unitless
Count: 5

Description: Array of unsigned long.

float0¶

IDL_Type: float
Units: unitless
Count: 5

Description: Array of float.

double0¶

IDL_Type: double
Units: unitless
Count: 5

Description: Array of double.

setScalars¶

Description: Set scalar values.

EFDB_Topic: Test_command_setScalars

boolean0¶

IDL_Type: boolean
Units: unitless

Description: A boolean.

byte0¶

IDL_Type: byte
Units: unitless

Description: A byte.

short0¶

IDL_Type: short
Units: unitless

Description: A short.

int0¶

IDL_Type: int
Units: unitless

Description: An int.

long0¶

IDL_Type: long
Units: unitless

Description: A long.

longLong0¶

IDL_Type: long long
Units: unitless

Description: A long long.

unsignedShort0¶

IDL_Type: unsigned short
Units: unitless

Description: An unsigned short.

unsignedInt0¶

IDL_Type: unsigned int
Units: unitless

Description: An unsigned int.

unsignedLong0¶

IDL_Type: unsigned long
Units: unitless

Description: An unsigned long.

float0¶

IDL_Type: float
Units: unitless

Description: A float.

double0¶

IDL_Type: double
Units: unitless

Description: A double.

string0¶

IDL_Type: string
IDL_Size: 20
Units: unitless

Description: A string.

wait¶

Description: Wait for the specified period.

EFDB_Topic: Test_command_wait

ack¶

IDL_Type: int
Units: unitless

Description: Final ack code, typically a SAL__CMD constant.

duration¶

IDL_Type: double
Units: second

Description: Desired command duration.

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. 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
Category: csc

setAuthList¶

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 the 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 the CSC itself.

standby¶

Description: Transition from state Offline, 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”.

Enumerations¶

Enum

One
Two
Three

ValueEnum

Zero=0
Two=2
Four=04
Five=0x05

Events¶

arrays¶

Description: Array values.

EFDB_Topic: Test_logevent_arrays

boolean0¶

IDL_Type: boolean
Units: unitless
Count: 5

Description: Array of boolean.

byte0¶

IDL_Type: byte
Units: unitless
Count: 5

Description: Array of byte.

short0¶

IDL_Type: short
Units: unitless
Count: 5

Description: Array of short.

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.

long0¶

IDL_Type: long
Units: unitless
Count: 5

Description: Array of long.

longLong0¶

IDL_Type: long long
Units: unitless
Count: 5

Description: Array of long long.

unsignedShort0¶

IDL_Type: unsigned short
Units: unitless
Count: 5

Description: Array of unsigned short.

unsignedInt0¶

IDL_Type: unsigned int
Units: unitless
Count: 5

Description: Array of unsigned int.

unsignedLong0¶

IDL_Type: unsigned long
Units: unitless
Count: 5

Description: Array of unsigned long.

float0¶

IDL_Type: float
Units: unitless
Count: 5

Description: Array of float.

double0¶

IDL_Type: double
Units: unitless
Count: 5

Description: Array of double.

scalars¶

Description: Scalar values.

EFDB_Topic: Test_logevent_scalars

boolean0¶

IDL_Type: boolean
Units: unitless

Description: A boolean.

byte0¶

IDL_Type: byte
Units: unitless

Description: A byte.

short0¶

IDL_Type: short
Units: unitless

Description: A short.

int0¶

IDL_Type: int
Units: unitless
Enumeration: Int0Enum_One, Int0Enum_Two, Int0Enum_Three

Description: An int.

long0¶

IDL_Type: long
Units: unitless

Description: A long.

longLong0¶

IDL_Type: long long
Units: unitless

Description: A long long.

unsignedShort0¶

IDL_Type: unsigned short
Units: unitless

Description: An unsigned short.

unsignedInt0¶

IDL_Type: unsigned int
Units: unitless

Description: An unsigned int.

unsignedLong0¶

IDL_Type: unsigned long
Units: unitless

Description: An unsigned long.

float0¶

IDL_Type: float
Units: unitless

Description: A float.

double0¶

IDL_Type: double
Units: unitless

Description: A double.

string0¶

IDL_Type: string
IDL_Size: 20
Units: unitless

Description: A string.

authList¶

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 CSC’s configuration.

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 the 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 the CSC, and any other pertinent information. Ignore whitespace after commas.

configurationsAvailable¶

Description: Information about the source of configuration information for the 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 the 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 a 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¶

EFDB_Topic: SALGeneric_logevent_heartbeat
Category: mandatory

heartbeat¶

IDL_Type: boolean
Units: unitless

Description: Beats the drum.

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 the 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 the 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: This is the top-level version of the 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 a CSC

summaryState¶

Description: Current summary state of the CSC

EFDB_Topic: SALGeneric_logevent_summaryState
Category: csc

summaryState¶

IDL_Type: long
Units: unitless

Description: High level state machine state identifier

Telemetry¶

arrays¶

Description: Array values.

EFDB_Topic: Test_arrays

boolean0¶

IDL_Type: boolean
Units: unitless
Count: 5

Description: Array of boolean.

byte0¶

IDL_Type: byte
Units: unitless
Count: 5

Description: Array of byte.

short0¶

IDL_Type: short
Units: unitless
Count: 5

Description: Array of short.

int0¶

IDL_Type: int
Units: unitless
Count: 5

Description: Array of int.

long0¶

IDL_Type: long
Units: unitless
Count: 5

Description: Array of long.

longLong0¶

IDL_Type: long long
Units: unitless
Count: 5

Description: Array of long long.

unsignedShort0¶

IDL_Type: unsigned short
Units: unitless
Count: 5

Description: Array of unsigned short.

unsignedInt0¶

IDL_Type: unsigned int
Units: unitless
Count: 5

Description: Array of unsigned int.

unsignedLong0¶

IDL_Type: unsigned long
Units: unitless
Count: 5

Description: Array of unsigned long.

float0¶

IDL_Type: float
Units: unitless
Count: 5

Description: Array of float.

double0¶

IDL_Type: double
Units: unitless
Count: 5

Description: Array of double.

scalars¶

Description: Scalar values.

EFDB_Topic: Test_scalars

boolean0¶

IDL_Type: boolean
Units: unitless

Description: A boolean.

byte0¶

IDL_Type: byte
Units: unitless

Description: A byte.

short0¶

IDL_Type: short
Units: unitless

Description: A short.

int0¶

IDL_Type: int
Units: unitless

Description: An int.

long0¶

IDL_Type: long
Units: unitless

Description: A long.

longLong0¶

IDL_Type: long long
Units: unitless

Description: A long long.

unsignedShort0¶

IDL_Type: unsigned short
Units: unitless

Description: An unsigned short.

unsignedInt0¶

IDL_Type: unsigned int
Units: unitless

Description: An unsigned int.

unsignedLong0¶

IDL_Type: unsigned long
Units: unitless

Description: An unsigned long.

float0¶

IDL_Type: float
Units: unitless

Description: A float.

double0¶

IDL_Type: double
Units: unitless

Description: A double.

string0¶

IDL_Type: string
IDL_Size: 20
Units: unitless

Description: A string.

Navigation

Test¶

Commands¶

fault¶

setArrays¶

boolean0¶

byte0¶

short0¶

int0¶

long0¶

longLong0¶

unsignedShort0¶

unsignedInt0¶

unsignedLong0¶

float0¶

double0¶

setScalars¶

boolean0¶

byte0¶

short0¶

int0¶

long0¶

longLong0¶

unsignedShort0¶

unsignedInt0¶

unsignedLong0¶

float0¶

double0¶

string0¶

wait¶

ack¶

duration¶

disable¶

enable¶

exitControl¶

setAuthList¶

authorizedUsers¶

nonAuthorizedCSCs¶

setLogLevel¶

level¶

subsystem¶

standby¶

start¶

configurationOverride¶

Enumerations¶

Events¶

arrays¶

boolean0¶

byte0¶

short0¶

int0¶

long0¶

longLong0¶

unsignedShort0¶

unsignedInt0¶

unsignedLong0¶

float0¶

double0¶

scalars¶

boolean0¶

byte0¶

short0¶

int0¶

long0¶

longLong0¶

unsignedShort0¶

unsignedInt0¶

unsignedLong0¶

float0¶

double0¶

string0¶

authList¶

authorizedUsers¶

nonAuthorizedCSCs¶

configurationApplied¶

configurations¶

version¶

url¶

schemaVersion¶

otherInfo¶