Skip to content

Commit

Permalink
breaking into list
Browse files Browse the repository at this point in the history
  • Loading branch information
sneakers-the-rat committed Aug 17, 2020
1 parent 882a65c commit 0f3b67c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion _docs/alarm.alarm_rule.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Next, we define the ``MEDIUM`` severity alarm condition::
The first ``ValueCondition`` is the same as in the ``LOW`` alarm severity condition, except that it is
set 15% below ``PIP``.

A second :class:`.CycleAlarmSeverityCondition` has been added (with ``\+``) to the :class:`.ValueCondition`
A second :class:`.CycleAlarmSeverityCondition` has been added (with ``+``) to the :class:`.ValueCondition`
When conditions are added together, they will only return ``True`` (ie. trigger an alarm) if all of the conditions are met.
This condition checks that the ``LOW_PRESSURE`` alarm has been active at a ``LOW`` severity for at least two cycles.

Expand Down
12 changes: 5 additions & 7 deletions _docs/alarm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@ Alarm
Alarm System Overview
----------------------

Alarms are represented as :class:`~.alarm.Alarm` objects, which are created and managed by the
:class:`.Alarm_Manager`. A collection of :class:`.Alarm_Rule` s define the :class:`.Condition` s
for raising :class:`~.alarm.Alarm` s of different :class:`~.alarm.AlarmSeverity` . The alarm manager is
continuously fed :class:`~.message.SensorValues` objects during :meth:`.PVP_Gui.update_gui`, which it uses to
:meth:`~.Alarm_Rule.check` each alarm rule. The alarm manager emits :class:`~.alarm.Alarm` objects to the
:meth:`.PVP_Gui.handle_alarm` method. The alarm manager also updates alarm thresholds set as :attr:`.Condition.depends`
when control parameters are set (eg. updates the ``HIGH_PRESSURE`` alarm to be triggered 15% above some set ``PIP`` ).
* Alarms are represented as :class:`~.alarm.Alarm` objects, which are created and managed by the :class:`.Alarm_Manager`.
* A collection of :class:`.Alarm_Rule` s define the :class:`.Condition` s for raising :class:`~.alarm.Alarm` s of different :class:`~.alarm.AlarmSeverity` .
* The alarm manager is continuously fed :class:`~.message.SensorValues` objects during :meth:`.PVP_Gui.update_gui`, which it uses to:meth:`~.Alarm_Rule.check` each alarm rule.
* The alarm manager emits :class:`~.alarm.Alarm` objects to the :meth:`.PVP_Gui.handle_alarm` method.
* The alarm manager also updates alarm thresholds set as :attr:`.Condition.depends` to :meth:`.PVP_Gui.limits_updated` when control parameters are set (eg. updates the ``HIGH_PRESSURE`` alarm to be triggered 15% above some set ``PIP`` ).

Alarm Modules
---------------
Expand Down

0 comments on commit 0f3b67c

Please sign in to comment.