- General Information
- Server Administration
- Mission Database
- Data Management
- Data Links
- Processors
- Commanding
- Services
- Security
- Web Interface
- Programs
Extending Yamcs
Appendices
Yamcs HTTP API
Yamcs Release Notes
Source Code Documentation
Alarms SheetΒΆ
This sheet defines how the monitoring results of a parameter should be derived. E.g. if a parameter exceeds some pre-defined value, this parameter's state changes to CRITICAL.
parameter referenceThe reference name of the parameter for which this alarm definition applies
contextA condition under which the defined triggers apply. This can be used to define multiple different sets of triggers for one and the same parameter, that apply depending on some other condition (typically a state of some kind). When left blank, the defined set of conditions are assumed to be part of the default context.
Contextual alarms are evaluated from top to bottom, until a match is found. If no context conditions apply, the default context applies.
reportWhen alarms under the given context should be reported. Should be one of
OnSeverityChangeorOnValueChange. WithOnSeverityChangebeing the default. The conditionOnValueChangewill check value changes based on the engineering values. It can also be applied to a parameter without any defined severity levels, in which case an event will be generated with every change in value.min violationsNumber of successive instances that meet any of the alarm conditions under the given context before the alarm event triggers (defaults to 1). This field affects when an event is generated (i.e. only after X violations). It does not affect the monitoring result associated with each parameter. That would still be out of limits, even after a first violation.
watch: trigger typeOne of
low(or aliaslowInclusive),high(or aliashighInclusive),lowExclusive,highExlusiveorstate. For each context of a numeric parameter, you can have both a low and a high trigger that lead to theWATCHstate. For each context of an enumerated parameter, you can have multiple state triggers that lead to theWATCHstate.watch: trigger valueIf the trigger type is
low,lowInclusive,highorhighInclusive: a numeric value indicating the low resp. high limit value. The value is considered inclusive with respect to its nominal range. For example, a low limit of 20, will have aWATCHalarm if and only if its value is smaller than 20.If the trigger type is
lowExclusiveorhighExclusive: a numeric value indicating the low resp. heigh limit value. The value is considered exclusive with respect to its nominal range. For example, a lowExclusive limit of 20, will have aWATCHalarm if and only if its value is smaller than or equal to 20.If the trigger value is
state: a state that would bring the given parameter in itsWATCHstate.warning trigger type,warning trigger valueAnalogous to
watchtriggerdistress trigger type,distress trigger valueAnalogous to
watchtriggercritical trigger type,critical trigger valueAnalogous to
watchtriggersevere trigger type,severe trigger valueAnalogous to
watchtrigger