Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation on the alarm config editor #3201

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added app/alarm/ui/doc/images/configuration_editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added app/alarm/ui/doc/images/context_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added app/alarm/ui/doc/images/context_menu_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added app/alarm/ui/doc/images/disable_alarm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions app/alarm/ui/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,7 @@ parent components of the alarm hierarchy.
A slightly longer text with the content of the guidance, for example a list of
telephone numbers, or description of things to try for handling the alarm.


Displays
--------

Expand Down Expand Up @@ -409,5 +410,43 @@ Where the include component is identified in the inclusion file with a DID decla
</component>
</config>

Context Menu
------------

In the Alarm Tree and the Alarm Table views user may right click on an alarm item to launch a context menu:

.. image:: images/context_menu.png
:width: 20%

The top item ("Guidance" in the screenshot) will launch a dialog showing the guidance text for the alarm item.

With the Disable Alarms menu item (Alarm Tree only) user may disable an alarm item, or all alarms in the sub-tree of a
node. The alarm(s) will stay disabled until explicitly enabled by the user. See also notes below for
more information on how disabled alarms are handled upon import of the alarm configuration XML file.

Configuration Editor
--------------------

In the Alarm Tree and the Alarm Table views user may right click on an alarm item to launch the configuration
editor dialog:

.. image:: images/context_menu_config.png
:width: 20%

In this view user may update all settings defined in the alarm configuration XML file:

.. image:: images/configuration_editor.png
:width: 50%

**NOTE 1:** Any changes performed in the editor will be overwritten when the associated alarm configuration XML file is
imported again.

**NOTE 2:** An alarm configured as enabled cannot be disabled using the checkbox in the editor dialog. Instead, user needs to
specify a disable-until date/time. At the specified date/time the alarm will be enabled automatically,
even if configured to be *disabled* by default in the alarm configuration XML file. Further, an alarm configured
to be *enabled* by default in the alarm configuration XML file will be enabled when the file is imported, even if
a disable-until date/time in the future has been set.

.. image:: images/disable_alarm.png
:width: 50%

Loading