PyThermostat: Improve pyproject metadata

Forms a more convienient interface.

README.md

@@ -111,8 +111,8 @@ formatted as line-delimited JSON.
 | `pid <0/1> kd <value>`                    | Set differential gain                                                         |
 | `pid <0/1> output_min <amp>`              | Set mininum output                                                            |
 | `pid <0/1> output_max <amp>`              | Set maximum output                                                            |
-| `s-h`                                     | Show Steinhart-Hart equation parameters                                       |
+| `b-p`                                     | Show B-Parameter equation parameters                                          |
-| `s-h <0/1> <t0/b/r0> <value>`             | Set Steinhart-Hart parameter for a channel                                    |
+| `b-p <0/1> <t0/b/r0> <value>`             | Set B-Parameter for a channel                                                 |
 | `postfilter`                              | Show postfilter settings                                                      |
 | `postfilter <0/1> off`                    | Disable postfilter                                                            |
 | `postfilter <0/1> rate <rate>`            | Set postfilter output data rate                                               |
@@ -144,22 +144,22 @@ output will be truncated when USB buffers are full.
 
 Connect the thermistor with the SENS pins of the
 device. Temperature-depending resistance is measured by the AD7172
-ADC. To prepare conversion to a temperature, set the Beta parameters
+ADC. To prepare conversion to a temperature, set the parameters
-for the Steinhart-Hart equation.
+for the B-Parameter equation.
 
 Set the base temperature in degrees celsius for the channel 0 thermistor:
 ```
-s-h 0 t0 20
+b-p 0 t0 20
 ```
 
 Set the resistance in Ohms measured at the base temperature t0:
 ```
-s-h 0 r0 10000
+b-p 0 r0 10000
 ```
 
 Set the Beta parameter:
 ```
-s-h 0 b 3800
+b-p 0 b 3800
 ```
 
 ### 50/60 Hz filtering
@@ -189,31 +189,30 @@ Testing heat flow direction with a low set current is recommended before install
 
 ### Limits
 
-Each MAX1968 TEC driver has analog/PWM inputs for setting
+Each channel has maximum value settings, for setting
 output limits.
 
-Use the `output` command to see current settings and maximum values.
+Use the `output` command to see them.
 
 | Limit       | Unit    | Description                   |
 | ---         | :---:   | ---                           |
 | `max_v`     | Volts   | Maximum voltage               |
 | `max_i_pos` | Amperes | Maximum positive current      |
 | `max_i_neg` | Amperes | Maximum negative current      |
-| `i_set`     | Amperes | (Not a limit; Open-loop mode) |
 
 Example: set the maximum voltage of channel 0 to 1.5 V.
 ```
 output 0 max_v 1.5
 ```
 
-Example: set the maximum negative current of channel 0 to -3 A.
+Example: set the maximum negative current of channel 0 to -2 A.
 ```
-output 0 max_i_neg 3
+output 0 max_i_neg 2
 ```
 
-Example: set the maximum positive current of channel 1 to 3 A.
+Example: set the maximum positive current of channel 1 to 2 A.
 ```
-output 0 max_i_pos 3
+output 1 max_i_pos 2
 ```
 
 ### Open-loop mode
@@ -240,6 +239,22 @@ of channel 0 to the PID algorithm:
 output 0 pid
 ```
 
+### PID output clamping
+
+It is possible to clamp the PID algorithm output independently of channel output limits. This is desirable when e.g. there is a need to keep the current value above a certain threshold in closed-loop mode.
+
+Note that the actual output will still ultimately be limited by the `max_i_pos` and `max_i_neg` values.
+
+Set PID maximum output of channel 0 to 1.5 A.
+```
+pid 0 output_max 1.5
+```
+
+Set PID minimum output of channel 0 to 0.1 A.
+```
+pid 0 output_min 0.1
+```
+
 ## LED indicators
 
 | Name | Color | Meaning                        |
@@ -260,7 +275,7 @@ with the following keys.
 | `interval`     | Seconds         | Time elapsed since last report update on channel     |
 | `adc`          | Volts           | AD7172 input                                         |
 | `sens`         | Ohms            | Thermistor resistance derived from `adc`             |
-| `temperature`  | Degrees Celsius | Steinhart-Hart conversion result derived from `sens` |
+| `temperature`  | Degrees Celsius | B-Parameter conversion result derived from `sens`    |
 | `pid_engaged`  | Boolean         | `true` if in closed-loop mode                        |
 | `i_set`        | Amperes         | TEC output current                                   |
 | `dac_value`    | Volts           | AD5680 output derived from `i_set`                   |

doc/PID tuning.md

@@ -13,7 +13,7 @@ When tuning Thermostat PID parameters, it is helpful to view the temperature, PI
 To use the Python real-time plotting utility, run
 
 ```shell
-python pytec/plot.py
+python pythermostat/pythermostat/plot.py
 ```
 
 ![default view](./assets/default%20view.png)
@@ -44,12 +44,12 @@ Below are some general guidelines for manually tuning PID loops. Note that every
 
 ## Auto Tuning
 
-A PID auto tuning utility is provided in the Pytec library. The auto tuning utility drives the the load to a controlled oscillation, observes the ultimate gain and oscillation period and calculates a set of PID parameters.
+A PID auto tuning utility is provided in the PyThermostat library. The auto tuning utility drives the the load to a controlled oscillation, observes the ultimate gain and oscillation period and calculates a set of PID parameters.
 
 To run the auto tuning utility, run
 
 ```shell
-python pytec/autotune.py
+python pythermostat/pythermostat/autotune.py
 ```
 
 After some time, the auto tuning utility will output the auto tuning results, below is a sample output

flake.nix

@@ -2,14 +2,22 @@
   description = "Firmware for the Sinara 8451 Thermostat";
 
   inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.05";
-  inputs.rust-overlay = { 
+  inputs.rust-overlay = {
     url = "github:oxalica/rust-overlay";
     inputs.nixpkgs.follows = "nixpkgs";
   };
 
-  outputs = { self, nixpkgs, rust-overlay }:
+  outputs =
+    {
+      self,
+      nixpkgs,
+      rust-overlay,
+    }:
     let
-      pkgs = import nixpkgs { system = "x86_64-linux"; overlays = [ (import rust-overlay) ]; };
+      pkgs = import nixpkgs {
+        system = "x86_64-linux";
+        overlays = [ (import rust-overlay) ];
+      };
 
       rust = pkgs.rust-bin.stable."1.66.0".default.override {
         extensions = [ "rust-src" ];
@@ -25,7 +33,7 @@
         version = "0.0.0";
 
         src = self;
-        cargoLock = { 
+        cargoLock = {
           lockFile = ./Cargo.lock;
           outputHashes = {
             "stm32-eth-0.2.0" = "sha256-48RpZgagUqgVeKm7GXdk3Oo0v19ScF9Uby0nTFlve2o=";
@@ -49,9 +57,23 @@
         dontFixup = true;
         auditable = false;
       };
-    in {
+
+      pythermostat = pkgs.python3Packages.buildPythonPackage {
+        pname = "pythermostat";
+        version = "0.0.0";
+        format = "pyproject";
+        src = "${self}/pythermostat";
+
+        propagatedBuildInputs =
+          with pkgs.python3Packages; [
+            numpy
+            matplotlib
+          ];
+      };
+    in
+    {
       packages.x86_64-linux = {
-        inherit thermostat;
+        inherit thermostat pythermostat;
         default = thermostat;
       };
 
@@ -61,12 +83,21 @@
 
       devShells.x86_64-linux.default = pkgs.mkShellNoCC {
         name = "thermostat-dev-shell";
-        packages = with pkgs; [
+        packages =
-          rust llvm
+          with pkgs;
-          openocd dfu-util rlwrap
+          [
-          ] ++ (with python3Packages; [
+            rust
-            numpy matplotlib
+            llvm
+            openocd
+            dfu-util
+            rlwrap
+          ]
+          ++ (with python3Packages; [
+            numpy
+            matplotlib
           ]);
       };
+
+      formatter.x86_64-linux = nixpkgs.legacyPackages.x86_64-linux.nixfmt-rfc-style;
     };
-}
+}

pytec/example.py

@@ -1,11 +0,0 @@
-from pytec.client import Client
-
-tec = Client() #(host="localhost", port=6667)
-tec.set_param("s-h", 1, "t0", 20)
-print(tec.get_output())
-print(tec.get_pid())
-print(tec.get_output())
-print(tec.get_postfilter())
-print(tec.get_steinhart_hart())
-for data in tec.report_mode():
-    print(data)

pytec/plot.py

@@ -1,128 +0,0 @@
-import numpy as np
-import matplotlib.pyplot as plt
-import matplotlib.animation as animation
-from threading import Thread, Lock
-from pytec.client import Client
-
-TIME_WINDOW = 300.0
-
-tec = Client()
-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
-        self.x_data = []
-        self.y_data = []
-
-    def append(self, x, y):
-        self.x_data.append(x)
-        self.y_data.append(self.conv(y))
-
-    def clip(self, min_x):
-        drop = 0
-        while drop < len(self.x_data) and self.x_data[drop] < min_x:
-            drop += 1
-        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(),
-    # 'i_set': Series(),
-    'pid_output': Series(),
-    # 'vref': Series(),
-    # 'dac_value': Series(),
-    # 'dac_feedback': Series(),
-    # 'i_tec': 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():
-        ch0 = data[0]
-        series_lock.acquire()
-        try:
-            for k, s in series.items():
-                if k in ch0:
-                    v = ch0[k]
-                    if type(v) is float:
-                        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)
-legend = ax.legend()
-
-def animate(i):
-    min_x, max_x, min_y, max_y = None, None, None, None
-    
-    series_lock.acquire()
-    try:
-        for k, s in series.items():
-            s.plot.set_data(s.x_data, s.y_data)
-            if len(s.y_data) > 0:
-                s.plot.set_label("{}: {:.3f}".format(k, s.y_data[-1]))
-
-            if len(s.x_data) > 0:
-                min_x_ = min(s.x_data)
-                if min_x is None:
-                    min_x = min_x_
-                else:
-                    min_x = min(min_x, min_x_)
-                max_x_ = max(s.x_data)
-                if max_x is None:
-                    max_x = max_x_
-                else:
-                    max_x = max(max_x, max_x_)
-            if len(s.y_data) > 0:
-                min_y_ = min(s.y_data)
-                if min_y is None:
-                    min_y = min_y_
-                else:
-                    min_y = min(min_y, min_y_)
-                max_y_ = max(s.y_data)
-                if max_y is None:
-                    max_y = max_y_
-                else:
-                    max_y = max(max_y, max_y_)
-
-        if min_x and max_x - TIME_WINDOW > min_x:
-            for s in series.values():
-                s.clip(max_x - TIME_WINDOW)
-    finally:
-        series_lock.release()
-
-    if min_x != max_x:
-        ax.set_xlim(min_x, max_x)
-    if min_y != max_y:
-        margin_y = 0.01 * (max_y - min_y)
-        ax.set_ylim(min_y - margin_y, max_y + margin_y)
-
-    global legend
-    legend.remove()
-    legend = ax.legend()
-
-ani = animation.FuncAnimation(
-    fig, animate, interval=1, blit=False, save_count=50)
-
-plt.show()
-quit = True
-thread.join()

pytec/setup.py

@@ -1,12 +0,0 @@
-from setuptools import setup, find_packages
-
-setup(
-    name="pytec",
-    version="0.0",
-    author="M-Labs",
-    url="https://git.m-labs.hk/M-Labs/thermostat",
-    description="Control TEC",
-    license="GPLv3",
-    install_requires=["setuptools"],
-    packages=find_packages(),
-)

pythermostat/example.py

@@ -0,0 +1,13 @@
+import time
+from pythermostat.client import Client
+
+tec = Client() #(host="localhost", port=6667)
+tec.set_param("b-p", 1, "t0", 20)
+print(tec.get_output())
+print(tec.get_pid())
+print(tec.get_output())
+print(tec.get_postfilter())
+print(tec.get_b_parameter())
+while True:
+    print(tec.get_report())
+    time.sleep(0.05)

pythermostat/pyproject.toml

@@ -0,0 +1,18 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pythermostat"
+version = "0.0"
+authors = [{name = "M-Labs"}]
+description = "Python utilities for the Sinara 8451 Thermostat"
+urls.Repository = "https://git.m-labs.hk/M-Labs/thermostat"
+license = {text = "GPLv3"}
+
+[project.gui-scripts]
+thermostat_plot = "pythermostat.plot:main"
+
+[project.scripts]
+thermostat_autotune = "pythermostat.autotune:main"
+thermostat_test = "pythermostat.test:main"

pythermostat/pythermostat/autotune.py

@@ -1,9 +1,10 @@
 import math
 import logging
+import time
 from collections import deque, namedtuple
 from enum import Enum
 
-from pytec.client import Client
+from pythermostat.client import Client
 
 # Based on hirshmann pid-autotune libiary
 # See https://github.com/hirschmann/pid-autotune
@@ -236,13 +237,14 @@ def main():
 
     tec = Client()
 
-    data = next(tec.report_mode())
+    data = tec.get_report()
     ch = data[channel]
 
     tuner = PIDAutotune(target_temperature, output_step,
                         lookback, noiseband, ch['interval'])
 
-    for data in tec.report_mode():
+    while True:
+        data = tec.get_report()
 
         ch = data[channel]
 
@@ -255,6 +257,8 @@ def main():
 
         tec.set_param("output", channel, "i_set", tuner_out)
 
+        time.sleep(0.05)
+
     tec.set_param("output", channel, "i_set", 0)
 
 

pythermostat/pythermostat/client.py

@@ -1,7 +1,7 @@
 import socket
 import json
 import logging
-import time
+
 
 class CommandError(Exception):
     pass
@@ -12,6 +12,10 @@ class Client:
         self._lines = [""]
         self._check_zero_limits()
 
+    def disconnect(self):
+        self._socket.shutdown(socket.SHUT_RDWR)
+        self._socket.close()
+
     def _check_zero_limits(self):
         output_report = self.get_output()
         for output_channel in output_report:
@@ -92,14 +96,14 @@ class Client:
         """
         return self._get_conf("pid")
 
-    def get_steinhart_hart(self):
+    def get_b_parameter(self):
-        """Retrieve Steinhart-Hart parameters for resistance to temperature conversion
+        """Retrieve B-Parameter equation parameters for resistance to temperature conversion
 
         Example::
             [{'params': {'b': 3800.0, 'r0': 10000.0, 't0': 298.15}, 'channel': 0},
              {'params': {'b': 3800.0, 'r0': 10000.0, 't0': 298.15}, 'channel': 1}]
         """
-        return self._get_conf("s-h")
+        return self._get_conf("b-p")
 
     def get_postfilter(self):
         """Retrieve DAC postfilter configuration
@@ -110,18 +114,18 @@ class Client:
         """
         return self._get_conf("postfilter")
 
-    def report_mode(self):
+    def get_report(self):
-        """Start reporting measurement values
+        """Obtain one-time report on measurement values
 
         Example of yielded data::
             {'channel': 0,
              'time': 2302524,
+             'interval': 0.12
              'adc': 0.6199188965423515,
              'sens': 6138.519310282602,
              'temperature': 36.87032392655527,
              'pid_engaged': True,
              'i_set': 2.0635816680889123,
-             'vref': 1.494,
              'dac_value': 2.527790834044456,
              'dac_feedback': 2.523,
              'i_tec': 2.331,
@@ -129,16 +133,19 @@ class Client:
              'tec_u_meas': 2.5340000000000003,
              'pid_output': 2.067581958092247}
         """
-        while True:
+        return self._get_conf("report")
-            self._socket.sendall("report\n".encode('utf-8'))
+
-            line = self._read_line()
+    def get_ipv4(self):
-            if not line:
+        """Get the IPv4 settings of the Thermostat"""
-                break
+        return self._command("ipv4")
-            try:
+
-                yield json.loads(line)
+    def get_fan(self):
-            except json.decoder.JSONDecodeError:
+        """Get Thermostat current fan settings"""
-                pass
+        return self._command("fan")
-            time.sleep(0.05)
+
+    def get_hwrev(self):
+        """Get Thermostat hardware revision"""
+        return self._command("hwrev")
 
     def set_param(self, topic, channel, field="", value=""):
         """Set configuration parameters
@@ -146,7 +153,7 @@ class Client:
         Examples::
             tec.set_param("output", 0, "max_v", 2.0)
             tec.set_param("pid", 1, "output_max", 2.5)
-            tec.set_param("s-h", 0, "t0", 20.0)
+            tec.set_param("b-p", 0, "t0", 20.0)
             tec.set_param("center", 0, "vref")
             tec.set_param("postfilter", 1, 21)
 
@@ -163,10 +170,38 @@ class Client:
         self.set_param("pid", channel, "target", value=target)
         self.set_param("output", channel, "pid")
 
-    def save_config(self):
+    def save_config(self, channel=""):
         """Save current configuration to EEPROM"""
-        self._command("save")
+        self._command("save", channel)
+        if channel != "":
+            self._read_line()  # read the extra {}
 
-    def load_config(self):
+    def load_config(self, channel=""):
         """Load current configuration from EEPROM"""
-        self._command("load")
+        self._command("load", channel)
+        if channel != "":
+            self._read_line()  # read the extra {}
+
+    def reset(self):
+        """Reset the device"""
+        self._socket.sendall("reset".encode("utf-8"))
+        self.disconnect()  # resetting ends the TCP session, disconnect anyway
+
+    def enter_dfu_mode(self):
+        """Reset device and enters USB device firmware update (DFU) mode"""
+        self._socket.sendall("dfu".encode("utf-8"))
+        self.disconnect()  # resetting ends the TCP session, disconnect anyway
+
+    def set_ipv4(self, address, netmask, gateway=""):
+        """Configure IPv4 address, netmask length, and optional default gateway"""
+        self._command("ipv4", f"{address}/{netmask}", gateway)
+
+    def set_fan(self, power=None):
+        """Set fan power with values from 1 to 100. If omitted, set according to fcurve"""
+        if power is None:
+            power = "auto"
+        self._command("fan", power)
+
+    def set_fcurve(self, a=1.0, b=0.0, c=0.0):
+        """Set fan controller curve coefficients"""
+        self._command("fcurve", a, b, c)

pythermostat/pythermostat/plot.py

@@ -0,0 +1,137 @@
+import time
+import numpy as np
+import matplotlib.pyplot as plt
+import matplotlib.animation as animation
+from threading import Thread, Lock
+from pythermostat.client import Client
+
+
+def main():
+    TIME_WINDOW = 300.0
+
+    tec = Client()
+    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
+            self.x_data = []
+            self.y_data = []
+
+        def append(self, x, y):
+            self.x_data.append(x)
+            self.y_data.append(self.conv(y))
+
+        def clip(self, min_x):
+            drop = 0
+            while drop < len(self.x_data) and self.x_data[drop] < min_x:
+                drop += 1
+            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(),
+        # 'i_set': Series(),
+        'pid_output': Series(),
+        # 'vref': Series(),
+        # 'dac_value': Series(),
+        # 'dac_feedback': Series(),
+        # 'i_tec': Series(),
+        'tec_i': Series(),
+        'tec_u_meas': Series(),
+        # 'interval': Series(),
+    }
+    series_lock = Lock()
+
+    quit = False
+
+    def recv_data(tec):
+        global last_packet_time
+        while True:
+            data = tec.get_report()
+            ch0 = data[0]
+            series_lock.acquire()
+            try:
+                for k, s in series.items():
+                    if k in ch0:
+                        v = ch0[k]
+                        if type(v) is float:
+                            s.append(ch0['time'], v)
+            finally:
+                series_lock.release()
+
+            if quit:
+                break
+            time.sleep(0.05)
+
+    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)
+    legend = ax.legend()
+
+    def animate(i):
+        min_x, max_x, min_y, max_y = None, None, None, None
+        
+        series_lock.acquire()
+        try:
+            for k, s in series.items():
+                s.plot.set_data(s.x_data, s.y_data)
+                if len(s.y_data) > 0:
+                    s.plot.set_label("{}: {:.3f}".format(k, s.y_data[-1]))
+
+                if len(s.x_data) > 0:
+                    min_x_ = min(s.x_data)
+                    if min_x is None:
+                        min_x = min_x_
+                    else:
+                        min_x = min(min_x, min_x_)
+                    max_x_ = max(s.x_data)
+                    if max_x is None:
+                        max_x = max_x_
+                    else:
+                        max_x = max(max_x, max_x_)
+                if len(s.y_data) > 0:
+                    min_y_ = min(s.y_data)
+                    if min_y is None:
+                        min_y = min_y_
+                    else:
+                        min_y = min(min_y, min_y_)
+                    max_y_ = max(s.y_data)
+                    if max_y is None:
+                        max_y = max_y_
+                    else:
+                        max_y = max(max_y, max_y_)
+
+            if min_x and max_x - TIME_WINDOW > min_x:
+                for s in series.values():
+                    s.clip(max_x - TIME_WINDOW)
+        finally:
+            series_lock.release()
+
+        if min_x != max_x:
+            ax.set_xlim(min_x, max_x)
+        if min_y != max_y:
+            margin_y = 0.01 * (max_y - min_y)
+            ax.set_ylim(min_y - margin_y, max_y + margin_y)
+
+        nonlocal legend
+        legend.remove()
+        legend = ax.legend()
+
+    ani = animation.FuncAnimation(
+        fig, animate, interval=1, blit=False, save_count=50)
+
+    plt.show()
+    quit = True
+    thread.join()
+
+
+if __name__ == "__main__":
+    main()

pythermostat/pythermostat/test.py

@@ -0,0 +1,81 @@
+import argparse
+from contextlib import contextmanager
+from pythermostat.client import Client
+
+
+CHANNELS = 2
+
+
+def get_argparser():
+    parser = argparse.ArgumentParser(description="Thermostat hardware testing script")
+
+    parser.add_argument("host", metavar="HOST", default="192.168.1.26", nargs="?")
+    parser.add_argument("port", metavar="PORT", default=23, nargs="?")
+    parser.add_argument(
+        "-r",
+        "--testing_resistance",
+        default=10_000,
+        help="Testing resistance value through SENS pin in Ohms",
+    )
+    parser.add_argument(
+        "-d",
+        "--deviation",
+        default=1,
+        help="Allowed deviation of resistance in percentage",
+    )
+
+    return parser
+
+
+def main():
+    args = get_argparser().parse_args()
+
+    min_allowed_resistance = args.testing_resistance * (1 - args.deviation / 100)
+    max_allowed_resistance = args.testing_resistance * (1 + args.deviation / 100)
+
+    print(min_allowed_resistance, max_allowed_resistance)
+
+    thermostat = Client(args.host, args.port)
+    for channel in range(CHANNELS):
+        print(f"Channel {channel} is active")
+
+        print("Checking resistance through SENS input ....", end=" ")
+        sens_resistance = thermostat.get_report()[channel]["sens"]
+        if sens_resistance is not None:
+            print(sens_resistance, "Ω")
+            if min_allowed_resistance <= sens_resistance <= max_allowed_resistance:
+                print("PASSED")
+            else:
+                print("FAILED")
+        else:
+            print("Floating SENS input! Is the channel connected?")
+
+        with preserve_thermostat_output_settings(thermostat, channel):
+            test_output_settings = {
+                "max_i_pos": 2,
+                "max_i_neg": 2,
+                "max_v": 4,
+                "i_set": 0.1,
+                "polarity": "normal",
+            }
+            for field, value in test_output_settings.items():
+                thermostat.set_param("output", channel, field, value)
+
+            input(f"Check if channel {channel} current = 0.1 A, and press ENTER...")
+
+        input(f"Channel {channel} testing done, press ENTER to continue.")
+        print()
+
+    print("Testing complete.")
+
+
+@contextmanager
+def preserve_thermostat_output_settings(client, channel):
+    original_output_settings = client.get_output()[channel]
+    yield original_output_settings
+    for setting in "max_i_pos", "max_i_neg", "max_v", "i_set", "polarity":
+        client.set_param("output", channel, setting, original_output_settings[setting])
+
+
+if __name__ == "__main__":
+    main()

src/b_parameter.rs

@@ -8,14 +8,14 @@ use uom::si::{
     thermodynamic_temperature::{degree_celsius, kelvin},
 };
 
-/// Steinhart-Hart equation parameters
+/// B-Parameter equation parameters
 #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 pub struct Parameters {
     /// Base temperature
     pub t0: ThermodynamicTemperature,
-    /// Resistance at base temperature
+    /// Thermistor resistance at base temperature
     pub r0: ElectricalResistance,
-    /// Beta
+    /// Beta (average slope of the function ln R vs. 1/T)
     pub b: TemperatureInterval,
 }
 

src/channel_state.rs

@@ -1,8 +1,8 @@
 use crate::{
-    ad7172,
+    ad7172, b_parameter as bp,
     command_parser::{CenterPoint, Polarity},
     config::PwmLimits,
-    pid, steinhart_hart as sh,
+    pid,
 };
 use num_traits::Zero;
 use smoltcp::time::{Duration, Instant};
@@ -32,7 +32,7 @@ pub struct ChannelState {
     pub pwm_limits: PwmLimits,
     pub pid_engaged: bool,
     pub pid: pid::Controller,
-    pub sh: sh::Parameters,
+    pub bp: bp::Parameters,
     pub polarity: Polarity,
 }
 
@@ -54,7 +54,7 @@ impl ChannelState {
             },
             pid_engaged: false,
             pid: pid::Controller::new(pid::Parameters::default()),
-            sh: sh::Parameters::default(),
+            bp: bp::Parameters::default(),
             polarity: Polarity::Normal,
         }
     }
@@ -100,7 +100,7 @@ impl ChannelState {
 
     pub fn get_temperature(&self) -> Option<ThermodynamicTemperature> {
         let r = self.get_sens()?;
-        let temperature = self.sh.get_temperature(r);
+        let temperature = self.bp.get_temperature(r);
         Some(temperature)
     }
 }

src/channels.rs

@@ -1,12 +1,11 @@
 use crate::timer::sleep;
 use crate::{
-    ad5680, ad7172,
+    ad5680, ad7172, b_parameter,
     channel::{Channel, Channel0, Channel1},
     channel_state::ChannelState,
     command_handler::JsonBuffer,
     command_parser::{CenterPoint, Polarity, PwmPin},
     pins::{self, Channel0VRef, Channel1VRef},
-    steinhart_hart,
 };
 use core::marker::PhantomData;
 use heapless::{consts::U2, Vec};
@@ -558,17 +557,17 @@ impl Channels {
         serde_json_core::to_vec(&summaries)
     }
 
-    fn steinhart_hart_summary(&mut self, channel: usize) -> SteinhartHartSummary {
+    fn b_parameter_summary(&mut self, channel: usize) -> BParameterSummary {
-        let params = self.channel_state(channel).sh.clone();
+        let params = self.channel_state(channel).bp.clone();
-        SteinhartHartSummary { channel, params }
+        BParameterSummary { channel, params }
     }
 
-    pub fn steinhart_hart_summaries_json(
+    pub fn b_parameter_summaries_json(
         &mut self,
     ) -> Result<JsonBuffer, serde_json_core::ser::Error> {
         let mut summaries = Vec::<_, U2>::new();
         for channel in 0..CHANNELS {
-            let _ = summaries.push(self.steinhart_hart_summary(channel));
+            let _ = summaries.push(self.b_parameter_summary(channel));
         }
         serde_json_core::to_vec(&summaries)
     }
@@ -647,7 +646,7 @@ pub struct PostFilterSummary {
 }
 
 #[derive(Serialize)]
-pub struct SteinhartHartSummary {
+pub struct BParameterSummary {
     channel: usize,
-    params: steinhart_hart::Parameters,
+    params: b_parameter::Parameters,
 }

src/command_handler.rs

@@ -2,7 +2,7 @@ use super::{
     ad7172,
     channels::{Channels, CHANNELS},
     command_parser::{
-        CenterPoint, Command, Ipv4Config, PidParameter, Polarity, PwmPin, ShParameter, ShowCommand,
+        BpParameter, CenterPoint, Command, Ipv4Config, PidParameter, Polarity, PwmPin, ShowCommand,
     },
     config::ChannelConfig,
     dfu,
@@ -113,16 +113,13 @@ impl Handler {
         Ok(Handler::Handled)
     }
 
-    fn show_steinhart_hart(
+    fn show_b_parameter(socket: &mut TcpSocket, channels: &mut Channels) -> Result<Handler, Error> {
-        socket: &mut TcpSocket,
+        match channels.b_parameter_summaries_json() {
-        channels: &mut Channels,
-    ) -> Result<Handler, Error> {
-        match channels.steinhart_hart_summaries_json() {
             Ok(buf) => {
                 send_line(socket, &buf);
             }
             Err(e) => {
-                error!("unable to serialize steinhart-hart summaries: {:?}", e);
+                error!("unable to serialize b parameter summaries: {:?}", e);
                 let _ = writeln!(socket, "{{\"error\":\"{:?}\"}}", e);
                 return Err(Error::Report);
             }
@@ -241,19 +238,19 @@ impl Handler {
         Ok(Handler::Handled)
     }
 
-    fn set_steinhart_hart(
+    fn set_b_parameter(
         socket: &mut TcpSocket,
         channels: &mut Channels,
         channel: usize,
-        parameter: ShParameter,
+        parameter: BpParameter,
         value: f64,
     ) -> Result<Handler, Error> {
-        let sh = &mut channels.channel_state(channel).sh;
+        let bp = &mut channels.channel_state(channel).bp;
-        use super::command_parser::ShParameter::*;
+        use super::command_parser::BpParameter::*;
         match parameter {
-            T0 => sh.t0 = ThermodynamicTemperature::new::<degree_celsius>(value),
+            T0 => bp.t0 = ThermodynamicTemperature::new::<degree_celsius>(value),
-            B => sh.b = TemperatureInterval::new::<kelvin>(value),
+            B => bp.b = TemperatureInterval::new::<kelvin>(value),
-            R0 => sh.r0 = ElectricalResistance::new::<ohm>(value),
+            R0 => bp.r0 = ElectricalResistance::new::<ohm>(value),
         }
         send_line(socket, b"{}");
         Ok(Handler::Handled)
@@ -480,9 +477,7 @@ impl Handler {
             Command::Show(ShowCommand::Input) => Handler::show_report(socket, channels),
             Command::Show(ShowCommand::Pid) => Handler::show_pid(socket, channels),
             Command::Show(ShowCommand::Output) => Handler::show_pwm(socket, channels),
-            Command::Show(ShowCommand::SteinhartHart) => {
+            Command::Show(ShowCommand::BParameter) => Handler::show_b_parameter(socket, channels),
-                Handler::show_steinhart_hart(socket, channels)
-            }
             Command::Show(ShowCommand::PostFilter) => Handler::show_post_filter(socket, channels),
             Command::Show(ShowCommand::Ipv4) => Handler::show_ipv4(socket, ipv4_config),
             Command::OutputPid { channel } => Handler::engage_pid(socket, channels, channel),
@@ -502,11 +497,11 @@ impl Handler {
                 parameter,
                 value,
             } => Handler::set_pid(socket, channels, channel, parameter, value),
-            Command::SteinhartHart {
+            Command::BParameter {
                 channel,
                 parameter,
                 value,
-            } => Handler::set_steinhart_hart(socket, channels, channel, parameter, value),
+            } => Handler::set_b_parameter(socket, channels, channel, parameter, value),
             Command::PostFilter {
                 channel,
                 rate: None,

src/command_parser.rs

@@ -93,7 +93,7 @@ pub enum ShowCommand {
     Input,
     Output,
     Pid,
-    SteinhartHart,
+    BParameter,
     PostFilter,
     Ipv4,
 }
@@ -108,9 +108,9 @@ pub enum PidParameter {
     OutputMax,
 }
 
-/// Steinhart-Hart equation parameter
+/// B-Parameter equation parameter
 #[derive(Debug, Clone, PartialEq)]
-pub enum ShParameter {
+pub enum BpParameter {
     T0,
     B,
     R0,
@@ -172,9 +172,9 @@ pub enum Command {
         parameter: PidParameter,
         value: f64,
     },
-    SteinhartHart {
+    BParameter {
         channel: usize,
-        parameter: ShParameter,
+        parameter: BpParameter,
         value: f64,
     },
     PostFilter {
@@ -366,18 +366,18 @@ fn pid(input: &[u8]) -> IResult<&[u8], Result<Command, Error>> {
     ))(input)
 }
 
-/// `s-h <0-1> <parameter> <value>`
+/// `b-p <0-1> <parameter> <value>`
-fn steinhart_hart_parameter(input: &[u8]) -> IResult<&[u8], Result<Command, Error>> {
+fn b_parameter_parameter(input: &[u8]) -> IResult<&[u8], Result<Command, Error>> {
     let (input, channel) = channel(input)?;
     let (input, _) = whitespace(input)?;
     let (input, parameter) = alt((
-        value(ShParameter::T0, tag("t0")),
+        value(BpParameter::T0, tag("t0")),
-        value(ShParameter::B, tag("b")),
+        value(BpParameter::B, tag("b")),
-        value(ShParameter::R0, tag("r0")),
+        value(BpParameter::R0, tag("r0")),
     ))(input)?;
     let (input, _) = whitespace(input)?;
     let (input, value) = float(input)?;
-    let result = value.map(|value| Command::SteinhartHart {
+    let result = value.map(|value| Command::BParameter {
         channel,
         parameter,
         value,
@@ -385,12 +385,12 @@ fn steinhart_hart_parameter(input: &[u8]) -> IResult<&[u8], Result<Command, Erro
     Ok((input, result))
 }
 
-/// `s-h` | `s-h <steinhart_hart_parameter>`
+/// `b-p` | `b-p <b_parameter_parameter>`
-fn steinhart_hart(input: &[u8]) -> IResult<&[u8], Result<Command, Error>> {
+fn b_parameter(input: &[u8]) -> IResult<&[u8], Result<Command, Error>> {
-    let (input, _) = tag("s-h")(input)?;
+    let (input, _) = tag("b-p")(input)?;
     alt((
-        preceded(whitespace, steinhart_hart_parameter),
+        preceded(whitespace, b_parameter_parameter),
-        value(Ok(Command::Show(ShowCommand::SteinhartHart)), end),
+        value(Ok(Command::Show(ShowCommand::BParameter)), end),
     ))(input)
 }
 
@@ -572,7 +572,7 @@ fn command(input: &[u8]) -> IResult<&[u8], Result<Command, Error>> {
         output,
         center_point,
         pid,
-        steinhart_hart,
+        b_parameter,
         postfilter,
         value(Ok(Command::Dfu), tag("dfu")),
         fan,
@@ -678,7 +678,7 @@ mod test {
 
     #[test]
     fn parse_output_polarity() {
-        let command = Command::parse(b"pwm 0 polarity reversed");
+        let command = Command::parse(b"output 0 polarity reversed");
         assert_eq!(
             command,
             Ok(Command::OutputPolarity {
@@ -753,19 +753,19 @@ mod test {
     }
 
     #[test]
-    fn parse_steinhart_hart() {
+    fn parse_b_parameter() {
-        let command = Command::parse(b"s-h");
+        let command = Command::parse(b"b-p");
-        assert_eq!(command, Ok(Command::Show(ShowCommand::SteinhartHart)));
+        assert_eq!(command, Ok(Command::Show(ShowCommand::BParameter)));
     }
 
     #[test]
-    fn parse_steinhart_hart_set() {
+    fn parse_b_parameter_set() {
-        let command = Command::parse(b"s-h 1 t0 23.05");
+        let command = Command::parse(b"b-p 1 t0 23.05");
         assert_eq!(
             command,
-            Ok(Command::SteinhartHart {
+            Ok(Command::BParameter {
                 channel: 1,
-                parameter: ShParameter::T0,
+                parameter: BpParameter::T0,
                 value: 23.05,
             })
         );

src/config.rs

@@ -1,8 +1,9 @@
 use crate::{
     ad7172::PostFilter,
+    b_parameter,
     channels::Channels,
     command_parser::{CenterPoint, Polarity},
-    pid, steinhart_hart,
+    pid,
 };
 use num_traits::Zero;
 use serde::{Deserialize, Serialize};
@@ -16,7 +17,7 @@ pub struct ChannelConfig {
     pid_engaged: bool,
     i_set: ElectricCurrent,
     polarity: Polarity,
-    sh: steinhart_hart::Parameters,
+    bp: b_parameter::Parameters,
     pwm: PwmLimits,
     /// uses variant `PostFilter::Invalid` instead of `None` to save space
     adc_postfilter: PostFilter,
@@ -45,7 +46,7 @@ impl ChannelConfig {
             pid_engaged: state.pid_engaged,
             i_set,
             polarity: state.polarity.clone(),
-            sh: state.sh.clone(),
+            bp: state.bp.clone(),
             pwm,
             adc_postfilter,
         }
@@ -57,7 +58,7 @@ impl ChannelConfig {
         state.pid.parameters = self.pid.clone();
         state.pid.target = self.pid_target.into();
         state.pid_engaged = self.pid_engaged;
-        state.sh = self.sh.clone();
+        state.bp = self.bp.clone();
 
         self.pwm.apply(channels, channel);
 

src/main.rs

@@ -35,9 +35,9 @@ mod session;
 use session::{Session, SessionInput};
 mod command_parser;
 use command_parser::Ipv4Config;
+mod b_parameter;
 mod channels;
 mod pid;
-mod steinhart_hart;
 mod timer;
 use channels::{Channels, CHANNELS};
 mod channel;
@@ -107,8 +107,8 @@ fn main() -> ! {
         .use_hse(HSE)
         .sysclk(168.mhz())
         .hclk(168.mhz())
-        .pclk1(42.mhz())
+        .pclk1(32.mhz())
-        .pclk2(84.mhz())
+        .pclk2(64.mhz())
         .freeze();
 
     let mut wd = IndependentWatchdog::new(dp.IWDG);