Skip to content

Commit

Permalink
Adding documentation on the alarm config editor
Browse files Browse the repository at this point in the history
  • Loading branch information
georgweiss committed Nov 25, 2024
1 parent bac3f06 commit 4921978
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 0 deletions.
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/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.
25 changes: 25 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,29 @@ Where the include component is identified in the inclusion file with a DID decla
</component>
</config>
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.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 date/time when the alarm item is put back automatically into enabled state. At the specified date/time the alarm will be enabled,
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
the alarm has been disabled in the editor by setting a date/time in the future.

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

0 comments on commit 4921978

Please sign in to comment.