Add support for custom channel name in DataQ

doizuc · doizuc · commit b427e397b136 · 2024-10-18T17:19:25.000-04:00
- Add support for custom channel name in DataQ
- Fix timeseries on instruments without selectable channel widget
- Rename Flow Control widget to Switch
- Fix ADU setup not disabling Relay when first or third are on two-wire setting
- Fix Ontrak FlowControl and PumpControl widgets ids
- Bump version to 2.9.14.gamma
diff --git a/inlinino/__init__.py b/inlinino/__init__.py
@@ -8,7 +8,7 @@
 import numpy as np
 
 
-__version__ = '2.9.14.beta'
+__version__ = '2.9.14.gamma'
 
 # Setup Logger
 logging.basicConfig(level=logging.DEBUG)
diff --git a/inlinino/__main__.py b/inlinino/__main__.py
@@ -12,7 +12,7 @@
     # Get instrument selected
     if len(sys.argv) == 2:
         try:
-            inlinino.start(int(sys.argv[1]))
+            inlinino.start(sys.argv[1])
         except ValueError as e:
             # raise e
             logging.critical('Invalid arguments.')
diff --git a/inlinino/gui.py b/inlinino/gui.py
@@ -417,48 +417,57 @@ def on_packet_corrupted(self):
             self.packets_corrupted_flag = True
         self.last_packet_corrupted_timestamp = ts
 
+
+    def reset_ts(self, data, reset):
+        n = len(data)
+        if reset or len(self._buffer_data) != len(data) or self.reset_ts_trace:
+            self.reset_ts_trace = False
+            # Init legend
+            if hasattr(self.instrument, 'widget_active_timeseries_variables_selected'):
+                legend = self.instrument.widget_active_timeseries_variables_selected[
+                         :]  # Shallow copy to prevent update
+            else:
+                legend = [f"{name} ({units})" for name, units in
+                          zip(self.instrument.variable_names, self.instrument.variable_units)]
+            # Check data is correct length
+            if len(legend) != n:
+                # Possible in rare instance widget_active_timeseries_variables_selected is updated by user after the data is received and updated
+                logger.warning('Variables selected do not match data received. Skip timeseries update.')
+                self.reset_ts_trace = True
+                return
+            # Init buffers
+            self._buffer_timestamp = RingBuffer(self.BUFFER_LENGTH)
+            self._buffer_data = [RingBuffer(self.BUFFER_LENGTH) for i in range(len(data))]
+            # Re-initialize Plot (need to do so when number of curve changes)
+            self.timeseries_plot_widget.clear()
+            # Init curves
+            for i in range(n):
+                self.timeseries_plot_widget.plotItem.addItem(
+                    pg.PlotCurveItem(pen=pg.mkPen(color=self.PEN_COLORS[i % len(self.PEN_COLORS)], width=2),
+                                     name=legend[i])
+                )
+
     @QtCore.pyqtSlot(list, float)
     @QtCore.pyqtSlot(np.ndarray, float)
     @QtCore.pyqtSlot(list, float, bool)
     @QtCore.pyqtSlot(np.ndarray, float, bool)
     def on_new_ts_data(self, data, timestamp, reset=False):
-        if self.instrument.active_timeseries_variables_lock.acquire(timeout=0.25):
-            try:
-                n = len(data)
+        if self.instrument.widget_select_channel_enabled:
+            # Select channel widget enabled, hence user can change channels while receiving data
+            if self.instrument.active_timeseries_variables_lock.acquire(timeout=0.25):
+                try:
+                    self.reset_ts(data, reset)
+                finally:
+                    self.instrument.active_timeseries_variables_lock.release()
+            else:
                 if reset or len(self._buffer_data) != len(data) or self.reset_ts_trace:
-                    self.reset_ts_trace = False
-                    # Init legend
-                    if hasattr(self.instrument, 'widget_active_timeseries_variables_selected'):
-                        legend = self.instrument.widget_active_timeseries_variables_selected[
-                                 :]  # Shallow copy to prevent update
-                    else:
-                        legend = [f"{name} ({units})" for name, units in
-                                  zip(self.instrument.variable_names, self.instrument.variable_units)]
-                    # Check data is correct length
-                    if len(legend) != n:
-                        # Possible in rare instance widget_active_timeseries_variables_selected is updated by user after the data is received and updated
-                        logger.warning('Variables selected do not match data received. Skip timeseries update.')
-                        self.reset_ts_trace = True
-                        return
-                    # Init buffers
-                    self._buffer_timestamp = RingBuffer(self.BUFFER_LENGTH)
-                    self._buffer_data = [RingBuffer(self.BUFFER_LENGTH) for i in range(len(data))]
-                    # Re-initialize Plot (need to do so when number of curve changes)
-                    self.timeseries_plot_widget.clear()
-                    # Init curves
-                    for i in range(n):
-                        self.timeseries_plot_widget.plotItem.addItem(
-                            pg.PlotCurveItem(pen=pg.mkPen(color=self.PEN_COLORS[i % len(self.PEN_COLORS)], width=2),
-                                             name=legend[i])
-                        )
-            finally:
-                self.instrument.active_timeseries_variables_lock.release()
+                    logger.warning('Unable to acquire lock to update timeseries variables.')
+                    self.reset_ts_trace = True
+                    return
         else:
-            if reset or len(self._buffer_data) != len(data) or self.reset_ts_trace:
-                logger.warning('Unable to acquire lock to update timeseries variables.')
-                self.reset_ts_trace = True
-                return
-            n = len(data)
+            # No select channel widget, hence user can't change channels while receiving data
+            self.reset_ts(data, reset)
+        n = len(data)
         # Update buffers
         self._buffer_timestamp.extend(timestamp)
         for i in range(n):
@@ -973,9 +982,11 @@ def act_save(self):
                 self.notification('No data will be logged.')
         elif self.cfg['module'] == 'dataq':
             self.cfg['channels_enabled'] = []
+            self.cfg['channels_names'] = [None] * 8
             for c in range(8):
                 if getattr(self, 'checkbox_channel%d_enabled' % (c+1)).isChecked():
                     self.cfg['channels_enabled'].append(c)
+                self.cfg['channels_names'][c] = getattr(self, 'optional_le_channel%d_name' % (c+1)).text()
             if not self.cfg['channels_enabled']:
                 self.notification('At least one channel must be enabled.', 'Nothing to log if no channels are enabled.')
                 return
@@ -1146,6 +1157,10 @@ def __init__(self, uuid, parent=None):
         if self.cfg['module'] == 'dataq':
             for c in self.cfg['channels_enabled']:
                 getattr(self, 'checkbox_channel%d_enabled' % (c + 1)).setChecked(True)
+            if 'channels_names' in self.cfg:
+                for c, name in enumerate(self.cfg['channels_names']):
+                    if name is not None:
+                        getattr(self, 'optional_le_channel%d_name' % (c + 1)).setText(name)
             # Handle legacy configuration
             for k in [k for k in self.cfg.keys() if k.startswith('variable_')]:
                 if len(self.cfg[k]) == 1 and self.cfg[k][0] == '':
@@ -1157,15 +1172,15 @@ def __init__(self, uuid, parent=None):
                                                     .index(self.cfg['model']))
             except ValueError:
                 logger.warning('Configured model not available in GUI. Interface set to GUI default.')
-            self.act_activate_fields_for_adu_model()
             for r in range(4):
                 try:
                     cb_relay_mode = getattr(self, f'combobox_relay{r}_mode')
                     cb_relay_mode.setCurrentIndex([cb_relay_mode.itemText(i) for i in range(cb_relay_mode.count())]
                                                   .index(self.cfg[f'relay{r}_mode']))
                 except ValueError:
                     logger.warning(f'Configured relay{r}_mode not available in GUI. Interface set to GUI default.')
-                getattr(self, f'checkbox_relay{r}_enabled').setChecked(self.cfg[f'relay{r}_enabled'])
+                getattr(self, f'checkbox_relay{r}_enabled').setChecked(
+                    self.cfg[f'relay{r}_enabled'] if f'relay{r}_enabled' in self.cfg.keys() else False)
             for c, g in zip(self.cfg['event_counter_channels_enabled'], self.cfg['event_counter_k_factors']):
                 getattr(self, 'checkbox_event_counter_channel%d_enabled' % (c)).setChecked(True)
                 getattr(self, 'spinbox_event_counter_channel%d_k_factor' % (c)).setValue(g)
@@ -1174,6 +1189,7 @@ def __init__(self, uuid, parent=None):
             for c, g in zip(self.cfg['analog_channels_enabled'], self.cfg['analog_channels_gains']):
                 getattr(self, 'checkbox_analog_channel%d_enabled' % (c)).setChecked(True)
                 getattr(self, 'spinbox_analog_channel%d_gain' % (c)).setValue(g)
+            self.act_activate_fields_for_adu_model()
         if hasattr(self, 'combobox_interface'):
             if 'interface' in self.cfg.keys():
                 try:
diff --git a/inlinino/instruments/dataq.py b/inlinino/instruments/dataq.py
@@ -1,6 +1,6 @@
 import numpy as np  # Needed to compute advanced products
 
-from inlinino.instruments import Instrument
+from inlinino.instruments import Instrument, InterfaceException
 from time import time, sleep
 
 class DATAQ(Instrument):
@@ -38,7 +38,9 @@ def setup(self, cfg):
             if len(cfg[k]) == 1 and cfg[k][0] == '':
                 del cfg[k]
         # Overload cfg with DATAQ specific parameters
-        cfg['variable_names'] = ['C%d' % (c+1) for c in self.channels_enabled] + \
+        channels_names = cfg['channels_names'] if 'channels_names' in cfg.keys() else [None] * 8
+        channels_names = [('_' + c.strip().replace(' ', '_')) if c is not None and len(c.strip()) > 0 else '' for c in channels_names]
+        cfg['variable_names'] = ['C%d%s' % (c+1, channels_names[c]) for c in self.channels_enabled] + \
                                 (cfg['variable_names'] if 'variable_names' in cfg.keys() else [])
         cfg['variable_units'] = ['V'] * len(self.channels_enabled) + \
                                 (cfg['variable_units'] if 'variable_units' in cfg.keys() else [])
@@ -55,8 +57,11 @@ def setup(self, cfg):
 
     def close(self, *args, **kwargs):
         if self.alive:
-            self.send_cmd('stop')
-            sleep(self._interface.timeout)
+            try:
+                self.send_cmd('stop')
+                sleep(self._interface.timeout)
+            except InterfaceException as e:
+                self.logger.warning(f'unable to stop instrument, {e}')
         super().close(*args, **kwargs)
 
     def send_cmd(self, command):
diff --git a/inlinino/instruments/ontrak.py b/inlinino/instruments/ontrak.py
@@ -104,7 +104,7 @@ def __init__(self, uuid, cfg, signal, *args, **kwargs):
         # Init Flow Control Widget
         self.widget_flow_controls_enabled: Union[List[bool], List[None]] = [None] * 4
         self.widget_pump_controls_enabled: Union[List[bool], List[None]] = [None] * 4
-        self.widgets_to_load: List[str] = ['FlowControlWidget', 'PumpControlWidget'] * 4
+        self.widgets_to_load: List[str] = ['FlowControlWidget'] * 4 + ['PumpControlWidget'] * 4
         self.widgets_to_load_kwargs: List[Dict] = [{'id': k} for k in range(4)] * 2
         # Setup
         self.setup(cfg)
@@ -123,17 +123,14 @@ def setup(self, cfg, raw_logger=LogText):
         self.relays_enabled, self.relays_gui_mode, self.relays = [], [None]*4, [None]*4
         self.widget_flow_controls_enabled, self.widget_pump_controls_enabled = [None]*4, [None]*4
         for r in range(n_relays):
-            if f'relay{r}_enabled' in cfg.keys():
-                if cfg[f'relay{r}_enabled']:
-                    self.relays_enabled.append(r)
-                else:
-                    self.relays_gui_mode[r] = None
-                    self.relays[r] = None
-                    self.widget_flow_controls_enabled[r] = False
-                    self.widget_pump_controls_enabled[r] = False
-                    continue
-            elif r == 0:
-                raise ValueError('Missing field relay0 enabled')
+            if f'relay{r}_enabled' in cfg.keys() and cfg[f'relay{r}_enabled']:
+                self.relays_enabled.append(r)
+            else:
+                self.relays_gui_mode[r] = None
+                self.relays[r] = None
+                self.widget_flow_controls_enabled[r] = False
+                self.widget_pump_controls_enabled[r] = False
+                continue
             if f'relay{r}_mode' in cfg.keys():
                 if cfg[f'relay{r}_mode'] not in relay_mode_supported:
                     raise ValueError(f"{cfg[f'relay{r}_mode']} not supported by {cfg['model']}.")
diff --git a/inlinino/resources/setup_dataq.ui b/inlinino/resources/setup_dataq.ui
@@ -9,8 +9,8 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>390</width>
-    <height>510</height>
+    <width>503</width>
+    <height>588</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -87,63 +87,119 @@
        <property name="alignment">
         <set>Qt::AlignLeading|Qt::AlignLeft|Qt::AlignTop</set>
        </property>
-       <layout class="QVBoxLayout" name="verticalLayout">
-        <item>
+       <layout class="QFormLayout" name="formLayout">
+        <item row="0" column="0">
          <widget class="QCheckBox" name="checkbox_channel1_enabled">
           <property name="text">
            <string>Channel 1</string>
           </property>
          </widget>
         </item>
-        <item>
+        <item row="1" column="0">
          <widget class="QCheckBox" name="checkbox_channel2_enabled">
           <property name="text">
            <string>Channel 2</string>
           </property>
          </widget>
         </item>
-        <item>
+        <item row="2" column="0">
          <widget class="QCheckBox" name="checkbox_channel3_enabled">
           <property name="text">
            <string>Channel 3</string>
           </property>
          </widget>
         </item>
-        <item>
+        <item row="3" column="0">
          <widget class="QCheckBox" name="checkbox_channel4_enabled">
           <property name="text">
            <string>Channel 4</string>
           </property>
          </widget>
         </item>
-        <item>
+        <item row="4" column="0">
          <widget class="QCheckBox" name="checkbox_channel5_enabled">
           <property name="text">
            <string>Channel 5</string>
           </property>
          </widget>
         </item>
-        <item>
+        <item row="5" column="0">
          <widget class="QCheckBox" name="checkbox_channel6_enabled">
           <property name="text">
            <string>Channel 6</string>
           </property>
          </widget>
         </item>
-        <item>
+        <item row="6" column="0">
          <widget class="QCheckBox" name="checkbox_channel7_enabled">
           <property name="text">
            <string>Channel 7</string>
           </property>
          </widget>
         </item>
-        <item>
+        <item row="7" column="0">
          <widget class="QCheckBox" name="checkbox_channel8_enabled">
           <property name="text">
            <string>Channel 8</string>
           </property>
          </widget>
         </item>
+        <item row="0" column="1">
+         <widget class="QLineEdit" name="optional_le_channel1_name">
+          <property name="placeholderText">
+           <string>Instr. Model S/N</string>
+          </property>
+         </widget>
+        </item>
+        <item row="1" column="1">
+         <widget class="QLineEdit" name="optional_le_channel2_name">
+          <property name="placeholderText">
+           <string>Instr. Model S/N</string>
+          </property>
+         </widget>
+        </item>
+        <item row="2" column="1">
+         <widget class="QLineEdit" name="optional_le_channel3_name">
+          <property name="placeholderText">
+           <string>Instr. Model S/N</string>
+          </property>
+         </widget>
+        </item>
+        <item row="3" column="1">
+         <widget class="QLineEdit" name="optional_le_channel4_name">
+          <property name="placeholderText">
+           <string>Instr. Model S/N</string>
+          </property>
+         </widget>
+        </item>
+        <item row="4" column="1">
+         <widget class="QLineEdit" name="optional_le_channel5_name">
+          <property name="placeholderText">
+           <string>Instr. Model S/N</string>
+          </property>
+         </widget>
+        </item>
+        <item row="5" column="1">
+         <widget class="QLineEdit" name="optional_le_channel6_name">
+          <property name="placeholderText">
+           <string>Instr. Model S/N</string>
+          </property>
+         </widget>
+        </item>
+        <item row="6" column="1">
+         <widget class="QLineEdit" name="optional_le_channel7_name">
+          <property name="placeholderText">
+           <string>Instr. Model S/N</string>
+          </property>
+         </widget>
+        </item>
+        <item row="7" column="1">
+         <widget class="QLineEdit" name="optional_le_channel8_name">
+          <property name="placeholderText">
+           <string>Instr. Model S/N</string>
+          </property>
+         </widget>
+        </item>
        </layout>
       </widget>
      </item>
diff --git a/inlinino/widgets/flow_control.py b/inlinino/widgets/flow_control.py
@@ -9,7 +9,7 @@ class FlowControlWidget(GenericWidget):
     def __init__(self, instrument, id=0):
         self.id = id
         super().__init__(instrument)
-        self.group_box_instrument_control.setTitle(f'Flow Control {self.id}')
+        self.group_box_instrument_control.setTitle(f'Switch {self.id}')
         self.radio_instrument_control_filter.clicked.connect(self.set_switch_mode)
         self.radio_instrument_control_total.clicked.connect(self.set_switch_mode)
         self.radio_instrument_control_hourly.clicked.connect(self.set_switch_mode)
