AlarmManager

class pyhades.managers.AlarmManager()

This class implements all definitions for the Alarm Management System

append_alarm(self, alarm)

Append alarm to the Alarm Manager

Paramters

  • alarm: (Alarm Object)

Returns

  • None
update_alarm(self, id, **kwargs)

Updates alarm attributes

Parameters

  • id (int).
  • name (str)[Optional]:
  • tag (str)[Optional]:
  • description (str)[Optional]:
  • alarm_type (str)[Optional]:
  • trigger (float)[Optional]:

Returns

  • alarm (dict) Alarm Object jsonable
delete_alarm(self, id)

Removes alarm

Paramters

  • id (int): Alarm ID
load_alarms_from_db(self)

Load alarms into alarm manager from database

get_alarms(self)

Gets all alarms

Returns

  • alarms: (dict) Alarm objects
get_alarm(self, id)

Gets alarm from the Alarm Manager by id

Paramters

  • id: (int) Alarm ID

Returns

  • alarm (Alarm Object)
get_alarm_by_name(self, name)

Gets alarm from the Alarm Manager by name

Paramters

  • name: (str) Alarm name

Returns

  • alarm (Alarm Object)
get_alarms_by_tag(self, tag)

Gets all alarms associated to some tag

Parameters

  • tag: (str) tag name binded to alarm

Returns

  • alarm (dict) of alarm objects
get_alarm_by_tag(self, tag)

Gets alarm associated to some tag

Parameters

  • tag: (str) tag name binded to alarm

Returns

  • alarm (list) of alarm objects
get_tag_alarms(self)

Gets all tag alarms defined

Returns

  • tags_alarms: (list) alarm tags
tags(self)

Gets all tags variables binded into alarms

Returns

  • tags: (list)
summary(self)

Summarizes all Alarm Manager

Returns

  • summary: (dict)
attach_all(self)
execute(self, tag)

Execute update state value of alarm if the value store in cvt for tag reach alarm threshold values

Paramters

  • tag: (str) Tag in CVT