bec_lib.alarm_handler.AlarmHandler

class AlarmHandler(connector: RedisConnector)

Bases: object

Methods

add_alarm	Add a new alarm message to the stack.
clear	clear all alarms from stack
get_alarm	Get the next alarm
get_unhandled_alarms	Get all unhandled alarms equal or above a minimum severity.
raise_alarms	Raise unhandled alarms with specified severity.
shutdown	shutdown the alarm handler
start	start the alarm handler and its subscriptions

add_alarm(msg: AlarmMessage)

Add a new alarm message to the stack.

Parameters:

msg (messages.AlarmMessage) – Alarm message that should be added

clear()

clear all alarms from stack

get_alarm(severity=Alarms.WARNING)

Get the next alarm

Parameters:

severity (Alarm, optional) – Minimum severity. Defaults to Alarms.WARNING.

Yields:

AlarmBase – Alarm

get_unhandled_alarms(severity=Alarms.WARNING) → list

Get all unhandled alarms equal or above a minimum severity.

Parameters:

severity (Alarms, optional) – Minimum severity. Defaults to Alarms.WARNING.

Returns:

List of unhandled alarms

Return type:

list

raise_alarms(severity=Alarms.MAJOR)

Raise unhandled alarms with specified severity.

Parameters:

severity (Alarm, optional) – Minimum severity. Defaults to Alarms.MAJOR.

Raises:

alarms – Alarm exception.

shutdown()

shutdown the alarm handler

start()

start the alarm handler and its subscriptions