bec-widgets 2.8.4__py3-none-any.whl → 2.9.1__py3-none-any.whl

CHANGELOG.md

@@ -1,6 +1,42 @@
 # CHANGELOG
 
 
+## v2.9.1 (2025-05-30)
+
+### Bug Fixes
+
+- Make registry update log message debug level
+  ([`12f8c82`](https://github.com/bec-project/bec_widgets/commit/12f8c82eb59ed6a7273b57126efe340bf37b65cc))
+
+
+## v2.9.0 (2025-05-30)
+
+### Bug Fixes
+
+- **DeviceSignalInput**: Improve robustness
+  ([`91195ae`](https://github.com/bec-project/bec_widgets/commit/91195ae0fdf024daf2daaa4ea2963992b4e40e04))
+
+use set for storing filter properties to allow multiple set to true or false
+
+### Code Style
+
+- Typing in bec_dispatcher
+  ([`a6c5c21`](https://github.com/bec-project/bec_widgets/commit/a6c5c21afaa6dcf33ce71027e8730354ee34e3b4))
+
+### Documentation
+
+- Add usage docs for signal label widget
+  ([`2b9919b`](https://github.com/bec-project/bec_widgets/commit/2b9919bb34a66708f4b910ffc17dc253e9b7f70d))
+
+### Features
+
+- (#569) add signal label widget
+  ([`822e7d0`](https://github.com/bec-project/bec_widgets/commit/822e7d06ff7479d006ae99942fed5e2c836831ce))
+
+add a widget which shows the current value of a signal from BEC. configurable with many properties
+  in designer. intended for use mainly in static GUIs.
+
+
 ## v2.8.4 (2025-05-30)
 
 ### Bug Fixes

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 2.8.4
+Version: 2.9.1
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

bec_widgets/cli/client.py

@@ -52,6 +52,7 @@ _Widgets = {
     "ScanControl": "ScanControl",
     "ScatterWaveform": "ScatterWaveform",
     "SignalComboBox": "SignalComboBox",
+    "SignalLabel": "SignalLabel",
     "SignalLineEdit": "SignalLineEdit",
     "StopButton": "StopButton",
     "TextBox": "TextBox",
@@ -3459,6 +3460,78 @@ class SignalComboBox(RPCBase):
         """
 
 
+class SignalLabel(RPCBase):
+    @property
+    @rpc_call
+    def custom_label(self) -> "str":
+        """
+        Use a cusom label rather than the signal name
+        """
+
+    @property
+    @rpc_call
+    def custom_units(self) -> "str":
+        """
+        Use a custom unit string
+        """
+
+    @custom_label.setter
+    @rpc_call
+    def custom_label(self) -> "str":
+        """
+        Use a cusom label rather than the signal name
+        """
+
+    @custom_units.setter
+    @rpc_call
+    def custom_units(self) -> "str":
+        """
+        Use a custom unit string
+        """
+
+    @property
+    @rpc_call
+    def decimal_places(self) -> "int":
+        """
+        Format to a given number of decimal_places. Set to 0 to disable.
+        """
+
+    @decimal_places.setter
+    @rpc_call
+    def decimal_places(self) -> "int":
+        """
+        Format to a given number of decimal_places. Set to 0 to disable.
+        """
+
+    @property
+    @rpc_call
+    def show_default_units(self) -> "bool":
+        """
+        Show default units obtained from the signal alongside it
+        """
+
+    @show_default_units.setter
+    @rpc_call
+    def show_default_units(self) -> "bool":
+        """
+        Show default units obtained from the signal alongside it
+        """
+
+    @property
+    @rpc_call
+    def show_select_button(self) -> "bool":
+        """
+        Show the button to select the signal to display
+        """
+
+    @show_select_button.setter
+    @rpc_call
+    def show_select_button(self) -> "bool":
+        """
+        Show the button to select the signal to display
+        """
+
+
 class SignalLineEdit(RPCBase):
     """Line edit widget for device input with autocomplete for device names."""
 

bec_widgets/utils/bec_dispatcher.py

@@ -163,7 +163,7 @@ class BECDispatcher:
     def connect_slot(
         self,
         slot: Callable,
-        topics: Union[EndpointInfo, str, list[Union[EndpointInfo, str]]],
+        topics: EndpointInfo | str | list[EndpointInfo] | list[str],
         cb_info: dict | None = None,
         **kwargs,
     ) -> None:
@@ -172,7 +172,7 @@ class BECDispatcher:
         Args:
             slot (Callable): A slot method/function that accepts two inputs: content and metadata of
                 the corresponding pub/sub message
-            topics (EndpointInfo | str | list): A topic or list of topics that can typically be acquired via bec_lib.MessageEndpoints
+            topics EndpointInfo | str | list[EndpointInfo] | list[str]: A topic or list of topics that can typically be acquired via bec_lib.MessageEndpoints
             cb_info (dict | None): A dictionary containing information about the callback. Defaults to None.
         """
         qt_slot = QtThreadSafeCallback(cb=slot, cb_info=cb_info)
@@ -183,13 +183,15 @@ class BECDispatcher:
         topics_str, _ = self.client.connector._convert_endpointinfo(topics)
         qt_slot.topics.update(set(topics_str))
 
-    def disconnect_slot(self, slot: Callable, topics: Union[str, list]):
+    def disconnect_slot(
+        self, slot: Callable, topics: EndpointInfo | str | list[EndpointInfo] | list[str]
+    ):
         """
         Disconnect a slot from a topic.
 
         Args:
             slot(Callable): The slot to disconnect
-            topics(Union[str, list]): The topic(s) to disconnect from
+            topics EndpointInfo | str | list[EndpointInfo] | list[str]: A topic or list of topics to unsub from.
         """
         # find the right slot to disconnect from ;
         # slot callbacks are wrapped in QtThreadSafeCallback objects,

bec_widgets/utils/rpc_server.py

@@ -195,7 +195,7 @@ class RPCServer:
             return
         self._broadcasted_data = data
 
-        logger.info(f"Broadcasting registry update: {data} for {self.gui_id}")
+        logger.debug(f"Broadcasting registry update: {data} for {self.gui_id}")
         self.client.connector.xadd(
             MessageEndpoints.gui_registry_state(self.gui_id),
             msg_dict={"data": messages.GUIRegistryStateMessage(state=data)},

bec_widgets/widgets/control/device_input/base_classes/device_signal_input_base.py

@@ -1,10 +1,11 @@
 from bec_lib.callback_handler import EventType
 from bec_lib.device import Signal
 from bec_lib.logger import bec_logger
-from qtpy.QtCore import Property, Slot
+from qtpy.QtCore import Property
 
 from bec_widgets.utils import ConnectionConfig
 from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.utils.error_popups import SafeSlot
 from bec_widgets.utils.filter_io import FilterIO
 from bec_widgets.utils.ophyd_kind_util import Kind
 from bec_widgets.utils.widget_io import WidgetIO
@@ -49,7 +50,7 @@ class DeviceSignalInputBase(BECWidget):
 
         self._device = None
         self.get_bec_shortcuts()
-        self._signal_filter = []
+        self._signal_filter = set()
         self._signals = []
         self._hinted_signals = []
         self._normal_signals = []
@@ -60,7 +61,7 @@ class DeviceSignalInputBase(BECWidget):
 
     ### Qt Slots ###
 
-    @Slot(str)
+    @SafeSlot(str)
     def set_signal(self, signal: str):
         """
         Set the signal.
@@ -76,7 +77,7 @@ class DeviceSignalInputBase(BECWidget):
                 f"Signal {signal} not found for device {self.device} and filtered selection {self.signal_filter}."
             )
 
-    @Slot(str)
+    @SafeSlot(str)
     def set_device(self, device: str | None):
         """
         Set the device. If device is not valid, device will be set to None which happens
@@ -90,8 +91,8 @@ class DeviceSignalInputBase(BECWidget):
             self._device = device
         self.update_signals_from_filters()
 
-    @Slot(dict, dict)
-    @Slot()
+    @SafeSlot(dict, dict)
+    @SafeSlot()
     def update_signals_from_filters(
         self, content: dict | None = None, metadata: dict | None = None
     ):
@@ -158,9 +159,9 @@ class DeviceSignalInputBase(BECWidget):
     @include_hinted_signals.setter
     def include_hinted_signals(self, value: bool):
         if value:
-            self._signal_filter.append(Kind.hinted)
+            self._signal_filter.add(Kind.hinted)
         else:
-            self._signal_filter.remove(Kind.hinted)
+            self._signal_filter.discard(Kind.hinted)
         self.update_signals_from_filters()
 
     @Property(bool)
@@ -171,9 +172,9 @@ class DeviceSignalInputBase(BECWidget):
     @include_normal_signals.setter
     def include_normal_signals(self, value: bool):
         if value:
-            self._signal_filter.append(Kind.normal)
+            self._signal_filter.add(Kind.normal)
         else:
-            self._signal_filter.remove(Kind.normal)
+            self._signal_filter.discard(Kind.normal)
         self.update_signals_from_filters()
 
     @Property(bool)
@@ -184,9 +185,9 @@ class DeviceSignalInputBase(BECWidget):
     @include_config_signals.setter
     def include_config_signals(self, value: bool):
         if value:
-            self._signal_filter.append(Kind.config)
+            self._signal_filter.add(Kind.config)
         else:
-            self._signal_filter.remove(Kind.config)
+            self._signal_filter.discard(Kind.config)
         self.update_signals_from_filters()
 
     ### Properties and Methods ###

bec_widgets/widgets/control/device_input/signal_combobox/signal_combobox.py

@@ -1,11 +1,13 @@
 from bec_lib.device import Positioner
-from qtpy.QtCore import QSize, Signal, Slot
+from qtpy.QtCore import QSize, Signal
 from qtpy.QtWidgets import QComboBox, QSizePolicy
 
+from bec_widgets.utils.error_popups import SafeSlot
 from bec_widgets.utils.filter_io import ComboBoxFilterHandler, FilterIO
 from bec_widgets.utils.ophyd_kind_util import Kind
 from bec_widgets.widgets.control.device_input.base_classes.device_signal_input_base import (
     DeviceSignalInputBase,
+    DeviceSignalInputBaseConfig,
 )
 
 
@@ -35,7 +37,7 @@ class SignalComboBox(DeviceSignalInputBase, QComboBox):
         self,
         parent=None,
         client=None,
-        config: DeviceSignalInputBase = None,
+        config: DeviceSignalInputBaseConfig | None = None,
         gui_id: str | None = None,
         device: str | None = None,
         signal_filter: str | list[str] | None = None,
@@ -65,9 +67,13 @@ class SignalComboBox(DeviceSignalInputBase, QComboBox):
         if default is not None:
             self.set_signal(default)
 
-    def update_signals_from_filters(self):
+    @SafeSlot()
+    @SafeSlot(dict, dict)
+    def update_signals_from_filters(
+        self, content: dict | None = None, metadata: dict | None = None
+    ):
         """Update the filters for the combobox"""
-        super().update_signals_from_filters()
+        super().update_signals_from_filters(content, metadata)
         # pylint: disable=protected-access
         if FilterIO._find_handler(self) is ComboBoxFilterHandler:
             if len(self._config_signals) > 0:
@@ -84,7 +90,7 @@ class SignalComboBox(DeviceSignalInputBase, QComboBox):
                 self.insertItem(0, "Hinted Signals")
                 self.model().item(0).setEnabled(False)
 
-    @Slot(str)
+    @SafeSlot(str)
     def on_text_changed(self, text: str):
         """Slot for text changed. If a device is selected and the signal is changed and valid it emits a signal.
         For a positioner, the readback value has to be renamed to the device name.

bec_widgets/widgets/utility/signal_label/register_signal_label.py

@@ -0,0 +1,15 @@
+def main():  # pragma: no cover
+    from qtpy import PYSIDE6
+
+    if not PYSIDE6:
+        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
+        return
+    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
+
+    from bec_widgets.widgets.utility.signal_label.signal_label_plugin import SignalLabelPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(SignalLabelPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/widgets/utility/signal_label/signal_label.py

@@ -0,0 +1,456 @@
+from __future__ import annotations
+
+import sys
+import traceback
+from typing import TYPE_CHECKING
+
+from bec_lib.device import Device, Signal
+from bec_lib.endpoints import MessageEndpoints
+from bec_qthemes import material_icon
+from qtpy.QtCore import Signal as QSignal
+from qtpy.QtWidgets import (
+    QApplication,
+    QComboBox,
+    QDialog,
+    QDialogButtonBox,
+    QGroupBox,
+    QHBoxLayout,
+    QLabel,
+    QLineEdit,
+    QToolButton,
+    QVBoxLayout,
+    QWidget,
+)
+
+from bec_widgets.utils.bec_connector import ConnectionConfig
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.utils.colors import get_accent_colors
+from bec_widgets.utils.error_popups import SafeProperty, SafeSlot
+from bec_widgets.utils.ophyd_kind_util import Kind
+from bec_widgets.widgets.control.device_input.base_classes.device_input_base import (
+    DeviceInputConfig,
+)
+from bec_widgets.widgets.control.device_input.base_classes.device_signal_input_base import (
+    DeviceSignalInputBaseConfig,
+)
+from bec_widgets.widgets.control.device_input.device_line_edit.device_line_edit import (
+    DeviceLineEdit,
+)
+from bec_widgets.widgets.control.device_input.signal_combobox.signal_combobox import SignalComboBox
+
+if TYPE_CHECKING:
+    from bec_lib.client import BECClient
+
+
+class ChoiceDialog(QDialog):
+    accepted_output = QSignal(str, str)
+
+    CONNECTION_ERROR_STR = "Error: client is not connected!"
+
+    def __init__(
+        self,
+        parent: QWidget | None = None,
+        config: ConnectionConfig | None = None,
+        client: BECClient | None = None,
+        show_hinted: bool = True,
+        show_normal: bool = False,
+        show_config: bool = False,
+    ):
+        if not client or not client.started:
+            self._display_error()
+            return
+        super().__init__(parent=parent)
+        self.setWindowTitle("Choose device and signal...")
+        self._accent_colors = get_accent_colors()
+
+        layout = QHBoxLayout()
+
+        config_dict = config.model_dump() if config is not None else {}
+        self._device_config = DeviceInputConfig.model_validate(config_dict)
+        self._signal_config = DeviceSignalInputBaseConfig.model_validate(config_dict)
+        self._device_field = DeviceLineEdit(
+            config=self._device_config, parent=parent, client=client
+        )
+        self._signal_field = SignalComboBox(
+            config=self._signal_config,
+            device=self._signal_config.device,
+            parent=parent,
+            client=client,
+        )
+        layout.addWidget(self._device_field)
+        layout.addWidget(self._signal_field)
+
+        self.button_box = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel)
+        self.button_box.accepted.connect(self.accept)
+        self.button_box.rejected.connect(self.reject)
+        layout.addWidget(self.button_box)
+
+        self._signal_field.include_hinted_signals = show_hinted
+        self._signal_field.include_normal_signals = show_normal
+        self._signal_field.include_config_signals = show_config
+
+        self.setLayout(layout)
+        self._device_field.textChanged.connect(self._update_device)
+        self._device_field.setText(config.device if config is not None else "")
+
+    def _display_error(self):
+        try:
+            super().__init__()
+        except Exception:
+            ...
+        layout = QHBoxLayout()
+        layout.addWidget(QLabel(self.CONNECTION_ERROR_STR))
+        self.button_box = QDialogButtonBox(QDialogButtonBox.Cancel)
+        self.button_box.accepted.connect(self.reject)
+        layout.addWidget(self.button_box)
+        self.setLayout(layout)
+
+    @SafeSlot(str)
+    def _update_device(self, device: str):
+        if device in self._device_field.dev:
+            self._device_field.set_device(device)
+            self._signal_field.set_device(device)
+            self._device_field.setStyleSheet(
+                f"QLineEdit {{ border-style: solid; border-width: 2px; border-color: {self._accent_colors.success.name() if self._accent_colors else 'green'}}}"
+            )
+            self.button_box.button(QDialogButtonBox.Ok).setEnabled(True)
+        else:
+            self._device_field.setStyleSheet(
+                f"QLineEdit {{ border-style: solid; border-width: 2px; border-color: {self._accent_colors.emergency.name() if self._accent_colors else 'red'}}}"
+            )
+            self.button_box.button(QDialogButtonBox.Ok).setEnabled(False)
+            self._signal_field.clear()
+
+    def accept(self):
+        self.accepted_output.emit(self._device_field.text(), self._signal_field.currentText())
+        return super().accept()
+
+
+class SignalLabel(BECWidget, QWidget):
+
+    ICON_NAME = "scoreboard"
+    RPC = True
+    PLUGIN = True
+
+    USER_ACCESS = [
+        "custom_label",
+        "custom_units",
+        "custom_label.setter",
+        "custom_units.setter",
+        "decimal_places",
+        "decimal_places.setter",
+        "show_default_units",
+        "show_default_units.setter",
+        "show_select_button",
+        "show_select_button.setter",
+    ]
+
+    def __init__(
+        self,
+        parent: QWidget | None = None,
+        client: BECClient | None = None,
+        device: str | None = None,
+        signal: str | None = None,
+        show_select_button: bool = True,
+        show_default_units: bool = False,
+        custom_label: str = "",
+        custom_units: str = "",
+        **kwargs,
+    ):
+        """Initialize the SignalLabel widget.
+
+        Args:
+            parent (QWidget, optional): The parent widget. Defaults to None.
+            client (BECClient, optional): The BEC client. Defaults to None.
+            device (str, optional): The device name. Defaults to None.
+            signal (str, optional): The signal name. Defaults to None.
+            selection_dialog_config (DeviceSignalInputBaseConfig | dict, optional): Configuration for the signal selection dialog.
+            show_select_button (bool, optional): Whether to show the select button. Defaults to True.
+            show_default_units (bool, optional): Whether to show default units. Defaults to False.
+            custom_label (str, optional): Custom label for the widget. Defaults to "".
+            custom_units (str, optional): Custom units for the widget. Defaults to "".
+        """
+        self._config = DeviceSignalInputBaseConfig(default=signal, device=device)
+        super().__init__(parent=parent, client=client, **kwargs)
+
+        self._device = device
+        self._signal = signal
+
+        self._custom_label: str = custom_label
+        self._custom_units: str = custom_units
+        self._show_default_units: bool = show_default_units
+        self._decimal_places = 3
+
+        self._show_hinted_signals: bool = True
+        self._show_normal_signals: bool = False
+        self._show_config_signals: bool = False
+
+        self._outer_layout = QHBoxLayout()
+        self._layout = QHBoxLayout()
+        self._outer_layout.setContentsMargins(0, 0, 0, 0)
+        self._layout.setContentsMargins(0, 0, 0, 0)
+        self.setLayout(self._outer_layout)
+
+        self._label = QGroupBox(custom_label)
+        self._outer_layout.addWidget(self._label)
+        self._update_label()
+        self._label.setLayout(self._layout)
+
+        self._value: str = ""
+        self._display = QLabel()
+        self._layout.addWidget(self._display)
+
+        self._select_button = QToolButton()
+        self._select_button.setIcon(material_icon(icon_name="settings", size=(20, 20)))
+        self._show_select_button: bool = show_select_button
+        self._layout.addWidget(self._select_button)
+        self._display.setMinimumHeight(self._select_button.sizeHint().height())
+        self.show_select_button = self._show_select_button
+
+        self._select_button.clicked.connect(self.show_choice_dialog)
+        self.get_bec_shortcuts()
+
+        self._connected: bool = False
+        self.connect_device()
+
+    def _create_dialog(self):
+        return ChoiceDialog(
+            config=self._config,
+            parent=self,
+            client=self.client,
+            show_config=self.show_config_signals,
+            show_normal=self.show_normal_signals,
+            show_hinted=self.show_hinted_signals,
+        )
+
+    @SafeSlot()
+    def _process_dialog(self, device: str, signal: str):
+        self.disconnect_device()
+        self.device = device
+        self.signal = signal
+        self._update_label()
+        self.connect_device()
+
+    def show_choice_dialog(self):
+        dialog = self._create_dialog()
+        dialog.accepted_output.connect(self._process_dialog)
+        dialog.open()
+        return dialog
+
+    def connect_device(self):
+        """Subscribe to the Redis topic for the device to display"""
+        if not self._connected and self._device and self._device in self.dev:
+            self._connected = True
+            self._readback_endpoint = MessageEndpoints.device_readback(self._device)
+            self.bec_dispatcher.connect_slot(self.on_device_readback, self._readback_endpoint)
+            self._manual_read()
+            self.set_display_value(self._value)
+
+    def disconnect_device(self):
+        """Unsubscribe from the Redis topic for the device to display"""
+        if self._connected:
+            self._connected = False
+            self.bec_dispatcher.disconnect_slot(self.on_device_readback, self._readback_endpoint)
+
+    def _manual_read(self):
+        if self._device is None or not isinstance(
+            (device := self.dev.get(self._device)), Device | Signal
+        ):
+            self._units = ""
+            self._value = "__"
+            return
+        signal: Signal = (
+            getattr(device, self.signal, None) if isinstance(device, Device) else device
+        )
+        if not isinstance(signal, Signal):  # Avoid getting other attributes of device, e.g. methods
+            signal = None
+        if signal is None:
+            self._units = ""
+            self._value = "__"
+            return
+        self._value = signal.get()
+        self._units = signal.get_device_config().get("egu", "")
+
+    @SafeSlot(dict, dict)
+    def on_device_readback(self, msg: dict, metadata: dict) -> None:
+        """
+        Update the display with the new value.
+        """
+        try:
+            signal_to_read = self._patch_hinted_signal()
+            self._value = msg["signals"][signal_to_read]["value"]
+            self.set_display_value(self._value)
+        except Exception as e:
+            self._display.setText("ERROR!")
+            self._display.setToolTip(
+                f"Error processing incoming reading: {msg}, handled with exception: {''.join(traceback.format_exception(e))}"
+            )
+
+    def _patch_hinted_signal(self):
+        if self.dev[self._device]._info["signals"] == {}:
+            return self._signal
+        signal_info = self.dev[self._device]._info["signals"][self._signal]
+        return (
+            signal_info["obj_name"] if signal_info["kind_str"] == Kind.hinted.name else self._signal
+        )
+
+    @SafeProperty(str)
+    def device(self) -> str:
+        """The device from which to select a signal"""
+        return self._device or "Not set!"
+
+    @device.setter
+    def device(self, value: str) -> None:
+        self.disconnect_device()
+        self._device = value
+        self._config.device = value
+        self.connect_device()
+        self._update_label()
+
+    @SafeProperty(str)
+    def signal(self) -> str:
+        """The signal to display"""
+        return self._signal or "Not set!"
+
+    @signal.setter
+    def signal(self, value: str) -> None:
+        self.disconnect_device()
+        self._signal = value
+        self._config.default = value
+        self.connect_device()
+        self._update_label()
+
+    @SafeProperty(bool)
+    def show_select_button(self) -> bool:
+        """Show the button to select the signal to display"""
+        return self._show_select_button
+
+    @show_select_button.setter
+    def show_select_button(self, value: bool) -> None:
+        self._show_select_button = value
+        self._select_button.setVisible(value)
+
+    @SafeProperty(bool)
+    def show_default_units(self) -> bool:
+        """Show default units obtained from the signal alongside it"""
+        return self._show_default_units
+
+    @show_default_units.setter
+    def show_default_units(self, value: bool) -> None:
+        self._show_default_units = value
+        self.set_display_value(self._value)
+
+    @SafeProperty(str)
+    def custom_label(self) -> str:
+        """Use a cusom label rather than the signal name"""
+        return self._custom_label
+
+    @custom_label.setter
+    def custom_label(self, value: str) -> None:
+        self._custom_label = value
+        self._update_label()
+
+    @SafeProperty(str)
+    def custom_units(self) -> str:
+        """Use a custom unit string"""
+        return self._custom_units
+
+    @custom_units.setter
+    def custom_units(self, value: str) -> None:
+        self._custom_units = value
+        self.set_display_value(self._value)
+
+    @SafeProperty(int)
+    def decimal_places(self) -> int:
+        """Format to a given number of decimal_places. Set to 0 to disable."""
+        return self._decimal_places
+
+    @decimal_places.setter
+    def decimal_places(self, value: int) -> None:
+        self._decimal_places = value
+        self._update_label()
+
+    @SafeProperty(bool)
+    def show_hinted_signals(self) -> bool:
+        """In the signal selection menu, show hinted signals"""
+        return self._show_hinted_signals
+
+    @show_hinted_signals.setter
+    def show_hinted_signals(self, value: bool) -> None:
+        self._show_hinted_signals = value
+
+    @SafeProperty(bool)
+    def show_config_signals(self) -> bool:
+        """In the signal selection menu, show config signals"""
+        return self._show_config_signals
+
+    @show_config_signals.setter
+    def show_config_signals(self, value: bool) -> None:
+        self._show_config_signals = value
+
+    @SafeProperty(bool)
+    def show_normal_signals(self) -> bool:
+        """In the signal selection menu, show normal signals"""
+        return self._show_normal_signals
+
+    @show_normal_signals.setter
+    def show_normal_signals(self, value: bool) -> None:
+        self._show_normal_signals = value
+
+    def _format_value(self, value: str):
+        if self._decimal_places == 0:
+            return value
+        try:
+            return f"{float(value):0.{self._decimal_places}f}"
+        except ValueError:
+            return value
+
+    @SafeSlot(str)
+    def set_display_value(self, value: str):
+        """Set the display to a given value, appending the units if specified"""
+        self._display.setText(f"{self._format_value(value)}{self._units_string}")
+        self._display.setToolTip("")
+
+    @property
+    def _units_string(self):
+        if self.custom_units or self._show_default_units:
+            return f" {self.custom_units or self._default_units or ''}"
+        return ""
+
+    @property
+    def _default_units(self) -> str:
+        return self._units
+
+    @property
+    def _default_label(self) -> str:
+        return (
+            str(self._signal) if self._device == self._signal else f"{self._device} {self._signal}"
+        )
+
+    def _update_label(self):
+        self._label.setTitle(
+            self._custom_label if self._custom_label else f"{self._default_label}:"
+        )
+
+
+if __name__ == "__main__":
+
+    app = QApplication(sys.argv)
+    w = QWidget()
+    w.setLayout(QVBoxLayout())
+    w.layout().addWidget(
+        SignalLabel(
+            device="samx",
+            signal="readback",
+            custom_label="custom label:",
+            custom_units=" m/s/s",
+            show_select_button=False,
+        )
+    )
+    w.layout().addWidget(SignalLabel(device="samy", signal="readback", show_default_units=True))
+    l = SignalLabel()
+    l.device = "bpm4i"
+    l.signal = "bpm4i"
+    w.layout().addWidget(l)
+    w.show()
+    sys.exit(app.exec_())

bec_widgets/widgets/utility/signal_label/signal_label.pyproject

@@ -0,0 +1 @@
+{'files': ['signal_label.py']}

bec_widgets/widgets/utility/signal_label/signal_label_plugin.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.utility.signal_label.signal_label import SignalLabel
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='SignalLabel' name='signal_label'>
+    </widget>
+</ui>
+"""
+
+
+class SignalLabelPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = SignalLabel(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Utils"
+
+    def icon(self):
+        return designer_material_icon(SignalLabel.ICON_NAME)
+
+    def includeFile(self):
+        return "signal_label"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "SignalLabel"
+
+    def toolTip(self):
+        return "Display the live value of any signal"
+
+    def whatsThis(self):
+        return self.toolTip()

{bec_widgets-2.8.4.dist-info → bec_widgets-2.9.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 2.8.4
+Version: 2.9.1
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

{bec_widgets-2.8.4.dist-info → bec_widgets-2.9.1.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=1nMYldzVk0tFkBWYTcUjumOrdSADASheWOAc0kOFDYs,9509
 .pylintrc,sha256=eeY8YwSI74oFfq6IYIbCqnx3Vk8ZncKaatv96n_Y8Rs,18544
 .readthedocs.yaml,sha256=ivqg3HTaOxNbEW3bzWh9MXAkrekuGoNdj0Mj3SdRYuw,639
-CHANGELOG.md,sha256=zrzPgv4SdkfI87Bynz1AKCww3iy1vOyt7iaEzOy2M4Q,289871
+CHANGELOG.md,sha256=M__eaV2qFZ_rzZPL5yHSuCg6ymh4veC-MLWH7I20Qyc,290970
 LICENSE,sha256=Daeiu871NcAp8uYi4eB_qHgvypG-HX0ioRQyQxFwjeg,1531
-PKG-INFO,sha256=i_3fowZja6vwAtG6rabvccdxkcoUynup_6DHrxGLYuw,1273
+PKG-INFO,sha256=JmSUIffA_-E4bhT7es7Y81PRNsG76VEYuRCqWw_DbcY,1273
 README.md,sha256=oY5Jc1uXehRASuwUJ0umin2vfkFh7tHF-LLruHTaQx0,3560
-pyproject.toml,sha256=s2v1q74HdC09fmE082F9bwYEDALJFrH_W0PPKu7Ykgo,2902
+pyproject.toml,sha256=xInUTzdYljzVQdPaETaRqGblNXIaAZuFvCK3yhJsLog,2902
 .git_hooks/pre-commit,sha256=n3RofIZHJl8zfJJIUomcMyYGFi_rwq4CC19z0snz3FI,286
 .github/pull_request_template.md,sha256=F_cJXzooWMFgMGtLK-7KeGcQt0B4AYFse5oN0zQ9p6g,801
 .github/ISSUE_TEMPLATE/bug_report.yml,sha256=WdRnt7HGxvsIBLzhkaOWNfg8IJQYa_oV9_F08Ym6znQ,1081
@@ -35,7 +35,7 @@ bec_widgets/assets/app_icons/bec_widgets_icon.png,sha256=K8dgGwIjalDh9PRHUsSQBqg
 bec_widgets/assets/app_icons/ui_loader_tile.png,sha256=qSK3XHqvnAVGV9Q0ulORcGFbXJ9LDq2uz8l9uTtMsNk,1812476
 bec_widgets/assets/app_icons/widget_launch_tile.png,sha256=bWsICHFfSe9-ESUj3AwlE95dDOea-f6M-s9fBapsxB4,2252911
 bec_widgets/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_widgets/cli/client.py,sha256=qtAdEDsNub66VLi0uInX4RUQnSaFW86a-I_0bj4um_A,95077
+bec_widgets/cli/client.py,sha256=Pl93U3IyN5OisaEDCrS2ytY5CppRfuyIiCppXNMf8yg,96703
 bec_widgets/cli/client_utils.py,sha256=F2hyt--jL53bN8NoWifNUMqwwx5FbpS6I1apERdTRzM,18114
 bec_widgets/cli/generate_cli.py,sha256=K_wMxo2XBUn92SnY3dSrlyUn8ax6Y20QBGCuP284DsQ,10986
 bec_widgets/cli/server.py,sha256=h7QyBOOGjyrP_fxJIIOSEMc4E06cLG0JyaofjNV6oCA,5671
@@ -62,7 +62,7 @@ bec_widgets/tests/utils.py,sha256=DSzi6Z70fospjfyx0Uz5bWIDwaAzKbzcHfWPW0YyxzQ,71
 bec_widgets/utils/__init__.py,sha256=1930ji1Jj6dVuY81Wd2kYBhHYNV-2R0bN_L4o9zBj1U,533
 bec_widgets/utils/bec_connector.py,sha256=ATOSyZqryn1QHPc7aotiDnUtzFhlj_gmcukMT_pqjHQ,19272
 bec_widgets/utils/bec_designer.py,sha256=ehNl_i743rijmhPiIGNd1bihE7-l4oJzTVoa4yjPjls,5426
-bec_widgets/utils/bec_dispatcher.py,sha256=y9EFIgU3JqIs7R10XnLh0I1_Skts9sbPe3ijOVJumYs,9837
+bec_widgets/utils/bec_dispatcher.py,sha256=qYyd0SjCCUDwihxUFYzlKVxvZwSqQpDDPxF7_xt-sz0,9948
 bec_widgets/utils/bec_plugin_helper.py,sha256=tLXEyzh0LWuRp-1XhJg32m-hUSLfRStC0YRUWKdhY5Q,3565
 bec_widgets/utils/bec_signal_proxy.py,sha256=Yc08fdBEDABrowwNPSngT9-28R8FD4ml7oTL6BoMyEE,3263
 bec_widgets/utils/bec_table.py,sha256=nA2b8ukSeUfquFMAxGrUVOqdrzMoDYD6O_4EYbOG2zk,717
@@ -89,7 +89,7 @@ bec_widgets/utils/redis_message_waiter.py,sha256=fvL_QgC0cTDv_FPJdRyp5AKjf401EJU
 bec_widgets/utils/reference_utils.py,sha256=8pq06TOvZBZdim0G6hvPJXzVDib7ve4o-Ptvfp563nk,2859
 bec_widgets/utils/round_frame.py,sha256=SLtoPi8sfJvjfK7G_a4_sRBMGivF5fTHNwMLq93-cVM,4920
 bec_widgets/utils/rpc_decorator.py,sha256=pIvtqySQLnuS7l2Ti_UAe4WX7CRivZnsE5ZdKAihxh0,479
-bec_widgets/utils/rpc_server.py,sha256=iOIEy8s5DAL_aG6RC9G5DScBfyolpfDVeR2a_3h46JM,10310
+bec_widgets/utils/rpc_server.py,sha256=6FqSsjndXwLoL5d-zIHHLMg_U3GyK0aSk5gc1833UGw,10311
 bec_widgets/utils/serialization.py,sha256=_SO8q0ylC0MWckT9yTbCtF0QNsRoT6ysL8WnN8-GQ-U,1174
 bec_widgets/utils/settings_dialog.py,sha256=1z6noC9k6BSIGAw12DvHHiW3LmvPquaGMjWSe5wdmek,4307
 bec_widgets/utils/side_panel.py,sha256=enxcQOwJOMfD3MxgPA9mQSKSX_F6Omy2zePncYDW1FA,14193
@@ -177,7 +177,7 @@ bec_widgets/widgets/control/device_control/positioner_group/register_positioner_
 bec_widgets/widgets/control/device_input/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/control/device_input/base_classes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/control/device_input/base_classes/device_input_base.py,sha256=r4DwWQz2wwNQ3Uswzdy12MGycV7pFrE_Zv4h_2G5IRA,15915
-bec_widgets/widgets/control/device_input/base_classes/device_signal_input_base.py,sha256=oylgVQ2XyN7CWrI_Aj4xtKT5tac41JRpGvccaY0SUHw,9271
+bec_widgets/widgets/control/device_input/base_classes/device_signal_input_base.py,sha256=wLEzPfEqaCPL3EpvMgFL5aZqSwuGj1OEkiyKaOQ7M1I,9330
 bec_widgets/widgets/control/device_input/device_combobox/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/control/device_input/device_combobox/device_combo_box.pyproject,sha256=wI2eXR5ky_IM9-BCHJnH_9CEqYcZwIuLcgitSEr8OJU,40
 bec_widgets/widgets/control/device_input/device_combobox/device_combo_box_plugin.py,sha256=E8LD9T4O2w621q25uHqBqZLDiQ6zpMR25ZDuf51jrPw,1434
@@ -192,7 +192,7 @@ bec_widgets/widgets/control/device_input/signal_combobox/__init__.py,sha256=47DE
 bec_widgets/widgets/control/device_input/signal_combobox/register_signal_combo_box.py,sha256=VEdFRUfLph7JE2arcnzHw8etsE-4wZkwyzlNLMJBsZk,526
 bec_widgets/widgets/control/device_input/signal_combobox/signal_combo_box.pyproject,sha256=xod6iyRD-WD0Uk6LWXjSxFJCQy-831pvTkKcw2FAdnM,33
 bec_widgets/widgets/control/device_input/signal_combobox/signal_combo_box_plugin.py,sha256=sstqm2KtyR5wwOIYJRbzOqHMq5_9ExKP-YS5qV5ACrA,1373
-bec_widgets/widgets/control/device_input/signal_combobox/signal_combobox.py,sha256=NCT0ql6KCe-YspoYKSv2py7JeqKBGJFU97q6UoG-Oxg,4641
+bec_widgets/widgets/control/device_input/signal_combobox/signal_combobox.py,sha256=vM4PsYDl8RBHb9g083fRpeUZZkW1u1m7uXfaVMGUpyY,4869
 bec_widgets/widgets/control/device_input/signal_line_edit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/control/device_input/signal_line_edit/register_signal_line_edit.py,sha256=aQLTy_3gbji0vq5VvvAddHFimpwGGaMYJy5iGgX23aM,527
 bec_widgets/widgets/control/device_input/signal_line_edit/signal_line_edit.py,sha256=-y_Oy8A7pQVQbzjvHznGxTX-wCisP-4l5py7WOm1_EY,6008
@@ -363,6 +363,10 @@ bec_widgets/widgets/utility/logpanel/log_panel.pyproject,sha256=2ncs1bsu-wICstR1
 bec_widgets/widgets/utility/logpanel/log_panel_plugin.py,sha256=KY7eS1uGZzLYtDAdBv6S2mw8UjcDGVt3UklN_D5M06A,1250
 bec_widgets/widgets/utility/logpanel/logpanel.py,sha256=tnjczAwtfe1biL-u9h9tntoQerWo3iLVD9RTSLOvd5o,20651
 bec_widgets/widgets/utility/logpanel/register_log_panel.py,sha256=LFUE5JzCYvIwJQtTqZASLVAHYy3gO1nrHzPVH_kpCEY,470
+bec_widgets/widgets/utility/signal_label/register_signal_label.py,sha256=wDB4Q3dSbZ51hsxnuB74oXdMRoLgDRd-XfhaomYY2OA,483
+bec_widgets/widgets/utility/signal_label/signal_label.py,sha256=bht1zpHKxrslfFCknnLe3Q9FeF8Do0j6onWAiLXZan0,15875
+bec_widgets/widgets/utility/signal_label/signal_label.pyproject,sha256=DXgt__AGnPCqXo5A92aTPH0SxbWlvgyNzKraWUuumWg,30
+bec_widgets/widgets/utility/signal_label/signal_label_plugin.py,sha256=ZXR8oYl4NkPcXJ8pgDcdXcg3teB0MHtoNZoiGDmgCoU,1298
 bec_widgets/widgets/utility/spinbox/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/utility/spinbox/bec_spin_box.pyproject,sha256=RIg1SZuCltuZZuK1O4Djg0TpCInhoCw8KeqNaf1_K0A,33
 bec_widgets/widgets/utility/spinbox/bec_spin_box_plugin.py,sha256=-XNrUAz1LZQPhJrH1sszfGrpBfpHUIfNO4bw7MPcc3k,1255
@@ -404,8 +408,8 @@ bec_widgets/widgets/utility/visual/dark_mode_button/dark_mode_button.py,sha256=O
 bec_widgets/widgets/utility/visual/dark_mode_button/dark_mode_button.pyproject,sha256=Lbi9zb6HNlIq14k6hlzR-oz6PIFShBuF7QxE6d87d64,34
 bec_widgets/widgets/utility/visual/dark_mode_button/dark_mode_button_plugin.py,sha256=CzChz2SSETYsR8-36meqWnsXCT-FIy_J_xeU5coWDY8,1350
 bec_widgets/widgets/utility/visual/dark_mode_button/register_dark_mode_button.py,sha256=rMpZ1CaoucwobgPj1FuKTnt07W82bV1GaSYdoqcdMb8,521
-bec_widgets-2.8.4.dist-info/METADATA,sha256=i_3fowZja6vwAtG6rabvccdxkcoUynup_6DHrxGLYuw,1273
-bec_widgets-2.8.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-bec_widgets-2.8.4.dist-info/entry_points.txt,sha256=dItMzmwA1wizJ1Itx15qnfJ0ZzKVYFLVJ1voxT7K7D4,214
-bec_widgets-2.8.4.dist-info/licenses/LICENSE,sha256=Daeiu871NcAp8uYi4eB_qHgvypG-HX0ioRQyQxFwjeg,1531
-bec_widgets-2.8.4.dist-info/RECORD,,
+bec_widgets-2.9.1.dist-info/METADATA,sha256=JmSUIffA_-E4bhT7es7Y81PRNsG76VEYuRCqWw_DbcY,1273
+bec_widgets-2.9.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+bec_widgets-2.9.1.dist-info/entry_points.txt,sha256=dItMzmwA1wizJ1Itx15qnfJ0ZzKVYFLVJ1voxT7K7D4,214
+bec_widgets-2.9.1.dist-info/licenses/LICENSE,sha256=Daeiu871NcAp8uYi4eB_qHgvypG-HX0ioRQyQxFwjeg,1531
+bec_widgets-2.9.1.dist-info/RECORD,,

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "2.8.4"
+version = "2.9.1"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [