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.
octet0
IDL_Type: | octet |
Units: | unitless |
Count: | 5 |
Description: Array of octet.
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.
char0
IDL_Type: | char |
Units: | unitless |
Description: A char, which is a synonym for string.
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.
octet0
IDL_Type: | octet |
Units: | unitless |
Description: A octet.
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.
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 |
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 |
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 |
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 |
settingsToApply
IDL_Type: | string |
IDL_Size: | 256 |
Units: | unitless |
Description: Name of the selected settings set
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.
octet0
IDL_Type: | octet |
Units: | unitless |
Count: | 5 |
Description: Array of octet.
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.
char0
IDL_Type: | char |
Units: | unitless |
Description: A char, which is a synonym for string.
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.
octet0
IDL_Type: | octet |
Units: | unitless |
Description: An octet.
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.
appliedSettingsMatchStart
EFDB_Topic: | SALGeneric_logevent_appliedSettingsMatchStart |
appliedSettingsMatchStartIsTrue
IDL_Type: | boolean |
Units: | unitless |
Description: True when the configuration matches the start conditions
authList
EFDB_Topic: | SALGeneric_logevent_authList |
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.
errorCode
Description: Output when a CSC goes into the Fault state as an explanation of the problem.
EFDB_Topic: | SALGeneric_logevent_errorCode |
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 |
heartbeat
IDL_Type: | boolean |
Units: | unitless |
Description: Beats the drum.
logLevel
Description: Current logging level.
EFDB_Topic: | SALGeneric_logevent_logLevel |
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 |
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.
settingVersions
Description: Information about settings which can be specified in the start command.
EFDB_Topic: | SALGeneric_logevent_settingVersions |
recommendedSettingsVersion
IDL_Type: | string |
Units: | unitless |
Description: List of comma seperated recomended versions of settings sets
recommendedSettingsLabels
IDL_Type: | string |
Units: | unitless |
Description: List of comma seperated names of settings sets
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 |
settingsVersion
IDL_Type: | string |
IDL_Size: | 256 |
Units: | unitless |
Description: The SHA or name corresponding to the published configuration
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 |
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 |
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 |
summaryState
IDL_Type: | long |
Units: | unitless |
Description: High level state machine state identifier