Subscribe Global StatusΒΆ
Receive alarm status updates
WebSocket
This method requires to upgrade an HTTP connection to WebSocket. See details on how Yamcs uses WebSocket.
Use the message type global-alarm-status.
Input Type
interface SubscribeGlobalStatusRequest {
// Yamcs instance name
instance: string;
// Processor name
processor: string;
}
Output Type
interface GlobalAlarmStatus {
// The number of active unacknowledged alarms
unacknowledgedCount: number;
// True if there is at least one unacknowledged alarm not OK
// (i.e. latest value of parameter still out of limits)
unacknowledgedActive: boolean;
// Highest severity among all unacknowledged alarms
unacknowledgedSeverity: AlarmSeverity;
// The number of active acknowledged alarms
acknowledgedCount: number;
// True if there is at least one acknowledged alarm not OK
// (i.e. latest value of parameter still out of limits)
acknowledgedActive: boolean;
// Highest severity among all acknowledged alarms
acknowledgedSeverity: AlarmSeverity;
// The number of shelved alarms
shelvedCount: number;
// True if there is at least one shelved alarm not OK (i.e. latest value of parameter still out of limits)
shelvedActive: boolean;
// Highest severity among all shelved alarms
shelvedSeverity: AlarmSeverity;
}
Related Types
enum AlarmSeverity {
WATCH = "WATCH",
WARNING = "WARNING",
DISTRESS = "DISTRESS",
CRITICAL = "CRITICAL",
SEVERE = "SEVERE",
}