Watcher

Commands

acknowledge

Description: Acknowledge one or more alarms.

Subsystem:Watcher Version:1.0.0 EFDB_Topic:Watcher_command_acknowledge

name

IDL_Type:string IDL_Size:1 Units:unitless Count:1

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

severity

IDL_Type:int Units:unitless Count:1

Description: Severity level being acknowledged. An AlarmSeverity enum.

acknowledgedBy

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: User who acknowledged the alarm.

mute

Description: Mute one or more alarms.

Subsystem:Watcher Version:1.0.0 EFDB_Topic:Watcher_command_mute

name

IDL_Type:string IDL_Size:1 Units:unitless Count:1

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

duration

IDL_Type:float Units:second Count:1

Description: Duration of mute.

severity

IDL_Type:int Units:unitless Count:1

Description: Severity level being muted. An AlarmSeverity enum.

mutedBy

IDL_Type:string IDL_Size:1 Units:unitless Count:1

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.

Subsystem:Watcher Version:1.0.0 EFDB_Topic:Watcher_command_showAlarms

ignored

IDL_Type:boolean IDL_Size:1 Units:unitless Count:1

Description: This field is ignored.

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.

Subsystem:Watcher Version:1.0.0 EFDB_Topic:Watcher_command_unacknowledge

name

IDL_Type:string IDL_Size:1 Units:unitless Count:1

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

unmute

Description: Unmute one or more alarms.

Subsystem:Watcher Version:1.0.0 EFDB_Topic:Watcher_command_unmute

name

IDL_Type:string IDL_Size:1 Units:unitless Count:1

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

Events

• AlarmSeverity_None
• AlarmSeverity_Warning
• AlarmSeverity_Serious
• AlarmSeverity_Critical

alarm

Description: Alarm about a problem.

Subsystem:Watcher Version:1.0.0 EFDB_Topic:Watcher_logevent_alarm

name

IDL_Type:string IDL_Size:1 Units:unitless Count:1

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

severity

IDL_Type:int Units:unitless Count:1

Description: The current alarm severity. An AlarmSeverity enum.

reason

IDL_Type:string IDL_Size:1 Units:unitless Count:1

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 Count:1

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 Count:1

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

Irrelevant if severity and maxSeverity are both AlarmSeverity_None.

acknowledgedBy

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: User who acknowledged the alarm.

Irrelevant if acknowledged is false.

escalated

IDL_Type:boolean Units:unitless Count:1

Description: Has this alarm been escalated to backup personnel?

escalateTo

IDL_Type:string IDL_Size:1 Units:unitless Count:1

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

mutedSeverity

IDL_Type:long Units:unitless Count:1

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 IDL_Size:1 Units:unitless Count:1

Description: User who muted the alarm.

Irrelevant if mutedSeverity is AlarmSeverity_None.

timestampSeverityOldest

IDL_Type:double Units:second Count:1

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

timestampSeverityNewest

IDL_Type:double Units:second Count:1

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

timestampMaxSeverity

IDL_Type:double Units:second Count:1

Description: Time at which maxSeverity was last changed.

timestampAcknowledged

IDL_Type:double Units:second Count:1

Description: Time at which acknowledged was last changed.

timestampAutoAcknowledge

IDL_Type:double Units:second Count:1

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 Count:1

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 Count:1

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 Count:1

Description: Time at which the alarm will be unmuted.

Irrelevant if mutedSeverity = AlarmSeverity_None.