Watcher

Note

This page is generated by python script generate_cet.py.

Back to table

Commands

acknowledge

Description: Acknowledge one or more alarms.

EFDB_Topic

Watcher_command_acknowledge

name

IDL_Type

string

Units

unitless

Description: Name of alarm or alarms to acknowledge. Specify a regular expression for multiple alarms.

severity

IDL_Type

int

Units

unitless

Description: Severity level being acknowledged. An AlarmSeverity enum.

acknowledgedBy

IDL_Type

string

Units

unitless

Description: User who acknowledged the alarm.

mute

Description: Mute one or more alarms.

EFDB_Topic

Watcher_command_mute

name

IDL_Type

string

Units

unitless

Description: Name of alarm or alarms to mute. Specify a regular expression for multiple alarms.

duration

IDL_Type

float

Units

second

Description: Duration of mute.

severity

IDL_Type

int

Units

unitless

Description: Severity level being muted. An AlarmSeverity enum.

mutedBy

IDL_Type

string

Units

unitless

Description: User who muted the alarm.

showAlarms

Description: Output an alarm event for each active alarm (those with maxSeverity > None). The Watcher GUI should issue this command when it starts up.

EFDB_Topic

Watcher_command_showAlarms

unacknowledge

Description: Unacknowledge one or more alarms. A no-op for alarms that have not been acknowledged or are in the nominal state. Note: when an alarm with severity=None is acknowledged the alarm is reset to nominal state, so unacknowledge will have no effect.

EFDB_Topic

Watcher_command_unacknowledge

name

IDL_Type

string

Units

unitless

Description: Name of alarm or alarms to unacknowledge. Specify a regular expression for multiple alarms.

unmute

Description: Unmute one or more alarms.

EFDB_Topic

Watcher_command_unmute

name

IDL_Type

string

Units

unitless

Description: Name of alarm or alarms to unmute. Specify a regular expression for multiple alarms; “.*” to unmute all alarms.

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: Subsystem this applies to. If empty, the change applies to all subsystems. Beyond that, the meaning depends on the CSC.

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

settingsToApply

IDL_Type

string

IDL_Size

256

Units

unitless

Description: Name of the selected settings set

Enumerations

AlarmSeverity

• None

• Warning

• Serious

• Critical

Events

alarm

Description: Alarm about a problem.

EFDB_Topic

Watcher_logevent_alarm

name

IDL_Type

string

Units

unitless

Description: Name of alarm. Each alarm has a unique name.

severity

IDL_Type

int

Units

unitless

Description: The current alarm severity. An AlarmSeverity enum.

reason

IDL_Type

string

Units

unitless

Description: A detailed description of what is wrong.

For example if a voltage is out of range, please specify the measured voltage and the range.

maxSeverity

IDL_Type

int

Units

unitless

Description: The maximum severity seen for this alarm.

Reset to AlarmSeverity_None if alarm is aknowledged while the severity is AlarmSeverity_None. An AlarmSeverity enum.

acknowledged

IDL_Type

boolean

Units

unitless

Description: Has this alarm been acknowledged? true=yes, false=no.

Irrelevant if severity and maxSeverity are both AlarmSeverity_None.

acknowledgedBy

IDL_Type

string

Units

unitless

Description: User who acknowledged the alarm.

Irrelevant if acknowledged is false.

escalated

IDL_Type

boolean

Units

unitless

Description: Has this alarm been escalated to backup personnel?

escalateTo

IDL_Type

string

Units

unitless

Description: Backup user who was or will be notified if the alarm is escalated.

mutedSeverity

IDL_Type

long

Units

unitless

Description: Severity at which this alarm is muted.

A value of AlarmSeverity_None means not muted. If severity <= mutedSeverity then the alarm is considered muted and should not be displayed by default.

mutedBy

IDL_Type

string

Units

unitless

Description: User who muted the alarm.

Irrelevant if mutedSeverity is AlarmSeverity_None.

timestampSeverityOldest

IDL_Type

double

Units

second

Description: Time at which severity was originally set to its current value.

timestampSeverityNewest

IDL_Type

double

Units

second

Description: Time at which severity was most recently found to still have its current value.

timestampMaxSeverity

IDL_Type

double

Units

second

Description: Time at which maxSeverity was last changed.

timestampAcknowledged

IDL_Type

double

Units

second

Description: Time at which acknowledged was last changed.

timestampAutoAcknowledge

IDL_Type

double

Units

second

Description: Time at which the alarm will be automatically acknowledged if still stale (not active and not acknowledged).

0 if not relevant in this state or the alarm does not support automatic acknowledgement of stale alarms.

timestampAutoUnacknowledge

IDL_Type

double

Units

second

Description: Time at which the alarm will be automatically unacknowledged if still active. 0 if not relevant in this state or the alarm does not support automatic unacknowledgement.

timestampEscalate

IDL_Type

double

Units

second

Description: Time at which the alarm was or will be escalated to backup personnel (if escalated is true or false, respectively).

0 if not relevant in this state or the alarm does not support escalation.

timestampUnmute

IDL_Type

double

Units

second

Description: Time at which the alarm will be unmuted.

Irrelevant if mutedSeverity = AlarmSeverity_None.

appliedSettingsMatchStart

EFDB_Topic

SALGeneric_logevent_appliedSettingsMatchStart

Category

configurable

appliedSettingsMatchStartIsTrue

IDL_Type

boolean

Units

unitless

Description: True when the configuration matches the start conditions

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.

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: Subsystem this applies to. The empty string if all subsystems. Beyond that, the meaning depends on the CSC.

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.

settingVersions

Description: Information about settings which can be specified in the start command.

EFDB_Topic

SALGeneric_logevent_settingVersions

Category

configurable

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

Category

configurable

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

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