flake: Add pytec runnables to devShell

Makes it possible to directly run `autotune`, `plot` and `test` in the
devShell.

README.md

@@ -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

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/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/autotune.py
 ```
 
 After some time, the auto tuning utility will output the auto tuning results, below is a sample output

flake.nix

@@ -58,21 +58,33 @@
         auditable = false;
       };
 
-      pytec = pkgs.python3Packages.buildPythonPackage {
-        pname = "pytec";
+      pythermostat = pkgs.python3Packages.buildPythonPackage {
+        pname = "pythermostat";
         version = "0.0.0";
-        src = "${self}/pytec";
+        src = "${self}/pythermostat";
 
-        propagatedBuildInputs =
-          with pkgs.python3Packages; [
-            numpy
-            matplotlib
-          ];
+        propagatedBuildInputs = with pkgs.python3Packages; [
+          numpy
+          matplotlib
+        ];
       };
+
+      pythermostat-dev-wrappers = pkgs.runCommandNoCC "pythermostat-dev-wrappers" { } ''
+        mkdir -p $out/bin
+        for program in ${self}/pythermostat/*.py; do
+          if [ -x $program ]; then
+            progname=`basename -s .py $program`
+            outname=$out/bin/$progname
+            echo "#!${pkgs.bash}/bin/bash" >> $outname
+            echo "exec python3 -m $progname \"\$@\"" >> $outname
+            chmod 755 $outname
+          fi
+        done
+      '';
     in
     {
       packages.x86_64-linux = {
-        inherit thermostat pytec;
+        inherit thermostat pythermostat;
         default = thermostat;
       };
 
@@ -90,11 +102,15 @@
             openocd
             dfu-util
             rlwrap
+            pythermostat-dev-wrappers
           ]
           ++ (with python3Packages; [
             numpy
             matplotlib
           ]);
+        shellHook = ''
+          export PYTHONPATH=`git rev-parse --show-toplevel`/pythermostat:$PYTHONPATH
+        '';
       };
 
       formatter.x86_64-linux = nixpkgs.legacyPackages.x86_64-linux.nixfmt-rfc-style;

pythermostat/autotune.py

@@ -3,7 +3,7 @@ import logging
 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

pythermostat/example.py

@@ -1,5 +1,5 @@
 import time
-from pytec.client import Client
+from pythermostat.client import Client
 
 tec = Client() #(host="localhost", port=6667)
 tec.set_param("b-p", 1, "t0", 20)

pythermostat/plot.py

@@ -1,8 +1,9 @@
+import time
 import numpy as np
 import matplotlib.pyplot as plt
 import matplotlib.animation as animation
 from threading import Thread, Lock
-from pytec.client import Client
+from pythermostat.client import Client
 
 TIME_WINDOW = 300.0
 
@@ -47,7 +48,8 @@ quit = False
 
 def recv_data(tec):
     global last_packet_time
-    for data in tec.report_mode():
+    while True:
+        data = tec.get_report()
         ch0 = data[0]
         series_lock.acquire()
         try:
@@ -61,6 +63,7 @@ def recv_data(tec):
 
         if quit:
             break
+        time.sleep(0.05)
 
 thread = Thread(target=recv_data, args=(tec,))
 thread.start()

pythermostat/setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 
 setup(
-    name="pytec",
+    name="pythermostat",
     version="0.0",
     author="M-Labs",
     url="https://git.m-labs.hk/M-Labs/thermostat",

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()