yr.AlarmInfo

Contents

yr.AlarmInfo#

class yr.AlarmInfo(alarm_name: str = '', alarm_severity: ~yr.base_runtime.AlarmSeverity = AlarmSeverity.OFF, location_info: str = '', cause: str = '', starts_at: int = -1, ends_at: int = -1, timeout: int = -1, custom_options: ~typing.Dict[str, str] = <factory>)[source]#

Bases: object

Alarm info.

Attributes

alarm_name

The name of the alarm.

alarm_severity

The severity of the alarm, of type AlarmSeverity, defaults to AlarmSeverity.OFF.

cause

The description of the cause of the alarm.The default value is an empty string.

ends_at

The timestamp when the alarm ends, with a default value of -1.

location_info

The location information of the alarm.

starts_at

The timestamp when the alarm starts, with a default value of -1.

timeout

The timeout duration of the alarm, with a default value of -1.

custom_options

Custom options, stored as a key-value pair dictionary, with a default value of an empty dictionary.

Methods