State

All calls to the Thermostat should be forwarded by the medium.

README.md

@@ -71,9 +71,8 @@ openocd -f interface/stlink.cfg -f target/stm32f4x.cfg -c "program target/thumbv
 
 A GUI has been developed for easy configuration and plotting of key parameters.
 
-The Python GUI program is located at pytec/tec_qt.py.
-
-The GUI is developed based on the Python library pyqtgraph. The GUI can be configured and launched automatically by running:
+The Python GUI program is located at pytec/tec_qt.py, and is developed based on the Python library pyqtgraph. The GUI can be configured and
+launched automatically by running:
 
 ```
 nix run .#thermostat_gui

flake.nix

@@ -1,10 +1,15 @@
 {
   description = "Firmware for the Sinara 8451 Thermostat";
 
-  inputs.nixpkgs.url = github:NixOS/nixpkgs/nixos-23.05;
+  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.05";
   inputs.mozilla-overlay = {url = github:mozilla/nixpkgs-mozilla; flake = false; };
 
-  outputs = { self, nixpkgs, mozilla-overlay }:
+  outputs =
+    {
+      self,
+      nixpkgs,
+      mozilla-overlay,
+    }:
     let
       pkgs = import nixpkgs { system = "x86_64-linux"; overlays = [ (import mozilla-overlay) ]; };
       rustManifest = pkgs.fetchurl {
@@ -76,7 +81,26 @@
           inherit pname version;
           hash = "sha256-WBCNhBHHBU4IQdi3ke6F4QH8KWubNZwOAd3jipj/Ks4=";
         };
-        propagatedBuildInputs = with pkgs.python3Packages; [ numpy pyqt6 ];
+        propagatedBuildInputs = with pkgs.python3Packages; [
+          numpy
+          pyqt6
+        ];
+      };
+
+      qtextras = pkgs.python3Packages.buildPythonPackage rec {
+        pname = "qtextras";
+        version = "0.6.8";
+        format = "pyproject";
+        src = pkgs.fetchPypi {
+          inherit pname version;
+          hash = "sha256-d1ZotSlOI4surUy0H0N4xHoq94IRQvMHunwRH1uubFg=";
+        };
+        buildInputs = [ pkgs.python3Packages.hatchling ];
+        propagatedBuildInputs = with pkgs.python3Packages; [
+          numpy
+          pyqtgraph
+          ruamel-yaml
+        ];
       };
 
       pglive = pkgs.python3Packages.buildPythonPackage rec {
@@ -88,7 +112,10 @@
           hash = "sha256-jqj8X6H1N5mJQ4OrY5ANqRB0YJByqg/bNneEALWmH1A=";
         };
         buildInputs = [ pkgs.python3Packages.poetry-core ];
-        propagatedBuildInputs = [ pyqtgraph pkgs.python3Packages.numpy ];
+        propagatedBuildInputs = [
+          pyqtgraph
+          pkgs.python3Packages.numpy
+        ];
       };
 
       thermostat_gui = pkgs.python3Packages.buildPythonPackage {
@@ -98,14 +125,23 @@
         src = "${self}/pytec";
 
         nativeBuildInputs = [ pkgs.qt6.wrapQtAppsHook ];
-        propagatedBuildInputs = [ pkgs.qt6.qtbase ] ++ (with pkgs.python3Packages; [ pyqtgraph pyqt6 qasync pglive ]);
+        propagatedBuildInputs =
+          [ pkgs.qt6.qtbase ]
+          ++ (with pkgs.python3Packages; [
+            pyqtgraph
+            pyqt6
+            qasync
+            pglive
+            qtextras
+          ]);
 
         dontWrapQtApps = true;
         postFixup = ''
           wrapQtApp "$out/bin/tec_qt"
         '';
       };
-    in {
+    in
+    {
       packages.x86_64-linux = {
         inherit thermostat thermostat_gui;
       };
@@ -121,10 +157,22 @@
 
       devShell.x86_64-linux = pkgs.mkShell {
         name = "thermostat-dev-shell";
-        buildInputs = with pkgs; [
-          rust openocd dfu-util
-          ] ++ (with python3Packages; [
-            numpy matplotlib pyqtgraph setuptools pyqt6 qasync pglive
+        buildInputs =
+          with pkgs;
+          [
+            rust
+            openocd
+            dfu-util
+          ]
+          ++ (with python3Packages; [
+            numpy
+            matplotlib
+            pyqtgraph
+            setuptools
+            pyqt6
+            qasync
+            pglive
+            qtextras
           ]);
       };
       defaultPackage.x86_64-linux = thermostat;

pytec/.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203,E701

pytec/autotune.py

@@ -12,16 +12,16 @@ from pytec.client import Client
 
 
 class PIDAutotuneState(Enum):
-    STATE_OFF = 'off'
-    STATE_RELAY_STEP_UP = 'relay step up'
-    STATE_RELAY_STEP_DOWN = 'relay step down'
-    STATE_SUCCEEDED = 'succeeded'
-    STATE_FAILED = 'failed'
-    STATE_READY = 'ready'
+    STATE_OFF = "off"
+    STATE_RELAY_STEP_UP = "relay step up"
+    STATE_RELAY_STEP_DOWN = "relay step down"
+    STATE_SUCCEEDED = "succeeded"
+    STATE_FAILED = "failed"
+    STATE_READY = "ready"
 
 
 class PIDAutotune:
-    PIDParams = namedtuple('PIDParams', ['Kp', 'Ki', 'Kd'])
+    PIDParams = namedtuple("PIDParams", ["Kp", "Ki", "Kd"])
 
     PEAK_AMPLITUDE_TOLERANCE = 0.05
 
@@ -31,13 +31,14 @@ class PIDAutotune:
         "ciancone-marlin": [0.303, 0.1364, 0.0481],
         "pessen-integral": [0.7, 1.75, 0.105],
         "some-overshoot": [0.333, 0.667, 0.111],
-        "no-overshoot": [0.2, 0.4,  0.0667]
+        "no-overshoot": [0.2, 0.4, 0.0667],
     }
 
-    def __init__(self, setpoint, out_step=10, lookback=60,
-                 noiseband=0.5, sampletime=1.2):
+    def __init__(
+        self, setpoint, out_step=10, lookback=60, noiseband=0.5, sampletime=1.2
+    ):
         if setpoint is None:
-            raise ValueError('setpoint must be specified')
+            raise ValueError("setpoint must be specified")
 
         self._inputs = deque(maxlen=round(lookback / sampletime))
         self._setpoint = setpoint
@@ -84,7 +85,7 @@ class PIDAutotune:
         """Get a list of all available tuning rules."""
         return self._tuning_rules.keys()
 
-    def get_pid_parameters(self, tuning_rule='ziegler-nichols'):
+    def get_pid_parameters(self, tuning_rule="ziegler-nichols"):
         """Get PID parameters.
 
         Args:
@@ -116,28 +117,34 @@ class PIDAutotune:
         """
         now = time_input * 1000
 
-        if (self._state == PIDAutotuneState.STATE_OFF
+        if (
+            self._state == PIDAutotuneState.STATE_OFF
             or self._state == PIDAutotuneState.STATE_SUCCEEDED
             or self._state == PIDAutotuneState.STATE_FAILED
-                or self._state == PIDAutotuneState.STATE_READY):
+            or self._state == PIDAutotuneState.STATE_READY
+        ):
             self._state = PIDAutotuneState.STATE_RELAY_STEP_UP
 
         self._last_run_timestamp = now
 
         # check input and change relay state if necessary
-        if (self._state == PIDAutotuneState.STATE_RELAY_STEP_UP
-                and input_val > self._setpoint + self._noiseband):
+        if (
+            self._state == PIDAutotuneState.STATE_RELAY_STEP_UP
+            and input_val > self._setpoint + self._noiseband
+        ):
             self._state = PIDAutotuneState.STATE_RELAY_STEP_DOWN
-            logging.debug('switched state: {0}'.format(self._state))
-            logging.debug('input: {0}'.format(input_val))
-        elif (self._state == PIDAutotuneState.STATE_RELAY_STEP_DOWN
-                and input_val < self._setpoint - self._noiseband):
+            logging.debug("switched state: {0}".format(self._state))
+            logging.debug("input: {0}".format(input_val))
+        elif (
+            self._state == PIDAutotuneState.STATE_RELAY_STEP_DOWN
+            and input_val < self._setpoint - self._noiseband
+        ):
             self._state = PIDAutotuneState.STATE_RELAY_STEP_UP
-            logging.debug('switched state: {0}'.format(self._state))
-            logging.debug('input: {0}'.format(input_val))
+            logging.debug("switched state: {0}".format(self._state))
+            logging.debug("input: {0}".format(input_val))
 
         # set output
-        if (self._state == PIDAutotuneState.STATE_RELAY_STEP_UP):
+        if self._state == PIDAutotuneState.STATE_RELAY_STEP_UP:
             self._output = self._initial_output - self._outputstep
         elif self._state == PIDAutotuneState.STATE_RELAY_STEP_DOWN:
             self._output = self._initial_output + self._outputstep
@@ -180,8 +187,8 @@ class PIDAutotune:
             self._peak_count += 1
             self._peaks.append(input_val)
             self._peak_timestamps.append(now)
-            logging.debug('found peak: {0}'.format(input_val))
-            logging.debug('peak count: {0}'.format(self._peak_count))
+            logging.debug("found peak: {0}".format(input_val))
+            logging.debug("peak count: {0}".format(self._peak_count))
 
         # check for convergence of induced oscillation
         # convergence of amplitude assessed on last 4 peaks (1.5 cycles)
@@ -191,20 +198,19 @@ class PIDAutotune:
             abs_max = self._peaks[-2]
             abs_min = self._peaks[-2]
             for i in range(0, len(self._peaks) - 2):
-                self._induced_amplitude += abs(self._peaks[i]
-                                               - self._peaks[i+1])
+                self._induced_amplitude += abs(self._peaks[i] - self._peaks[i + 1])
                 abs_max = max(self._peaks[i], abs_max)
                 abs_min = min(self._peaks[i], abs_min)
 
             self._induced_amplitude /= 6.0
 
             # check convergence criterion for amplitude of induced oscillation
-            amplitude_dev = ((0.5 * (abs_max - abs_min)
-                              - self._induced_amplitude)
-                             / self._induced_amplitude)
+            amplitude_dev = (
+                0.5 * (abs_max - abs_min) - self._induced_amplitude
+            ) / self._induced_amplitude
 
-            logging.debug('amplitude: {0}'.format(self._induced_amplitude))
-            logging.debug('amplitude deviation: {0}'.format(amplitude_dev))
+            logging.debug("amplitude: {0}".format(self._induced_amplitude))
+            logging.debug("amplitude deviation: {0}".format(amplitude_dev))
 
             if amplitude_dev < PIDAutotune.PEAK_AMPLITUDE_TOLERANCE:
                 self._state = PIDAutotuneState.STATE_SUCCEEDED
@@ -218,25 +224,24 @@ class PIDAutotune:
 
         if self._state == PIDAutotuneState.STATE_SUCCEEDED:
             self._output = 0
-            logging.debug('peak finding successful')
+            logging.debug("peak finding successful")
 
             # calculate ultimate gain
-            self._Ku = 4.0 * self._outputstep / \
-                (self._induced_amplitude * math.pi)
-            logging.debug('Ku: {0}'.format(self._Ku))
+            self._Ku = 4.0 * self._outputstep / (self._induced_amplitude * math.pi)
+            logging.debug("Ku: {0}".format(self._Ku))
 
             # calculate ultimate period in seconds
             period1 = self._peak_timestamps[3] - self._peak_timestamps[1]
             period2 = self._peak_timestamps[4] - self._peak_timestamps[2]
             self._Pu = 0.5 * (period1 + period2) / 1000.0
-            logging.debug('Pu: {0}'.format(self._Pu))
+            logging.debug("Pu: {0}".format(self._Pu))
 
             for rule in self._tuning_rules:
                 params = self.get_pid_parameters(rule)
-                logging.debug('rule: {0}'.format(rule))
-                logging.debug('Kp: {0}'.format(params.Kp))
-                logging.debug('Ki: {0}'.format(params.Ki))
-                logging.debug('Kd: {0}'.format(params.Kd))
+                logging.debug("rule: {0}".format(rule))
+                logging.debug("Kp: {0}".format(params.Kp))
+                logging.debug("Ki: {0}".format(params.Ki))
+                logging.debug("Kd: {0}".format(params.Kd))
 
             return True
         return False
@@ -263,16 +268,17 @@ def main():
     data = next(tec.report_mode())
     ch = data[channel]
 
-    tuner = PIDAutotune(target_temperature, output_step,
-                        lookback, noiseband, ch['interval'])
+    tuner = PIDAutotune(
+        target_temperature, output_step, lookback, noiseband, ch["interval"]
+    )
 
     for data in tec.report_mode():
 
         ch = data[channel]
 
-        temperature = ch['temperature']
+        temperature = ch["temperature"]
 
-        if (tuner.run(temperature, ch['time'])):
+        if tuner.run(temperature, ch["time"]):
             break
 
         tuner_out = tuner.output()

pytec/examples/aioexample.py

@@ -1,8 +1,9 @@
 import asyncio
-from pytec.aioclient import Client
+from pytec.aioclient import AsyncioClient
+
 
 async def main():
-    tec = Client()
+    tec = AsyncioClient()
     await tec.start_session()  # (host="192.168.1.26", port=23)
     await tec.set_param("s-h", 1, "t0", 20)
     print(await tec.get_pwm())
@@ -13,4 +14,5 @@ async def main():
     async for data in tec.report_mode():
         print(data)
 
+
 asyncio.run(main())

pytec/plot.py

@@ -7,9 +7,10 @@ from pytec.client import Client
 TIME_WINDOW = 300.0
 
 tec = Client()
-target_temperature = tec.get_pid()[0]['target']
+target_temperature = tec.get_pid()[0]["target"]
 print("Channel 0 target temperature: {:.3f}".format(target_temperature))
 
+
 class Series:
     def __init__(self, conv=lambda x: x):
         self.conv = conv
@@ -27,24 +28,26 @@ class Series:
         self.x_data = self.x_data[drop:]
         self.y_data = self.y_data[drop:]
 
+
 series = {
     # 'adc': Series(),
     # 'sens': Series(lambda x: x * 0.0001),
-    'temperature': Series(),
+    "temperature": Series(),
     # 'i_set': Series(),
-    'pid_output': Series(),
+    "pid_output": Series(),
     # 'vref': Series(),
     # 'dac_value': Series(),
     # 'dac_feedback': Series(),
     # 'i_tec': Series(),
-    'tec_i': Series(),
-    'tec_u_meas': Series(),
+    "tec_i": Series(),
+    "tec_u_meas": Series(),
     # 'interval': Series(),
 }
 series_lock = Lock()
 
 quit = False
 
+
 def recv_data(tec):
     global last_packet_time
     for data in tec.report_mode():
@@ -55,22 +58,24 @@ def recv_data(tec):
                 if k in ch0:
                     v = ch0[k]
                     if type(v) is float:
-                        s.append(ch0['time'], v)
+                        s.append(ch0["time"], v)
         finally:
             series_lock.release()
 
         if quit:
             break
 
+
 thread = Thread(target=recv_data, args=(tec,))
 thread.start()
 
 fig, ax = plt.subplots()
 
 for k, s in series.items():
-    s.plot, = ax.plot([], [], label=k)
+    (s.plot,) = ax.plot([], [], label=k)
 legend = ax.legend()
 
+
 def animate(i):
     min_x, max_x, min_y, max_y = None, None, None, None
 
@@ -120,8 +125,8 @@ def animate(i):
     legend.remove()
     legend = ax.legend()
 
-ani = animation.FuncAnimation(
-    fig, animate, interval=1, blit=False, save_count=50)
+
+ani = animation.FuncAnimation(fig, animate, interval=1, blit=False, save_count=50)
 
 plt.show()
 quit = True

pytec/pyproject.toml

@@ -16,3 +16,6 @@ tec_qt = "tec_qt:main"
 [tool.setuptools]
 packages.find = {}
 py-modules = ["autotune", "plot", "tec_qt"]
+
+[tool.pylint.format]
+max-line-length = "88"

pytec/pytec/aioclient.py

@@ -2,58 +2,34 @@ import asyncio
 import json
 import logging
 
+
 class CommandError(Exception):
     pass
 
-class StoppedConnecting(Exception):
-    pass
 
-class Client:
+class AsyncioClient:
     def __init__(self):
         self._reader = None
         self._writer = None
-        self._connecting_task = None
         self._command_lock = asyncio.Lock()
         self._report_mode_on = False
-        self.timeout = None
 
-    async def start_session(self, host='192.168.1.26', port=23, timeout=None):
+    async def start_session(self, host="192.168.1.26", port=23):
         """Start session to Thermostat at specified host and port.
-        Throws StoppedConnecting if disconnect was called while connecting.
-        Throws asyncio.TimeoutError if timeout was exceeded.
 
         Example::
-            client = Client()
-            try:
+            client = AsyncioClient()
             await client.start_session()
-            except StoppedConnecting:
-                print("Stopped connecting")
         """
-        self._connecting_task = asyncio.create_task(
-            asyncio.wait_for(asyncio.open_connection(host, port), timeout)
-        )
-        self.timeout = timeout
-        try:
-            self._reader, self._writer = await self._connecting_task
-        except asyncio.CancelledError:
-            raise StoppedConnecting
-        finally:
-            self._connecting_task = None
-
+        self._reader, self._writer = await asyncio.open_connection(host, port)
         await self._check_zero_limits()
 
-    def connecting(self):
-        """Returns True if client is connecting"""
-        return self._connecting_task is not None
-
     def connected(self):
         """Returns True if client is connected"""
         return self._writer is not None
 
     async def end_session(self):
-        """End session to Thermostat if connected, cancel connection if connecting"""
-        if self._connecting_task is not None:
-            self._connecting_task.cancel()
+        """End session to Thermostat"""
 
         if self._writer is None:
             return
@@ -69,23 +45,26 @@ class Client:
         for pwm_channel in pwm_report:
             for limit in ["max_i_neg", "max_i_pos", "max_v"]:
                 if pwm_channel[limit]["value"] == 0.0:
-                    logging.warning("`{}` limit is set to zero on channel {}".format(limit, pwm_channel["channel"]))
+                    logging.warning(
+                        "`{}` limit is set to zero on channel {}".format(
+                            limit, pwm_channel["channel"]
+                        )
+                    )
 
     async def _read_line(self):
         # read 1 line
-        chunk = await asyncio.wait_for(self._reader.readline(), self.timeout) # Only wait for response until timeout
-        return chunk.decode('utf-8', errors='ignore')
+        chunk = await self._reader.readline()
+        return chunk.decode("utf-8", errors="ignore")
 
     async def _read_write(self, command):
-        self._writer.write(((" ".join(command)).strip() + "\n").encode('utf-8'))
+        self._writer.write(((" ".join(command)).strip() + "\n").encode("utf-8"))
         await self._writer.drain()
 
         return await self._read_line()
 
     async def _command(self, *command):
         async with self._command_lock:
-            # protect the read-write process from being cancelled midway
-            line = await asyncio.shield(self._read_write(command))
+            line = await self._read_write(command)
 
         response = json.loads(line)
         logging.debug(f"{command}: {response}")
@@ -256,7 +235,7 @@ class Client:
         The client is disconnected as the TCP session is terminated.
         """
         async with self._command_lock:
-            self._writer.write("reset\n".encode('utf-8'))
+            self._writer.write("reset\n".encode("utf-8"))
             await self._writer.drain()
 
         await self.end_session()
@@ -269,11 +248,11 @@ class Client:
         power-cycling.
         """
         async with self._command_lock:
-            self._writer.write("dfu\n".encode('utf-8'))
+            self._writer.write("dfu\n".encode("utf-8"))
             await self._writer.drain()
 
         await self.end_session()
 
     async def ipv4(self):
         """Get the IPv4 settings of the Thermostat"""
-        return await self._command('ipv4')
+        return await self._command("ipv4")

pytec/pytec/client.py

@@ -2,9 +2,11 @@ import socket
 import json
 import logging
 
+
 class CommandError(Exception):
     pass
 
+
 class Client:
     def __init__(self, host="192.168.1.26", port=23, timeout=None):
         self._socket = socket.create_connection((host, port), timeout)
@@ -20,7 +22,11 @@ class Client:
         for pwm_channel in pwm_report:
             for limit in ["max_i_neg", "max_i_pos", "max_v"]:
                 if pwm_channel[limit]["value"] == 0.0:
-                    logging.warning("`{}` limit is set to zero on channel {}".format(limit, pwm_channel["channel"]))
+                    logging.warning(
+                        "`{}` limit is set to zero on channel {}".format(
+                            limit, pwm_channel["channel"]
+                        )
+                    )
 
     def _read_line(self):
         # read more lines
@@ -28,7 +34,7 @@ class Client:
             chunk = self._socket.recv(4096)
             if not chunk:
                 return None
-            buf = self._lines[-1] + chunk.decode('utf-8', errors='ignore')
+            buf = self._lines[-1] + chunk.decode("utf-8", errors="ignore")
             self._lines = buf.split("\n")
 
         line = self._lines[0]
@@ -36,7 +42,7 @@ class Client:
         return line
 
     def _command(self, *command):
-        self._socket.sendall((" ".join(command) + "\n").encode('utf-8'))
+        self._socket.sendall((" ".join(command) + "\n").encode("utf-8"))
 
         line = self._read_line()
         response = json.loads(line)

pytec/pytec/gui/model/pid_autotuner.py

@@ -4,10 +4,10 @@ from autotune import PIDAutotuneState, PIDAutotune
 
 
 class PIDAutoTuner(QObject):
-    def __init__(self, parent, client, num_of_channel):
-        super().__init__()
+    def __init__(self, parent, thermostat, num_of_channel):
+        super().__init__(parent)
 
-        self._client = client
+        self._thermostat = thermostat
         self.autotuners = [PIDAutotune(25) for _ in range(num_of_channel)]
         self.target_temp = [20.0 for _ in range(num_of_channel)]
         self.test_current = [1.0 for _ in range(num_of_channel)]
@@ -37,7 +37,7 @@ class PIDAutoTuner(QObject):
 
     async def stop_pid_from_running(self, ch):
         self.autotuners[ch].setOff()
-        await self._client.set_param("pwm", ch, "i_set", 0)
+        await self._thermostat.set_param("pwm", ch, "i_set", 0)
 
     @asyncSlot(list)
     async def tick(self, report):
@@ -48,25 +48,29 @@ class PIDAutoTuner(QObject):
 
             ch = channel_report["channel"]
             match self.autotuners[ch].state():
-                case PIDAutotuneState.STATE_READY | PIDAutotuneState.STATE_RELAY_STEP_UP | PIDAutotuneState.STATE_RELAY_STEP_DOWN:
+                case (
+                    PIDAutotuneState.STATE_READY
+                    | PIDAutotuneState.STATE_RELAY_STEP_UP
+                    | PIDAutotuneState.STATE_RELAY_STEP_DOWN
+                ):
                     self.autotuners[ch].run(
                         channel_report["temperature"], channel_report["time"]
                     )
-                    await self._client.set_param(
+                    await self._thermostat.set_param(
                         "pwm", ch, "i_set", self.autotuners[ch].output()
                     )
                 case PIDAutotuneState.STATE_SUCCEEDED:
                     kp, ki, kd = self.autotuners[ch].get_tec_pid()
                     self.autotuners[ch].setOff()
 
-                    await self._client.set_param("pid", ch, "kp", kp)
-                    await self._client.set_param("pid", ch, "ki", ki)
-                    await self._client.set_param("pid", ch, "kd", kd)
-                    await self._client.set_param("pwm", ch, "pid")
+                    await self._thermostat.set_param("pid", ch, "kp", kp)
+                    await self._thermostat.set_param("pid", ch, "ki", ki)
+                    await self._thermostat.set_param("pid", ch, "kd", kd)
+                    await self._thermostat.set_param("pwm", ch, "pid")
 
-                    await self._client.set_param(
+                    await self._thermostat.set_param(
                         "pid", ch, "target", self.target_temp[ch]
                     )
                 case PIDAutotuneState.STATE_FAILED:
                     self.autotuners[ch].setOff()
-                    await self._client.set_param("pwm", ch, "i_set", 0)
+                    await self._thermostat.set_param("pwm", ch, "i_set", 0)

pytec/pytec/gui/model/thermostat.py

@@ -1,20 +1,16 @@
-from pytec.aioclient import Client
 from PyQt6.QtCore import pyqtSignal, QObject, pyqtSlot
 from qasync import asyncSlot
 from pytec.gui.model.property import Property, PropertyMeta
 import asyncio
 import logging
+from enum import Enum
+from pytec.aioclient import AsyncioClient
 
 
-class WrappedClient(QObject, Client):
-    connection_error = pyqtSignal()
-
-    async def _read_line(self):
-        try:
-            return await super()._read_line()
-        except (Exception, TimeoutError, asyncio.exceptions.TimeoutError):
-            logging.error("Client connection error, disconnecting", exc_info=True)
-            self.connection_error.emit()
+class ThermostatConnectionState(Enum):
+    STATE_DISCONNECTED = "disconnected"
+    STATE_CONNECTING = "connecting"
+    STATE_CONNECTED = "connected"
 
 
 class Thermostat(QObject, metaclass=PropertyMeta):
@@ -27,35 +23,40 @@ class Thermostat(QObject, metaclass=PropertyMeta):
     interval = Property(list)
     report = Property(list)
     info_box_trigger = pyqtSignal(str, str)
+    connection_error = pyqtSignal()
 
-    def __init__(self, parent, client, update_s):
+    def __init__(self, parent, update_s):
         self._update_s = update_s
-        self._client = client
+        self._client = AsyncioClient()
         self._watch_task = None
         self._report_mode_task = None
         self._poll_for_report = True
+        self.connection_errored = False
         super().__init__(parent)
 
+    async def start_session(self, host, port):
+        await self._client.start_session(host, port)
+
     async def run(self):
         self.task = asyncio.create_task(self.update_params())
         while True:
             if self.task.done():
-                if self.task.exception() is not None:
                 try:
-                        raise self.task.exception()
-                    except (
-                        Exception,
-                        TimeoutError,
-                        asyncio.exceptions.TimeoutError,
-                    ):
+                    _ = self.task.result()
+                except asyncio.TimeoutError:
                     logging.error(
                         "Encountered an error while updating parameter tree.",
                         exc_info=True,
                     )
-                _ = self.task.result()
+                    self.connection_error.emit()
+                    return
                 self.task = asyncio.create_task(self.update_params())
             await asyncio.sleep(self._update_s)
 
+    @pyqtSlot()
+    def timed_out(self):
+        self.connection_errored = True
+
     async def get_hw_rev(self):
         self.hw_rev = await self._client.hw_rev()
         return self.hw_rev
@@ -73,10 +74,7 @@ class Thermostat(QObject, metaclass=PropertyMeta):
         self.postfilter = await self._client.get_postfilter()
 
     def connected(self):
-        return self._client.connected
-
-    def connecting(self):
-        return self._client.connecting
+        return self._client.connected()
 
     def start_watching(self):
         self._watch_task = asyncio.create_task(self.run())
@@ -106,6 +104,7 @@ class Thermostat(QObject, metaclass=PropertyMeta):
 
     async def end_session(self):
         await self._client.end_session()
+        self.connection_errored = False
 
     async def set_ipv4(self, ipv4):
         await self._client.set_param("ipv4", ipv4)
@@ -136,3 +135,12 @@ class Thermostat(QObject, metaclass=PropertyMeta):
     @pyqtSlot(float)
     def set_update_s(self, update_s):
         self._update_s = update_s
+
+    async def set_fan(self, power="auto"):
+        await self._client.set_fan(power)
+
+    async def get_fan(self):
+        return await self._client.get_fan()
+
+    async def set_param(self, topic, channel, field="", value=""):
+        await self._client.set_param(topic, channel, field, value)

pytec/pytec/gui/view/live_plot_view.py

@@ -67,9 +67,7 @@ class _TecGraphs:
         self._t_line = self._t_widget.getPlotItem().addLine(label="{value} °C")
         self._t_line.setVisible(False)
         # Hack for keeping setpoint line in plot range
-        self._t_setpoint_plot = (
-            LiveLinePlot()
-        )
+        self._t_setpoint_plot = LiveLinePlot()
 
         for graph in t_widget, i_widget:
             time_axis = LiveAxis(

pytec/pytec/gui/view/waitingspinnerwidget.py

@@ -67,16 +67,30 @@ class QtWaitingSpinner(QWidget):
         painter.setPen(Qt.PenStyle.NoPen)
         for i in range(0, self._numberOfLines):
             painter.save()
-            painter.translate(self._innerRadius + self._lineLength, self._innerRadius + self._lineLength)
+            painter.translate(
+                self._innerRadius + self._lineLength,
+                self._innerRadius + self._lineLength,
+            )
             rotateAngle = float(360 * i) / float(self._numberOfLines)
             painter.rotate(rotateAngle)
             painter.translate(self._innerRadius, 0)
-            distance = self.lineCountDistanceFromPrimary(i, self._currentCounter, self._numberOfLines)
-            color = self.currentLineColor(distance, self._numberOfLines, self._trailFadePercentage,
-                                          self._minimumTrailOpacity, self._color)
+            distance = self.lineCountDistanceFromPrimary(
+                i, self._currentCounter, self._numberOfLines
+            )
+            color = self.currentLineColor(
+                distance,
+                self._numberOfLines,
+                self._trailFadePercentage,
+                self._minimumTrailOpacity,
+                self._color,
+            )
             painter.setBrush(color)
-            painter.drawRoundedRect(QRect(0, int(-self._lineWidth / 2), self._lineLength, self._lineWidth), self._roundness,
-                                    self._roundness, Qt.SizeMode.RelativeSize)
+            painter.drawRoundedRect(
+                QRect(0, int(-self._lineWidth / 2), self._lineLength, self._lineWidth),
+                self._roundness,
+                self._roundness,
+                Qt.SizeMode.RelativeSize,
+            )
             painter.restore()
 
     def start(self):
@@ -160,7 +174,9 @@ class QtWaitingSpinner(QWidget):
         self.setFixedSize(self.size, self.size)
 
     def updateTimer(self):
-        self._timer.setInterval(int(1000 / (self._numberOfLines * self._revolutionsPerSecond)))
+        self._timer.setInterval(
+            int(1000 / (self._numberOfLines * self._revolutionsPerSecond))
+        )
 
     def lineCountDistanceFromPrimary(self, current, primary, totalNrOfLines):
         distance = primary - current
@@ -168,7 +184,9 @@ class QtWaitingSpinner(QWidget):
             distance += totalNrOfLines
         return distance
 
-    def currentLineColor(self, countDistance, totalNrOfLines, trailFadePerc, minOpacity, colorinput):
+    def currentLineColor(
+        self, countDistance, totalNrOfLines, trailFadePerc, minOpacity, colorinput
+    ):
         color = QColor(colorinput)
         if countDistance == 0:
             return color
@@ -186,7 +204,7 @@ class QtWaitingSpinner(QWidget):
         return color
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     app = QApplication([])
     waiting_spinner = QtWaitingSpinner()
     waiting_spinner.show()

pytec/tec_qt.py

@@ -7,12 +7,11 @@ from pytec.gui.view.live_plot_view import LiveDataPlotter
 from pytec.gui.view.ctrl_panel import CtrlPanel
 from pytec.gui.view.info_box import InfoBox
 from pytec.gui.model.pid_autotuner import PIDAutoTuner
-from pytec.gui.model.thermostat import WrappedClient, Thermostat
+from pytec.gui.model.thermostat import Thermostat
 import json
 from autotune import PIDAutotuneState
 from qasync import asyncSlot, asyncClose
 import qasync
-from pytec.aioclient import StoppedConnecting
 import asyncio
 import logging
 import argparse
@@ -63,14 +62,23 @@ class MainWindow(QtWidgets.QMainWindow):
         self.hw_rev_data = None
         self.info_box = InfoBox()
 
-        self.client = WrappedClient(self)
-        self.client.connection_error.connect(self.bail)
-
         self.thermostat = Thermostat(
-            self, self.client, self.report_refresh_spin.value()
+            self, self.report_refresh_spin.value()
         )
 
-        self.autotuners = PIDAutoTuner(self, self.client, 2)
+        def handle_connection_error():
+            self.info_box.display_info_box(
+                "Connection Error", "Thermostat connection lost. Is it unplugged?"
+            )
+
+            self.bail()
+
+        self.thermostat.connection_error.connect(handle_connection_error)
+
+        self.thermostat.connection_error.connect(self.thermostat.timed_out)
+        self.thermostat.connection_error.connect(self.bail)
+
+        self.autotuners = PIDAutoTuner(self, self.thermostat, 2)
 
         def get_ctrl_panel_config(args):
             with open(args.param_tree, "r") as f:
@@ -89,15 +97,16 @@ class MainWindow(QtWidgets.QMainWindow):
         ]
         self.thermostat.info_box_trigger.connect(self.info_box.display_info_box)
 
-        self.zero_limits_warning = ZeroLimitsWarningView(
-            self.style(), self.limits_warning
-        )
         self.ctrl_panel_view = CtrlPanel(
             [self.ch0_tree, self.ch1_tree],
             get_ctrl_panel_config(args),
             self.send_command,
             param_tree_sigActivated_handles,
         )
+
+        self.zero_limits_warning = ZeroLimitsWarningView(
+            self.style(), self.limits_warning
+        )
         self.ctrl_panel_view.set_zero_limits_warning_sig.connect(
             self.zero_limits_warning.set_limits_warning
         )
@@ -188,9 +197,12 @@ class MainWindow(QtWidgets.QMainWindow):
             self.thermostat_ctrl_menu.fan_pwm_warning.setToolTip("")
             self.clear_graphs()
             self.report_box.setChecked(False)
-            if not Thermostat.connecting or Thermostat.connected:
             for ch in range(self.NUM_CHANNELS):
                 if self.autotuners.get_state(ch) != PIDAutotuneState.STATE_OFF:
+                    if self.thermostat.connection_errored:
+                        # Don't send any commands, just reset local state
+                        self.autotuners.autotuners[ch].setOff()
+                    else:
                         await self.autotuners.stop_pid_from_running(ch)
             await self.thermostat.set_report_mode(False)
             self.thermostat.stop_watching()
@@ -232,23 +244,30 @@ class MainWindow(QtWidgets.QMainWindow):
             self.conn_menu.host_set_line.text(),
             self.conn_menu.port_set_spin.value(),
         )
+
+        self._connecting_task = None
         try:
-            if not (self.client.connecting() or self.client.connected()):
+            if (self._connecting_task is None) or (not self.thermostat.connected()):
                 self.status_lbl.setText("Connecting...")
                 self.connect_btn.setText("Stop")
                 self.conn_menu.host_set_line.setEnabled(False)
                 self.conn_menu.port_set_spin.setEnabled(False)
 
                 try:
-                    await self.client.start_session(host=host, port=port, timeout=5)
-                except StoppedConnecting:
+                    self._connecting_task = asyncio.wait_for(
+                        self.thermostat.start_session(host=host, port=port), timeout=5
+                    )
+                    await self._connecting_task
+                except asyncio.TimeoutError:
                     return
                 await self._on_connection_changed(True)
             else:
+                if self._connecting_task is not None:
+                    self._connecting_task.cancel()
                 await self.bail()
 
         # TODO: Remove asyncio.TimeoutError in Python 3.11
-        except (OSError, TimeoutError, asyncio.TimeoutError):
+        except (OSError, asyncio.TimeoutError):
             try:
                 await self.bail()
             except ConnectionResetError:
@@ -257,7 +276,7 @@ class MainWindow(QtWidgets.QMainWindow):
     @asyncSlot()
     async def bail(self):
         await self._on_connection_changed(False)
-        await self.client.end_session()
+        await self.thermostat.end_session()
 
     @asyncSlot(object, object)
     async def send_command(self, param, changes):
@@ -279,7 +298,7 @@ class MainWindow(QtWidgets.QMainWindow):
                     else:
                         set_param_args = (*thermostat_param, data)
                     param.child(*param.childPath(inner_param)).setOpts(lock=True)
-                    await self.client.set_param(*set_param_args)
+                    await self.thermostat.set_param(*set_param_args)
                     param.child(*param.childPath(inner_param)).setOpts(lock=False)
 
                 if inner_param.opts.get("pid_autotune", None) is not None:
@@ -295,7 +314,7 @@ class MainWindow(QtWidgets.QMainWindow):
                     if activater is not None:
                         if activater[1] == "ch":
                             activater[1] = ch
-                        await self.client.set_param(*activater)
+                        await self.thermostat.set_param(*activater)
 
     @asyncSlot()
     async def pid_auto_tune_request(self, ch=0):
@@ -303,7 +322,11 @@ class MainWindow(QtWidgets.QMainWindow):
             case PIDAutotuneState.STATE_OFF | PIDAutotuneState.STATE_FAILED:
                 self.autotuners.load_params_and_set_ready(ch)
 
-            case PIDAutotuneState.STATE_READY | PIDAutotuneState.STATE_RELAY_STEP_UP | PIDAutotuneState.STATE_RELAY_STEP_DOWN:
+            case (
+                PIDAutotuneState.STATE_READY
+                | PIDAutotuneState.STATE_RELAY_STEP_UP
+                | PIDAutotuneState.STATE_RELAY_STEP_DOWN
+            ):
                 await self.autotuners.stop_pid_from_running(ch)
                 # To Update the UI elements
                 self.pid_autotune_handler([])
@@ -317,7 +340,11 @@ class MainWindow(QtWidgets.QMainWindow):
                     self.ctrl_panel_view.change_params_title(
                         ch, ("PID Config", "PID Auto Tune", "Run"), "Run"
                     )
-                case PIDAutotuneState.STATE_READY | PIDAutotuneState.STATE_RELAY_STEP_UP | PIDAutotuneState.STATE_RELAY_STEP_DOWN:
+                case (
+                    PIDAutotuneState.STATE_READY
+                    | PIDAutotuneState.STATE_RELAY_STEP_UP
+                    | PIDAutotuneState.STATE_RELAY_STEP_DOWN
+                ):
                     self.ctrl_panel_view.change_params_title(
                         ch, ("PID Config", "PID Auto Tune", "Run"), "Stop"
                     )
@@ -332,7 +359,8 @@ class MainWindow(QtWidgets.QMainWindow):
 
                 case PIDAutotuneState.STATE_FAILED:
                     self.info_box.display_info_box(
-                        "PID Autotune Failed", f"Channel {ch} PID Autotune has failed."
+                        "PID Autotune Failed",
+                        f"Channel {ch} PID Autotune has failed.",
                     )
                     self.info_box.show()
 
@@ -349,42 +377,50 @@ class MainWindow(QtWidgets.QMainWindow):
 
     @asyncSlot(int)
     async def fan_set_request(self, value):
-        if not self.client.connected():
-            return
+        assert self.thermostat.connected()
+
         if self.thermostat_ctrl_menu.fan_auto_box.isChecked():
             with QSignalBlocker(self.thermostat_ctrl_menu.fan_auto_box):
                 self.thermostat_ctrl_menu.fan_auto_box.setChecked(False)
-        await self.client.set_fan(value)
+        await self.thermostat.set_fan(value)
         if not self.hw_rev_data["settings"]["fan_pwm_recommended"]:
             self.thermostat_ctrl_menu.set_fan_pwm_warning()
 
     @asyncSlot(int)
     async def fan_auto_set_request(self, enabled):
-        if not self.client.connected():
-            return
+        assert self.thermostat.connected()
+
         if enabled:
-            await self.client.set_fan("auto")
-            self.fan_update(await self.client.get_fan())
+            await self.thermostat.set_fan("auto")
+            self.fan_update(await self.thermostat.get_fan())
         else:
-            await self.client.set_fan(
+            await self.thermostat.set_fan(
                 self.thermostat_ctrl_menu.fan_power_slider.value()
             )
 
     @asyncSlot(int)
     async def save_cfg_request(self, ch):
+        assert self.thermostat.connected()
+
         await self.thermostat.save_cfg(str(ch))
 
     @asyncSlot(int)
     async def load_cfg_request(self, ch):
+        assert self.thermostat.connected()
+
         await self.thermostat.load_cfg(str(ch))
 
     @asyncSlot(bool)
     async def dfu_request(self, _):
+        assert self.thermostat.connected()
+
         await self._on_connection_changed(False)
         await self.thermostat.dfu()
 
     @asyncSlot(bool)
     async def reset_request(self, _):
+        assert self.thermostat.connected()
+
         await self._on_connection_changed(False)
         await self.thermostat.reset()
         await asyncio.sleep(0.1)  # Wait for the reset to start
@@ -393,14 +429,18 @@ class MainWindow(QtWidgets.QMainWindow):
 
     @asyncSlot(bool)
     async def net_settings_request(self, _):
+        assert self.thermostat.connected()
+
         ipv4 = await self.thermostat.get_ipv4()
         self.net_settings_input_diag = NetSettingsInputDiag(ipv4["addr"])
         self.net_settings_input_diag.set_ipv4_act.connect(self.set_net_settings_request)
 
     @asyncSlot(str)
     async def set_net_settings_request(self, ipv4_settings):
+        assert self.thermostat.connected()
+
         await self.thermostat.set_ipv4(ipv4_settings)
-        await self.thermostat._client.end_session()
+        await self.thermostat.end_session()
         await self._on_connection_changed(False)
 
 
@@ -414,7 +454,9 @@ async def coro_main():
     app = QtWidgets.QApplication.instance()
     app.aboutToQuit.connect(app_quit_event.set)
     app.setWindowIcon(
-        QtGui.QIcon(str(importlib.resources.files("pytec.gui.resources").joinpath("artiq.ico")))
+        QtGui.QIcon(
+            str(importlib.resources.files("pytec.gui.resources").joinpath("artiq.ico"))
+        )
     )
 
     main_window = MainWindow(args)