Skip to content

Commit

Permalink
Merge pull request #3209 from ControlSystemStudio/CSSTUDIO-2844
Browse files Browse the repository at this point in the history 
Fix alarm disable bug + add documentation
  • Loading branch information
@shroffk
shroffk authored Jan 21, 2025
2 parents ad5856f + 3714250 commit c1cc010
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 31 deletions.
Binary file added app/alarm/ui/doc/images/configuration_editor.png
View file
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
View file
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
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions app/alarm/ui/doc/index.rst
View file
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,34 @@ 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:** Any changes performed in the editor will be overwritten when the associated alarm configuration XML file is
imported again.

89 changes: 58 additions & 31 deletions app/alarm/ui/src/main/java/org/phoebus/applications/alarm/ui/tree/ItemConfigDialog.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,21 @@
package org.phoebus.applications.alarm.ui.tree;

import javafx.application.Platform;
import javafx.beans.value.ChangeListener;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.event.ActionEvent;
import javafx.event.EventHandler;
import javafx.geometry.Pos;
import javafx.scene.control.*;
import javafx.scene.control.Button;
import javafx.scene.control.ButtonType;
import javafx.scene.control.CheckBox;
import javafx.scene.control.ComboBox;
import javafx.scene.control.DateCell;
import javafx.scene.control.Dialog;
import javafx.scene.control.Label;
import javafx.scene.control.ScrollPane;
import javafx.scene.control.Spinner;
import javafx.scene.control.TextField;
import javafx.scene.control.Tooltip;
import javafx.scene.layout.ColumnConstraints;
import javafx.scene.layout.GridPane;
import javafx.scene.layout.HBox;
Expand All @@ -29,6 +39,7 @@
import org.phoebus.util.time.SecondsParser;
import org.phoebus.util.time.TimeParser;

import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.temporal.TemporalAmount;

Expand All @@ -50,13 +61,14 @@ class ItemConfigDialog extends Dialog<Boolean> {
private final TitleDetailTable guidance, displays, commands;
private final TitleDetailDelayTable actions;

private final SimpleBooleanProperty itemEnabled = new SimpleBooleanProperty();

public ItemConfigDialog(final AlarmClient model, final AlarmTreeItem<?> item) {
// Allow multiple instances
initModality(Modality.NONE);
setTitle("Configure " + item.getName());

final GridPane layout = new GridPane();
// layout.setGridLinesVisible(true); // Debug layout
layout.setHgap(5);
layout.setVgap(5);

Expand All @@ -76,8 +88,8 @@ public ItemConfigDialog(final AlarmClient model, final AlarmTreeItem<?> item) {
path.setEditable(false);
layout.add(path, 1, row++);

if (item instanceof AlarmClientLeaf) {
final AlarmClientLeaf leaf = (AlarmClientLeaf) item;
if (item instanceof AlarmClientLeaf leaf) {
itemEnabled.setValue(((AlarmClientLeaf) item).isEnabled());

layout.add(new Label("Description:"), 0, row);
description = new TextField(leaf.getDescription());
Expand All @@ -89,22 +101,35 @@ public ItemConfigDialog(final AlarmClient model, final AlarmTreeItem<?> item) {
enabled = new CheckBox("Enabled");
enabled.setTooltip(new Tooltip("Enable alarms? See also 'Enabling Filter'"));
enabled.setSelected(leaf.isEnabled());
enabled.setOnAction((event) ->
{
relative_date.getSelectionModel().clearSelection();
relative_date.setValue(null);
enabled_date_picker.getEditor().clear();
enabled_date_picker.setValue(null);
enabled.setSelected(true);

itemEnabled.addListener((obs, o, n) -> {
((AlarmClientLeaf) item).setEnabled(n);
});

enabled.setOnAction(e -> {
itemEnabled.setValue(enabled.isSelected());
if (enabled.isSelected()) {
relative_date.getSelectionModel().clearSelection();
relative_date.setValue(null);
enabled_date_picker.getEditor().clear();
enabled_date_picker.setValue(null);
}
// User has unchecked checkbox to disable alarm -> disable indefinitely.
if (!enabled.isSelected()) {
((AlarmClientLeaf) item).setEnabled(false);
}
});


latching = new CheckBox("Latch");
latching.setTooltip(new Tooltip("Latch alarm until acknowledged?"));
latching.setSelected(leaf.isLatching());
latching.disableProperty().bind(itemEnabled.not());

annunciating = new CheckBox("Annunciate");
annunciating.setTooltip(new Tooltip("Request audible alarm annunciation (using the description)?"));
annunciating.setSelected(leaf.isAnnunciating());
annunciating.disableProperty().bind(itemEnabled.not());

layout.add(new HBox(10, enabled, latching, annunciating), 1, row++);

Expand All @@ -113,11 +138,15 @@ public ItemConfigDialog(final AlarmClient model, final AlarmTreeItem<?> item) {
enabled_date_picker.setTooltip(new Tooltip("Select a date until which the alarm should be disabled"));
enabled_date_picker.setDateTimeValue(leaf.getEnabledDate());
enabled_date_picker.setPrefSize(280, 25);
enabled_date_picker.setDisable(!leaf.isEnabled());
enabled_date_picker.disableProperty().bind(itemEnabled.not());

relative_date = new ComboBox<>();
relative_date.setTooltip(new Tooltip("Select a predefined duration for disabling the alarm"));
relative_date.getItems().addAll(AlarmSystem.shelving_options);
relative_date.setPrefSize(200, 25);
relative_date.setDisable(!leaf.isEnabled());
relative_date.disableProperty().bind(itemEnabled.not());

final EventHandler<ActionEvent> relative_event_handler = (ActionEvent e) ->
{
Expand Down Expand Up @@ -164,33 +193,23 @@ public ItemConfigDialog(final AlarmClient model, final AlarmTreeItem<?> item) {
delay.setTooltip(delay_tt);
delay.setEditable(true);
delay.setPrefWidth(80);
delay.disableProperty().bind(itemEnabled.not());
layout.add(delay, 1, row++);

layout.add(new Label("Alarm Count [within delay]:"), 0, row);
count = new Spinner<>(0, Integer.MAX_VALUE, leaf.getCount());
count.setTooltip(new Tooltip("Alarms are indicated when they occur this often within the delay"));
count.setEditable(true);
count.setPrefWidth(80);
count.disableProperty().bind(itemEnabled.not());
layout.add(count, 1, row++);

layout.add(new Label("Enabling Filter:"), 0, row);
filter = new TextField(leaf.getFilter());
filter.setTooltip(new Tooltip("Optional expression for enabling the alarm"));
filter.disableProperty().bind(itemEnabled.not());
layout.add(filter, 1, row++);

// Disable most of the detail when PV not enabled
final ChangeListener<? super Boolean> enablement = (p, old, enable) ->
{
latching.setDisable(!enable);
annunciating.setDisable(!enable);
delay.setDisable(!enable);
count.setDisable(!enable);
filter.setDisable(!enable);
};
enabled.selectedProperty().addListener(enablement);
enablement.changed(null, null, leaf.isEnabled());


// Initial focus on description
Platform.runLater(() -> description.requestFocus());
}
Expand Down Expand Up @@ -245,6 +264,15 @@ public ItemConfigDialog(final AlarmClient model, final AlarmTreeItem<?> item) {
validateAndStore(model, item, event));

setResultConverter(button -> button == ButtonType.OK);

// Configure date picker to disable selection of all dates in the past.
enabled_date_picker.setDayCellFactory(picker -> new DateCell() {
public void updateItem(LocalDate date, boolean empty) {
super.updateItem(date, empty);
LocalDate today = LocalDate.now();
setDisable(empty || date.isBefore(today));
}
});
}

/**
Expand Down Expand Up @@ -272,17 +300,16 @@ private void validateAndStore(final AlarmClient model, final AlarmTreeItem<?> it
final LocalDateTime selected_enable_date = enabled_date_picker.getDateTimeValue();
final String relative_enable_date = relative_date.getValue();

if ((selected_enable_date != null) && selected_enable_date.isAfter(LocalDateTime.now()))
if ((selected_enable_date != null)) {
pv.setEnabledDate(selected_enable_date);
else
pv.setEnabled(true);

if (relative_enable_date != null) {
} else if (relative_enable_date != null) {
final TemporalAmount amount = TimeParser.parseTemporalAmount(relative_enable_date);
final LocalDateTime update_date = LocalDateTime.now().plus(amount);
pv.setEnabledDate(update_date);
} else {
pv.setEnabled(itemEnabled.get());
}
;

config = pv;
} else
config = new AlarmClientNode(null, item.getName());
Expand Down

0 comments on commit c1cc010

Please sign in to comment.