:tocdepth: 3 ####### Watcher ####### .. note:: This page is generated by the following python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- .. _Watcher:Commands:acknowledge: acknowledge ~~~~~~~~~~~ **Description**: Acknowledge one or more alarms. :EFDB_Topic: Watcher_command_acknowledge .. _Watcher:Commands:acknowledge:name: name **** :IDL_Type: string :Units: unitless **Description**: Name of alarm or alarms to acknowledge. Specify a regular expression for multiple alarms. .. _Watcher:Commands:acknowledge:severity: severity ******** :IDL_Type: int :Units: unitless **Description**: Severity level being acknowledged. An AlarmSeverity enum. .. _Watcher:Commands:acknowledge:acknowledgedBy: acknowledgedBy ************** :IDL_Type: string :Units: unitless **Description**: User who acknowledged the alarm. .. _Watcher:Commands:mute: mute ~~~~ **Description**: Mute one or more alarms. :EFDB_Topic: Watcher_command_mute .. _Watcher:Commands:mute:name: name **** :IDL_Type: string :Units: unitless **Description**: Name of alarm or alarms to mute. Specify a regular expression for multiple alarms. .. _Watcher:Commands:mute:duration: duration ******** :IDL_Type: float :Units: second **Description**: Duration of mute. .. _Watcher:Commands:mute:severity: severity ******** :IDL_Type: int :Units: unitless **Description**: Severity level being muted. An AlarmSeverity enum. .. _Watcher:Commands:mute:mutedBy: mutedBy ******* :IDL_Type: string :Units: unitless **Description**: User who muted the alarm. .. _Watcher:Commands:showAlarms: 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 .. _Watcher:Commands:unacknowledge: 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 .. _Watcher:Commands:unacknowledge:name: name **** :IDL_Type: string :Units: unitless **Description**: Name of alarm or alarms to unacknowledge. Specify a regular expression for multiple alarms. .. _Watcher:Commands:unmute: unmute ~~~~~~ **Description**: Unmute one or more alarms. :EFDB_Topic: Watcher_command_unmute .. _Watcher:Commands:unmute:name: 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. abort ~~~~~ :EFDB_Topic: SALGeneric_command_abort .. _Watcher:abort:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used disable ~~~~~~~ **Description**: Transition from state Enabled to Disabled. :EFDB_Topic: SALGeneric_command_disable .. _Watcher:disable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enable ~~~~~~ **Description**: Transition from state Disabled to Enabled. :EFDB_Topic: SALGeneric_command_enable .. _Watcher: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 .. _Watcher: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 .. _Watcher:exitControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _Watcher: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. .. _Watcher: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 .. _Watcher: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 .. _Watcher: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 .. _Watcher: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 .. _Watcher:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Enumerations ------------ :AlarmSeverity: * None * Warning * Serious * Critical Events ------ .. _Watcher:Events:alarm: alarm ~~~~~ **Description**: Alarm about a problem. :EFDB_Topic: Watcher_logevent_alarm .. _Watcher:Events:alarm:name: name **** :IDL_Type: string :Units: unitless **Description**: Name of alarm. Each alarm has a unique name. .. _Watcher:Events:alarm:severity: severity ******** :IDL_Type: int :Units: unitless **Description**: The current alarm severity. An AlarmSeverity enum. .. _Watcher:Events:alarm:reason: 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. .. _Watcher:Events:alarm:maxSeverity: 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. .. _Watcher:Events:alarm:acknowledged: 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`. .. _Watcher:Events:alarm:acknowledgedBy: acknowledgedBy ************** :IDL_Type: string :Units: unitless **Description**: User who acknowledged the alarm. Irrelevant if `acknowledged` is false. .. _Watcher:Events:alarm:escalated: escalated ********* :IDL_Type: boolean :Units: unitless **Description**: Has this alarm been escalated to backup personnel? .. _Watcher:Events:alarm:escalateTo: escalateTo ********** :IDL_Type: string :Units: unitless **Description**: Backup user who was or will be notified if the alarm is escalated. .. _Watcher:Events:alarm:mutedSeverity: 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. .. _Watcher:Events:alarm:mutedBy: mutedBy ******* :IDL_Type: string :Units: unitless **Description**: User who muted the alarm. Irrelevant if `mutedSeverity` is `AlarmSeverity_None`. .. _Watcher:Events:alarm:timestampSeverityOldest: timestampSeverityOldest *********************** :IDL_Type: double :Units: second **Description**: Time at which severity was originally set to its current value. .. _Watcher:Events:alarm:timestampSeverityNewest: timestampSeverityNewest *********************** :IDL_Type: double :Units: second **Description**: Time at which severity was most recently found to still have its current value. .. _Watcher:Events:alarm:timestampMaxSeverity: timestampMaxSeverity ******************** :IDL_Type: double :Units: second **Description**: Time at which maxSeverity was last changed. .. _Watcher:Events:alarm:timestampAcknowledged: timestampAcknowledged ********************* :IDL_Type: double :Units: second **Description**: Time at which acknowledged was last changed. .. _Watcher:Events:alarm:timestampAutoAcknowledge: 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. .. _Watcher:Events:alarm:timestampAutoUnacknowledge: 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. .. _Watcher:Events:alarm:timestampEscalate: 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. .. _Watcher:Events:alarm:timestampUnmute: 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 .. _Watcher:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _Watcher:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _Watcher: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 .. _Watcher:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _Watcher:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _Watcher:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _Watcher:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _Watcher: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 .. _Watcher:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _Watcher:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _Watcher:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _Watcher:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _Watcher:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _Watcher:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _Watcher:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _Watcher: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 .. _Watcher:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _Watcher:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _Watcher: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 .. _Watcher:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _Watcher: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 .. _Watcher: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 .. _Watcher:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of SAL generation .. _Watcher:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of CSC XML .. _Watcher:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of OpenSplice .. _Watcher:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the top-level version of the CSC .. _Watcher: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 .. _Watcher:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier