Alarm Objects¶
Alarm objects represent the state and severity of active alarms, but are otherwise intentionally quite featureless.
They are created and maintained by the Alarm_Manager
and sent to any listeners registered in Alarm_Manager.callbacks
.
Classes:
|
Representation of alarm status and parameters |
- class pvp.alarm.alarm.Alarm(alarm_type: pvp.alarm.AlarmType, severity: pvp.alarm.AlarmSeverity, start_time: Optional[float] = None, latch: bool = True, cause: Optional[list] = None, value=None, message=None)[source]¶
Representation of alarm status and parameters
Parameterized by a
Alarm_Rule
and managed byAlarm_Manager
- Parameters
alarm_type (
AlarmType
) – Type of alarmseverity (
AlarmSeverity
) – Severity of alarmstart_time (float) – Timestamp of alarm start, (as generated by
time.time()
cause (ValueName) – The
ValueName
that caused the alarm to be firedvalue (int, float) – optional - numerical value that generated the alarm
message (str) – optional - override default text generated by
AlarmManager
Attributes:
used to generate unique IDs for each alarm
Alarm Severity, property without setter to prevent change after instantiation
Alarm Type, property without setter to prevent change after instantiation
Methods:
__init__
(alarm_type, severity[, start_time, ...])- param alarm_type
Type of alarm
If active, register an end time and set as
active == False
Returns:- id_counter = count(0)¶
used to generate unique IDs for each alarm
- Type
itertools.count
- __init__(alarm_type: pvp.alarm.AlarmType, severity: pvp.alarm.AlarmSeverity, start_time: Optional[float] = None, latch: bool = True, cause: Optional[list] = None, value=None, message=None)[source]¶
- Parameters
alarm_type (
AlarmType
) – Type of alarmseverity (
AlarmSeverity
) – Severity of alarmstart_time (float) – Timestamp of alarm start, (as generated by
time.time()
cause (ValueName) – The
ValueName
that caused the alarm to be firedvalue (int, float) – optional - numerical value that generated the alarm
message (str) – optional - override default text generated by
AlarmManager
- property severity: pvp.alarm.AlarmSeverity¶
Alarm Severity, property without setter to prevent change after instantiation
- Returns
- property alarm_type: pvp.alarm.AlarmType¶
Alarm Type, property without setter to prevent change after instantiation
- Returns