MTOutClosedLoopControl

class lsst.ts.watcher.rules.MTOutClosedLoopControl(config, log=None)

Bases: BaseRule

Monitor the main telescope M2 is out of the closed-loop control.

Parameters:

• config (types.SimpleNamespace) – Rule configuration, as validated by the schema.

• log (logging.Logger or None, optional) – Parent logger. (the default is None)

Methods Summary

compute_alarm_severity(data, **kwargs)	Compute and set alarm severity and reason.
get_schema()	Return a jsonschema as a dict, to validate configuration.

Methods Documentation

compute_alarm_severity(data, **kwargs)

Compute and set alarm severity and reason.

Parameters:

• data (salobj.BaseMsgType) – Message from the topic described by topic_callback.

• **kwargs (dict [str, typing.Any]) –

  Keyword arguments. If triggered by TopicCallback calling update_alarm_severity, the arguments will be as follows:

  • topic_callback : TopicCallback Topic callback wrapper.

Return type:

tuple[AlarmSeverity, str] | None

Returns:

• None, if no change or unknown, or a tuple of two values

• severity (lsst.ts.xml.enums.Watcher.AlarmSeverity) – The new alarm severity.

• reason (str) – Detailed reason for the severity, e.g. a string describing what value is out of range, and what the range is. If severity is NONE then this value is ignored (but still required) and the old reason is retained until the alarm is reset to nominal state.

Notes

You may return NoneNoReason if the alarm state is NONE.

classmethod get_schema()

Return a jsonschema as a dict, to validate configuration.

Return type:

None

Notes

Please provide default values for all fields for which defaults make sense. This makes watcher configuration files easier to write.

If your rule has no configuration then return None.

We recommend that you write the schema as yaml, for compactness, then use yaml.safe_load to convert it to a dict. For example:

schema_yaml = """
    $schema: http://json-schema.org/draft-07/schema#
    description: Configuration for MyRule
    type: object
    properties:
    ...
    required: [...]
    additionalProperties: false
"""
return yaml.safe_load(schema_yaml)