flake: update nixpkgs

Following ARTIQ. Now needs `nix fmt .` instead of just `nix fmt`.

.gitignore

@@ -1,2 +1,5 @@
 target/
 result
+*.bin
+
+__pycache__/

Cargo.lock

@@ -99,15 +99,15 @@ dependencies = [
  "aligned",
  "bare-metal 0.2.5",
  "bitfield",
- "cortex-m 0.7.4",
+ "cortex-m 0.7.7",
  "volatile-register",
 ]
 
 [[package]]
 name = "cortex-m"
-version = "0.7.4"
+version = "0.7.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "37ff967e867ca14eba0c34ac25cd71ea98c678e741e3915d923999bb2fe7c826"
+checksum = "8ec610d8f49840a5b376c69663b6369e71f4b34484b9b2eb29fb918d92516cb9"
 dependencies = [
  "bare-metal 0.2.5",
  "bitfield",
@@ -173,7 +173,7 @@ version = "0.3.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "6bffa6c1454368a6aa4811ae60964c38e6996d397ff8095a8b9211b1c1f749bc"
 dependencies = [
- "cortex-m 0.7.4",
+ "cortex-m 0.6.7",
 ]
 
 [[package]]
@@ -306,6 +306,28 @@ dependencies = [
  "version_check",
 ]
 
+[[package]]
+name = "num-bigint"
+version = "0.4.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "608e7659b5c3d7cba262d894801b9ec9d00de989e8a82bd4bef91d08da45cdc0"
+dependencies = [
+ "autocfg",
+ "num-integer",
+ "num-traits",
+ "serde",
+]
+
+[[package]]
+name = "num-complex"
+version = "0.4.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "73f88a1307638156682bada9d7604135552957b7818057dcef22705b4d509495"
+dependencies = [
+ "num-traits",
+ "serde",
+]
+
 [[package]]
 name = "num-integer"
 version = "0.1.44"
@@ -317,10 +339,21 @@ dependencies = [
 ]
 
 [[package]]
-name = "num-traits"
-version = "0.2.14"
+name = "num-rational"
+version = "0.4.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9a64b1ec5cda2586e284722486d802acf1f7dbdc623e2bfc57e65ca1cd099290"
+checksum = "f83d14da390562dca69fc84082e73e548e1ad308d24accdedd2720017cb37824"
+dependencies = [
+ "num-integer",
+ "num-traits",
+ "serde",
+]
+
+[[package]]
+name = "num-traits"
+version = "0.2.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841"
 dependencies = [
  "autocfg",
  "libm",
@@ -328,9 +361,9 @@ dependencies = [
 
 [[package]]
 name = "panic-halt"
-version = "0.2.0"
+version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "de96540e0ebde571dc55c73d60ef407c653844e6f9a1e2fdbd40c07b9252d812"
+checksum = "a513e167849a384b7f9b746e517604398518590a9142f4846a32e3c2a4de7b11"
 
 [[package]]
 name = "panic-semihosting"
@@ -338,7 +371,7 @@ version = "0.5.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "c3d55dedd501dfd02514646e0af4d7016ce36bc12ae177ef52056989966a1eec"
 dependencies = [
- "cortex-m 0.7.4",
+ "cortex-m 0.6.7",
  "cortex-m-semihosting",
 ]
 
@@ -487,7 +520,7 @@ version = "0.2.0"
 source = "git+https://github.com/stm32-rs/stm32-eth.git?rev=3759c5c9#3759c5c99c0ab69bb71759030766bc0fba0b6cde"
 dependencies = [
  "aligned",
- "cortex-m 0.7.4",
+ "cortex-m 0.7.7",
  "smoltcp",
  "stm32f4xx-hal",
  "volatile-register",
@@ -500,7 +533,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "da3d56009c8f32e4f208dbea17df72484154d1040a8969b75d8c73eb7b18fe8f"
 dependencies = [
  "bare-metal 0.2.5",
- "cortex-m 0.7.4",
+ "cortex-m 0.6.7",
  "cortex-m-rt 0.6.13",
  "vcell",
 ]
@@ -513,7 +546,7 @@ checksum = "3a06fde2dd27c0ba934c9e69b62af66eb1c20dbb6d741b187a763912e9892d13"
 dependencies = [
  "bare-metal 1.0.0",
  "cast",
- "cortex-m 0.7.4",
+ "cortex-m 0.7.7",
  "cortex-m-rt 0.7.1",
  "embedded-dma",
  "embedded-hal",
@@ -554,7 +587,7 @@ dependencies = [
  "bare-metal 1.0.0",
  "bit_field",
  "byteorder",
- "cortex-m 0.6.7",
+ "cortex-m 0.7.7",
  "cortex-m-log",
  "cortex-m-rt 0.6.13",
  "eeprom24x",
@@ -578,9 +611,9 @@ dependencies = [
 
 [[package]]
 name = "typenum"
-version = "1.12.0"
+version = "1.18.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "373c8a200f9e67a0c95e62a4f52fbf80c23b4381c05a17845531982fa99e6b33"
+checksum = "1dccffe3ce07af9386bfd29e80c0ab1a8205a2fc34e4bcd40364df902cfa8f3f"
 
 [[package]]
 name = "unicode-xid"
@@ -590,10 +623,13 @@ checksum = "f7fe0bb3479651439c9112f72b6c505038574c9fbb575ed1bf3b797fa39dd564"
 
 [[package]]
 name = "uom"
-version = "0.30.0"
+version = "0.36.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e76503e636584f1e10b9b3b9498538279561adcef5412927ba00c2b32c4ce5ed"
+checksum = "ffd36e5350a65d112584053ee91843955826bf9e56ec0d1351214e01f6d7cd9c"
 dependencies = [
+ "num-bigint",
+ "num-complex",
+ "num-rational",
  "num-traits",
  "serde",
  "typenum",

Cargo.toml

@@ -14,11 +14,11 @@ features = []
 default-target = "thumbv7em-none-eabihf"
 
 [dependencies]
-panic-halt = "0.2"
+panic-halt = "1.0"
 panic-semihosting = { version = "0.5", optional = true }
 log = "0.4"
 bare-metal = "1"
-cortex-m = "0.6"
+cortex-m = "0.7"
 cortex-m-rt = { version = "0.6", features = ["device"] }
 cortex-m-log = { version = "0.6", features = ["log-integration"] }
 stm32f4xx-hal = { version = "=0.10.1", features = ["rt", "stm32f427", "usb_fs"] }
@@ -31,7 +31,7 @@ num-traits = { version = "0.2", default-features = false, features = ["libm"] }
 usb-device = "0.2"
 usbd-serial = "0.1"
 nb = "1"
-uom = { version = "0.30", default-features = false, features = ["autoconvert", "si", "f64", "use_serde"] }
+uom = { version = "0.36", default-features = false, features = ["autoconvert", "si", "f64", "serde"] }
 eeprom24x = "0.3"
 serde = { version = "1.0", default-features = false, features = ["derive"] }
 heapless = "0.5"

README.md

@@ -23,7 +23,7 @@ cargo build --release
 
 The resulting ELF file will be located under `target/thumbv7em-none-eabihf/release/thermostat`.
 
-Alternatively, you can install the Rust toolchain without Nix using rustup; see the Rust manifest file pulled in `flake.nix` to determine which Rust version to use.
+Alternatively, you can install the Rust toolchain without Nix using rustup; see the `rust` variable in `flake.nix` to determine which Rust version to use.
 
 ## Debugging
 
@@ -45,7 +45,7 @@ There are several options for flashing Thermostat. DFU requires only a micro-USB
 
 ### dfu-util on Linux
 * Install the DFU USB tool (dfu-util).
-* Convert firmware from ELF to BIN: `arm-none-eabi-objcopy -O binary thermostat thermostat.bin` (you can skip this step if using the BIN from Hydra)
+* Convert firmware from ELF to BIN: `llvm-objcopy -O binary target/thumbv7em-none-eabihf/release/thermostat thermostat.bin` (you can skip this step if using the BIN from Hydra)
 * Connect to the Micro USB connector to Thermostat below the RJ45.
 * Add jumper to Thermostat v2.0 across 2-pin jumper adjacent to JTAG connector.
 * Cycle board power to put it in DFU update mode
@@ -69,14 +69,20 @@ openocd -f interface/stlink.cfg -f target/stm32f4x.cfg -c "program target/thumbv
 
 ## GUI Usage
 
-A GUI has been developed for easy configuration and plotting of key parameters.
+The Thermostat Control Panel is available for easy configuration and plotting of key parameters.
+It is included in the enclosed PyThermostat library, developed based on the Python libraries PyQt and PyQtGraph.
 
-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:
+Launch it by either running:
 
+```sh
+nix run git+https://git.m-labs.hk/M-Labs/thermostat#control_panel
 ```
-nix run .#thermostat_gui
+
+Or, without Nix, run it after installing the PyThermostat library:
+
+```sh
+pip install git+https://git.m-labs.hk/M-Labs/thermostat#subdirectory=pythermostat
+thermostat_control_panel
 ```
 
 ## Command Line Usage
@@ -96,9 +102,7 @@ invalidate the first line of input.
 
 ### Reading ADC input
 
-Set report mode to `on` for a continuous stream of input data.
-
-The scope of this setting is per TCP session.
+ADC input data is provided in reports. Query for the latest report with the command `report`. See the *Reports* section below.
 
 
 ### TCP commands
@@ -106,42 +110,41 @@ The scope of this setting is per TCP session.
 Send commands as simple text string terminated by `\n`. Responses are
 formatted as line-delimited JSON.
 
-| Syntax                           | Function                                                                      |
-|----------------------------------|-------------------------------------------------------------------------------|
-| `report`                         | Show current input                                                            |
-| `report mode`                    | Show current report mode                                                      |
-| `report mode <off/on>`           | Set report mode                                                               |
-| `pwm`                            | Show current PWM settings                                                     |
-| `pwm <0/1> max_i_pos <amp>`      | Set maximum positive output current                                           |
-| `pwm <0/1> max_i_neg <amp>`      | Set maximum negative output current                                           |
-| `pwm <0/1> max_v <volt>`         | Set maximum output voltage                                                    |
-| `pwm <0/1> i_set <amp>`          | Disengage PID, set fixed output current                                       |
-| `pwm <0/1> pid`                  | Let output current to be controlled by the PID                                |
-| `center <0/1> <volt>`            | Set the MAX1968 0A-centerpoint to the specified fixed voltage                 |
-| `center <0/1> vref`              | Set the MAX1968 0A-centerpoint to measure from VREF                           |
-| `pid`                            | Show PID configuration                                                        |
-| `pid <0/1> target <deg_celsius>` | Set the PID controller target temperature                                     |
-| `pid <0/1> kp <value>`           | Set proportional gain                                                         |
-| `pid <0/1> ki <value>`           | Set integral gain                                                             |
-| `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                                       |
-| `s-h <0/1> <t0/b/r0> <value>`    | Set Steinhart-Hart parameter for a channel                                    |
-| `postfilter`                     | Show postfilter settings                                                      |
-| `postfilter <0/1> off`           | Disable postfilter                                                            |
-| `postfilter <0/1> rate <rate>`   | Set postfilter output data rate                                               |
-| `load [0/1]`                     | Restore configuration for channel all/0/1 from flash                          |
-| `save [0/1]`                     | Save configuration for channel all/0/1 to flash                               |
-| `reset`                          | Reset the device                                                              |
-| `dfu`                            | Reset device and enters USB device firmware update (DFU) mode                 |
-| `ipv4 <X.X.X.X/L> [Y.Y.Y.Y]`     | Configure IPv4 address, netmask length, and optional default gateway          |
-| `fan`                            | Show current fan settings and sensors' measurements                           |
-| `fan <value>`                    | Set fan power with values from 1 to 100                                       |
-| `fan auto`                       | Enable automatic fan speed control                                            |
-| `fcurve <a> <b> <c>`             | Set fan controller curve coefficients (see *Fan control* section)             |
-| `fcurve default`                 | Set fan controller curve coefficients to defaults (see *Fan control* section) |
-| `hwrev`                          | Show hardware revision, and settings related to it                            |
+| Syntax                                    | Function                                                                      |
+|-------------------------------------------|-------------------------------------------------------------------------------|
+| `report`                                  | Show latest report of channel parameters (see *Reports* section)              |
+| `output`                                  | Show current output settings                                                  |
+| `output <0/1> max_i_pos <amp>`            | Set maximum positive output current, clamped to [0, 2]                        |
+| `output <0/1> max_i_neg <amp>`            | Set maximum negative output current, clamped to [0, 2]                        |
+| `output <0/1> max_v <volt>`               | Set maximum output voltage, clamped to [0, 4.3]                               |
+| `output <0/1> i_set <amp>`                | Disengage PID, set fixed output current, clamped to [-2, 2]                   |
+| `output <0/1> polarity <normal/reversed>` | Set output current polarity, with 'normal' being the front panel polarity     |
+| `output <0/1> pid`                        | Let output current to be controlled by the PID                                |
+| `center <0/1> <volt>`                     | Set the MAX1968 0A-centerpoint to the specified fixed voltage                 |
+| `center <0/1> vref`                       | Set the MAX1968 0A-centerpoint to measure from VREF                           |
+| `pid`                                     | Show PID configuration                                                        |
+| `pid <0/1> target <deg_celsius>`          | Set the PID controller target temperature                                     |
+| `pid <0/1> kp <value>`                    | Set proportional gain                                                         |
+| `pid <0/1> ki <value>`                    | Set integral gain                                                             |
+| `pid <0/1> kd <value>`                    | Set differential gain                                                         |
+| `pid <0/1> output_min <amp>`              | Set lower limit of PID-regulated output current                               |
+| `pid <0/1> output_max <amp>`              | Set upper limit of PID-regulated output current                               |
+| `b-p`                                     | Show B-Parameter equation parameters                                          |
+| `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                                               |
+| `load [0/1]`                              | Restore configuration for channel all/0/1 from flash                          |
+| `save [0/1]`                              | Save configuration for channel all/0/1 to flash                               |
+| `reset`                                   | Reset the device                                                              |
+| `dfu`                                     | Reset device and enters USB device firmware update (DFU) mode                 |
+| `ipv4 <X.X.X.X/L> [Y.Y.Y.Y]`              | Configure IPv4 address, netmask length, and optional default gateway          |
+| `fan`                                     | Show current fan settings and sensors' measurements                           |
+| `fan <value>`                             | Set fan power with values from 1 to 100                                       |
+| `fan auto`                                | Enable automatic fan speed control                                            |
+| `fcurve <a> <b> <c>`                      | Set fan controller curve coefficients (see *Fan control* section)             |
+| `fcurve default`                          | Set fan controller curve coefficients to defaults (see *Fan control* section) |
+| `hwrev`                                   | Show hardware revision, and settings related to it                            |
 
 
 ## USB
@@ -159,22 +162,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
-for the Steinhart-Hart equation.
+ADC. To prepare conversion to a temperature, set the parameters
+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
@@ -185,10 +188,10 @@ postfilter rate can be tuned with the `postfilter` command.
 
 | Postfilter rate | Rejection | Effective sampling rate |
 | ---             | :---:     | ---                     |
-| 16.67 Hz        | 92 dB     | 8.4 Hz                  |
-| 20 Hz           | 86 dB     | 9.1 Hz                  |
-| 21.25 Hz        | 62 dB     | 10 Hz                   |
-| 27 Hz           | 47 dB     | 10.41 Hz                |
+| 16.667 Hz       | 90 dB     | 8.4 Hz                  |
+| 20 Hz           | 85 dB     | 9.1 Hz                  |
+| 25 Hz           | 62 dB     | 10 Hz                   |
+| 27.27 Hz        | 47 dB     | 10.41 Hz                |
 
 ## Thermo-Electric Cooling (TEC)
 
@@ -198,46 +201,47 @@ postfilter rate can be tuned with the `postfilter` command.
 
 When using a TEC module with the Thermostat, the Thermostat expects the thermal load (where the thermistor is located) to cool down with a positive software current set point, and heat up with a negative current set point.
 
+If the Thermostat is used for temperature control with the Sinara 5432 DAC "Zotino", and is connected via an IDC cable, the TEC polarity may need to be reversed with the `output <ch> polarity reversed` TCP command.
+
 Testing heat flow direction with a low set current is recommended before installation of the TEC module.
 
 ### Limits
 
-Each of the MAX1968 TEC driver has analog/PWM inputs for setting
+Each channel has maximum value settings, for setting
 output limits.
 
-Use the `pwm` 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.
 ```
-pwm 0 max_v 1.5
+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.
 ```
-pwm 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.
 ```
-pwm 0 max_i_pos 3
+output 1 max_i_pos 2
 ```
 
 ### Open-loop mode
 
-To manually control TEC output current, omit the limit parameter of
-the `pwm` command. Doing so will disengage the PID control for that
+To manually control TEC output current, set a fixed output current with
+the `output` command. Doing so will disengage the PID control for that
 channel.
 
 Example: set output current of channel 0 to 0 A.
 ```
-pwm 0 i_set 0
+output 0 i_set 0
 ```
 
 ## PID-stabilized temperature control
@@ -250,7 +254,23 @@ pid 0 target 20
 Enter closed-loop mode by switching control of the TEC output current
 of channel 0 to the PID algorithm:
 ```
-pwm 0 pid
+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
@@ -263,17 +283,17 @@ pwm 0 pid
 
 ## Reports
 
-Use the bare `report` command to obtain a single report. Enable
-continuous reporting with `report mode on`. Reports are JSON objects
+Use the bare `report` command to obtain a single report. Reports are JSON objects
 with the following keys.
 
 | Key            | Unit            | Description                                          |
 | ---            | :---:           | ---                                                  |
 | `channel`      | Integer         | Channel `0`, or `1`                                  |
 | `time`         | Seconds         | Temperature measurement time                         |
+| `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`                   |
@@ -283,7 +303,7 @@ with the following keys.
 | `tec_u_meas`   | Volts           | Measurement of the voltage across the TEC            |
 | `pid_output`   | Amperes         | PID control output                                   |
 
-Note: With Thermostat v2 and below, the voltage and current readouts `i_tec` and `tec_i` are noisy without the hardware fix shown in [this PR][https://git.m-labs.hk/M-Labs/thermostat/pulls/105].
+Note: Prior to Thermostat hardware revision v2.2.4, the voltage and current readouts `i_tec` and `tec_i` are noisy without the hardware fix shown in [this PR](https://git.m-labs.hk/M-Labs/thermostat/pulls/105).
 
 ## PID Tuning
 

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.lock

@@ -1,41 +1,45 @@
 {
   "nodes": {
-    "mozilla-overlay": {
-      "flake": false,
-      "locked": {
-        "lastModified": 1690536331,
-        "narHash": "sha256-aRIf2FB2GTdfF7gl13WyETmiV/J7EhBGkSWXfZvlxcA=",
-        "owner": "mozilla",
-        "repo": "nixpkgs-mozilla",
-        "rev": "db89c8707edcffefcd8e738459d511543a339ff5",
-        "type": "github"
-      },
-      "original": {
-        "owner": "mozilla",
-        "repo": "nixpkgs-mozilla",
-        "type": "github"
-      }
-    },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1691421349,
-        "narHash": "sha256-RRJyX0CUrs4uW4gMhd/X4rcDG8PTgaaCQM5rXEJOx6g=",
+        "lastModified": 1775811116,
+        "narHash": "sha256-t+HZK42pB6N+i5RGbuy7Xluez/VvWbembBdvzsc23Ss=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "011567f35433879aae5024fc6ec53f2a0568a6c4",
+        "rev": "54170c54449ea4d6725efd30d719c5e505f1c10e",
         "type": "github"
       },
       "original": {
         "owner": "NixOS",
-        "ref": "nixos-23.05",
+        "ref": "nixos-25.11",
         "repo": "nixpkgs",
         "type": "github"
       }
     },
     "root": {
       "inputs": {
-        "mozilla-overlay": "mozilla-overlay",
-        "nixpkgs": "nixpkgs"
+        "nixpkgs": "nixpkgs",
+        "rust-overlay": "rust-overlay"
+      }
+    },
+    "rust-overlay": {
+      "inputs": {
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1775877051,
+        "narHash": "sha256-wpSQm2PD/w4uRo2wb8utk0b5hOBkkg/CZ1xICY+qB7M=",
+        "owner": "oxalica",
+        "repo": "rust-overlay",
+        "rev": "08b4f3633471874c8894632ade1b78d75dbda002",
+        "type": "github"
+      },
+      "original": {
+        "owner": "oxalica",
+        "repo": "rust-overlay",
+        "type": "github"
       }
     }
   },

flake.nix

@@ -1,132 +1,123 @@
 {
   description = "Firmware for the Sinara 8451 Thermostat";
 
-  inputs.nixpkgs.url = github:NixOS/nixpkgs/nixos-23.05;
-  inputs.mozilla-overlay = { url = github:mozilla/nixpkgs-mozilla; flake = false; };
+  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-25.11";
+  inputs.rust-overlay = {
+    url = "github:oxalica/rust-overlay";
+    inputs.nixpkgs.follows = "nixpkgs";
+  };
 
-  outputs = { self, nixpkgs, mozilla-overlay }:
-    let
-      pkgs = import nixpkgs { system = "x86_64-linux"; overlays = [ (import mozilla-overlay) ]; };
-      rustManifest = pkgs.fetchurl {
-        url = "https://static.rust-lang.org/dist/2022-12-15/channel-rust-stable.toml";
-        hash = "sha256-S7epLlflwt0d1GZP44u5Xosgf6dRrmr8xxC+Ml2Pq7c=";
-      };
-
-      targets = [
-        "thumbv7em-none-eabihf"
-      ];
-      rustChannelOfTargets = _channel: _date: targets:
-        (pkgs.lib.rustLib.fromManifestFile rustManifest {
-          inherit (pkgs) stdenv lib fetchurl patchelf;
-          }).rust.override {
-          inherit targets;
-          extensions = ["rust-src"];
-        };
-      rust = rustChannelOfTargets "stable" null targets;
-      rustPlatform = pkgs.recurseIntoAttrs (pkgs.makeRustPlatform {
-        rustc = rust;
-        cargo = rust;
-      });
-      thermostat = rustPlatform.buildRustPackage {
-        name = "thermostat";
-        version = "0.0.0";
-
-        src = self;
-        cargoLock = { 
-          lockFile = ./Cargo.lock;
-          outputHashes = {
-            "stm32-eth-0.2.0" = "sha256-48RpZgagUqgVeKm7GXdk3Oo0v19ScF9Uby0nTFlve2o=";
-          };
-        };
-
-        nativeBuildInputs = [ pkgs.llvm ];
-
-        buildPhase = ''
-          cargo build --release --bin thermostat
-        '';
-
-        installPhase = ''
-          mkdir -p $out $out/nix-support
-          cp target/thumbv7em-none-eabihf/release/thermostat $out/thermostat.elf
-          echo file binary-dist $out/thermostat.elf >> $out/nix-support/hydra-build-products
-          llvm-objcopy -O binary target/thumbv7em-none-eabihf/release/thermostat $out/thermostat.bin
-          echo file binary-dist $out/thermostat.bin >> $out/nix-support/hydra-build-products
-        '';
-
-        dontFixup = true;
-      };
-
-      qasync = pkgs.python3Packages.buildPythonPackage rec {
-        pname = "qasync";
-        version = "0.27.1";
-        format = "pyproject";
-        src = pkgs.fetchPypi {
-          inherit pname version;
-          sha256 = "sha256-jcdo/R7l3hBEx8MF7M8tOdJNh4A+pxGJ1AJPtHX0mF8=";
-        };
-        buildInputs = [ pkgs.python3Packages.poetry-core ];
-        propagatedBuildInputs = [ pkgs.python3Packages.pyqt6 ];
-      };
-
-      pyqtgraph = pkgs.python3Packages.buildPythonPackage rec {
-        pname = "pyqtgraph";
-        version = "0.13.3";
-        format = "pyproject";
-        src = pkgs.fetchPypi {
-          inherit pname version;
-          sha256 = "sha256-WBCNhBHHBU4IQdi3ke6F4QH8KWubNZwOAd3jipj/Ks4=";
-        };
-        propagatedBuildInputs = with pkgs.python3Packages; [ numpy pyqt6 ];
-      };
-
-      pglive = pkgs.python3Packages.buildPythonPackage rec {
-        pname = "pglive";
-        version = "0.7.2";
-        format = "pyproject";
-        src = pkgs.fetchPypi {
-          inherit pname version;
-          sha256 = "sha256-jqj8X6H1N5mJQ4OrY5ANqRB0YJByqg/bNneEALWmH1A=";
-        };
-        buildInputs = [ pkgs.python3Packages.poetry-core ];
-        propagatedBuildInputs = [ pyqtgraph pkgs.python3Packages.numpy ];
-      };
-
-      thermostat_gui = pkgs.python3Packages.buildPythonPackage {
-        pname = "thermostat_gui";
-        version = "0.0.0";
-        format = "pyproject";
-        src = "${self}/pytec";
-
-        nativeBuildInputs = [ pkgs.qt6.wrapQtAppsHook ];
-        propagatedBuildInputs = [ pkgs.qt6.qtbase ] ++ (with pkgs.python3Packages; [ pyqtgraph pyqt6 qasync pglive ]);
-
-        dontWrapQtApps = true;
-        postFixup = ''
-          wrapQtApp "$out/bin/tec_qt"
-        '';
-      };
-    in {
-      packages.x86_64-linux = {
-        inherit thermostat thermostat_gui;
-      };
-
-      apps.x86_64-linux.thermostat_gui = {
-        type = "app";
-        program = "${self.packages.x86_64-linux.thermostat_gui}/bin/tec_qt";
-      };
-
-      hydraJobs = {
-        inherit thermostat;
-      };
-
-      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
-          ]);
-      };
-      defaultPackage.x86_64-linux = thermostat;
+  outputs = {
+    self,
+    nixpkgs,
+    rust-overlay,
+  }: let
+    pkgs = import nixpkgs {
+      system = "x86_64-linux";
+      overlays = [(import rust-overlay)];
     };
-}
+
+    rust = pkgs.rust-bin.stable."1.66.0".default.override {
+      extensions = ["rust-src"];
+      targets = ["thumbv7em-none-eabihf"];
+    };
+    rustPlatform = pkgs.makeRustPlatform {
+      rustc = rust;
+      cargo = rust;
+    };
+
+    thermostat = rustPlatform.buildRustPackage {
+      name = "thermostat";
+      version = "0.0.0";
+
+      src = self;
+      cargoLock = {
+        lockFile = ./Cargo.lock;
+        outputHashes = {
+          "stm32-eth-0.2.0" = "sha256-48RpZgagUqgVeKm7GXdk3Oo0v19ScF9Uby0nTFlve2o=";
+        };
+      };
+
+      nativeBuildInputs = [pkgs.llvm];
+
+      buildPhase = ''
+        cargo build --release --bin thermostat
+      '';
+
+      installPhase = ''
+        mkdir -p $out $out/nix-support
+        cp target/thumbv7em-none-eabihf/release/thermostat $out/thermostat.elf
+        echo file binary-dist $out/thermostat.elf >> $out/nix-support/hydra-build-products
+        llvm-objcopy -O binary target/thumbv7em-none-eabihf/release/thermostat $out/thermostat.bin
+        echo file binary-dist $out/thermostat.bin >> $out/nix-support/hydra-build-products
+      '';
+
+      dontFixup = true;
+      auditable = false;
+    };
+
+    pythermostat = pkgs.python3Packages.buildPythonPackage {
+      pname = "pythermostat";
+      version = "0.0.0";
+      format = "pyproject";
+      src = "${self}/pythermostat";
+
+      nativeBuildInputs = [
+        pkgs.python3Packages.setuptools
+        pkgs.qt6.wrapQtAppsHook
+      ];
+      propagatedBuildInputs =
+        [pkgs.qt6.qtbase]
+        ++ (with pkgs.python3Packages; [
+          numpy
+          matplotlib
+          pyqtgraph
+          pyqt6
+          qasync
+          pglive
+        ]);
+
+      dontWrapQtApps = true;
+      postFixup = ''
+        wrapQtApp "$out/bin/thermostat_control_panel"
+      '';
+    };
+
+  in {
+    packages.x86_64-linux = {
+      inherit thermostat pythermostat;
+      default = thermostat;
+    };
+
+    apps.x86_64-linux.control_panel = {
+      type = "app";
+      program = "${pythermostat}/bin/thermostat_control_panel";
+    };
+
+    hydraJobs = {
+      inherit thermostat;
+    };
+
+    devShells.x86_64-linux.default = pkgs.mkShellNoCC {
+      name = "thermostat-dev-shell";
+      packages = with pkgs;
+        [
+          rust
+          llvm
+          openocd
+          dfu-util
+          rlwrap
+        ]
+        ++ (with python3Packages; [
+          numpy
+          matplotlib
+          pyqtgraph
+          pyqt6
+          qasync
+          pglive
+        ]);
+    };
+
+    formatter.x86_64-linux = pkgs.alejandra;
+  };
+}

pytec/aioexample.py

@@ -1,16 +0,0 @@
-import asyncio
-from pytec.aioclient import Client
-
-async def main():
-    tec = Client()
-    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())
-    print(await tec.get_pid())
-    print(await tec.get_pwm())
-    print(await tec.get_postfilter())
-    print(await tec.get_steinhart_hart())
-    async for data in tec.report_mode():
-        print(data)
-
-asyncio.run(main())

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_pwm())
-print(tec.get_pid())
-print(tec.get_pwm())
-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/pyproject.toml

@@ -1,18 +0,0 @@
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "pytec"
-version = "0.0"
-authors = [{name = "M-Labs"}]
-description = "Control TEC"
-urls.Repository = "https://git.m-labs.hk/M-Labs/thermostat"
-license = {text = "GPLv3"}
-
-[project.gui-scripts]
-tec_qt = "tec_qt:main"
-
-[tool.setuptools]
-packages.find = {}
-py-modules = ["aioexample", "autotune", "example", "plot", "tec_qt", "ui_tec_qt", "waitingspinnerwidget"]

pytec/pytec/aioclient.py

@@ -1,279 +0,0 @@
-import asyncio
-import json
-import logging
-
-class CommandError(Exception):
-    pass
-
-class StoppedConnecting(Exception):
-    pass
-
-class Client:
-    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):
-        """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:
-                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
-
-        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()
-
-        if self._writer is None:
-            return
-
-        # Reader needn't be closed
-        self._writer.close()
-        await self._writer.wait_closed()
-        self._reader = None
-        self._writer = None
-
-    async def _check_zero_limits(self):
-        pwm_report = await self.get_pwm()
-        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"]))
-
-    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')
-
-    async def _read_write(self, command):
-        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))
-
-        response = json.loads(line)
-        logging.debug(f"{command}: {response}")
-        if "error" in response:
-            raise CommandError(response["error"])
-        return response
-
-    async def _get_conf(self, topic):
-        result = [None, None]
-        for item in await self._command(topic):
-            result[int(item["channel"])] = item
-        return result
-
-    async def get_pwm(self):
-        """Retrieve PWM limits for the TEC
-
-        Example::
-            [{'channel': 0,
-              'center': 'vref',
-              'i_set': {'max': 2.9802790335151985, 'value': -0.02002179650216762},
-              'max_i_neg': {'max': 3.0, 'value': 3.0},
-              'max_v': {'max': 5.988, 'value': 5.988},
-              'max_i_pos': {'max': 3.0, 'value': 3.0}},
-             {'channel': 1,
-              'center': 'vref',
-              'i_set': {'max': 2.9802790335151985, 'value': -0.02002179650216762},
-              'max_i_neg': {'max': 3.0, 'value': 3.0},
-              'max_v': {'max': 5.988, 'value': 5.988},
-              'max_i_pos': {'max': 3.0, 'value': 3.0}}
-            ]
-        """
-        return await self._get_conf("pwm")
-
-    async def get_pid(self):
-        """Retrieve PID control state
-
-        Example::
-            [{'channel': 0,
-              'parameters': {
-                  'kp': 10.0,
-                  'ki': 0.02,
-                  'kd': 0.0,
-                  'output_min': 0.0,
-                  'output_max': 3.0},
-              'target': 37.0},
-             {'channel': 1,
-              'parameters': {
-                  'kp': 10.0,
-                  'ki': 0.02,
-                  'kd': 0.0,
-                  'output_min': 0.0,
-                  'output_max': 3.0},
-              'target': 36.5}]
-        """
-        return await self._get_conf("pid")
-
-    async def get_steinhart_hart(self):
-        """Retrieve Steinhart-Hart 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 await self._get_conf("s-h")
-
-    async def get_postfilter(self):
-        """Retrieve DAC postfilter configuration
-
-        Example::
-            [{'rate': None, 'channel': 0},
-             {'rate': 21.25, 'channel': 1}]
-        """
-        return await self._get_conf("postfilter")
-
-    async def get_fan(self):
-        """Get Thermostat current fan settings"""
-        return await self._command("fan")
-
-    async def report(self):
-        """Obtain one-time report on measurement values"""
-        return await self._command("report")
-
-    async def report_mode(self):
-        """Start reporting measurement values
-
-        Example of yielded data::
-            {'channel': 0,
-             'time': 2302524,
-             '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,
-             'tec_i': 2.0925,
-             'tec_u_meas': 2.5340000000000003,
-             'pid_output': 2.067581958092247}
-        """
-        await self._command("report mode", "on")
-        self._report_mode_on = True
-
-        while self._report_mode_on:
-            async with self._command_lock:
-                line = await self._read_line()
-            if not line:
-                break
-            try:
-                yield json.loads(line)
-            except json.decoder.JSONDecodeError:
-                pass
-
-        await self._command("report mode", "off")
-
-    def stop_report_mode(self):
-        self._report_mode_on = False
-
-    async def set_param(self, topic, channel, field="", value=""):
-        """Set configuration parameters
-
-        Examples::
-            await tec.set_param("pwm", 0, "max_v", 2.0)
-            await tec.set_param("pid", 1, "output_max", 2.5)
-            await tec.set_param("s-h", 0, "t0", 20.0)
-            await tec.set_param("center", 0, "vref")
-            await tec.set_param("postfilter", 1, 21)
-
-        See the firmware's README.md for a full list.
-        """
-        if type(value) is float:
-            value = "{:f}".format(value)
-        if type(value) is not str:
-            value = str(value)
-        await self._command(topic, str(channel), field, value)
-
-    async def set_fan(self, power="auto"):
-        """Set fan power"""
-        await self._command("fan", str(power))
-
-    async def set_fcurve(self, a=1.0, b=0.0, c=0.0):
-        """Set fan curve"""
-        await self._command("fcurve", str(a), str(b), str(c))
-
-    async def power_up(self, channel, target):
-        """Start closed-loop mode"""
-        await self.set_param("pid", channel, "target", value=target)
-        await self.set_param("pwm", channel, "pid")
-
-    async def save_config(self, channel=""):
-        """Save current configuration to EEPROM"""
-        await self._command("save", str(channel))
-
-    async def load_config(self, channel=""):
-        """Load current configuration from EEPROM"""
-        await self._command("load", str(channel))
-        if channel == "":
-            await self._read_line() # Read the extra {}
-
-    async def hw_rev(self):
-        """Get Thermostat hardware revision"""
-        return await self._command("hwrev")
-
-    async def reset(self):
-        """Reset the Thermostat
-        
-        The client is disconnected as the TCP session is terminated.
-        """
-        async with self._command_lock:
-            self._writer.write("reset\n".encode('utf-8'))
-            await self._writer.drain()
-
-        await self.end_session()
-
-    async def dfu(self):
-        """Put the Thermostat in DFU update mode
-        
-        The client is disconnected as the Thermostat stops responding to
-        TCP commands in DFU update mode. The only way to exit it is by
-        power-cycling.
-        """
-        async with self._command_lock:
-            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')

pytec/setup.py

@@ -1,18 +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(),
-    entry_points={
-        "gui_scripts": [
-            "tec_qt = tec_qt:main",
-        ]
-    },
-    py_modules=['tec_qt', 'ui_tec_qt', 'autotune', 'waitingspinnerwidget'],
-)

pytec/tec_qt.py

@@ -1,903 +0,0 @@
-from PyQt6 import QtWidgets, QtGui, QtCore
-from PyQt6.QtCore import pyqtSignal, QObject, QSignalBlocker, pyqtSlot
-import pyqtgraph.parametertree.parameterTypes as pTypes
-from pyqtgraph.parametertree import Parameter, ParameterTree, ParameterItem, registerParameterType
-import pyqtgraph as pg
-pg.setConfigOptions(antialias=True)
-from pglive.sources.data_connector import DataConnector
-from pglive.kwargs import Axis
-from pglive.sources.live_plot import LiveLinePlot
-from pglive.sources.live_plot_widget import LivePlotWidget
-from pglive.sources.live_axis import LiveAxis
-import sys
-import argparse
-import logging
-import asyncio
-from pytec.aioclient import Client, StoppedConnecting
-import qasync
-from qasync import asyncSlot, asyncClose
-from autotune import PIDAutotune, PIDAutotuneState
-
-# pyuic6 -x tec_qt.ui  -o ui_tec_qt.py
-from ui_tec_qt import Ui_MainWindow
-
-"""Number of channels provided by the Thermostat"""
-NUM_CHANNELS: int = 2
-
-def get_argparser():
-    parser = argparse.ArgumentParser(description="ARTIQ master")
-
-    parser.add_argument("--connect", default=None, action="store_true",
-                        help="Automatically connect to the specified Thermostat in IP:port format")
-    parser.add_argument('IP', metavar="ip", default=None, nargs='?')
-    parser.add_argument('PORT', metavar="port", default=None, nargs='?')
-    parser.add_argument("-l", "--log", dest="logLevel", choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'],
-                        help="Set the logging level")
-
-    return parser
-
-
-class MutexParameter(pTypes.ListParameter):
-    """
-    Mutually exclusive parameter where only one of its children is visible at a time, list selectable.
-
-    The ordering of the list items determines which children will be visible.
-    """
-    def __init__(self, **opts):
-        super().__init__(**opts)
-
-        self.sigValueChanged.connect(self.show_chosen_child)
-        self.sigValueChanged.emit(self, self.opts['value'])
-
-    def _get_param_from_value(self, value):
-        if isinstance(self.opts['limits'], dict):
-            values_list = list(self.opts['limits'].values())
-        else:
-            values_list = self.opts['limits']
-
-        return self.children()[values_list.index(value)]
-
-    @pyqtSlot(object, object)
-    def show_chosen_child(self, value):
-        for param in self.children():
-            param.hide()
-
-        child_to_show = self._get_param_from_value(value.value())
-        child_to_show.show()
-
-        if child_to_show.opts.get('triggerOnShow', None):
-            child_to_show.sigValueChanged.emit(child_to_show, child_to_show.value())
-
-
-registerParameterType('mutex', MutexParameter)
-
-
-class WrappedClient(QObject, Client):
-    connection_error = pyqtSignal()
-
-    async def _read_line(self):
-        try:
-            return await super()._read_line()
-        except (OSError, TimeoutError, asyncio.TimeoutError) as e: # TODO: Remove asyncio.TimeoutError in Python 3.11
-            logging.error("Client connection error, disconnecting", exc_info=True)
-            self.connection_error.emit()
-
-
-class ClientWatcher(QObject):
-    fan_update = pyqtSignal(dict)
-    pwm_update = pyqtSignal(list)
-    report_update = pyqtSignal(list)
-    pid_update = pyqtSignal(list)
-    thermistor_update = pyqtSignal(list)
-    postfilter_update = pyqtSignal(list)
-
-    def __init__(self, parent, client, update_s):
-        self._update_s = update_s
-        self._client = client
-        self._watch_task = None
-        self._report_mode_task = None
-        self._poll_for_report = True
-        super().__init__(parent)
-
-    async def run(self):
-        loop = asyncio.get_running_loop()
-        while True:
-            time = loop.time()
-            await self.update_params()
-            await asyncio.sleep(self._update_s - (loop.time() - time))
-
-    async def update_params(self):
-        self.fan_update.emit(await self._client.get_fan())
-        self.pwm_update.emit(await self._client.get_pwm())
-        if self._poll_for_report:
-            self.report_update.emit(await self._client.report())
-        self.pid_update.emit(await self._client.get_pid())
-        self.thermistor_update.emit(await self._client.get_steinhart_hart())
-        self.postfilter_update.emit(await self._client.get_postfilter())
-
-    def start_watching(self):
-        self._watch_task = asyncio.create_task(self.run())
-
-    @pyqtSlot()
-    def stop_watching(self):
-        if self._watch_task is not None:
-            self._watch_task.cancel()
-            self._watch_task = None
-
-    async def set_report_mode(self, enabled: bool):
-        self._poll_for_report = not enabled
-        if enabled:
-            self._report_mode_task = asyncio.create_task(self.report_mode())
-        else:
-            self._client.stop_report_mode()
-            if self._report_mode_task is not None:
-                await self._report_mode_task
-                self._report_mode_task = None
-
-    async def report_mode(self):
-        async for report in self._client.report_mode():
-            self.report_update.emit(report)
-
-    @pyqtSlot(float)
-    def set_update_s(self, update_s):
-        self._update_s = update_s
-
-
-class ChannelGraphs:
-    """Manager of a channel's two graphs and their elements."""
-
-    """The maximum number of sample points to store."""
-    DEFAULT_MAX_SAMPLES = 1000
-
-    def __init__(self, t_widget, i_widget):
-        self._t_widget = t_widget
-        self._i_widget = i_widget
-
-        self._t_plot = LiveLinePlot()
-        self._i_plot = LiveLinePlot(name="Measured")
-        self._iset_plot = LiveLinePlot(name="Set", pen=pg.mkPen('r'))
-
-        self._t_line = self._t_widget.getPlotItem().addLine(label='{value} °C')
-        self._t_line.setVisible(False)
-        self._t_setpoint_plot = LiveLinePlot() # Hack for keeping setpoint line in plot range
-
-        for graph in t_widget, i_widget:
-            time_axis = LiveAxis('bottom', text="Time since Thermostat reset", **{Axis.TICK_FORMAT: Axis.DURATION})
-            time_axis.showLabel()
-            graph.setAxisItems({'bottom': time_axis})
-
-            graph.add_crosshair(pg.mkPen(color='red', width=1), {'color': 'green'})
-
-            # Enable linking of axes in the graph widget's context menu
-            graph.register(graph.getPlotItem().titleLabel.text) # Slight hack getting the title
-
-        temperature_axis = LiveAxis('left', text="Temperature", units="°C")
-        temperature_axis.showLabel()
-        t_widget.setAxisItems({'left': temperature_axis})
-
-        current_axis = LiveAxis('left', text="Current", units="A")
-        current_axis.showLabel()
-        i_widget.setAxisItems({'left': current_axis})
-        i_widget.addLegend(brush=(50, 50, 200, 150))
-
-        t_widget.addItem(self._t_plot)
-        t_widget.addItem(self._t_setpoint_plot)
-        i_widget.addItem(self._i_plot)
-        i_widget.addItem(self._iset_plot)
-
-        self.t_connector = DataConnector(self._t_plot, max_points=self.DEFAULT_MAX_SAMPLES)
-        self.t_setpoint_connector = DataConnector(self._t_setpoint_plot, max_points=1)
-        self.i_connector = DataConnector(self._i_plot, max_points=self.DEFAULT_MAX_SAMPLES)
-        self.iset_connector = DataConnector(self._iset_plot, max_points=self.DEFAULT_MAX_SAMPLES)
-
-        self.max_samples = self.DEFAULT_MAX_SAMPLES
-
-    def plot_append(self, report):
-        temperature = report['temperature']
-        current = report['tec_i']
-        iset = report['i_set']
-        time = report['time']
-
-        if temperature is not None:
-            self.t_connector.cb_append_data_point(temperature, time)
-            if self._t_line.isVisible():
-                self.t_setpoint_connector.cb_append_data_point(self._t_line.value(), time)
-            else:
-                self.t_setpoint_connector.cb_append_data_point(temperature, time)
-            if current is not None:
-                self.i_connector.cb_append_data_point(current, time)
-            self.iset_connector.cb_append_data_point(iset, time)
-
-    def clear(self):
-        for connector in self.t_connector, self.i_connector, self.iset_connector:
-            connector.clear()
-
-    def set_t_line(self, temp=None, visible=None):
-        if visible is not None:
-            self._t_line.setVisible(visible)
-        if temp is not None:
-            self._t_line.setValue(temp)
-
-            # PyQtGraph normally does not update this text when the line
-            # is not visible, so make sure that the temperature label 
-            # gets updated always, and doesn't stay at an old value.
-            self._t_line.label.setText(f"{temp} °C")
-
-
-class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow):
-
-    """The maximum number of sample points to store."""
-    DEFAULT_MAX_SAMPLES = 1000
-
-    """Thermostat parameters that are particular to a channel"""
-    THERMOSTAT_PARAMETERS = [[
-        {'name': 'Temperature', 'type': 'float', 'format': '{value:.4f} °C', 'readonly': True},
-        {'name': 'Current through TEC', 'type': 'float', 'suffix': 'mA', 'decimals': 6, 'readonly': True},
-        {'name': 'Output Config', 'expanded': True, 'type': 'group', 'children': [
-            {'name': 'Control Method', 'type': 'mutex', 'limits': ['Constant Current', 'Temperature PID'],
-            'activaters': [None, ('pwm', ch, 'pid')], 'children': [
-                {'name': 'Set Current', 'type': 'float', 'value': 0, 'step': 100, 'limits': (-3000, 3000), 'triggerOnShow': True,
-                'decimals': 6, 'suffix': 'mA', 'param': ('pwm', ch, 'i_set')},
-                {'name': 'Set Temperature', 'type': 'float', 'value': 25, 'step': 0.1, 'limits': (-273, 300),
-                'format': '{value:.4f} °C', 'param': ('pid', ch, 'target')},
-            ]},
-            {'name': 'Limits', 'expanded': False, 'type': 'group', 'children': [
-                {'name': 'Max Cooling Current', 'type': 'float', 'value': 0, 'step': 100, 'decimals': 6, 'limits': (0, 3000),
-                'suffix': 'mA', 'param': ('pwm', ch, 'max_i_pos')},
-                {'name': 'Max Heating Current', 'type': 'float', 'value': 0, 'step': 100, 'decimals': 6, 'limits': (0, 3000),
-                'suffix': 'mA', 'param': ('pwm', ch, 'max_i_neg')},
-                {'name': 'Max Voltage Difference', 'type': 'float', 'value': 0, 'step': 0.1, 'limits': (0, 5), 'siPrefix': True,
-                'suffix': 'V', 'param': ('pwm', ch, 'max_v')},
-            ]}
-        ]},
-        {'name': 'Thermistor Config', 'expanded': False, 'type': 'group', 'children': [
-            {'name': 'T₀', 'type': 'float', 'value': 25, 'step': 0.1, 'limits': (-100, 100),
-            'format': '{value:.4f} °C', 'param': ('s-h', ch, 't0')},
-            {'name': 'R₀', 'type': 'float', 'value': 10000, 'step': 1, 'siPrefix': True, 'suffix': 'Ω',
-            'param': ('s-h', ch, 'r0')},
-            {'name': 'B', 'type': 'float', 'value': 3950, 'step': 1, 'suffix': 'K', 'decimals': 4, 'param': ('s-h', ch, 'b')},
-            {'name': 'Postfilter Rate', 'type': 'list', 'value': 16.67, 'param': ('postfilter', ch, 'rate'),
-            'limits': {'Off': None, '16.67 Hz': 16.67, '20 Hz': 20.0, '21.25 Hz': 21.25, '27 Hz': 27.0}},
-        ]},
-        {'name': 'PID Config', 'expanded': False, 'type': 'group', 'children': [
-            {'name': 'Kp', 'type': 'float', 'step': 0.1, 'suffix': '', 'param': ('pid', ch, 'kp')},
-            {'name': 'Ki', 'type': 'float', 'step': 0.1, 'suffix': 'Hz', 'param': ('pid', ch, 'ki')},
-            {'name': 'Kd', 'type': 'float', 'step': 0.1, 'suffix': 's', 'param': ('pid', ch, 'kd')},
-            {'name': "PID Output Clamping", 'expanded': True, 'type': 'group', 'children': [
-                {'name': 'Minimum', 'type': 'float', 'step': 100, 'limits': (-3000, 3000), 'decimals': 6, 'suffix': 'mA', 'param': ('pid', ch, 'output_min')},
-                {'name': 'Maximum', 'type': 'float', 'step': 100, 'limits': (-3000, 3000), 'decimals': 6, 'suffix': 'mA', 'param': ('pid', ch, 'output_max')},
-            ]},
-            {'name': 'PID Auto Tune', 'expanded': False, 'type': 'group', 'children': [
-                {'name': 'Target Temperature', 'type': 'float', 'value': 20, 'step': 0.1, 'format': '{value:.4f} °C'},
-                {'name': 'Test Current', 'type': 'float', 'value': 1000, 'decimals': 6, 'step': 100, 'limits': (-3000, 3000), 'suffix': 'mA'},
-                {'name': 'Temperature Swing', 'type': 'float', 'value': 1.5, 'step': 0.1, 'prefix': '±', 'format': '{value:.4f} °C'},
-                {'name': 'Run', 'type': 'action', 'tip': 'Run'},
-            ]},
-        ]},
-        {'name': 'Save to flash', 'type': 'action', 'tip': 'Save config to thermostat, applies on reset'},
-        {'name': 'Load from flash', 'type': 'action', 'tip': 'Load config from flash'}
-    ] for ch in range(NUM_CHANNELS)]
-
-    def __init__(self, args):
-        super().__init__()
-
-        self.setupUi(self)
-
-        self.ch0_t_graph.setTitle("Channel 0 Temperature")
-        self.ch0_i_graph.setTitle("Channel 0 Current")
-        self.ch1_t_graph.setTitle("Channel 1 Temperature")
-        self.ch1_i_graph.setTitle("Channel 1 Current")
-
-        self.max_samples = self.DEFAULT_MAX_SAMPLES
-
-        self._set_up_connection_menu()
-        self._set_up_thermostat_menu()
-        self._set_up_plot_menu()
-
-        self.client = WrappedClient(self)
-        self.client.connection_error.connect(self.bail)
-        self.client_watcher = ClientWatcher(self, self.client, self.report_refresh_spin.value())
-        self.client_watcher.fan_update.connect(self.fan_update)
-        self.client_watcher.report_update.connect(self.update_report)
-        self.client_watcher.pid_update.connect(self.update_pid)
-        self.client_watcher.pwm_update.connect(self.update_pwm)
-        self.client_watcher.thermistor_update.connect(self.update_thermistor)
-        self.client_watcher.postfilter_update.connect(self.update_postfilter)
-        self.report_apply_btn.clicked.connect(
-            lambda: self.client_watcher.set_update_s(self.report_refresh_spin.value())
-        )
-
-        self.params = [
-            Parameter.create(name=f"Thermostat Channel {ch} Parameters", type='group', value=ch, children=self.THERMOSTAT_PARAMETERS[ch])
-            for ch in range(NUM_CHANNELS)
-        ]
-        self._set_param_tree()
-
-        self.channel_graphs = [
-            ChannelGraphs(getattr(self, f'ch{ch}_t_graph'), getattr(self, f'ch{ch}_i_graph'))
-            for ch in range(NUM_CHANNELS)
-        ]
-
-        self.autotuners = [
-            PIDAutotune(25)
-            for _ in range(NUM_CHANNELS)
-        ]
-
-        self.loading_spinner.hide()
-
-        self.hw_rev_data = None
-
-        if args.connect:
-            if args.IP:
-                self.host_set_line.setText(args.IP)
-            if args.PORT:
-                self.port_set_spin.setValue(int(args.PORT))
-            self.connect_btn.click()
-
-    def _set_up_connection_menu(self):
-        self.connection_menu = QtWidgets.QMenu()
-        self.connection_menu.setTitle('Connection Settings')
-
-        self.host_set_line = QtWidgets.QLineEdit()
-        self.host_set_line.setMinimumSize(QtCore.QSize(160, 0))
-        self.host_set_line.setMaximumSize(QtCore.QSize(160, 16777215))
-        self.host_set_line.setMaxLength(15)
-        self.host_set_line.setClearButtonEnabled(True)
-
-        def connect_on_enter_press():
-            self.connect_btn.click()
-            self.connection_menu.hide()
-        self.host_set_line.returnPressed.connect(connect_on_enter_press)
-
-        self.host_set_line.setText("192.168.1.26")
-        self.host_set_line.setPlaceholderText("IP for the Thermostat")
-
-        host = QtWidgets.QWidgetAction(self.connection_menu)
-        host.setDefaultWidget(self.host_set_line)
-        self.connection_menu.addAction(host)
-        self.connection_menu.host = host
-
-        self.port_set_spin = QtWidgets.QSpinBox()
-        self.port_set_spin.setMinimumSize(QtCore.QSize(70, 0))
-        self.port_set_spin.setMaximumSize(QtCore.QSize(70, 16777215))
-        self.port_set_spin.setMaximum(65535)
-        self.port_set_spin.setValue(23)
-
-        def connect_only_if_enter_pressed():
-            if not self.port_set_spin.hasFocus(): # Don't connect if the spinbox only lost focus
-                return;
-            connect_on_enter_press()
-        self.port_set_spin.editingFinished.connect(connect_only_if_enter_pressed)
-
-        port = QtWidgets.QWidgetAction(self.connection_menu)
-        port.setDefaultWidget(self.port_set_spin)
-        self.connection_menu.addAction(port)
-        self.connection_menu.port = port
-
-        self.exit_button = QtWidgets.QPushButton()
-        self.exit_button.setText("Exit GUI")
-        self.exit_button.pressed.connect(QtWidgets.QApplication.instance().quit)
-
-        exit_action = QtWidgets.QWidgetAction(self.exit_button)
-        exit_action.setDefaultWidget(self.exit_button)
-        self.connection_menu.addAction(exit_action)
-        self.connection_menu.exit_action = exit_action
-
-        self.connect_btn.setMenu(self.connection_menu)
-
-    def _set_up_thermostat_menu(self):
-        self.thermostat_menu = QtWidgets.QMenu()
-        self.thermostat_menu.setTitle('Thermostat settings')
-
-        self.fan_group = QtWidgets.QWidget()
-        self.fan_group.setEnabled(False)
-        self.fan_group.setMinimumSize(QtCore.QSize(40, 0))
-        self.fan_layout = QtWidgets.QHBoxLayout(self.fan_group)
-        self.fan_layout.setSpacing(9)
-        self.fan_lbl = QtWidgets.QLabel(parent=self.fan_group)
-        self.fan_lbl.setMinimumSize(QtCore.QSize(40, 0))
-        self.fan_lbl.setMaximumSize(QtCore.QSize(40, 16777215))
-        self.fan_lbl.setBaseSize(QtCore.QSize(40, 0))
-        self.fan_layout.addWidget(self.fan_lbl)
-        self.fan_power_slider = QtWidgets.QSlider(parent=self.fan_group)
-        self.fan_power_slider.setMinimumSize(QtCore.QSize(200, 0))
-        self.fan_power_slider.setMaximumSize(QtCore.QSize(200, 16777215))
-        self.fan_power_slider.setBaseSize(QtCore.QSize(200, 0))
-        self.fan_power_slider.setRange(1, 100)
-        self.fan_power_slider.setOrientation(QtCore.Qt.Orientation.Horizontal)
-        self.fan_layout.addWidget(self.fan_power_slider)
-        self.fan_auto_box = QtWidgets.QCheckBox(parent=self.fan_group)
-        self.fan_auto_box.setMinimumSize(QtCore.QSize(70, 0))
-        self.fan_auto_box.setMaximumSize(QtCore.QSize(70, 16777215))
-        self.fan_layout.addWidget(self.fan_auto_box)
-        self.fan_pwm_warning = QtWidgets.QLabel(parent=self.fan_group)
-        self.fan_pwm_warning.setMinimumSize(QtCore.QSize(16, 0))
-        self.fan_layout.addWidget(self.fan_pwm_warning)
-
-        self.fan_power_slider.valueChanged.connect(self.fan_set)
-        self.fan_auto_box.stateChanged.connect(self.fan_auto_set)
-
-        self.fan_lbl.setToolTip("Adjust the fan")
-        self.fan_lbl.setText("Fan:")
-        self.fan_auto_box.setText("Auto")
-
-        fan = QtWidgets.QWidgetAction(self.thermostat_menu)
-        fan.setDefaultWidget(self.fan_group)
-        self.thermostat_menu.addAction(fan)
-        self.thermostat_menu.fan = fan
-
-        @asyncSlot(bool)
-        async def reset_thermostat(_):
-            await self._on_connection_changed(False)
-            await self.client.reset()
-            await asyncio.sleep(0.1) # Wait for the reset to start
-
-            self.connect_btn.click() # Reconnect
-
-        self.actionReset.triggered.connect(reset_thermostat)
-        self.thermostat_menu.addAction(self.actionReset)
-
-        @asyncSlot(bool)
-        async def dfu_mode(_):
-            await self._on_connection_changed(False)
-            await self.client.dfu()
-
-            # TODO: add a firmware flashing GUI?
-
-        self.actionEnter_DFU_Mode.triggered.connect(dfu_mode)
-        self.thermostat_menu.addAction(self.actionEnter_DFU_Mode)
-
-        @asyncSlot(bool)
-        async def network_settings(_):
-            ask_network = QtWidgets.QInputDialog(self)
-            ask_network.setWindowTitle("Network Settings")
-            ask_network.setLabelText("Set the Thermostat's IPv4 address, netmask and gateway (optional)")
-            ask_network.setTextValue((await self.client.ipv4())['addr'])
-
-            @pyqtSlot(str)
-            def set_ipv4(ipv4_settings):
-                sure = QtWidgets.QMessageBox(self)
-                sure.setWindowTitle("Set network?")
-                sure.setText(f"Setting this as network and disconnecting:<br>{ipv4_settings}")
-
-                @asyncSlot(object)
-                async def really_set(button):
-                    await self.client.set_param("ipv4", ipv4_settings)
-                    await self.client.disconnect()
-
-                    await self._on_connection_changed(False)
-
-                sure.buttonClicked.connect(really_set)
-                sure.show()
-            ask_network.textValueSelected.connect(set_ipv4)
-            ask_network.show()
-
-        self.actionNetwork_Settings.triggered.connect(network_settings)
-        self.thermostat_menu.addAction(self.actionNetwork_Settings)
-
-        @asyncSlot(bool)
-        async def load(_):
-            await self.client.load_config()
-            loaded = QtWidgets.QMessageBox(self)
-            loaded.setWindowTitle("Config loaded")
-            loaded.setText(f"All channel configs have been loaded from flash.")
-            loaded.setIcon(QtWidgets.QMessageBox.Icon.Information)
-            loaded.show()
-
-        self.actionLoad_all_configs.triggered.connect(load)
-        self.thermostat_menu.addAction(self.actionLoad_all_configs)
-
-        @asyncSlot(bool)
-        async def save(_):
-            await self.client.save_config()
-            saved = QtWidgets.QMessageBox(self)
-            saved.setWindowTitle("Config saved")
-            saved.setText(f"All channel configs have been saved to flash.")
-            saved.setIcon(QtWidgets.QMessageBox.Icon.Information)
-            saved.show()
-
-        self.actionSave_all_configs.triggered.connect(save)
-        self.thermostat_menu.addAction(self.actionSave_all_configs)
-
-        def about_thermostat():
-            QtWidgets.QMessageBox.about(
-                self,
-                "About Thermostat",
-                f"""
-                <h1>Sinara 8451 Thermostat v{self.hw_rev_data['rev']['major']}.{self.hw_rev_data['rev']['minor']}</h1>
-
-                <br>
-
-                <h2>Settings:</h2>
-                Default fan curve:
-                    a = {self.hw_rev_data['settings']['fan_k_a']},
-                    b = {self.hw_rev_data['settings']['fan_k_b']},
-                    c = {self.hw_rev_data['settings']['fan_k_c']}
-                <br>
-                Fan PWM range: 
-                    {self.hw_rev_data['settings']['min_fan_pwm']} \u2013 {self.hw_rev_data['settings']['max_fan_pwm']}
-                <br>
-                Fan PWM frequency: {self.hw_rev_data['settings']['fan_pwm_freq_hz']} Hz
-                <br>
-                Fan available: {self.hw_rev_data['settings']['fan_available']}
-                <br>
-                Fan PWM recommended: {self.hw_rev_data['settings']['fan_pwm_recommended']}
-                """
-            )
-
-        self.actionAbout_Thermostat.triggered.connect(about_thermostat)
-        self.thermostat_menu.addAction(self.actionAbout_Thermostat)
-
-        self.thermostat_settings.setMenu(self.thermostat_menu)
-
-    def _set_up_plot_menu(self):
-        self.plot_menu = QtWidgets.QMenu()
-        self.plot_menu.setTitle("Plot Settings")
-
-        clear = QtGui.QAction("Clear graphs", self.plot_menu)
-        clear.triggered.connect(self.clear_graphs)
-        self.plot_menu.addAction(clear)
-        self.plot_menu.clear = clear
-
-        self.samples_spinbox = QtWidgets.QSpinBox()
-        self.samples_spinbox.setRange(2, 100000)
-        self.samples_spinbox.setSuffix(' samples')
-        self.samples_spinbox.setValue(self.max_samples)
-        self.samples_spinbox.valueChanged.connect(self.set_max_samples)
-
-        limit_samples = QtWidgets.QWidgetAction(self.plot_menu)
-        limit_samples.setDefaultWidget(self.samples_spinbox)
-        self.plot_menu.addAction(limit_samples)
-        self.plot_menu.limit_samples = limit_samples
-
-        self.plot_settings.setMenu(self.plot_menu)
-
-    @pyqtSlot(list)
-    def set_limits_warning(self, channels_zeroed_limits: list):
-        channel_disabled = [False, False]
-
-        report_str = "The following output limit(s) are set to zero:\n"
-        for ch, zeroed_limits in enumerate(channels_zeroed_limits):
-            if {'max_i_pos', 'max_i_neg'}.issubset(zeroed_limits):
-                report_str += "Max Cooling Current, Max Heating Current"
-                channel_disabled[ch] = True
-
-            if 'max_v' in zeroed_limits:
-                if channel_disabled[ch]:
-                    report_str += ", "
-                report_str += "Max Voltage Difference"
-                channel_disabled[ch] = True
-
-            if channel_disabled[ch]:
-                report_str += f" for Channel {ch}\n"
-
-        report_str += "\nThese limit(s) are restricting the channel(s) from producing current."
-
-        if True in channel_disabled:
-            pixmapi = getattr(QtWidgets.QStyle.StandardPixmap, "SP_MessageBoxWarning")
-            icon = self.style().standardIcon(pixmapi)
-            self.limits_warning.setPixmap(icon.pixmap(16, 16))
-            self.limits_warning.setToolTip(report_str)
-        else:
-            self.limits_warning.setPixmap(QtGui.QPixmap())
-            self.limits_warning.setToolTip(None)
-
-    @pyqtSlot(int)
-    def set_max_samples(self, samples: int):
-        for channel_graph in self.channel_graphs:
-            channel_graph.t_connector.max_points = samples
-            channel_graph.i_connector.max_points = samples
-            channel_graph.iset_connector.max_points = samples
-
-    def clear_graphs(self):
-        for channel_graph in self.channel_graphs:
-            channel_graph.clear()
-
-    async def _on_connection_changed(self, result):
-        self.graph_group.setEnabled(result)
-        self.report_group.setEnabled(result)
-        self.thermostat_settings.setEnabled(result)
-
-        self.host_set_line.setEnabled(not result)
-        self.port_set_spin.setEnabled(not result)
-        self.connect_btn.setText("Disconnect" if result else "Connect")
-        if result:
-            self.hw_rev_data = await self.client.hw_rev()
-            self._status(self.hw_rev_data)
-            self.client_watcher.start_watching()
-            # await self.client.set_param("fan", 1)
-        else:
-            self.status_lbl.setText("Disconnected")
-            self.fan_pwm_warning.setPixmap(QtGui.QPixmap())
-            self.fan_pwm_warning.setToolTip("")
-            self.clear_graphs()
-            self.report_box.setChecked(False)
-            await self.client_watcher.set_report_mode(False)
-            self.client_watcher.stop_watching()
-            self.status_lbl.setText("Disconnected")
-
-    def _set_fan_pwm_warning(self):
-        if self.fan_power_slider.value() != 100:
-            pixmapi = getattr(QtWidgets.QStyle.StandardPixmap, "SP_MessageBoxWarning")
-            icon = self.style().standardIcon(pixmapi)
-            self.fan_pwm_warning.setPixmap(icon.pixmap(16, 16))
-            self.fan_pwm_warning.setToolTip("Throttling the fan (not recommended on this hardware rev)")
-        else:
-            self.fan_pwm_warning.setPixmap(QtGui.QPixmap())
-            self.fan_pwm_warning.setToolTip("")
-
-    def _status(self, hw_rev_d: dict):
-        logging.debug(hw_rev_d)
-        self.status_lbl.setText(f"Connected to Thermostat v{hw_rev_d['rev']['major']}.{hw_rev_d['rev']['minor']}")
-        self.fan_group.setEnabled(hw_rev_d["settings"]["fan_available"])
-
-    @pyqtSlot(dict)
-    def fan_update(self, fan_settings: dict):
-        logging.debug(fan_settings)
-        if fan_settings is None:
-            return
-        with QSignalBlocker(self.fan_power_slider):
-            self.fan_power_slider.setValue(fan_settings["fan_pwm"] or 100) # 0 = PWM off = full strength
-        with QSignalBlocker(self.fan_auto_box):
-            self.fan_auto_box.setChecked(fan_settings["auto_mode"])
-        if not self.hw_rev_data["settings"]["fan_pwm_recommended"]:
-            self._set_fan_pwm_warning()
-
-    @asyncSlot(int)
-    async def fan_set(self, value):
-        if not self.client.connected():
-            return
-        if self.fan_auto_box.isChecked():
-            with QSignalBlocker(self.fan_auto_box):
-                self.fan_auto_box.setChecked(False)
-        await self.client.set_fan(value)
-        if not self.hw_rev_data["settings"]["fan_pwm_recommended"]:
-            self._set_fan_pwm_warning()
-
-    @asyncSlot(int)
-    async def fan_auto_set(self, enabled):
-        if not self.client.connected():
-            return
-        if enabled:
-            await self.client.set_fan("auto")
-            self.fan_update(await self.client.get_fan())
-        else:
-            await self.client.set_fan(self.fan_power_slider.value())
-
-    @asyncSlot(int)
-    async def on_report_box_stateChanged(self, enabled):
-        await self.client_watcher.set_report_mode(enabled)
-
-    @asyncClose
-    async def closeEvent(self, event):
-        await self.bail()
-
-    @asyncSlot()
-    async def on_connect_btn_clicked(self):
-        host, port = self.host_set_line.text(), self.port_set_spin.value()
-        try:
-            if not (self.client.connecting() or self.client.connected()):
-                self.status_lbl.setText("Connecting...")
-                self.connect_btn.setText("Stop")
-                self.host_set_line.setEnabled(False)
-                self.port_set_spin.setEnabled(False)
-
-                try:
-                    await self.client.start_session(host=host, port=port, timeout=30)
-                except StoppedConnecting:
-                    return
-                await self._on_connection_changed(True)
-            else:
-                await self.bail()
-
-        except (OSError, TimeoutError, asyncio.TimeoutError) as e: # TODO: Remove asyncio.TimeoutError in Python 3.11
-            logging.error(f"Failed communicating to {host}:{port}: {e}")
-            await self.bail()
-
-    @asyncSlot()
-    async def bail(self):
-        await self._on_connection_changed(False)
-        await self.client.end_session()
-
-    @asyncSlot(object, object)
-    async def send_command(self, param, changes):
-        """Translates parameter tree changes into thermostat set_param calls"""
-
-        for inner_param, change, data in changes:
-            if change == 'value':
-                if inner_param.opts.get("param", None) is not None:
-                    if 'Current' in inner_param.name():
-                        data /= 1000 # Given in mA
-
-                    thermostat_param = inner_param.opts["param"]
-                    if inner_param.name() == 'Postfilter Rate' and data == None:
-                        set_param_args = (*thermostat_param[:2], 'off')
-                    else:
-                        set_param_args = (*thermostat_param, data)
-                    await self.client.set_param(*set_param_args)
-                if inner_param.opts.get('activaters', None) is not None:
-                    activater = inner_param.opts['activaters'][inner_param.opts['limits'].index(data)]
-                    if activater is not None:
-                        await self.client.set_param(*activater)
-
-
-    def _set_param_tree(self):
-        for i, tree in enumerate((self.ch0_tree, self.ch1_tree)):
-            tree.setHeaderHidden(True)
-            tree.setParameters(self.params[i], showTop=False)
-            self.params[i].sigTreeStateChanged.connect(self.send_command)
-
-            @asyncSlot()
-            async def save(_, ch=i):
-                await self.client.save_config(ch)
-                saved = QtWidgets.QMessageBox(self)
-                saved.setWindowTitle("Config saved")
-                saved.setText(f"Channel {ch} Config has been saved to flash.")
-                saved.setIcon(QtWidgets.QMessageBox.Icon.Information)
-                saved.show()
-
-            self.params[i].child('Save to flash').sigActivated.connect(save)
-
-            @asyncSlot()
-            async def load(_, ch=i):
-                await self.client.load_config(ch)
-                loaded = QtWidgets.QMessageBox(self)
-                loaded.setWindowTitle("Config loaded")
-                loaded.setText(f"Channel {ch} Config has been loaded from flash.")
-                loaded.setIcon(QtWidgets.QMessageBox.Icon.Information)
-                loaded.show()
-
-            self.params[i].child('Load from flash').sigActivated.connect(load)
-
-            @asyncSlot()
-            async def autotune(param, ch=i):
-                match self.autotuners[ch].state():
-                    case PIDAutotuneState.STATE_OFF:
-                        self.autotuners[ch].setParam(
-                            param.parent().child('Target Temperature').value(),
-                            param.parent().child('Test Current').value() / 1000,
-                            param.parent().child('Temperature Swing').value(),
-                            self.report_refresh_spin.value(),
-                            3)
-                        self.autotuners[ch].setReady()
-                        param.setOpts(title="Stop")
-                        self.client_watcher.report_update.connect(self.autotune_tick)
-                        self.loading_spinner.show()
-                        self.loading_spinner.start()
-                        if self.autotuners[1 - ch].state() == PIDAutotuneState.STATE_OFF:
-                            self.background_task_lbl.setText("Autotuning channel {ch}...".format(ch=ch))
-                        else:
-                            self.background_task_lbl.setText("Autotuning channel 0 and 1...")
-                    case PIDAutotuneState.STATE_READY | PIDAutotuneState.STATE_RELAY_STEP_UP | PIDAutotuneState.STATE_RELAY_STEP_DOWN:
-                        self.autotuners[ch].setOff()
-                        param.setOpts(title="Run")
-                        await self.client.set_param('pwm', ch, 'i_set', 0)
-                        self.client_watcher.report_update.disconnect(self.autotune_tick)
-                        if self.autotuners[1 - ch].state() == PIDAutotuneState.STATE_OFF:
-                            self.background_task_lbl.setText("Ready.")
-                            self.loading_spinner.stop()
-                            self.loading_spinner.hide()
-                        else:
-                            self.background_task_lbl.setText("Autotuning channel {ch}...".format(ch=1-ch))
-
-            self.params[i].child('PID Config', 'PID Auto Tune', 'Run').sigActivated.connect(autotune)
-
-    @asyncSlot(list)
-    async def autotune_tick(self, report):
-        for channel_report in report:
-            channel = channel_report['channel']
-            match self.autotuners[channel].state():
-                case PIDAutotuneState.STATE_READY | PIDAutotuneState.STATE_RELAY_STEP_UP | PIDAutotuneState.STATE_RELAY_STEP_DOWN:
-                    self.autotuners[channel].run(channel_report['temperature'], channel_report['time'])
-                    await self.client.set_param('pwm', channel, 'i_set', self.autotuners[channel].output())
-                case PIDAutotuneState.STATE_SUCCEEDED:
-                    kp, ki, kd = self.autotuners[channel].get_tec_pid()
-                    self.autotuners[channel].setOff()
-                    self.params[channel].child('PID Config', 'PID Auto Tune', 'Run').setOpts(title="Run")
-                    await self.client.set_param('pid', channel, 'kp', kp)
-                    await self.client.set_param('pid', channel, 'ki', ki)
-                    await self.client.set_param('pid', channel, 'kd', kd)
-                    await self.client.set_param('pwm', channel, 'pid')
-                    await self.client.set_param('pid', channel, 'target', self.params[channel].child("PID Config", "PID Auto Tune", "Target Temperature").value())
-                    self.client_watcher.report_update.disconnect(self.autotune_tick)
-                    if self.autotuners[1 - channel].state() == PIDAutotuneState.STATE_OFF:
-                        self.background_task_lbl.setText("Ready.")
-                        self.loading_spinner.stop()
-                        self.loading_spinner.hide()
-                    else:
-                        self.background_task_lbl.setText("Autotuning channel {ch}...".format(ch=1-ch))
-                case PIDAutotuneState.STATE_FAILED:
-                    self.autotuners[channel].setOff()
-                    self.params[channel].child('PID Config', 'PID Auto Tune', 'Run').setOpts(title="Run")
-                    await self.client.set_param('pwm', channel, 'i_set', 0)
-                    self.client_watcher.report_update.disconnect(self.autotune_tick)
-                    if self.autotuners[1 - channel].state() == PIDAutotuneState.STATE_OFF:
-                        self.background_task_lbl.setText("Ready.")
-                        self.loading_spinner.stop()
-                        self.loading_spinner.hide()
-                    else:
-                        self.background_task_lbl.setText("Autotuning channel {ch}...".format(ch=1-ch))
-
-    @pyqtSlot(list)
-    def update_pid(self, pid_settings):
-        for settings in pid_settings:
-            channel = settings["channel"]
-            with QSignalBlocker(self.params[channel]):
-                self.params[channel].child("PID Config", "Kp").setValue(settings["parameters"]["kp"])
-                self.params[channel].child("PID Config", "Ki").setValue(settings["parameters"]["ki"])
-                self.params[channel].child("PID Config", "Kd").setValue(settings["parameters"]["kd"])
-                self.params[channel].child("PID Config", "PID Output Clamping", "Minimum").setValue(settings["parameters"]["output_min"] * 1000)
-                self.params[channel].child("PID Config", "PID Output Clamping", "Maximum").setValue(settings["parameters"]["output_max"] * 1000)
-                self.params[channel].child("Output Config", "Control Method", "Set Temperature").setValue(settings["target"])
-                self.channel_graphs[channel].set_t_line(temp=round(settings["target"], 6))
-
-    @pyqtSlot(list)
-    def update_report(self, report_data):
-        for settings in report_data:
-            channel = settings["channel"]
-            self.channel_graphs[channel].plot_append(settings)
-            with QSignalBlocker(self.params[channel]):
-                self.params[channel].child("Output Config", "Control Method").setValue("Temperature PID" if settings["pid_engaged"] else "Constant Current")
-                self.channel_graphs[channel].set_t_line(visible=settings['pid_engaged'])
-                self.params[channel].child("Output Config", "Control Method", "Set Current").setValue(settings["i_set"] * 1000)
-                if settings['temperature'] is not None:
-                    self.params[channel].child("Temperature").setValue(settings['temperature'])
-                    if settings['tec_i'] is not None:
-                        self.params[channel].child("Current through TEC").setValue(settings['tec_i'] * 1000)
-
-    @pyqtSlot(list)
-    def update_thermistor(self, sh_data):
-        for sh_param in sh_data:
-            channel = sh_param["channel"]
-            with QSignalBlocker(self.params[channel]):
-                self.params[channel].child("Thermistor Config", "T₀").setValue(sh_param["params"]["t0"] - 273.15)
-                self.params[channel].child("Thermistor Config", "R₀").setValue(sh_param["params"]["r0"])
-                self.params[channel].child("Thermistor Config", "B").setValue(sh_param["params"]["b"])
-
-    @pyqtSlot(list)
-    def update_pwm(self, pwm_data):
-        channels_zeroed_limits = [set() for i in range(NUM_CHANNELS)]
-
-        for pwm_params in pwm_data:
-            channel = pwm_params["channel"]
-            with QSignalBlocker(self.params[channel]):
-                self.params[channel].child("Output Config", "Limits", "Max Voltage Difference").setValue(pwm_params["max_v"]["value"])
-                self.params[channel].child("Output Config", "Limits", "Max Cooling Current").setValue(pwm_params["max_i_pos"]["value"] * 1000)
-                self.params[channel].child("Output Config", "Limits", "Max Heating Current").setValue(pwm_params["max_i_neg"]["value"] * 1000)
-
-            for limit in "max_i_pos", "max_i_neg", "max_v":
-                if pwm_params[limit]["value"] == 0.0:
-                    channels_zeroed_limits[channel].add(limit)
-
-        self.set_limits_warning(channels_zeroed_limits)
-
-    @pyqtSlot(list)
-    def update_postfilter(self, postfilter_data):
-        for postfilter_params in postfilter_data:
-            channel = postfilter_params["channel"]
-            with QSignalBlocker(self.params[channel]):
-                self.params[channel].child("Thermistor Config", "Postfilter Rate").setValue(postfilter_params["rate"])
-
-
-async def coro_main():
-    args = get_argparser().parse_args()
-    if args.logLevel:
-        logging.basicConfig(level=getattr(logging, args.logLevel))
-
-    app_quit_event = asyncio.Event()
-
-    app = QtWidgets.QApplication.instance()
-    app.aboutToQuit.connect(app_quit_event.set)
-
-    main_window = MainWindow(args)
-    main_window.show()
-
-    await app_quit_event.wait()
-
-
-def main():
-    qasync.run(coro_main())
-
-
-if __name__ == '__main__':
-    main()

pytec/ui_tec_qt.py

@@ -1,268 +0,0 @@
-# Form implementation generated from reading ui file 'tec_qt.ui'
-#
-# Created by: PyQt6 UI code generator 6.5.2
-#
-# WARNING: Any manual changes made to this file will be lost when pyuic6 is
-# run again.  Do not edit this file unless you know what you are doing.
-
-
-from PyQt6 import QtCore, QtGui, QtWidgets
-
-
-class Ui_MainWindow(object):
-    def setupUi(self, MainWindow):
-        MainWindow.setObjectName("MainWindow")
-        MainWindow.resize(1280, 720)
-        MainWindow.setMinimumSize(QtCore.QSize(1280, 720))
-        MainWindow.setMaximumSize(QtCore.QSize(3840, 2160))
-        icon = QtGui.QIcon()
-        icon.addPixmap(QtGui.QPixmap("thermostat-icon-640x640.png"), QtGui.QIcon.Mode.Normal, QtGui.QIcon.State.Off)
-        MainWindow.setWindowIcon(icon)
-        self.main_widget = QtWidgets.QWidget(parent=MainWindow)
-        sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Policy.Expanding, QtWidgets.QSizePolicy.Policy.Expanding)
-        sizePolicy.setHorizontalStretch(1)
-        sizePolicy.setVerticalStretch(1)
-        sizePolicy.setHeightForWidth(self.main_widget.sizePolicy().hasHeightForWidth())
-        self.main_widget.setSizePolicy(sizePolicy)
-        self.main_widget.setObjectName("main_widget")
-        self.gridLayout_2 = QtWidgets.QGridLayout(self.main_widget)
-        self.gridLayout_2.setContentsMargins(3, 3, 3, 3)
-        self.gridLayout_2.setSpacing(3)
-        self.gridLayout_2.setObjectName("gridLayout_2")
-        self.main_layout = QtWidgets.QVBoxLayout()
-        self.main_layout.setSpacing(0)
-        self.main_layout.setObjectName("main_layout")
-        self.graph_group = QtWidgets.QFrame(parent=self.main_widget)
-        self.graph_group.setEnabled(False)
-        sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Policy.Expanding, QtWidgets.QSizePolicy.Policy.Expanding)
-        sizePolicy.setHorizontalStretch(1)
-        sizePolicy.setVerticalStretch(1)
-        sizePolicy.setHeightForWidth(self.graph_group.sizePolicy().hasHeightForWidth())
-        self.graph_group.setSizePolicy(sizePolicy)
-        self.graph_group.setFrameShape(QtWidgets.QFrame.Shape.StyledPanel)
-        self.graph_group.setFrameShadow(QtWidgets.QFrame.Shadow.Raised)
-        self.graph_group.setObjectName("graph_group")
-        self.graphs_layout = QtWidgets.QGridLayout(self.graph_group)
-        self.graphs_layout.setSizeConstraint(QtWidgets.QLayout.SizeConstraint.SetDefaultConstraint)
-        self.graphs_layout.setContentsMargins(3, 3, 3, 3)
-        self.graphs_layout.setSpacing(2)
-        self.graphs_layout.setObjectName("graphs_layout")
-        self.ch1_tree = ParameterTree(parent=self.graph_group)
-        self.ch1_tree.setObjectName("ch1_tree")
-        self.graphs_layout.addWidget(self.ch1_tree, 1, 0, 1, 1)
-        self.ch0_tree = ParameterTree(parent=self.graph_group)
-        self.ch0_tree.setObjectName("ch0_tree")
-        self.graphs_layout.addWidget(self.ch0_tree, 0, 0, 1, 1)
-        self.ch1_t_graph = LivePlotWidget(parent=self.graph_group)
-        self.ch1_t_graph.setObjectName("ch1_t_graph")
-        self.graphs_layout.addWidget(self.ch1_t_graph, 1, 1, 1, 1)
-        self.ch0_t_graph = LivePlotWidget(parent=self.graph_group)
-        self.ch0_t_graph.setObjectName("ch0_t_graph")
-        self.graphs_layout.addWidget(self.ch0_t_graph, 0, 1, 1, 1)
-        self.ch0_i_graph = LivePlotWidget(parent=self.graph_group)
-        self.ch0_i_graph.setObjectName("ch0_i_graph")
-        self.graphs_layout.addWidget(self.ch0_i_graph, 0, 2, 1, 1)
-        self.ch1_i_graph = LivePlotWidget(parent=self.graph_group)
-        self.ch1_i_graph.setObjectName("ch1_i_graph")
-        self.graphs_layout.addWidget(self.ch1_i_graph, 1, 2, 1, 1)
-        self.graphs_layout.setColumnMinimumWidth(0, 100)
-        self.graphs_layout.setColumnMinimumWidth(1, 100)
-        self.graphs_layout.setColumnMinimumWidth(2, 100)
-        self.graphs_layout.setRowMinimumHeight(0, 100)
-        self.graphs_layout.setRowMinimumHeight(1, 100)
-        self.graphs_layout.setColumnStretch(0, 1)
-        self.graphs_layout.setColumnStretch(1, 1)
-        self.graphs_layout.setColumnStretch(2, 1)
-        self.graphs_layout.setRowStretch(0, 1)
-        self.graphs_layout.setRowStretch(1, 1)
-        self.main_layout.addWidget(self.graph_group)
-        self.bottom_settings_group = QtWidgets.QFrame(parent=self.main_widget)
-        sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Policy.Expanding, QtWidgets.QSizePolicy.Policy.Fixed)
-        sizePolicy.setHorizontalStretch(0)
-        sizePolicy.setVerticalStretch(0)
-        sizePolicy.setHeightForWidth(self.bottom_settings_group.sizePolicy().hasHeightForWidth())
-        self.bottom_settings_group.setSizePolicy(sizePolicy)
-        self.bottom_settings_group.setMinimumSize(QtCore.QSize(0, 40))
-        self.bottom_settings_group.setMaximumSize(QtCore.QSize(16777215, 40))
-        self.bottom_settings_group.setFrameShape(QtWidgets.QFrame.Shape.StyledPanel)
-        self.bottom_settings_group.setFrameShadow(QtWidgets.QFrame.Shadow.Raised)
-        self.bottom_settings_group.setObjectName("bottom_settings_group")
-        self.horizontalLayout_2 = QtWidgets.QHBoxLayout(self.bottom_settings_group)
-        self.horizontalLayout_2.setContentsMargins(3, 3, 3, 3)
-        self.horizontalLayout_2.setSpacing(3)
-        self.horizontalLayout_2.setObjectName("horizontalLayout_2")
-        self.settings_layout = QtWidgets.QHBoxLayout()
-        self.settings_layout.setObjectName("settings_layout")
-        self.connect_btn = QtWidgets.QToolButton(parent=self.bottom_settings_group)
-        sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Policy.Fixed, QtWidgets.QSizePolicy.Policy.Expanding)
-        sizePolicy.setHorizontalStretch(0)
-        sizePolicy.setVerticalStretch(0)
-        sizePolicy.setHeightForWidth(self.connect_btn.sizePolicy().hasHeightForWidth())
-        self.connect_btn.setSizePolicy(sizePolicy)
-        self.connect_btn.setMinimumSize(QtCore.QSize(100, 0))
-        self.connect_btn.setMaximumSize(QtCore.QSize(100, 16777215))
-        self.connect_btn.setBaseSize(QtCore.QSize(100, 0))
-        self.connect_btn.setPopupMode(QtWidgets.QToolButton.ToolButtonPopupMode.MenuButtonPopup)
-        self.connect_btn.setToolButtonStyle(QtCore.Qt.ToolButtonStyle.ToolButtonFollowStyle)
-        self.connect_btn.setObjectName("connect_btn")
-        self.settings_layout.addWidget(self.connect_btn)
-        self.status_lbl = QtWidgets.QLabel(parent=self.bottom_settings_group)
-        sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Policy.Fixed, QtWidgets.QSizePolicy.Policy.Expanding)
-        sizePolicy.setHorizontalStretch(0)
-        sizePolicy.setVerticalStretch(0)
-        sizePolicy.setHeightForWidth(self.status_lbl.sizePolicy().hasHeightForWidth())
-        self.status_lbl.setSizePolicy(sizePolicy)
-        self.status_lbl.setMinimumSize(QtCore.QSize(240, 0))
-        self.status_lbl.setMaximumSize(QtCore.QSize(120, 16777215))
-        self.status_lbl.setBaseSize(QtCore.QSize(120, 50))
-        self.status_lbl.setObjectName("status_lbl")
-        self.settings_layout.addWidget(self.status_lbl)
-        self.thermostat_settings = QtWidgets.QToolButton(parent=self.bottom_settings_group)
-        self.thermostat_settings.setEnabled(False)
-        self.thermostat_settings.setText("⚙")
-        self.thermostat_settings.setPopupMode(QtWidgets.QToolButton.ToolButtonPopupMode.InstantPopup)
-        self.thermostat_settings.setObjectName("thermostat_settings")
-        self.settings_layout.addWidget(self.thermostat_settings)
-        self.plot_settings = QtWidgets.QToolButton(parent=self.bottom_settings_group)
-        self.plot_settings.setPopupMode(QtWidgets.QToolButton.ToolButtonPopupMode.InstantPopup)
-        self.plot_settings.setObjectName("plot_settings")
-        self.settings_layout.addWidget(self.plot_settings)
-        self.limits_warning = QtWidgets.QLabel(parent=self.bottom_settings_group)
-        self.limits_warning.setToolTipDuration(1000000000)
-        self.limits_warning.setObjectName("limits_warning")
-        self.settings_layout.addWidget(self.limits_warning)
-        self.background_task_lbl = QtWidgets.QLabel(parent=self.bottom_settings_group)
-        self.background_task_lbl.setObjectName("background_task_lbl")
-        self.settings_layout.addWidget(self.background_task_lbl)
-        self.loading_spinner = QtWaitingSpinner(parent=self.bottom_settings_group)
-        self.loading_spinner.setObjectName("loading_spinner")
-        self.settings_layout.addWidget(self.loading_spinner)
-        spacerItem = QtWidgets.QSpacerItem(40, 20, QtWidgets.QSizePolicy.Policy.Expanding, QtWidgets.QSizePolicy.Policy.Minimum)
-        self.settings_layout.addItem(spacerItem)
-        self.report_group = QtWidgets.QWidget(parent=self.bottom_settings_group)
-        self.report_group.setEnabled(False)
-        sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Policy.Minimum, QtWidgets.QSizePolicy.Policy.Expanding)
-        sizePolicy.setHorizontalStretch(0)
-        sizePolicy.setVerticalStretch(0)
-        sizePolicy.setHeightForWidth(self.report_group.sizePolicy().hasHeightForWidth())
-        self.report_group.setSizePolicy(sizePolicy)
-        self.report_group.setMinimumSize(QtCore.QSize(40, 0))
-        self.report_group.setObjectName("report_group")
-        self.horizontalLayout_4 = QtWidgets.QHBoxLayout(self.report_group)
-        self.horizontalLayout_4.setContentsMargins(0, 0, 0, 0)
-        self.horizontalLayout_4.setSpacing(0)
-        self.horizontalLayout_4.setObjectName("horizontalLayout_4")
-        self.report_layout = QtWidgets.QHBoxLayout()
-        self.report_layout.setSizeConstraint(QtWidgets.QLayout.SizeConstraint.SetDefaultConstraint)
-        self.report_layout.setContentsMargins(0, -1, -1, -1)
-        self.report_layout.setSpacing(6)
-        self.report_layout.setObjectName("report_layout")
-        self.report_lbl = QtWidgets.QLabel(parent=self.report_group)
-        self.report_lbl.setAlignment(QtCore.Qt.AlignmentFlag.AlignRight|QtCore.Qt.AlignmentFlag.AlignTrailing|QtCore.Qt.AlignmentFlag.AlignVCenter)
-        self.report_lbl.setObjectName("report_lbl")
-        self.report_layout.addWidget(self.report_lbl)
-        self.report_refresh_spin = QtWidgets.QDoubleSpinBox(parent=self.report_group)
-        sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Policy.Fixed, QtWidgets.QSizePolicy.Policy.Expanding)
-        sizePolicy.setHorizontalStretch(0)
-        sizePolicy.setVerticalStretch(0)
-        sizePolicy.setHeightForWidth(self.report_refresh_spin.sizePolicy().hasHeightForWidth())
-        self.report_refresh_spin.setSizePolicy(sizePolicy)
-        self.report_refresh_spin.setMinimumSize(QtCore.QSize(70, 0))
-        self.report_refresh_spin.setMaximumSize(QtCore.QSize(70, 16777215))
-        self.report_refresh_spin.setBaseSize(QtCore.QSize(70, 0))
-        self.report_refresh_spin.setDecimals(1)
-        self.report_refresh_spin.setMinimum(0.1)
-        self.report_refresh_spin.setSingleStep(0.1)
-        self.report_refresh_spin.setStepType(QtWidgets.QAbstractSpinBox.StepType.AdaptiveDecimalStepType)
-        self.report_refresh_spin.setProperty("value", 1.0)
-        self.report_refresh_spin.setObjectName("report_refresh_spin")
-        self.report_layout.addWidget(self.report_refresh_spin)
-        self.report_box = QtWidgets.QCheckBox(parent=self.report_group)
-        sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Policy.Fixed, QtWidgets.QSizePolicy.Policy.Expanding)
-        sizePolicy.setHorizontalStretch(0)
-        sizePolicy.setVerticalStretch(0)
-        sizePolicy.setHeightForWidth(self.report_box.sizePolicy().hasHeightForWidth())
-        self.report_box.setSizePolicy(sizePolicy)
-        self.report_box.setMaximumSize(QtCore.QSize(80, 16777215))
-        self.report_box.setBaseSize(QtCore.QSize(80, 0))
-        self.report_box.setObjectName("report_box")
-        self.report_layout.addWidget(self.report_box)
-        self.report_apply_btn = QtWidgets.QPushButton(parent=self.report_group)
-        sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Policy.Fixed, QtWidgets.QSizePolicy.Policy.Expanding)
-        sizePolicy.setHorizontalStretch(0)
-        sizePolicy.setVerticalStretch(0)
-        sizePolicy.setHeightForWidth(self.report_apply_btn.sizePolicy().hasHeightForWidth())
-        self.report_apply_btn.setSizePolicy(sizePolicy)
-        self.report_apply_btn.setMinimumSize(QtCore.QSize(80, 0))
-        self.report_apply_btn.setMaximumSize(QtCore.QSize(80, 16777215))
-        self.report_apply_btn.setBaseSize(QtCore.QSize(80, 0))
-        self.report_apply_btn.setObjectName("report_apply_btn")
-        self.report_layout.addWidget(self.report_apply_btn)
-        self.report_layout.setStretch(1, 1)
-        self.report_layout.setStretch(2, 1)
-        self.report_layout.setStretch(3, 1)
-        self.horizontalLayout_4.addLayout(self.report_layout)
-        self.settings_layout.addWidget(self.report_group)
-        self.horizontalLayout_2.addLayout(self.settings_layout)
-        self.main_layout.addWidget(self.bottom_settings_group)
-        self.gridLayout_2.addLayout(self.main_layout, 0, 1, 1, 1)
-        MainWindow.setCentralWidget(self.main_widget)
-        self.actionReset = QtGui.QAction(parent=MainWindow)
-        self.actionReset.setMenuRole(QtGui.QAction.MenuRole.NoRole)
-        self.actionReset.setObjectName("actionReset")
-        self.actionEnter_DFU_Mode = QtGui.QAction(parent=MainWindow)
-        self.actionEnter_DFU_Mode.setMenuRole(QtGui.QAction.MenuRole.NoRole)
-        self.actionEnter_DFU_Mode.setObjectName("actionEnter_DFU_Mode")
-        self.actionNetwork_Settings = QtGui.QAction(parent=MainWindow)
-        self.actionNetwork_Settings.setMenuRole(QtGui.QAction.MenuRole.NoRole)
-        self.actionNetwork_Settings.setObjectName("actionNetwork_Settings")
-        self.actionAbout_Thermostat = QtGui.QAction(parent=MainWindow)
-        self.actionAbout_Thermostat.setMenuRole(QtGui.QAction.MenuRole.NoRole)
-        self.actionAbout_Thermostat.setObjectName("actionAbout_Thermostat")
-        self.actionLoad_all_configs = QtGui.QAction(parent=MainWindow)
-        self.actionLoad_all_configs.setMenuRole(QtGui.QAction.MenuRole.NoRole)
-        self.actionLoad_all_configs.setObjectName("actionLoad_all_configs")
-        self.actionSave_all_configs = QtGui.QAction(parent=MainWindow)
-        self.actionSave_all_configs.setMenuRole(QtGui.QAction.MenuRole.NoRole)
-        self.actionSave_all_configs.setObjectName("actionSave_all_configs")
-
-        self.retranslateUi(MainWindow)
-        QtCore.QMetaObject.connectSlotsByName(MainWindow)
-
-    def retranslateUi(self, MainWindow):
-        _translate = QtCore.QCoreApplication.translate
-        MainWindow.setWindowTitle(_translate("MainWindow", "Thermostat Control Panel"))
-        self.connect_btn.setText(_translate("MainWindow", "Connect"))
-        self.status_lbl.setText(_translate("MainWindow", "Disconnected"))
-        self.plot_settings.setToolTip(_translate("MainWindow", "Plot Settings"))
-        self.plot_settings.setText(_translate("MainWindow", "📉"))
-        self.background_task_lbl.setText(_translate("MainWindow", "Ready."))
-        self.report_lbl.setText(_translate("MainWindow", "Poll every: "))
-        self.report_refresh_spin.setSuffix(_translate("MainWindow", " s"))
-        self.report_box.setText(_translate("MainWindow", "Report"))
-        self.report_apply_btn.setText(_translate("MainWindow", "Apply"))
-        self.actionReset.setText(_translate("MainWindow", "Reset"))
-        self.actionReset.setToolTip(_translate("MainWindow", "Reset the Thermostat"))
-        self.actionEnter_DFU_Mode.setText(_translate("MainWindow", "Enter DFU Mode"))
-        self.actionEnter_DFU_Mode.setToolTip(_translate("MainWindow", "Reset thermostat and enter USB device firmware update (DFU) mode"))
-        self.actionNetwork_Settings.setText(_translate("MainWindow", "Network Settings"))
-        self.actionNetwork_Settings.setToolTip(_translate("MainWindow", "Configure IPv4 address, netmask length, and optional default gateway"))
-        self.actionAbout_Thermostat.setText(_translate("MainWindow", "About Thermostat"))
-        self.actionAbout_Thermostat.setToolTip(_translate("MainWindow", "Show Thermostat hardware revision, and settings related to i"))
-        self.actionLoad_all_configs.setText(_translate("MainWindow", "Load all channel configs from flash"))
-        self.actionLoad_all_configs.setToolTip(_translate("MainWindow", "Restore configuration for all channels from flash"))
-        self.actionSave_all_configs.setText(_translate("MainWindow", "Save all channel configs to flash"))
-        self.actionSave_all_configs.setToolTip(_translate("MainWindow", "Save configuration for all channels to flash"))
-from pglive.sources.live_plot_widget import LivePlotWidget
-from pyqtgraph.parametertree import ParameterTree
-from waitingspinnerwidget import QtWaitingSpinner
-
-
-if __name__ == "__main__":
-    import sys
-    app = QtWidgets.QApplication(sys.argv)
-    MainWindow = QtWidgets.QMainWindow()
-    ui = Ui_MainWindow()
-    ui.setupUi(MainWindow)
-    MainWindow.show()
-    sys.exit(app.exec())

pythermostat/MANIFEST.in

@@ -0,0 +1,4 @@
+graft examples
+include pythermostat/gui/resources/artiq.svg
+include pythermostat/gui/view/param_tree.json
+include pythermostat/gui/view/MainWindow.ui

pythermostat/pyproject.toml

@@ -0,0 +1,27 @@
+[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"}
+dependencies = [
+    "numpy >= 1.26.4",
+    "matplotlib >= 3.8.4",
+    "pyqtgraph >= 0.13.7",
+    "pyqt6 >= 6.7.0",
+    "qasync >= 0.27.1",
+    "pglive >= 0.7.2",
+]
+
+[project.gui-scripts]
+thermostat_plot = "pythermostat.plot:main"
+thermostat_control_panel = "pythermostat.control_panel:main"
+
+[project.scripts]
+thermostat_autotune = "pythermostat.autotune:main"
+thermostat_test = "pythermostat.test:main"

pythermostat/pythermostat/aioclient.py

@@ -0,0 +1,240 @@
+import asyncio
+import json
+import logging
+
+
+class CommandError(Exception):
+    pass
+
+
+class AsyncioClient:
+    def __init__(self):
+        self._reader = None
+        self._writer = None
+        self._read_lock = asyncio.Lock()
+
+    async def connect(self, host="192.168.1.26", port=23):
+        """Connect to Thermostat at specified host and port.
+
+        Example::
+            thermostat = AsyncioClient()
+            await client.connect()
+        """
+        self._reader, self._writer = await asyncio.open_connection(host, port)
+        await self._check_zero_limits()
+
+    def connected(self):
+        """Returns True if client is connected"""
+        return self._writer is not None
+
+    async def disconnect(self):
+        """Disconnect from the Thermostat"""
+
+        if self._writer is None:
+            return
+
+        # Reader needn't be closed
+        self._writer.close()
+        await self._writer.wait_closed()
+        self._reader = None
+        self._writer = None
+
+    async def _check_zero_limits(self):
+        output_report = await self.get_output()
+        for output_channel in output_report:
+            for limit in ["max_i_neg", "max_i_pos", "max_v"]:
+                if output_channel[limit] == 0.0:
+                    logging.warning(
+                        "`%s` limit is set to zero on channel %d",
+                        limit,
+                        output_channel["channel"],
+                    )
+
+    async def _read_line(self):
+        # read 1 line
+        async with self._read_lock:
+            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"))
+        await self._writer.drain()
+
+        return await self._read_line()
+
+    async def _command(self, *command):
+        line = await self._read_write(command)
+
+        response = json.loads(line)
+        if "error" in response:
+            raise CommandError(response["error"])
+        return response
+
+    async def _get_conf(self, topic):
+        result = [None, None]
+        for item in await self._command(topic):
+            result[int(item["channel"])] = item
+        return result
+
+    async def get_output(self):
+        """Retrieve output limits for the TEC
+
+        Example::
+            [{'channel': 0,
+              'center': 'vref',
+              'i_set': -0.02002179650216762,
+              'max_i_neg': 2.0,
+              'max_v': : 3.988,
+              'max_i_pos': 2.0,
+              'polarity': 'normal'},
+             {'channel': 1,
+              'center': 'vref',
+              'i_set': -0.02002179650216762,
+              'max_i_neg': 2.0,
+              'max_v': : 3.988,
+              'max_i_pos': 2.0,
+              'polarity': 'normal'},
+            ]
+        """
+        return await self._get_conf("output")
+
+    async def get_pid(self):
+        """Retrieve PID control state
+
+        Example::
+            [{'channel': 0,
+              'parameters': {
+                  'kp': 10.0,
+                  'ki': 0.02,
+                  'kd': 0.0,
+                  'output_min': 0.0,
+                  'output_max': 3.0},
+              'target': 37.0},
+             {'channel': 1,
+              'parameters': {
+                  'kp': 10.0,
+                  'ki': 0.02,
+                  'kd': 0.0,
+                  'output_min': 0.0,
+                  'output_max': 3.0},
+              'target': 36.5}]
+        """
+        return await self._get_conf("pid")
+
+    async def get_b_parameter(self):
+        """
+        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 await self._get_conf("b-p")
+
+    async def get_postfilter(self):
+        """Retrieve DAC postfilter configuration
+
+        Example::
+            [{'rate': None, 'channel': 0},
+             {'rate': 21.25, 'channel': 1}]
+        """
+        return await self._get_conf("postfilter")
+
+    async def get_report(self):
+        """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,
+             'dac_value': 2.527790834044456,
+             'dac_feedback': 2.523,
+             'i_tec': 2.331,
+             'tec_i': 2.0925,
+             'tec_u_meas': 2.5340000000000003,
+             'pid_output': 2.067581958092247}
+        """
+        return await self._command("report")
+
+    async def get_ipv4(self):
+        """Get the IPv4 settings of the Thermostat"""
+        return await self._command("ipv4")
+
+    async def get_fan(self):
+        """Get Thermostat current fan settings"""
+        return await self._command("fan")
+
+    async def get_hwrev(self):
+        """Get Thermostat hardware revision"""
+        return await self._command("hwrev")
+
+    async def set_param(self, topic, channel, field="", value=""):
+        """Set configuration parameters
+
+        Examples::
+            await thermostat.set_param("output", 0, "max_v", 2.0)
+            await thermostat.set_param("pid", 1, "output_max", 2.5)
+            await thermostat.set_param("b-p", 0, "t0", 20.0)
+            await thermostat.set_param("center", 0, "vref")
+            await thermostat.set_param("postfilter", 1, 21)
+
+        See the firmware's README.md for a full list.
+        """
+        if isinstance(value, float):
+            value = f"{value:f}"
+        if not isinstance(value, str):
+            value = str(value)
+        await self._command(topic, str(channel), field, value)
+
+    async def power_up(self, channel, target):
+        """Start closed-loop mode"""
+        await self.set_param("pid", channel, "target", value=target)
+        await self.set_param("output", channel, "pid")
+
+    async def save_config(self, channel=""):
+        """Save current configuration to EEPROM"""
+        await self._command("save", str(channel))
+        if channel == "":
+            await self._read_line()  # Read the extra {}
+
+    async def load_config(self, channel=""):
+        """Load current configuration from EEPROM"""
+        await self._command("load", str(channel))
+        if channel == "":
+            await self._read_line()  # Read the extra {}
+
+    async def reset(self):
+        """Reset the Thermostat
+
+        The client is disconnected as the TCP session is terminated.
+        """
+        self._writer.write("reset\n".encode("utf-8"))
+        await self._writer.drain()
+
+        await self.disconnect()
+
+    async def enter_dfu_mode(self):
+        """Put the Thermostat in DFU mode
+
+        The client is disconnected as the Thermostat stops responding to
+        TCP commands in DFU mode. To exit it, submit a DFU leave request
+        or power-cycle the Thermostat.
+        """
+        self._writer.write("dfu\n".encode("utf-8"))
+        await self._writer.drain()
+
+        await self.disconnect()
+
+    async def set_fan(self, power="auto"):
+        """Set fan power with values from 1 to 100. If omitted, set according to fcurve"""
+        await self._command("fan", str(power))
+
+    async def set_fcurve(self, a=1.0, b=0.0, c=0.0):
+        """Set fan controller curve coefficients"""
+        await self._command("fcurve", str(a), str(b), str(c))

pythermostat/pythermostat/autotune.py

@@ -1,9 +1,11 @@
+import argparse
 import math
 import logging
+import time
 from collections import deque, namedtuple
-from enum import Enum
+from enum import Enum, auto
 
-from pytec.client import Client
+from pythermostat.client import Client
 
 # Based on hirshmann pid-autotune libiary
 # See https://github.com/hirschmann/pid-autotune
@@ -11,13 +13,62 @@ from pytec.client import Client
 # See https://github.com/t0mpr1c3/Arduino-PID-AutoTune-Library
 
 
+def get_argparser():
+    parser = argparse.ArgumentParser(description="Thermostat PID Autotuning Utility")
+
+    parser.add_argument(
+        "-c",
+        "--channel",
+        default=0,
+        type=int,
+        help="Thermostat channel to autotune",
+    )
+    parser.add_argument(
+        "-t",
+        "--target",
+        default=20,
+        type=float,
+        help="Target temperature of the autotune routine, degrees Celcius",
+    )
+    parser.add_argument(
+        "-s",
+        "--step",
+        default=1,
+        type=float,
+        help="Value by which output will be increased/decreased from zero, amps",
+    )
+    parser.add_argument(
+        "-b",
+        "--lookback",
+        default=3,
+        type=float,
+        help="Reference period for local minima/maxima, seconds",
+    )
+    parser.add_argument(
+        "-n",
+        "--noiseband",
+        default=1.5,
+        type=float,
+        help="Determines by how much the input value must overshoot/undershoot the setpoint, degrees Celcius",
+    )
+    parser.add_argument(
+        "-l",
+        "--log",
+        dest="logLevel",
+        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+        help="Set the logging level",
+    )
+
+    return parser
+
+
 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'
+    OFF = auto()
+    RELAY_STEP_UP = auto()
+    RELAY_STEP_DOWN = auto()
+    SUCCEEDED = auto()
+    FAILED = auto()
+    READY = auto()
 
 
 class PIDAutotune:
@@ -45,7 +96,7 @@ class PIDAutotune:
         self._noiseband = noiseband
         self._out_min = -out_step
         self._out_max = out_step
-        self._state = PIDAutotuneState.STATE_OFF
+        self._state = PIDAutotuneState.OFF
         self._peak_timestamps = deque(maxlen=5)
         self._peaks = deque(maxlen=5)
         self._output = 0
@@ -57,7 +108,7 @@ class PIDAutotune:
         self._Ku = 0
         self._Pu = 0
 
-    def setParam(self, target, step, noiseband, sampletime, lookback):
+    def set_param(self, target, step, noiseband, sampletime, lookback):
         self._setpoint = target
         self._outputstep = step
         self._out_max = step
@@ -65,11 +116,12 @@ class PIDAutotune:
         self._noiseband = noiseband
         self._inputs = deque(maxlen=round(lookback / sampletime))
 
-    def setReady(self):
-        self._state = PIDAutotuneState.STATE_READY
+    def set_ready(self):
+        self._state = PIDAutotuneState.READY
+        self._peak_count = 0
 
-    def setOff(self):
-        self._state = PIDAutotuneState.STATE_OFF
+    def set_off(self):
+        self._state = PIDAutotuneState.OFF
 
     def state(self):
         """Get the current state."""
@@ -96,13 +148,6 @@ class PIDAutotune:
         kd = divisors[2] * self._Ku * self._Pu
         return PIDAutotune.PIDParams(kp, ki, kd)
 
-    def get_tec_pid (self):
-        divisors = self._tuning_rules["tyreus-luyben"]
-        kp = self._Ku * divisors[0]
-        ki = divisors[1] * self._Ku / self._Pu
-        kd = divisors[2] * self._Ku * self._Pu
-        return kp, ki, kd
-
     def run(self, input_val, time_input):
         """To autotune a system, this method must be called periodically.
 
@@ -115,30 +160,30 @@ class PIDAutotune:
         """
         now = time_input * 1000
 
-        if (self._state == PIDAutotuneState.STATE_OFF
-                or self._state == PIDAutotuneState.STATE_SUCCEEDED
-                or self._state == PIDAutotuneState.STATE_FAILED
-                or self._state == PIDAutotuneState.STATE_READY):
-            self._state = PIDAutotuneState.STATE_RELAY_STEP_UP
+        if self._state not in {
+            PIDAutotuneState.RELAY_STEP_DOWN,
+            PIDAutotuneState.RELAY_STEP_UP,
+        }:
+            self._state = PIDAutotuneState.RELAY_STEP_UP
 
         self._last_run_timestamp = now
 
         # check input and change relay state if necessary
-        if (self._state == PIDAutotuneState.STATE_RELAY_STEP_UP
+        if (self._state == PIDAutotuneState.RELAY_STEP_UP
                 and input_val > self._setpoint + self._noiseband):
-            self._state = PIDAutotuneState.STATE_RELAY_STEP_DOWN
+            self._state = PIDAutotuneState.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
+        elif (self._state == PIDAutotuneState.RELAY_STEP_DOWN
                 and input_val < self._setpoint - self._noiseband):
-            self._state = PIDAutotuneState.STATE_RELAY_STEP_UP
+            self._state = PIDAutotuneState.RELAY_STEP_UP
             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.RELAY_STEP_UP:
             self._output = self._initial_output - self._outputstep
-        elif self._state == PIDAutotuneState.STATE_RELAY_STEP_DOWN:
+        elif self._state == PIDAutotuneState.RELAY_STEP_DOWN:
             self._output = self._initial_output + self._outputstep
 
         # respect output limits
@@ -206,66 +251,69 @@ class PIDAutotune:
             logging.debug('amplitude deviation: {0}'.format(amplitude_dev))
 
             if amplitude_dev < PIDAutotune.PEAK_AMPLITUDE_TOLERANCE:
-                self._state = PIDAutotuneState.STATE_SUCCEEDED
+                self._state = PIDAutotuneState.SUCCEEDED
 
         # if the autotune has not already converged
         # terminate after 10 cycles
         if self._peak_count >= 20:
             self._output = 0
-            self._state = PIDAutotuneState.STATE_FAILED
+            self._state = PIDAutotuneState.FAILED
             return True
 
-        if self._state == PIDAutotuneState.STATE_SUCCEEDED:
+        if self._state == PIDAutotuneState.SUCCEEDED:
             self._output = 0
             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))
+            print('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))
+            print('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))
+                print('rule: {0}'.format(rule))
+                print('Kp: {0}'.format(params.Kp))
+                print('Ki: {0}'.format(params.Ki))
+                print('Kd: {0}'.format(params.Kd))
 
             return True
         return False
 
 
 def main():
+    args = get_argparser().parse_args()
+    if args.logLevel:
+        logging.basicConfig(level=getattr(logging, args.logLevel))
+
     # Auto tune parameters
     # Thermostat channel
-    channel = 0
+    channel = args.channel
     # Target temperature of the autotune routine, celcius
-    target_temperature = 20
+    target_temperature = args.target
     # Value by which output will be increased/decreased from zero, amps
-    output_step = 1
+    output_step = args.step
     # Reference period for local minima/maxima, seconds
-    lookback = 3
+    lookback = args.lookback
     # Determines by how much the input value must
     # overshoot/undershoot the setpoint, celcius
-    noiseband = 1.5
+    noiseband = args.noiseband
 
-    # logging.basicConfig(level=logging.DEBUG)
+    thermostat = Client()
 
-    tec = Client()
-
-    data = next(tec.report_mode())
+    data = thermostat.get_report()
     ch = data[channel]
 
     tuner = PIDAutotune(target_temperature, output_step,
                         lookback, noiseband, ch['interval'])
 
-    for data in tec.report_mode():
+    while True:
+        data = thermostat.get_report()
 
         ch = data[channel]
 
@@ -276,9 +324,11 @@ def main():
 
         tuner_out = tuner.output()
 
-        tec.set_param("pwm", channel, "i_set", tuner_out)
+        thermostat.set_param("output", channel, "i_set", tuner_out)
 
-    tec.set_param("pwm", channel, "i_set", 0)
+        time.sleep(0.05)
+
+    thermostat.set_param("output", channel, "i_set", 0)
 
 
 if __name__ == "__main__":

pythermostat/pythermostat/client.py

@@ -2,6 +2,7 @@ import socket
 import json
 import logging
 
+
 class CommandError(Exception):
     pass
 
@@ -16,11 +17,11 @@ class Client:
         self._socket.close()
 
     def _check_zero_limits(self):
-        pwm_report = self.get_pwm()
-        for pwm_channel in pwm_report:
+        output_report = self.get_output()
+        for output_channel in output_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"]))
+                if output_channel[limit] == 0.0:
+                    logging.warning("`{}` limit is set to zero on channel {}".format(limit, output_channel["channel"]))
 
     def _read_line(self):
         # read more lines
@@ -40,7 +41,6 @@ class Client:
 
         line = self._read_line()
         response = json.loads(line)
-        logging.debug(f"{command}: {response}")
         if "error" in response:
             raise CommandError(response["error"])
         return response
@@ -51,25 +51,27 @@ class Client:
             result[int(item["channel"])] = item
         return result
 
-    def get_pwm(self):
-        """Retrieve PWM limits for the TEC
+    def get_output(self):
+        """Retrieve output limits for the TEC
 
         Example::
             [{'channel': 0,
               'center': 'vref',
-              'i_set': {'max': 2.9802790335151985, 'value': -0.02002179650216762},
-              'max_i_neg': {'max': 3.0, 'value': 3.0},
-              'max_v': {'max': 5.988, 'value': 5.988},
-              'max_i_pos': {'max': 3.0, 'value': 3.0}},
+              'i_set': -0.02002179650216762,
+              'max_i_neg': 2.0,
+              'max_v': 3.988,
+              'max_i_pos': 2.0,
+              'polarity': 'normal',
              {'channel': 1,
               'center': 'vref',
-              'i_set': {'max': 2.9802790335151985, 'value': -0.02002179650216762},
-              'max_i_neg': {'max': 3.0, 'value': 3.0},
-              'max_v': {'max': 5.988, 'value': 5.988},
-              'max_i_pos': {'max': 3.0, 'value': 3.0}}
+              'i_set': -0.02002179650216762,
+              'max_i_neg': 2.0,
+              'max_v': 3.988,
+              'max_i_pos': 2.0}
+              'polarity': 'normal',
             ]
         """
-        return self._get_conf("pwm")
+        return self._get_conf("output")
 
     def get_pid(self):
         """Retrieve PID control state
@@ -94,14 +96,14 @@ class Client:
         """
         return self._get_conf("pid")
 
-    def get_steinhart_hart(self):
-        """Retrieve Steinhart-Hart parameters for resistance to temperature conversion
+    def get_b_parameter(self):
+        """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
@@ -112,18 +114,18 @@ class Client:
         """
         return self._get_conf("postfilter")
 
-    def report_mode(self):
-        """Start reporting measurement values
+    def get_report(self):
+        """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,
@@ -131,26 +133,29 @@ class Client:
              'tec_u_meas': 2.5340000000000003,
              'pid_output': 2.067581958092247}
         """
-        self._command("report mode", "on")
+        return self._get_conf("report")
 
-        while True:
-            line = self._read_line()
-            if not line:
-                break
-            try:
-                yield json.loads(line)
-            except json.decoder.JSONDecodeError:
-                pass
+    def get_ipv4(self):
+        """Get the IPv4 settings of the Thermostat"""
+        return self._command("ipv4")
+
+    def get_fan(self):
+        """Get Thermostat current fan settings"""
+        return self._command("fan")
+
+    def get_hwrev(self):
+        """Get Thermostat hardware revision"""
+        return self._command("hwrev")
 
     def set_param(self, topic, channel, field="", value=""):
         """Set configuration parameters
 
         Examples::
-            tec.set_param("pwm", 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("center", 0, "vref")
-            tec.set_param("postfilter", 1, 21)
+            thermostat.set_param("output", 0, "max_v", 2.0)
+            thermostat.set_param("pid", 1, "output_max", 2.5)
+            thermostat.set_param("b-p", 0, "t0", 20.0)
+            thermostat.set_param("center", 0, "vref")
+            thermostat.set_param("postfilter", 1, 21)
 
         See the firmware's README.md for a full list.
         """
@@ -163,20 +168,40 @@ class Client:
     def power_up(self, channel, target):
         """Start closed-loop mode"""
         self.set_param("pid", channel, "target", value=target)
-        self.set_param("pwm", channel, "pid")
+        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 hw_rev(self):
-        """Get Thermostat hardware revision"""
-        return self._command("hwrev")
+    def reset(self):
+        """Reset the device"""
+        self._socket.sendall("reset".encode("utf-8"))
+        self.disconnect()  # resetting ends the TCP session, disconnect anyway
 
-    def fan(self):
-        """Get Thermostat current fan settings"""
-        return self._command("fan")
+    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/control_panel.py

@@ -0,0 +1,252 @@
+"""GUI Control Panel for the Sinara 8451 Thermostat"""
+
+import asyncio
+import logging
+import argparse
+import importlib.resources
+import json
+from PyQt6 import QtWidgets, QtGui, uic
+from PyQt6.QtCore import pyqtSlot
+import qasync
+from qasync import asyncSlot, asyncClose
+from pythermostat.autotune import PIDAutotuneState
+from pythermostat.gui.model.thermostat import Thermostat, ThermostatConnectionState
+from pythermostat.gui.model.pid_autotuner import PIDAutoTuner
+from pythermostat.gui.view.settings_tree_view import SettingsTreeView
+from pythermostat.gui.view.info_box import InfoBox
+from pythermostat.gui.view.menus import PlotOptionsMenu, ThermostatSettingsMenu, ConnectionDetailsMenu
+from pythermostat.gui.view.live_plot_view import LiveDataPlotter
+from pythermostat.gui.view.zero_limits_warning_view import ZeroLimitsWarningView
+
+
+def get_argparser():
+    parser = argparse.ArgumentParser(description="Thermostat Control Panel")
+
+    parser.add_argument(
+        "--connect",
+        default=None,
+        action="store_true",
+        help="Automatically connect to the specified Thermostat in host:port format",
+    )
+    parser.add_argument("host", metavar="HOST", default=None, nargs="?")
+    parser.add_argument("port", metavar="PORT", default=None, nargs="?")
+    parser.add_argument(
+        "-l",
+        "--log",
+        dest="logLevel",
+        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+        help="Set the logging level",
+    )
+    parser.add_argument(
+        "-p",
+        "--param_tree",
+        default=importlib.resources.files("pythermostat.gui.view").joinpath("param_tree.json"),
+        help="Param Tree Description JSON File",
+    )
+
+    return parser
+
+
+class MainWindow(QtWidgets.QMainWindow):
+    NUM_CHANNELS = 2
+
+    def __init__(self, args):
+        super().__init__()
+
+        ui_file_path = importlib.resources.files("pythermostat.gui.view").joinpath("MainWindow.ui")
+        uic.loadUi(ui_file_path, self)
+
+        self._info_box = InfoBox()
+
+        # Models
+        self._thermostat = Thermostat(self, self.report_refresh_spin.value())
+        self._connecting_task = None
+        self._thermostat.connection_state_update.connect(
+            self._on_connection_state_changed
+        )
+
+        self._autotuners = PIDAutoTuner(self, self._thermostat, 2)
+        self._autotuners.autotune_state_changed.connect(
+            self._on_pid_autotune_state_changed
+        )
+
+        # Handlers for disconnections
+        async def autotune_disconnect():
+            for ch in range(self.NUM_CHANNELS):
+                if self._autotuners.get_state(ch) != PIDAutotuneState.OFF:
+                    await self._autotuners.stop_pid_from_running(ch)
+
+        self._thermostat.disconnect_cb = autotune_disconnect
+
+        @pyqtSlot()
+        def handle_connection_error():
+            self._info_box.display_info_box(
+                "Connection Error", "Thermostat connection lost. Is it unplugged?"
+            )
+
+        self._thermostat.connection_error.connect(handle_connection_error)
+
+        # Settings tree view
+        def get_settings_tree_view_config(args):
+            with open(args.param_tree, "r", encoding="utf-8") as f:
+                return json.load(f)["settings_tree"]
+
+        self._settings_tree_view = SettingsTreeView(
+            self._thermostat,
+            self._autotuners,
+            self._info_box,
+            [self.ch0_tree, self.ch1_tree],
+            get_settings_tree_view_config(args),
+        )
+
+        # Graphs
+        self._channel_graphs = LiveDataPlotter(
+            self._thermostat,
+            [
+                [getattr(self, f"ch{ch}_t_graph"), getattr(self, f"ch{ch}_i_graph")]
+                for ch in range(self.NUM_CHANNELS)
+            ],
+        )
+
+        # Bottom bar menus
+        self.connection_details_menu = ConnectionDetailsMenu(
+            self._thermostat, self.connect_btn
+        )
+        self.connect_btn.setMenu(self.connection_details_menu)
+
+        self._thermostat_settings_menu = ThermostatSettingsMenu(
+            self._thermostat, self._info_box, self.style()
+        )
+        self.thermostat_settings.setMenu(self._thermostat_settings_menu)
+
+        self._plot_options_menu = PlotOptionsMenu(self._channel_graphs)
+        self.plot_settings.setMenu(self._plot_options_menu)
+
+        # Status line
+        self._zero_limits_warning_view = ZeroLimitsWarningView(
+            self._thermostat, self.style(), self.limits_warning
+        )
+        self.loading_spinner.hide()
+
+        self.report_apply_btn.clicked.connect(
+            lambda: self._thermostat.set_update_s(self.report_refresh_spin.value())
+        )
+
+    @asyncClose
+    async def closeEvent(self, _event):
+        try:
+            await self._thermostat.end_session()
+            self._thermostat.connection_state = ThermostatConnectionState.DISCONNECTED
+        except:
+            pass
+
+    @pyqtSlot(ThermostatConnectionState)
+    def _on_connection_state_changed(self, state):
+        self.graph_group.setEnabled(state == ThermostatConnectionState.CONNECTED)
+        self.thermostat_settings.setEnabled(
+            state == ThermostatConnectionState.CONNECTED
+        )
+        self.report_group.setEnabled(state == ThermostatConnectionState.CONNECTED)
+
+        match state:
+            case ThermostatConnectionState.CONNECTED:
+                self.connect_btn.setText("Disconnect")
+                self.status_lbl.setText(
+                    "Connected to Thermostat v"
+                    f"{self._thermostat.hw_rev['rev']['major']}."
+                    f"{self._thermostat.hw_rev['rev']['minor']}"
+                )
+
+            case ThermostatConnectionState.CONNECTING:
+                self.connect_btn.setText("Stop")
+                self.status_lbl.setText("Connecting...")
+
+            case ThermostatConnectionState.DISCONNECTED:
+                self.connect_btn.setText("Connect")
+                self.status_lbl.setText("Disconnected")
+
+    @pyqtSlot(int, PIDAutotuneState)
+    def _on_pid_autotune_state_changed(self, _ch, _state):
+        autotuning_channels = []
+        for ch in range(self.NUM_CHANNELS):
+            if self._autotuners.get_state(ch) in {
+                PIDAutotuneState.READY,
+                PIDAutotuneState.RELAY_STEP_UP,
+                PIDAutotuneState.RELAY_STEP_DOWN,
+            }:
+                autotuning_channels.append(ch)
+
+        if len(autotuning_channels) == 0:
+            self.background_task_lbl.setText("Ready.")
+            self.loading_spinner.hide()
+            self.loading_spinner.stop()
+        else:
+            self.background_task_lbl.setText(
+                f"Autotuning channel {autotuning_channels}..."
+            )
+            self.loading_spinner.start()
+            self.loading_spinner.show()
+
+    @asyncSlot()
+    async def on_connect_btn_clicked(self):
+        match self._thermostat.connection_state:
+            case ThermostatConnectionState.DISCONNECTED:
+                self._connecting_task = asyncio.current_task()
+                self._thermostat.connection_state = ThermostatConnectionState.CONNECTING
+                await self._thermostat.start_session(
+                    host=self.connection_details_menu.host_set_line.text(),
+                    port=self.connection_details_menu.port_set_spin.value(),
+                )
+                self._connecting_task = None
+                self._thermostat.connection_state = ThermostatConnectionState.CONNECTED
+                self._thermostat.start_watching()
+
+            case ThermostatConnectionState.CONNECTING:
+                self._connecting_task.cancel()
+                self._connecting_task = None
+                await self._thermostat.end_session()
+                self._thermostat.connection_state = (
+                    ThermostatConnectionState.DISCONNECTED
+                )
+
+            case ThermostatConnectionState.CONNECTED:
+                await self._thermostat.end_session()
+                self._thermostat.connection_state = (
+                    ThermostatConnectionState.DISCONNECTED
+                )
+
+
+async def coro_main():
+    args = get_argparser().parse_args()
+    if args.logLevel:
+        logging.basicConfig(level=getattr(logging, args.logLevel))
+
+    app_quit_event = asyncio.Event()
+
+    app = QtWidgets.QApplication.instance()
+    app.aboutToQuit.connect(app_quit_event.set)
+    app.setWindowIcon(
+        QtGui.QIcon(
+            str(importlib.resources.files("pythermostat.gui.resources").joinpath("artiq.svg"))
+        )
+    )
+
+    main_window = MainWindow(args)
+    main_window.show()
+
+    if args.connect:
+        if args.host:
+            main_window.connection_details_menu.host_set_line.setText(args.host)
+        if args.port:
+            main_window.connection_details_menu.port_set_spin.setValue(int(args.port))
+        main_window.connect_btn.click()
+
+    await app_quit_event.wait()
+
+
+def main():
+    qasync.run(coro_main())
+
+
+if __name__ == "__main__":
+    main()

pythermostat/pythermostat/examples/aioexample.py

@@ -0,0 +1,37 @@
+import asyncio
+from pythermostat.aioclient import AsyncioClient
+
+
+async def poll_for_reports(thermostat_aio):
+    while True:
+        print(await thermostat_aio.get_report())
+        await asyncio.sleep(0.05)
+
+
+async def poll_for_settings(thermostat_aio):
+    while True:
+        await asyncio.sleep(1)
+        print(await thermostat_aio.get_output())
+        print(await thermostat_aio.get_pid())
+        print(await thermostat_aio.get_fan())
+        print(await thermostat_aio.get_postfilter())
+        print(await thermostat_aio.get_b_parameter())
+
+
+async def main():
+    thermostat_aio = AsyncioClient()
+    await thermostat_aio.connect()
+    await thermostat_aio.set_param("b-p", 1, "t0", 20)
+    print(await thermostat_aio.get_output())
+    print(await thermostat_aio.get_pid())
+    print(await thermostat_aio.get_fan())
+    print(await thermostat_aio.get_postfilter())
+    print(await thermostat_aio.get_b_parameter())
+
+    # Poll both reports and settings, at different rates
+    async with asyncio.TaskGroup() as tg:
+        tg.create_task(poll_for_reports(thermostat_aio))
+        tg.create_task(poll_for_settings(thermostat_aio))
+
+
+asyncio.run(main())

pythermostat/pythermostat/examples/example.py

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

pythermostat/pythermostat/gui/model/pid_autotuner.py

@@ -0,0 +1,84 @@
+from PyQt6.QtCore import QObject, pyqtSlot, pyqtSignal
+from qasync import asyncSlot
+from pythermostat.autotune import PIDAutotuneState, PIDAutotune
+
+
+class PIDAutoTuner(QObject):
+    autotune_state_changed = pyqtSignal(int, PIDAutotuneState)
+
+    def __init__(self, parent, thermostat, num_of_channel):
+        super().__init__(parent)
+
+        self._thermostat = thermostat
+        self._thermostat.report_update.connect(self.tick)
+
+        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)]
+        self.temp_swing = [1.5 for _ in range(num_of_channel)]
+        self.lookback = [3.0 for _ in range(num_of_channel)]
+        self.sampling_interval = [1 / 16.67 for _ in range(num_of_channel)]
+
+    def set_params(self, params_name, ch, val):
+        getattr(self, params_name)[ch] = val
+
+    def get_state(self, ch):
+        return self.autotuners[ch].state()
+
+    def load_params_and_set_ready(self, ch):
+        self.autotuners[ch].set_param(
+            self.target_temp[ch],
+            self.test_current[ch] / 1000,
+            self.temp_swing[ch],
+            1 / self.sampling_interval[ch],
+            self.lookback[ch],
+        )
+        self.autotuners[ch].set_ready()
+        self.autotune_state_changed.emit(ch, self.autotuners[ch].state())
+
+    async def stop_pid_from_running(self, ch):
+        self.autotuners[ch].set_off()
+        self.autotune_state_changed.emit(ch, self.autotuners[ch].state())
+        if self._thermostat.connected():
+            await self._thermostat.set_param("output", ch, "i_set", 0)
+
+    @asyncSlot(list)
+    async def tick(self, report):
+        for channel_report in report:
+            ch = channel_report["channel"]
+
+            self.sampling_interval[ch] = channel_report["interval"]
+
+            # TODO: Skip when PID Autotune or emit error message if NTC is not connected
+            if channel_report["temperature"] is None:
+                continue
+
+            match self.autotuners[ch].state():
+                case (
+                    PIDAutotuneState.READY
+                    | PIDAutotuneState.RELAY_STEP_UP
+                    | PIDAutotuneState.RELAY_STEP_DOWN
+                ):
+                    self.autotuners[ch].run(
+                        channel_report["temperature"], channel_report["time"]
+                    )
+                    await self._thermostat.set_param(
+                        "output", ch, "i_set", self.autotuners[ch].output()
+                    )
+                case PIDAutotuneState.SUCCEEDED:
+                    kp, ki, kd = self.autotuners[ch].get_pid_parameters("tyreus-luyben")
+                    self.autotuners[ch].set_off()
+                    self.autotune_state_changed.emit(ch, self.autotuners[ch].state())
+
+                    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("output", ch, "pid")
+
+                    await self._thermostat.set_param(
+                        "pid", ch, "target", self.target_temp[ch]
+                    )
+                case PIDAutotuneState.FAILED:
+                    self.autotuners[ch].set_off()
+                    self.autotune_state_changed.emit(ch, self.autotuners[ch].state())
+                    await self._thermostat.set_param("output", ch, "i_set", 0)

pythermostat/pythermostat/gui/model/property.py

@@ -0,0 +1,126 @@
+# A Custom Class that allows defining a QObject Property Dynamically
+# Adapted from: https://stackoverflow.com/questions/48425316/how-to-create-pyqt-properties-dynamically
+
+from functools import wraps
+
+from PyQt6.QtCore import QObject, pyqtProperty, pyqtSignal
+
+
+class PropertyMeta(type(QObject)):
+    """Lets a class succinctly define Qt properties."""
+
+    def __new__(cls, name, bases, attrs):
+        for key in list(attrs.keys()):
+            attr = attrs[key]
+            if not isinstance(attr, Property):
+                continue
+
+            types = {list: "QVariantList", dict: "QVariantMap"}
+            type_ = types.get(attr.type_, attr.type_)
+
+            notifier = pyqtSignal(type_)
+            attrs[f"{key}_update"] = notifier
+            attrs[key] = PropertyImpl(type_=type_, name=key, notify=notifier)
+
+        return super().__new__(cls, name, bases, attrs)
+
+
+class Property:
+    """Property definition.
+
+    Instances of this class will be replaced with their full
+    implementation by the PropertyMeta metaclass.
+    """
+
+    def __init__(self, type_):
+        self.type_ = type_
+
+
+class PropertyImpl(pyqtProperty):
+    """Property implementation: gets, sets, and notifies of change."""
+
+    def __init__(self, type_, name, notify):
+        super().__init__(type_, self.getter, self.setter, notify=notify)
+        self.name = name
+
+    def getter(self, instance):
+        return getattr(instance, f"_{self.name}")
+
+    def setter(self, instance, value):
+        signal = getattr(instance, f"{self.name}_update")
+
+        if type(value) in {list, dict}:
+            value = make_notified(value, signal)
+
+        setattr(instance, f"_{self.name}", value)
+        signal.emit(value)
+
+
+class MakeNotified:
+    """Adds notifying signals to lists and dictionaries.
+
+    Creates the modified classes just once, on initialization.
+    """
+
+    change_methods = {
+        list: [
+            "__delitem__",
+            "__iadd__",
+            "__imul__",
+            "__setitem__",
+            "append",
+            "extend",
+            "insert",
+            "pop",
+            "remove",
+            "reverse",
+            "sort",
+        ],
+        dict: [
+            "__delitem__",
+            "__ior__",
+            "__setitem__",
+            "clear",
+            "pop",
+            "popitem",
+            "setdefault",
+            "update",
+        ],
+    }
+
+    def __init__(self):
+        if not hasattr(dict, "__ior__"):
+            # Dictionaries don't have | operator in Python < 3.9.
+            self.change_methods[dict].remove("__ior__")
+        self.notified_class = {
+            type_: self.make_notified_class(type_) for type_ in [list, dict]
+        }
+
+    def __call__(self, seq, signal):
+        """Returns a notifying version of the supplied list or dict."""
+        notified_class = self.notified_class[type(seq)]
+        notified_seq = notified_class(seq)
+        notified_seq.signal = signal
+        return notified_seq
+
+    @classmethod
+    def make_notified_class(cls, parent):
+        notified_class = type(f"notified_{parent.__name__}", (parent,), {})
+        for method_name in cls.change_methods[parent]:
+            original = getattr(notified_class, method_name)
+            notified_method = cls.make_notified_method(original, parent)
+            setattr(notified_class, method_name, notified_method)
+        return notified_class
+
+    @staticmethod
+    def make_notified_method(method, parent):
+        @wraps(method)
+        def notified_method(self, *args, **kwargs):
+            result = getattr(parent, method.__name__)(self, *args, **kwargs)
+            self.signal.emit(self)
+            return result
+
+        return notified_method
+
+
+make_notified = MakeNotified()

pythermostat/pythermostat/gui/model/thermostat.py

@@ -0,0 +1,135 @@
+import asyncio
+import logging
+from enum import Enum
+from PyQt6.QtCore import pyqtSignal, QObject, pyqtSlot
+from qasync import asyncSlot
+from pythermostat.aioclient import AsyncioClient
+from pythermostat.gui.model.property import Property, PropertyMeta
+
+
+class ThermostatConnectionState(Enum):
+    DISCONNECTED = "disconnected"
+    CONNECTING = "connecting"
+    CONNECTED = "connected"
+
+
+class Thermostat(QObject, metaclass=PropertyMeta):
+    connection_state = Property(ThermostatConnectionState)
+    hw_rev = Property(dict)
+    fan = Property(dict)
+    thermistor = Property(list)
+    pid = Property(list)
+    output = Property(list)
+    postfilter = Property(list)
+    report = Property(list)
+
+    connection_error = pyqtSignal()
+
+    NUM_CHANNELS = 2
+
+    def __init__(self, parent, update_s, disconnect_cb=None):
+        super().__init__(parent)
+
+        self._update_s = update_s
+        self._client = AsyncioClient()
+        self._watch_task = None
+        self._update_params_task = None
+        self.disconnect_cb = disconnect_cb
+        self.connection_state = ThermostatConnectionState.DISCONNECTED
+
+    async def start_session(self, host, port):
+        await self._client.connect(host, port)
+        self.hw_rev = await self._client.get_hwrev()
+
+    @asyncSlot()
+    async def end_session(self):
+        self.stop_watching()
+
+        if self.disconnect_cb is not None:
+            if asyncio.iscoroutinefunction(self.disconnect_cb):
+                await self.disconnect_cb()
+            else:
+                self.disconnect_cb()
+
+        await self._client.disconnect()
+
+    def start_watching(self):
+        self._watch_task = asyncio.create_task(self.run())
+
+    def stop_watching(self):
+        if self._watch_task is not None:
+            self._watch_task.cancel()
+            self._watch_task = None
+            self._update_params_task.cancel()
+            self._update_params_task = None
+
+    async def run(self):
+        self._update_params_task = asyncio.create_task(self.update_params())
+        while True:
+            if self._update_params_task.done():
+                try:
+                    self._update_params_task.result()
+                except OSError:
+                    logging.error(
+                        "Encountered an error while polling for information from Thermostat.",
+                        exc_info=True,
+                    )
+                    await self.end_session()
+                    self.connection_state = ThermostatConnectionState.DISCONNECTED
+                    self.connection_error.emit()
+                    return
+                self._update_params_task = asyncio.create_task(self.update_params())
+            await asyncio.sleep(self._update_s)
+
+    async def update_params(self):
+        (
+            self.fan,
+            self.output,
+            self.report,
+            self.pid,
+            self.thermistor,
+            self.postfilter,
+        ) = await asyncio.gather(
+            self._client.get_fan(),
+            self._client.get_output(),
+            self._client.get_report(),
+            self._client.get_pid(),
+            self._client.get_b_parameter(),
+            self._client.get_postfilter(),
+        )
+
+    def connected(self):
+        return self._client.connected()
+
+    @pyqtSlot(float)
+    def set_update_s(self, update_s):
+        self._update_s = update_s
+
+    async def set_ipv4(self, ipv4):
+        await self._client.set_param("ipv4", ipv4)
+
+    async def get_ipv4(self):
+        return await self._client.get_ipv4()
+
+    @asyncSlot()
+    async def save_cfg(self, ch=""):
+        await self._client.save_config(ch)
+
+    @asyncSlot()
+    async def load_cfg(self, ch=""):
+        await self._client.load_config(ch)
+
+    async def dfu(self):
+        await self._client.enter_dfu_mode()
+
+    async def reset(self):
+        await self._client.reset()
+
+    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)

pythermostat/pythermostat/gui/resources/artiq.svg

@@ -0,0 +1,134 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Generator: Adobe Illustrator 16.0.3, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+
+<svg
+   xmlns:i="&amp;#38;#38;ns_ai;"
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   version="1.1"
+   x="0px"
+   y="0px"
+   width="360"
+   height="360"
+   viewBox="0 0 360 360"
+   enable-background="new 0 0 800 800"
+   xml:space="preserve"
+   id="svg2"
+   inkscape:version="0.91 r13725"
+   sodipodi:docname="logo.svg"><metadata
+     id="metadata548"><rdf:RDF><cc:Work
+         rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title /></cc:Work></rdf:RDF></metadata><defs
+     id="defs546" /><sodipodi:namedview
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="1920"
+     inkscape:window-height="1156"
+     id="namedview544"
+     showgrid="false"
+     fit-margin-top="0"
+     fit-margin-left="0"
+     fit-margin-right="0"
+     fit-margin-bottom="0"
+     inkscape:zoom="0.417193"
+     inkscape:cx="287.46503"
+     inkscape:cy="-196.56401"
+     inkscape:window-x="0"
+     inkscape:window-y="44"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg2" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path381"
+     d="m 306.69585,335.11213 c 5.09,-0.035 9.227,-4.208 9.217,-9.303 -0.01,-5.062 -4.225,-9.248 -9.291,-9.229 -5.066,0.021 -9.246,4.237 -9.217,9.302 0.027,5.085 4.236,9.264 9.291,9.23 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path383"
+     d="m 89.214854,155.25113 10.609,9.812 c 0.214996,-0.162 0.460996,-0.348 0.688996,-0.549 20.543,-18.001 43.98,-33.619 69.662,-46.423 32.912,-16.40399 60.969,-25.001991 88.295,-27.057991 2.504,-0.188 4.811,-0.279 7.051,-0.279 9.105,0 16.873,1.591 23.744,4.864 7.635,3.636 11.473,9.740991 11.404,18.145991 -0.053,6.609 -1.955,13.229 -5.812,20.239 -2.68,4.868 -5.713,9.68 -8.646,14.332 -1.248,1.979 -2.502,3.969 -3.744,5.982 l 10.135,9.65 c 8.092,-10.235 16.82,-22.731 20.846,-38.001 0.467,-1.765 0.861,-3.586 1.244,-5.348 0.174,-0.804 0.348,-1.606 0.529,-2.408 l 0,-8.887 c -0.049,-0.148 -0.102,-0.297 -0.154,-0.444 -0.141,-0.387 -0.285,-0.787 -0.357,-1.216 -2.037,-12.212991 -8.967,-20.777991 -21.184,-26.185991 -7.824,-3.462 -16.289,-4.355 -23.535,-4.772 -2.264,-0.13 -4.576,-0.196 -6.877,-0.196 -11.945,0 -24.328,1.727 -37.859,5.278 -46.736,12.272 -90.896,35.553991 -131.251996,69.196991 -1.098,0.917 -2.182,1.903 -3.332,2.947 -0.465,0.425 -0.948,0.863 -1.456,1.32 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path385"
+     d="m 118.26585,121.01513 c 2.992,-2.037 5.816,-3.961 8.797,-5.561 3.58,-1.923 4.771,-4.586 5.459,-7.993 4.053,-20.110991 9.557,-35.939991 17.318,-49.815991 4.494,-8.033 9.088,-13.791 14.455,-18.119 9.002,-7.259 18.375,-7.266 27.412,-0.017 5.564,4.462 10.137,10.14 13.98,17.356 2.211,4.151 4.197,8.308 6.303,12.707 0.855,1.791 1.719,3.595 2.602,5.408 l 14.334,-3.655 c -1.174,-2.378 -2.311,-4.763 -3.412,-7.074 -2.658,-5.585 -5.172,-10.859 -8.139,-15.979 -9.824,-16.947 -20.699,-25.812 -35.26,-28.744 l -8.322,0.01 c -12.096,2.398 -22.07,9.437 -30.395,21.507 -3.602,5.219 -6.787,10.571 -9.471,15.906 -7.41,14.732 -12.738,31.635 -16.773,53.191991 -0.568,3.039 -1.053,6.101 -1.566,9.342 -0.193,1.218 -0.391,2.462 -0.598,3.74 1.132,-0.75 2.218,-1.49 3.276,-2.21 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path387"
+     d="m 105.42785,254.22313 c -3.225,0.31 -6.270996,0.602 -9.351996,0.754 -1.867,0.093 -3.594,0.139 -5.277,0.139 -7.129,0 -13.34,-0.867 -18.904,-2.646 -0.795,-0.254 -1.576,-0.526 -2.346,-0.817 -11.328,-4.29 -16.076,-12.875 -13.732,-24.827 2.135,-10.872 7.631,-19.988 13.254,-28.221 1.115,-1.634 2.314,-3.259 3.473,-4.83 0.453,-0.616 0.91,-1.233 1.365,-1.857 l -10.357,-10.004 c -7.527,9.307 -16.645,21.933 -20.824,37.338 -3.191,11.767 -2.23,22.453 2.783,30.906 5.008,8.446 13.908,14.409 25.738,17.245 6.105,1.465 12.57,2.177 19.76,2.177 3.754,-10e-4 7.688,-0.192 12.022996,-0.588 2.494,-0.227 4.928,-0.557 7.504,-0.906 0.973,-0.132 1.951,-0.265 2.936,-0.392 l -3.898,-13.857 c -1.415,0.124 -2.792,0.256 -4.146,0.386 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path389"
+     d="m 90.798854,255.11513 c 1.684,0 3.41,-0.046 5.277,-0.139 -1.866,0.093 -3.593,0.139 -5.277,0.139 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path391"
+     d="m 71.894854,252.47013 c 5.564,1.778 11.775,2.646 18.904,2.646 -7.127,-0.001 -13.339,-0.868 -18.904,-2.646 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path393"
+     d="m 91.007854,269.57913 c -7.189,0 -13.654,-0.712 -19.76,-2.177 6.106,1.465 12.571,2.177 19.76,2.177 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path395"
+     d="m 103.03185,268.99113 c -4.335996,0.396 -8.269996,0.587 -12.022996,0.588 3.753,0 7.685,-0.192 12.022996,-0.588 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path397"
+     d="m 216.19185,131.16013 c -0.625,-4.189 -1.227,-8.218 -1.867,-12.238 -0.326,-2.036 -5.861,-6.224 -8.229,-6.224 -0.156,0 -0.291,0.02 -0.402,0.058 -4.172,1.46 -8.242,3.096 -12.551,4.827 -1.42,0.57 -2.855,1.146 -4.316,1.727 l 28,16.088 -0.635,-4.238 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path399"
+     d="m 125.60785,156.07313 c -0.338,0.264 -0.668,0.525 -1,0.788 -0.463,0.366 -0.936,0.736 -1.393,1.099 -2.838,2.248 -5.516,4.371 -8.346,6.353 -2.75,1.927 -3.779,4.095 -3.336,7.03 0.102,0.675 0.096,1.436 0.09,2.17 -0.01,1.219 -0.02,2.479 0.488,2.946 3.336,3.059 6.891,5.851 10.654,8.807 0.605,0.477 1.227,0.968 1.842,1.452 0.334,0.264 0.664,0.523 1,0.789 0.188,0.148 0.369,0.29 0.557,0.439 l 0,-32.312 c -0.189,0.148 -0.369,0.291 -0.556,0.439 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path401"
+     d="m 151.98285,100.84014 0.104,-0.053 c 3.387,-1.754001 6.783,-3.483001 10.385,-5.316001 l 4.047,-2.062 -17.232,-6.35 -3.984,13.866001 c 1.803,0.81 2.684,1.17 3.451,1.17 0.584,0 1.174,-0.223 2.061,-0.658 0.34,-0.169 0.721,-0.365 1.168,-0.597 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path403"
+     d="m 150.81285,101.43614 c 0.342,-0.168 0.723,-0.364 1.172,-0.597 l 0.102,-0.053 -0.104,0.053 c -0.447,0.233 -0.828,0.429 -1.17,0.597 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path405"
+     d="m 266.77785,190.88113 -10.314,-9.723 c -0.9,2.513 -2.059,14.3 -1.457,19.737 l 11.771,-10.014 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path407"
+     d="m 146.40085,244.68813 c -0.344,0 -0.562,0.08 -0.627,0.134 -0.129,0.123 -0.217,0.812 -0.078,1.328 0.848,3.195 1.752,6.407 2.709,9.809 l 0.814,2.899 14.725,-5.297 -2.984,-1.559 c -4.799,-2.507 -9.33,-4.874 -13.859,-7.181 -0.163,-0.082 -0.431,-0.133 -0.7,-0.133 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path409"
+     d="m 178.01785,182.25313 c 5.09,-0.035 9.227,-4.207 9.217,-9.303 -0.008,-5.061 -4.223,-9.248 -9.291,-9.229 -5.066,0.021 -9.244,4.238 -9.217,9.303 0.029,5.084 4.236,9.264 9.291,9.229 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path411"
+     d="m 178.66685,137.26513 c 10.389,0 20.699,4.453 27.85,13.074 6.838,8.24 9.393,18.624 7.93,28.444 0.682,4.709 4.068,13.639 16.732,28.898 0,0 39.695,50.833 67.607,86.683 1.363,1.533 6.5,6.911 11.957,8.765 4.92,0.979 9.547,3.578 13.004,7.74 7.998,9.641 6.668,23.926 -2.971,31.917 -4.232,3.516 -9.361,5.229 -14.461,5.229 -6.51,0 -12.973,-2.793 -17.459,-8.197 -3.123,-3.762 -4.801,-8.235 -5.139,-12.764 l -0.014,0.019 c 0.004,-0.188 -0.045,-0.956 -0.047,-1.136 -0.498,-5.215 -5.215,-11.978 -7.074,-14.461 l -73.916,-80.137 c -12.717,-15.323 -21.002,-20.271 -25.605,-21.787 -9.816,-0.444 -19.428,-4.869 -26.199,-13.034 -12.762,-15.37 -10.639,-38.165 4.734,-50.921 6.752,-5.6 14.934,-8.332 23.071,-8.332 m -8.434,57.243 22.721,-3.874 8.002,-21.613 -14.719,-17.732 -22.719,3.875 -7.996,21.609 14.711,17.735 m 131.273,145.051 14.541,-2.529 5.084,-13.854 -9.451,-11.331 -14.543,2.523 -5.082,13.857 9.451,11.334" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path431"
+     d="m 200.61585,241.28413 0.006,-0.025 c -24.418,-9.209 -48.256,-21.711 -70.979,-37.256 -24.553,-16.797 -42.628996,-33.192 -56.884996,-51.596 -8.715,-11.247 -13.768,-20.717 -16.381,-30.705 -3.068,-11.729 0.105,-20.53999 9.178,-25.481991 2.277,-1.241 4.834,-2.269 7.596,-3.054 7.576,-2.153 15.721,-2.812 25.201,-2.015 1.244,0.104 2.519996,0.217 3.804996,0.332 1.402,0.123 2.803,0.242 4.209,0.368 l 3.176,0.281 3.846,-13.919 c -0.947,-0.121 -1.893,-0.245 -2.83,-0.37 -2.537,-0.337 -4.934,-0.656 -7.25,-0.857 -4.688996,-0.406 -8.802996,-0.604 -12.577996,-0.604 -8.74,0 -16.342,1.076 -23.24,3.29 -14.58,4.68 -23.049,13.281 -25.893,26.296991 -1.943,8.9 -0.568,18.38 4.328,29.833 6.098,14.267 15.623,27.692 29.977,42.251 31.706996,32.162 69.878996,56.911 116.698996,75.662 3.182,1.274 6.383,2.416 9.771,3.624 1.434,0.511 2.889,1.029 4.369,1.568 l 2.396,-8.365 -8.521,-9.258 z" /><path
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff"
+     id="path433"
+     d="m 315.10985,227.63013 c -0.146,-0.262 -0.314,-0.56 -0.359,-0.905 -0.99,-8.005 -3.834,-16.142 -8.688,-24.875 -7.945,-14.297 -18.83,-27.683 -34.252,-42.126 -3.812,-3.572 -7.723,-6.949 -11.863,-10.523 -1.678,-1.448 -3.377,-2.915 -5.096,-4.419 -0.006,0.032 -0.012,0.062 -0.018,0.092 -0.062,0.355 -0.096,0.551 -0.09,0.713 l 0.148,3.794 c 0.176,4.559 0.359,9.272 0.67,13.896 0.047,0.706 0.615,1.672 1.52,2.583 2.135,2.144 4.346,4.286 6.484,6.358 3.807,3.687 7.742,7.5 11.389,11.467 11.611,12.634 19.076,24.245 23.488,36.543 2.049,5.705 2.707,10.802 2.012,15.581 -1.146,7.896 -6.145,13.235 -15.281,16.322 -2.455,0.829 -5.002,1.474 -7.656,1.956 l 9.738,12.6 c 1.551,-0.468 3.08,-0.975 4.574,-1.562 12.387,-4.858 19.754,-12.956 22.521,-24.758 l 0.869,-3.686 0,-8.847 c -0.034,-0.068 -0.071,-0.136 -0.11,-0.204 z" /><g
+     style="fill:#ffffff"
+     id="g435"
+     transform="translate(-215.39315,-165.25587)"><path
+       inkscape:connector-curvature="0"
+       style="fill:#ffffff"
+       id="path437"
+       d="m 439.345,274.729 c 0.58,4.945 1.223,9.971 1.846,14.831 1.416,11.057 2.879,22.489 3.713,33.785 0.807,10.944 0.859,22.254 0.164,34.1 l 13,16.818 c 0.334,-3.384 0.643,-6.817 0.902,-10.349 1.854,-25.214 1.066,-50.093 -2.342,-73.945 -0.709,-4.964 -1.549,-9.816 -2.439,-14.955 -0.377,-2.185 -0.758,-4.387 -1.133,-6.617 l -14.16,3.555 c 0.043,0.257 0.086,0.5 0.127,0.734 0.13,0.742 0.244,1.39 0.322,2.043 z" /><path
+       inkscape:connector-curvature="0"
+       style="fill:#ffffff"
+       id="path439"
+       d="m 433.437,425.474 c -2.322,7.348 -4.98,14.184 -8.043,20.678 -3.967,8.416 -9.191,17.993 -17.877,25.219 -9.297,7.733 -19.082,7.701 -28.365,-0.092 -5.934,-4.982 -10.92,-11.633 -15.691,-20.929 -6.629,-12.926 -11.459,-27.311 -15.66,-46.642 l -0.072,-0.342 c -0.174,-0.828 -0.412,-1.962 -0.893,-2.284 -4.152,-2.786 -8.357,-5.448 -12.807,-8.267 -1.068,-0.677 -2.146,-1.359 -3.238,-2.054 0.164,0.969 0.32,1.911 0.475,2.834 0.434,2.596 0.842,5.047 1.303,7.478 4.703,24.702 10.705,42.76 19.463,58.551 7.541,13.604 17.859,28.05 37.209,32.08 l 8.318,0 c 17.949,-3.632 27.887,-16.568 35.24,-28.748 1.953,-3.234 3.717,-6.507 5.244,-9.726 2.389,-5.035 4.557,-10.249 6.533,-15.655 l -11.139,-12.101 z" /></g><i:pgf
+     id="adobe_illustrator_pgf" /></svg>

pythermostat/pythermostat/gui/view/MainWindow.ui

@@ -27,7 +27,7 @@
   </property>
   <property name="windowIcon">
    <iconset>
-    <normaloff>thermostat-icon-640x640.png</normaloff>thermostat-icon-640x640.png</iconset>
+    <normaloff>../resources/artiq.ico</normaloff>../resources/artiq.ico</iconset>
   </property>
   <widget class="QWidget" name="main_widget">
    <property name="sizePolicy">
@@ -69,14 +69,14 @@
          </sizepolicy>
         </property>
         <property name="frameShape">
-         <enum>QFrame::StyledPanel</enum>
+         <enum>QFrame::Shape::StyledPanel</enum>
         </property>
         <property name="frameShadow">
-         <enum>QFrame::Raised</enum>
+         <enum>QFrame::Shadow::Raised</enum>
         </property>
         <layout class="QGridLayout" name="graphs_layout" rowstretch="1,1" columnstretch="1,1,1" rowminimumheight="100,100" columnminimumwidth="100,100,100">
          <property name="sizeConstraint">
-          <enum>QLayout::SetDefaultConstraint</enum>
+          <enum>QLayout::SizeConstraint::SetDefaultConstraint</enum>
          </property>
          <property name="leftMargin">
           <number>3</number>
@@ -93,12 +93,6 @@
          <property name="spacing">
           <number>2</number>
          </property>
-         <item row="1" column="0">
-          <widget class="ParameterTree" name="ch1_tree" native="true"/>
-         </item>
-         <item row="0" column="0">
-          <widget class="ParameterTree" name="ch0_tree" native="true"/>
-         </item>
          <item row="1" column="1">
           <widget class="LivePlotWidget" name="ch1_t_graph" native="true"/>
          </item>
@@ -111,6 +105,65 @@
          <item row="1" column="2">
           <widget class="LivePlotWidget" name="ch1_i_graph" native="true"/>
          </item>
+         <item row="0" column="0" rowspan="2">
+          <widget class="QTabWidget" name="tabWidget">
+           <property name="sizePolicy">
+            <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+             <horstretch>0</horstretch>
+             <verstretch>0</verstretch>
+            </sizepolicy>
+           </property>
+           <property name="currentIndex">
+            <number>0</number>
+           </property>
+           <widget class="QWidget" name="ch0_tab">
+            <property name="sizePolicy">
+             <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+              <horstretch>0</horstretch>
+              <verstretch>0</verstretch>
+             </sizepolicy>
+            </property>
+            <attribute name="title">
+             <string>Channel 0</string>
+            </attribute>
+            <layout class="QVBoxLayout" name="verticalLayout_2">
+             <item>
+              <widget class="ParameterTree" name="ch0_tree" native="true">
+               <property name="sizePolicy">
+                <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+                 <horstretch>0</horstretch>
+                 <verstretch>0</verstretch>
+                </sizepolicy>
+               </property>
+              </widget>
+             </item>
+            </layout>
+           </widget>
+           <widget class="QWidget" name="ch1_tab">
+            <property name="sizePolicy">
+             <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+              <horstretch>0</horstretch>
+              <verstretch>0</verstretch>
+             </sizepolicy>
+            </property>
+            <attribute name="title">
+             <string>Channel 1</string>
+            </attribute>
+            <layout class="QVBoxLayout" name="verticalLayout">
+             <item>
+              <widget class="ParameterTree" name="ch1_tree" native="true">
+               <property name="sizePolicy">
+                <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+                 <horstretch>0</horstretch>
+                 <verstretch>0</verstretch>
+                </sizepolicy>
+               </property>
+              </widget>
+             </item>
+            </layout>
+           </widget>
+          </widget>
+         </item>
         </layout>
        </widget>
       </item>
@@ -135,10 +188,10 @@
          </size>
         </property>
         <property name="frameShape">
-         <enum>QFrame::StyledPanel</enum>
+         <enum>QFrame::Shape::StyledPanel</enum>
         </property>
         <property name="frameShadow">
-         <enum>QFrame::Raised</enum>
+         <enum>QFrame::Shadow::Raised</enum>
         </property>
         <layout class="QHBoxLayout" name="horizontalLayout_2">
          <property name="spacing">
@@ -188,10 +241,10 @@
               <string>Connect</string>
              </property>
              <property name="popupMode">
-              <enum>QToolButton::MenuButtonPopup</enum>
+              <enum>QToolButton::ToolButtonPopupMode::MenuButtonPopup</enum>
              </property>
              <property name="toolButtonStyle">
-              <enum>Qt::ToolButtonFollowStyle</enum>
+              <enum>Qt::ToolButtonStyle::ToolButtonFollowStyle</enum>
              </property>
             </widget>
            </item>
@@ -235,7 +288,7 @@
               <string notr="true">⚙</string>
              </property>
              <property name="popupMode">
-              <enum>QToolButton::InstantPopup</enum>
+              <enum>QToolButton::ToolButtonPopupMode::InstantPopup</enum>
              </property>
             </widget>
            </item>
@@ -248,7 +301,7 @@
               <string>📉</string>
              </property>
              <property name="popupMode">
-              <enum>QToolButton::InstantPopup</enum>
+              <enum>QToolButton::ToolButtonPopupMode::InstantPopup</enum>
              </property>
             </widget>
            </item>
@@ -272,7 +325,7 @@
            <item>
             <spacer name="horizontalSpacer">
              <property name="orientation">
-              <enum>Qt::Horizontal</enum>
+              <enum>Qt::Orientation::Horizontal</enum>
              </property>
              <property name="sizeHint" stdset="0">
               <size>
@@ -316,12 +369,12 @@
                <number>0</number>
               </property>
               <item>
-               <layout class="QHBoxLayout" name="report_layout" stretch="0,1,1,1">
+               <layout class="QHBoxLayout" name="report_layout" stretch="0,1,1">
                 <property name="spacing">
                  <number>6</number>
                 </property>
                 <property name="sizeConstraint">
-                 <enum>QLayout::SetDefaultConstraint</enum>
+                 <enum>QLayout::SizeConstraint::SetDefaultConstraint</enum>
                 </property>
                 <property name="leftMargin">
                  <number>0</number>
@@ -332,7 +385,7 @@
                    <string>Poll every: </string>
                   </property>
                   <property name="alignment">
-                   <set>Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter</set>
+                   <set>Qt::AlignmentFlag::AlignRight|Qt::AlignmentFlag::AlignTrailing|Qt::AlignmentFlag::AlignVCenter</set>
                   </property>
                  </widget>
                 </item>
@@ -375,38 +428,13 @@
                    <double>0.100000000000000</double>
                   </property>
                   <property name="stepType">
-                   <enum>QAbstractSpinBox::AdaptiveDecimalStepType</enum>
+                   <enum>QAbstractSpinBox::StepType::AdaptiveDecimalStepType</enum>
                   </property>
                   <property name="value">
                    <double>1.000000000000000</double>
                   </property>
                  </widget>
                 </item>
-                <item>
-                 <widget class="QCheckBox" name="report_box">
-                  <property name="sizePolicy">
-                   <sizepolicy hsizetype="Fixed" vsizetype="Expanding">
-                    <horstretch>0</horstretch>
-                    <verstretch>0</verstretch>
-                   </sizepolicy>
-                  </property>
-                  <property name="maximumSize">
-                   <size>
-                    <width>80</width>
-                    <height>16777215</height>
-                   </size>
-                  </property>
-                  <property name="baseSize">
-                   <size>
-                    <width>80</width>
-                    <height>0</height>
-                   </size>
-                  </property>
-                  <property name="text">
-                   <string>Report</string>
-                  </property>
-                 </widget>
-                </item>
                 <item>
                  <widget class="QPushButton" name="report_apply_btn">
                   <property name="sizePolicy">
@@ -452,72 +480,6 @@
     </item>
    </layout>
   </widget>
-  <action name="actionReset">
-   <property name="text">
-    <string>Reset</string>
-   </property>
-   <property name="toolTip">
-    <string>Reset the Thermostat</string>
-   </property>
-   <property name="menuRole">
-    <enum>QAction::NoRole</enum>
-   </property>
-  </action>
-  <action name="actionEnter_DFU_Mode">
-   <property name="text">
-    <string>Enter DFU Mode</string>
-   </property>
-   <property name="toolTip">
-    <string>Reset thermostat and enter USB device firmware update (DFU) mode</string>
-   </property>
-   <property name="menuRole">
-    <enum>QAction::NoRole</enum>
-   </property>
-  </action>
-  <action name="actionNetwork_Settings">
-   <property name="text">
-    <string>Network Settings</string>
-   </property>
-   <property name="toolTip">
-    <string>Configure IPv4 address, netmask length, and optional default gateway</string>
-   </property>
-   <property name="menuRole">
-    <enum>QAction::NoRole</enum>
-   </property>
-  </action>
-  <action name="actionAbout_Thermostat">
-   <property name="text">
-    <string>About Thermostat</string>
-   </property>
-   <property name="toolTip">
-    <string>Show Thermostat hardware revision, and settings related to i</string>
-   </property>
-   <property name="menuRole">
-    <enum>QAction::NoRole</enum>
-   </property>
-  </action>
-  <action name="actionLoad_all_configs">
-   <property name="text">
-    <string>Load all channel configs from flash</string>
-   </property>
-   <property name="toolTip">
-    <string>Restore configuration for all channels from flash</string>
-   </property>
-   <property name="menuRole">
-    <enum>QAction::NoRole</enum>
-   </property>
-  </action>
-  <action name="actionSave_all_configs">
-   <property name="text">
-    <string>Save all channel configs to flash</string>
-   </property>
-   <property name="toolTip">
-    <string>Save configuration for all channels to flash</string>
-   </property>
-   <property name="menuRole">
-    <enum>QAction::NoRole</enum>
-   </property>
-  </action>
  </widget>
  <customwidgets>
   <customwidget>
@@ -535,7 +497,7 @@
   <customwidget>
    <class>QtWaitingSpinner</class>
    <extends>QWidget</extends>
-   <header>waitingspinnerwidget</header>
+   <header>pythermostat.gui.view.waitingspinnerwidget</header>
    <container>1</container>
   </customwidget>
  </customwidgets>

pythermostat/pythermostat/gui/view/connection_details_menu.py

@@ -0,0 +1,69 @@
+from PyQt6 import QtWidgets, QtCore
+from PyQt6.QtCore import pyqtSlot
+from pythermostat.gui.model.thermostat import ThermostatConnectionState
+
+
+class ConnectionDetailsMenu(QtWidgets.QMenu):
+    def __init__(self, thermostat, connect_btn):
+        super().__init__()
+        self._thermostat = thermostat
+        self._connect_btn = connect_btn
+        self._thermostat.connection_state_update.connect(
+            self.thermostat_state_change_handler
+        )
+
+        self._setup_menu_items()
+
+    @pyqtSlot(ThermostatConnectionState)
+    def thermostat_state_change_handler(self, state):
+        self.host_set_line.setEnabled(state == ThermostatConnectionState.DISCONNECTED)
+        self.port_set_spin.setEnabled(state == ThermostatConnectionState.DISCONNECTED)
+
+    def _setup_menu_items(self):
+        # Sets Thermostat host/IP
+        self.host_set_line = QtWidgets.QLineEdit()
+        self.host_set_line.setMinimumWidth(160)
+        self.host_set_line.setMaximumWidth(160)
+        self.host_set_line.setMaxLength(15)
+        self.host_set_line.setClearButtonEnabled(True)
+        self.host_set_line.setText("192.168.1.26")
+        self.host_set_line.setPlaceholderText("IP for the Thermostat")
+
+        def connect_on_enter_press():
+            self._connect_btn.click()
+            self.hide()
+
+        self.host_set_line.returnPressed.connect(connect_on_enter_press)
+
+        host = QtWidgets.QWidgetAction(self)
+        host.setDefaultWidget(self.host_set_line)
+        self.addAction(host)
+
+        # Sets Thermostat port
+        self.port_set_spin = QtWidgets.QSpinBox()
+        self.port_set_spin.setMinimumWidth(70)
+        self.port_set_spin.setMaximumWidth(70)
+        self.port_set_spin.setMaximum(65535)
+        self.port_set_spin.setValue(23)
+
+        def connect_only_if_enter_pressed():
+            if (
+                not self.port_set_spin.hasFocus()
+            ):  # Don't connect if the spinbox only lost focus
+                return
+            connect_on_enter_press()
+
+        self.port_set_spin.editingFinished.connect(connect_only_if_enter_pressed)
+
+        port = QtWidgets.QWidgetAction(self)
+        port.setDefaultWidget(self.port_set_spin)
+        self.addAction(port)
+
+        # Exits GUI
+        exit_button = QtWidgets.QPushButton()
+        exit_button.setText("Exit GUI")
+        exit_button.pressed.connect(QtWidgets.QApplication.instance().quit)
+
+        exit_action = QtWidgets.QWidgetAction(exit_button)
+        exit_action.setDefaultWidget(exit_button)
+        self.addAction(exit_action)

pythermostat/pythermostat/gui/view/info_box.py

@@ -0,0 +1,14 @@
+from PyQt6 import QtWidgets
+from PyQt6.QtCore import pyqtSlot
+
+
+class InfoBox(QtWidgets.QMessageBox):
+    def __init__(self):
+        super().__init__()
+        self.setIcon(QtWidgets.QMessageBox.Icon.Information)
+
+    @pyqtSlot(str, str)
+    def display_info_box(self, title, text):
+        self.setWindowTitle(title)
+        self.setText(text)
+        self.show()

pythermostat/pythermostat/gui/view/live_plot_view.py

@@ -0,0 +1,181 @@
+from collections import deque
+from PyQt6.QtCore import QObject, pyqtSlot
+from pglive.sources.data_connector import DataConnector
+from pglive.kwargs import Axis
+from pglive.sources.live_plot import LiveLinePlot
+from pglive.sources.live_axis import LiveAxis
+import pyqtgraph as pg
+from pythermostat.gui.model.thermostat import ThermostatConnectionState
+
+
+pg.setConfigOptions(antialias=True)
+
+
+class LiveDataPlotter(QObject):
+    def __init__(self, thermostat, live_plots):
+        super().__init__()
+        self._thermostat = thermostat
+
+        self._thermostat.report_update.connect(self.update_report)
+        self._thermostat.pid_update.connect(self.update_pid)
+        self._thermostat.connection_state_update.connect(
+            self.thermostat_state_change_handler
+        )
+
+        self.NUM_CHANNELS = len(live_plots)
+        self.graphs = []
+
+        for i, live_plot in enumerate(live_plots):
+            live_plot[0].setTitle(f"Channel {i} Temperature")
+            live_plot[1].setTitle(f"Channel {i} Current")
+            self.graphs.append(_TecGraphs(live_plot[0], live_plot[1]))
+
+    @pyqtSlot(ThermostatConnectionState)
+    def thermostat_state_change_handler(self, state):
+        if state == ThermostatConnectionState.DISCONNECTED:
+            self.clear_graphs()
+
+    def _config_connector_max_pts(self, connector, samples):
+        connector.max_points = samples
+        connector.x = deque(maxlen=int(connector.max_points))
+        connector.y = deque(maxlen=int(connector.max_points))
+
+    @pyqtSlot(int)
+    def set_max_samples(self, samples: int):
+        for graph in self.graphs:
+            self._config_connector_max_pts(graph.t_connector, samples)
+            self._config_connector_max_pts(graph.i_connector, samples)
+            self._config_connector_max_pts(graph.iset_connector, samples)
+
+    @pyqtSlot()
+    def clear_graphs(self):
+        for graph in self.graphs:
+            graph.clear()
+
+    @pyqtSlot(list)
+    def update_pid(self, pid_settings):
+        for settings in pid_settings:
+            channel = settings["channel"]
+            self.graphs[channel].update_pid(settings)
+
+    @pyqtSlot(list)
+    def update_report(self, report_data):
+        for settings in report_data:
+            channel = settings["channel"]
+            self.graphs[channel].update_report(settings)
+
+
+class _TecGraphs:
+    """The maximum number of sample points to store."""
+
+    DEFAULT_MAX_SAMPLES = 1000
+
+    def __init__(self, t_widget, i_widget):
+        self._t_widget = t_widget
+        self._i_widget = i_widget
+
+        self._t_plot = LiveLinePlot()
+        self._i_plot = LiveLinePlot(name="Measured")
+        self._iset_plot = LiveLinePlot(name="Set", pen=pg.mkPen("r"))
+
+        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()
+
+        for graph in t_widget, i_widget:
+            time_axis = LiveAxis(
+                "bottom",
+                text="Time since Thermostat reset",
+                **{Axis.TICK_FORMAT: Axis.DURATION},
+            )
+            time_axis.showLabel()
+            graph.setAxisItems({"bottom": time_axis})
+
+            graph.add_crosshair(pg.mkPen(color="red", width=1), {"color": "green"})
+
+            # Enable linking of axes in the graph widget's context menu
+            graph.register(
+                graph.getPlotItem().titleLabel.text  # Slight hack getting the title
+            )
+
+        temperature_axis = LiveAxis("left", text="Temperature", units="°C")
+        temperature_axis.showLabel()
+        t_widget.setAxisItems({"left": temperature_axis})
+
+        current_axis = LiveAxis("left", text="Current", units="A")
+        current_axis.showLabel()
+        i_widget.setAxisItems({"left": current_axis})
+        i_widget.addLegend(brush=(50, 50, 200, 150))
+
+        t_widget.addItem(self._t_plot)
+        t_widget.addItem(self._t_setpoint_plot)
+        i_widget.addItem(self._i_plot)
+        i_widget.addItem(self._iset_plot)
+
+        self.t_connector = DataConnector(
+            self._t_plot, max_points=self.DEFAULT_MAX_SAMPLES
+        )
+        self.t_setpoint_connector = DataConnector(self._t_setpoint_plot, max_points=1)
+        self.i_connector = DataConnector(
+            self._i_plot, max_points=self.DEFAULT_MAX_SAMPLES
+        )
+        self.iset_connector = DataConnector(
+            self._iset_plot, max_points=self.DEFAULT_MAX_SAMPLES
+        )
+
+        self.max_samples = self.DEFAULT_MAX_SAMPLES
+
+    def plot_append(self, report):
+        temperature = report["temperature"]
+        current = report["tec_i"]
+        iset = report["i_set"]
+        time = report["time"]
+
+        if temperature is not None:
+            self.t_connector.cb_append_data_point(temperature, time)
+            if self._t_line.isVisible():
+                self.t_setpoint_connector.cb_append_data_point(
+                    self._t_line.value(), time
+                )
+            else:
+                self.t_setpoint_connector.cb_append_data_point(temperature, time)
+            if current is not None:
+                self.i_connector.cb_append_data_point(current, time)
+            self.iset_connector.cb_append_data_point(iset, time)
+
+    def set_max_sample(self, samples: int):
+        for connector in self.t_connector, self.i_connector, self.iset_connector:
+            connector.max_points(samples)
+
+    def clear(self):
+        for connector in self.t_connector, self.i_connector, self.iset_connector:
+            connector.clear()
+
+    def set_t_line(self, temp=None, visible=None):
+        if visible is not None:
+            self._t_line.setVisible(visible)
+        if temp is not None:
+            self._t_line.setValue(temp)
+
+            # PyQtGraph normally does not update this text when the line
+            # is not visible, so make sure that the temperature label
+            # gets updated always, and doesn't stay at an old value.
+            self._t_line.label.setText(f"{temp} °C")
+
+    def set_max_samples(self, samples: int):
+        for graph in self.graphs:
+            graph.t_connector.max_points = samples
+            graph.i_connector.max_points = samples
+            graph.iset_connector.max_points = samples
+
+    def clear_graphs(self):
+        for graph in self.graphs:
+            graph.clear()
+
+    def update_pid(self, pid_settings):
+        self.set_t_line(temp=round(pid_settings["target"], 6))
+
+    def update_report(self, report_data):
+        self.plot_append(report_data)
+        self.set_t_line(visible=report_data["pid_engaged"])

pythermostat/pythermostat/gui/view/menus.py

@@ -0,0 +1,307 @@
+from PyQt6 import QtWidgets, QtCore, QtGui
+from PyQt6.QtCore import pyqtSlot, QSignalBlocker
+from qasync import asyncSlot
+from pythermostat.gui.model.thermostat import ThermostatConnectionState
+from pythermostat.gui.view.net_settings_input_diag import NetSettingsInputDiag
+
+
+class ConnectionDetailsMenu(QtWidgets.QMenu):
+    def __init__(self, thermostat, connect_btn):
+        super().__init__()
+        self._thermostat = thermostat
+        self._connect_btn = connect_btn
+        self._thermostat.connection_state_update.connect(
+            self.thermostat_state_change_handler
+        )
+
+        self._setup_menu_items()
+
+    @pyqtSlot(ThermostatConnectionState)
+    def thermostat_state_change_handler(self, state):
+        self.host_set_line.setEnabled(state == ThermostatConnectionState.DISCONNECTED)
+        self.port_set_spin.setEnabled(state == ThermostatConnectionState.DISCONNECTED)
+
+    def _setup_menu_items(self):
+        # Sets Thermostat host/IP
+        self.host_set_line = QtWidgets.QLineEdit()
+        self.host_set_line.setMinimumWidth(160)
+        self.host_set_line.setMaximumWidth(160)
+        self.host_set_line.setMaxLength(15)
+        self.host_set_line.setClearButtonEnabled(True)
+        self.host_set_line.setText("192.168.1.26")
+        self.host_set_line.setPlaceholderText("IP for the Thermostat")
+
+        def connect_on_enter_press():
+            self._connect_btn.click()
+            self.hide()
+
+        self.host_set_line.returnPressed.connect(connect_on_enter_press)
+
+        host = QtWidgets.QWidgetAction(self)
+        host.setDefaultWidget(self.host_set_line)
+        self.addAction(host)
+
+        # Sets Thermostat port
+        self.port_set_spin = QtWidgets.QSpinBox()
+        self.port_set_spin.setMinimumWidth(70)
+        self.port_set_spin.setMaximumWidth(70)
+        self.port_set_spin.setMaximum(65535)
+        self.port_set_spin.setValue(23)
+
+        def connect_only_if_enter_pressed():
+            if (
+                not self.port_set_spin.hasFocus()
+            ):  # Don't connect if the spinbox only lost focus
+                return
+            connect_on_enter_press()
+
+        self.port_set_spin.editingFinished.connect(connect_only_if_enter_pressed)
+
+        port = QtWidgets.QWidgetAction(self)
+        port.setDefaultWidget(self.port_set_spin)
+        self.addAction(port)
+
+        # Exits GUI
+        exit_button = QtWidgets.QPushButton()
+        exit_button.setText("Exit GUI")
+        exit_button.pressed.connect(QtWidgets.QApplication.instance().quit)
+
+        exit_action = QtWidgets.QWidgetAction(exit_button)
+        exit_action.setDefaultWidget(exit_button)
+        self.addAction(exit_action)
+
+
+class PlotOptionsMenu(QtWidgets.QMenu):
+    def __init__(self, channel_graphs, max_samples=1000):
+        super().__init__()
+
+        # Clears plots for both graphs in all channels
+        clear_graphs = QtGui.QAction("Clear graphs", self)
+        clear_graphs.triggered.connect(channel_graphs.clear_graphs)
+        self.addAction(clear_graphs)
+
+        # Set maximum samples in graphs
+        samples_spinbox = QtWidgets.QSpinBox()
+        samples_spinbox.setRange(2, 100000)
+        samples_spinbox.setSuffix(" samples")
+        samples_spinbox.setValue(max_samples)
+        samples_spinbox.valueChanged.connect(channel_graphs.set_max_samples)
+
+        limit_samples = QtWidgets.QWidgetAction(self)
+        limit_samples.setDefaultWidget(samples_spinbox)
+        self.addAction(limit_samples)
+
+
+class ThermostatSettingsMenu(QtWidgets.QMenu):
+    def __init__(self, thermostat, info_box, style):
+        super().__init__()
+        self._thermostat = thermostat
+        self._info_box = info_box
+        self._style = style
+
+        self.hw_rev_data = {}
+        self._thermostat.hw_rev_update.connect(self.hw_rev)
+        self._thermostat.connection_state_update.connect(
+            self.thermostat_state_change_handler
+        )
+
+        self._setup_menu_items()
+
+    @pyqtSlot("QVariantMap")
+    def fan_update(self, fan_settings):
+        if fan_settings is None:
+            return
+        with QSignalBlocker(self.fan_power_slider):
+            self.fan_power_slider.setValue(
+                fan_settings["fan_pwm"] or 100  # 0 = PWM off = full strength
+            )
+        with QSignalBlocker(self.fan_auto_box):
+            self.fan_auto_box.setChecked(fan_settings["auto_mode"])
+
+    def set_fan_pwm_warning(self):
+        if self.fan_power_slider.value() != 100:
+            pixmapi = getattr(QtWidgets.QStyle.StandardPixmap, "SP_MessageBoxWarning")
+            icon = self._style.standardIcon(pixmapi)
+            self.fan_pwm_warning.setPixmap(icon.pixmap(16, 16))
+            self.fan_pwm_warning.setToolTip(
+                "Throttling the fan (not recommended on this hardware rev)"
+            )
+        else:
+            self.fan_pwm_warning.setPixmap(QtGui.QPixmap())
+            self.fan_pwm_warning.setToolTip("")
+
+    @pyqtSlot(ThermostatConnectionState)
+    def thermostat_state_change_handler(self, state):
+        if state == ThermostatConnectionState.DISCONNECTED:
+            self.fan_pwm_warning.setPixmap(QtGui.QPixmap())
+            self.fan_pwm_warning.setToolTip("")
+
+    @pyqtSlot("QVariantMap")
+    def hw_rev(self, hw_rev):
+        self.hw_rev_data = hw_rev
+        self.fan_group.setEnabled(self.hw_rev_data["settings"]["fan_available"])
+
+    @asyncSlot(int)
+    async def fan_set_request(self, value):
+        assert self._thermostat.connected()
+
+        if self.fan_auto_box.isChecked():
+            with QSignalBlocker(self.fan_auto_box):
+                self.fan_auto_box.setChecked(False)
+        await self._thermostat.set_fan(value)
+        if not self.hw_rev_data["settings"]["fan_pwm_recommended"]:
+            self.set_fan_pwm_warning()
+
+    @asyncSlot(int)
+    async def fan_auto_set_request(self, enabled):
+        assert self._thermostat.connected()
+
+        if enabled:
+            await self._thermostat.set_fan("auto")
+            self.fan_update(await self._thermostat.get_fan())
+        else:
+            await self.thermostat.set_fan(self.fan_power_slider.value())
+
+    @asyncSlot(bool)
+    async def reset_request(self, _):
+        assert self._thermostat.connected()
+
+        await self._thermostat.reset()
+        await self._thermostat.end_session()
+        self._thermostat.connection_state = ThermostatConnectionState.DISCONNECTED
+
+    @asyncSlot(bool)
+    async def dfu_request(self, _):
+        assert self._thermostat.connected()
+
+        await self._thermostat.dfu()
+        await self._thermostat.end_session()
+        self._thermostat.connection_state = ThermostatConnectionState.DISCONNECTED
+
+    @asyncSlot(bool)
+    async def net_settings_request(self, _):
+        assert self._thermostat.connected()
+
+        ipv4 = await self._thermostat.get_ipv4()
+        net_settings_input_diag = NetSettingsInputDiag(ipv4["addr"])
+        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.end_session()
+        self._thermostat.connection_state = ThermostatConnectionState.DISCONNECTED
+
+    def _setup_menu_items(self):
+        self.addAction(self._setup_fan_group())
+
+        self.reset_action = QtGui.QAction("Reset Thermostat", self)
+        self.reset_action.triggered.connect(self.reset_request)
+        self.addAction(self.reset_action)
+
+        self.dfu_action = QtGui.QAction("Enter DFU Mode", self)
+        self.dfu_action.triggered.connect(self.dfu_request)
+        self.addAction(self.dfu_action)
+
+        self.ipv4_action = QtGui.QAction("Set IPv4 Settings", self)
+        self.ipv4_action.triggered.connect(self.net_settings_request)
+        self.addAction(self.ipv4_action)
+
+        @asyncSlot(bool)
+        async def load(_):
+            await self._thermostat.load_cfg()
+
+            self._info_box.display_info_box(
+                "Settings loaded", "All channel settings have been loaded from flash."
+            )
+
+        self.load_config_action = QtGui.QAction("Load Settings", self)
+        self.load_config_action.triggered.connect(load)
+        self.addAction(self.load_config_action)
+
+        @asyncSlot(bool)
+        async def save(_):
+            await self._thermostat.save_cfg()
+
+            self._info_box.display_info_box(
+                "Settings saved", "All channel settings have been saved to flash."
+            )
+
+        self.save_config_action = QtGui.QAction("Save Settings", self)
+        self.save_config_action.triggered.connect(save)
+        self.addAction(self.save_config_action)
+
+        def about_thermostat():
+            QtWidgets.QMessageBox.about(
+                self,
+                "About Thermostat",
+                f"""
+                <h1>Sinara 8451 Thermostat v{self.hw_rev_data['rev']['major']}.{self.hw_rev_data['rev']['minor']}</h1>
+
+                <br>
+
+                <h2>Settings:</h2>
+                Default fan curve:
+                    a = {self.hw_rev_data['settings']['fan_k_a']},
+                    b = {self.hw_rev_data['settings']['fan_k_b']},
+                    c = {self.hw_rev_data['settings']['fan_k_c']}
+                <br>
+                Fan PWM range:
+                    {self.hw_rev_data['settings']['min_fan_pwm']} \u2013 {self.hw_rev_data['settings']['max_fan_pwm']}
+                <br>
+                Fan PWM frequency: {self.hw_rev_data['settings']['fan_pwm_freq_hz']} Hz
+                <br>
+                Fan available: {self.hw_rev_data['settings']['fan_available']}
+                <br>
+                Fan PWM recommended: {self.hw_rev_data['settings']['fan_pwm_recommended']}
+                """,
+            )
+
+        self.about_action = QtGui.QAction("About Thermostat", self)
+        self.about_action.triggered.connect(about_thermostat)
+        self.addAction(self.about_action)
+
+    def _setup_fan_group(self):
+        # Fan settings
+        self.fan_group = QtWidgets.QWidget()
+        self.fan_group.setEnabled(False)
+        self.fan_group.setMinimumWidth(40)
+        fan_layout = QtWidgets.QHBoxLayout(self.fan_group)
+        fan_layout.setSpacing(9)
+
+        fan_label = QtWidgets.QLabel(parent=self.fan_group)
+        fan_label.setMinimumWidth(40)
+        fan_label.setMaximumWidth(40)
+        fan_label.setBaseSize(QtCore.QSize(40, 0))
+
+        fan_layout.addWidget(fan_label)
+        self.fan_power_slider = QtWidgets.QSlider(
+            QtCore.Qt.Orientation.Horizontal, parent=self.fan_group
+        )
+        self.fan_power_slider.setMinimumWidth(200)
+        self.fan_power_slider.setMaximumWidth(200)
+        self.fan_power_slider.setBaseSize(QtCore.QSize(200, 0))
+        self.fan_power_slider.setRange(1, 100)
+        fan_layout.addWidget(self.fan_power_slider)
+
+        self.fan_auto_box = QtWidgets.QCheckBox(parent=self.fan_group)
+        self.fan_auto_box.setMinimumWidth(70)
+        self.fan_auto_box.setMaximumWidth(70)
+        fan_layout.addWidget(self.fan_auto_box)
+        self.fan_pwm_warning = QtWidgets.QLabel(parent=self.fan_group)
+        self.fan_pwm_warning.setMinimumSize(QtCore.QSize(16, 0))
+        fan_layout.addWidget(self.fan_pwm_warning)
+
+        self.fan_power_slider.valueChanged.connect(self.fan_set_request)
+        self.fan_auto_box.stateChanged.connect(self.fan_auto_set_request)
+        self._thermostat.fan_update.connect(self.fan_update)
+
+        fan_label.setToolTip("Adjust the fan")
+        fan_label.setText("Fan:")
+        self.fan_auto_box.setText("Auto")
+
+        fan = QtWidgets.QWidgetAction(self)
+        fan.setDefaultWidget(self.fan_group)
+        return fan

pythermostat/pythermostat/gui/view/net_settings_input_diag.py

@@ -0,0 +1,36 @@
+from PyQt6 import QtWidgets
+from PyQt6.QtWidgets import QAbstractButton
+from PyQt6.QtCore import pyqtSignal, pyqtSlot
+
+
+class NetSettingsInputDiag(QtWidgets.QInputDialog):
+    set_ipv4_act = pyqtSignal(str)
+
+    def __init__(self, current_ipv4_settings):
+        super().__init__()
+        self.setWindowTitle("Network Settings")
+        self.setLabelText(
+            "Set the Thermostat's IPv4 address, netmask and gateway (optional)"
+        )
+        self.setTextValue(current_ipv4_settings)
+        self._new_ipv4 = ""
+
+        @pyqtSlot(str)
+        def set_ipv4(ipv4_settings):
+            self._new_ipv4 = ipv4_settings
+
+            sure = QtWidgets.QMessageBox(self)
+            sure.setWindowTitle("Set network?")
+            sure.setText(
+                f"Setting this as network and disconnecting:<br>{ipv4_settings}"
+            )
+
+            sure.buttonClicked.connect(self._emit_sig)
+            sure.show()
+
+        self.textValueSelected.connect(set_ipv4)
+        self.show()
+
+    @pyqtSlot(QAbstractButton)
+    def _emit_sig(self, _):
+        self.set_ipv4_act.emit(self._new_ipv4)

pythermostat/pythermostat/gui/view/param_tree.json

@@ -0,0 +1,391 @@
+{
+   "settings_tree": [
+      {
+         "name": "readings",
+         "title": "Readings",
+         "type": "group",
+         "children": [
+            {
+               "name": "temperature",
+               "title": "Temperature",
+               "type": "float",
+               "format": "{value:.4f} °C",
+               "readonly": true
+            },
+            {
+               "name": "tec_i",
+               "title": "Current through TEC",
+               "type": "float",
+               "suffix": "mA",
+               "decimals": 6,
+               "readonly": true
+            }
+         ]
+      },
+      {
+         "name": "output",
+         "title": "Output Settings",
+         "expanded": true,
+         "type": "group",
+         "children": [
+            {
+               "name": "control_method",
+               "title": "Control Method",
+               "type": "mutex",
+               "limits": {
+                  "Constant Current": "constant_current",
+                  "Temperature PID": "temperature_pid"
+               },
+               "value": "constant_current",
+               "thermostat:set_param": {
+                  "topic": "output",
+                  "field": "pid"
+               },
+               "children": [
+                  {
+                     "name": "i_set",
+                     "title": "Set Current",
+                     "type": "float",
+                     "value": 0,
+                     "step": 100,
+                     "limits": [
+                        -2000,
+                        2000
+                     ],
+                     "triggerOnShow": true,
+                     "decimals": 6,
+                     "suffix": "mA",
+                     "compactHeight": false,
+                     "thermostat:set_param": {
+                        "topic": "output",
+                        "field": "i_set"
+                     },
+                     "lock": false
+                  },
+                  {
+                     "name": "target",
+                     "title": "Set Temperature",
+                     "type": "float",
+                     "value": 25,
+                     "step": 0.1,
+                     "limits": [
+                        -273,
+                        300
+                     ],
+                     "format": "{value:.4f} °C",
+                     "compactHeight": false,
+                     "thermostat:set_param": {
+                        "topic": "pid",
+                        "field": "target"
+                     },
+                     "lock": false
+                  }
+               ]
+            },
+            {
+               "name": "limits",
+               "title": "Limits",
+               "expanded": true,
+               "type": "group",
+               "children": [
+                  {
+                     "name": "max_i_pos",
+                     "title": "Max Cooling Current",
+                     "type": "float",
+                     "value": 0,
+                     "step": 100,
+                     "decimals": 6,
+                     "limits": [
+                        0,
+                        2000
+                     ],
+                     "suffix": "mA",
+                     "compactHeight": false,
+                     "thermostat:set_param": {
+                        "topic": "output",
+                        "field": "max_i_pos"
+                     },
+                     "lock": false
+                  },
+                  {
+                     "name": "max_i_neg",
+                     "title": "Max Heating Current",
+                     "type": "float",
+                     "value": 0,
+                     "step": 100,
+                     "decimals": 6,
+                     "limits": [
+                        0,
+                        2000
+                     ],
+                     "suffix": "mA",
+                     "compactHeight": false,
+                     "thermostat:set_param": {
+                        "topic": "output",
+                        "field": "max_i_neg"
+                     },
+                     "lock": false
+                  },
+                  {
+                     "name": "max_v",
+                     "title": "Max Voltage Difference",
+                     "type": "float",
+                     "value": 0,
+                     "step": 0.1,
+                     "decimals": 3,
+                     "limits": [
+                        0,
+                        4.3
+                     ],
+                     "suffix": "V",
+                     "compactHeight": false,
+                     "thermostat:set_param": {
+                        "topic": "output",
+                        "field": "max_v"
+                     },
+                     "lock": false
+                  }
+               ]
+            }
+         ]
+      },
+      {
+         "name": "thermistor",
+         "title": "Thermistor Settings",
+         "expanded": true,
+         "type": "group",
+         "tip": "Settings of the connected Thermistor",
+         "children": [
+            {
+               "name": "t0",
+               "title": "T₀",
+               "type": "float",
+               "value": 25,
+               "step": 0.1,
+               "limits": [
+                  -100,
+                  100
+               ],
+               "format": "{value:.4f} °C",
+               "compactHeight": false,
+               "thermostat:set_param": {
+                  "topic": "b-p",
+                  "field": "t0"
+               },
+               "lock": false
+            },
+            {
+               "name": "r0",
+               "title": "R₀",
+               "type": "float",
+               "value": 10000,
+               "step": 100,
+               "min": 0,
+               "siPrefix": true,
+               "suffix": "Ω",
+               "compactHeight": false,
+               "thermostat:set_param": {
+                  "topic": "b-p",
+                  "field": "r0"
+               },
+               "lock": false
+            },
+            {
+               "name": "b",
+               "title": "B",
+               "type": "float",
+               "value": 3950,
+               "step": 10,
+               "suffix": "K",
+               "decimals": 4,
+               "compactHeight": false,
+               "thermostat:set_param": {
+                  "topic": "b-p",
+                  "field": "b"
+               },
+               "lock": false
+            },
+            {
+               "name": "rate",
+               "title": "Postfilter Rate",
+               "type": "list",
+               "value": 16.67,
+               "thermostat:set_param": {
+                  "topic": "postfilter",
+                  "field": "rate"
+               },
+               "limits": {
+                  "Off": null,
+                  "16.667 Hz": 16.667,
+                  "20 Hz": 20.0,
+                  "25 Hz": 25,
+                  "27.27 Hz": 27.27
+               },
+               "lock": false
+            }
+         ]
+      },
+      {
+         "name": "pid",
+         "title": "PID Settings",
+         "expanded": true,
+         "type": "group",
+         "children": [
+            {
+               "name": "kp",
+               "title": "Kp",
+               "type": "float",
+               "step": 0.1,
+               "suffix": "",
+               "compactHeight": false,
+               "thermostat:set_param": {
+                  "topic": "pid",
+                  "field": "kp"
+               },
+               "lock": false
+            },
+            {
+               "name": "ki",
+               "title": "Ki",
+               "type": "float",
+               "step": 0.1,
+               "suffix": "Hz",
+               "compactHeight": false,
+               "thermostat:set_param": {
+                  "topic": "pid",
+                  "field": "ki"
+               },
+               "lock": false
+            },
+            {
+               "name": "kd",
+               "title": "Kd",
+               "type": "float",
+               "step": 0.1,
+               "suffix": "s",
+               "compactHeight": false,
+               "thermostat:set_param": {
+                  "topic": "pid",
+                  "field": "kd"
+               },
+               "lock": false
+            },
+            {
+               "name": "pid_output_clamping",
+               "title": "PID Output Clamping",
+               "expanded": true,
+               "type": "group",
+               "children": [
+                  {
+                     "name": "output_min",
+                     "title": "Minimum",
+                     "type": "float",
+                     "step": 100,
+                     "limits": [
+                        -2000,
+                        2000
+                     ],
+                     "decimals": 6,
+                     "suffix": "mA",
+                     "compactHeight": false,
+                     "thermostat:set_param": {
+                        "topic": "pid",
+                        "field": "output_min"
+                     },
+                     "lock": false
+                  },
+                  {
+                     "name": "output_max",
+                     "title": "Maximum",
+                     "type": "float",
+                     "step": 100,
+                     "limits": [
+                        -2000,
+                        2000
+                     ],
+                     "decimals": 6,
+                     "suffix": "mA",
+                     "compactHeight": false,
+                     "thermostat:set_param": {
+                        "topic": "pid",
+                        "field": "output_max"
+                     },
+                     "lock": false
+                  }
+               ]
+            },
+            {
+               "name": "pid_autotune",
+               "title": "PID Auto Tune",
+               "expanded": false,
+               "type": "group",
+               "children": [
+                  {
+                     "name": "target_temp",
+                     "title": "Target Temperature",
+                     "type": "float",
+                     "value": 20,
+                     "step": 0.1,
+                     "format": "{value:.4f} °C",
+                     "compactHeight": false,
+                     "pid_autotune": "target_temp"
+                  },
+                  {
+                     "name": "test_current",
+                     "title": "Test Current",
+                     "type": "float",
+                     "value": 0,
+                     "decimals": 6,
+                     "step": 100,
+                     "limits": [
+                        0,
+                        2000
+                     ],
+                     "suffix": "mA",
+                     "compactHeight": false,
+                     "pid_autotune": "test_current"
+                  },
+                  {
+                     "name": "temp_swing",
+                     "title": "Temperature Swing",
+                     "type": "float",
+                     "value": 1.5,
+                     "step": 0.1,
+                     "format": "± {value:.4f} °C",
+                     "compactHeight": false,
+                     "pid_autotune": "temp_swing"
+                  },
+                  {
+                     "name": "lookback",
+                     "title": "Lookback",
+                     "type": "float",
+                     "value": 3.0,
+                     "step": 0.1,
+                     "format": "{value:.4f} s",
+                     "compactHeight": false,
+                     "pid_autotune": "lookback"
+                  },
+                  {
+                     "name": "run_pid",
+                     "title": "Run",
+                     "type": "action",
+                     "tip": "Run"
+                  }
+               ]
+            }
+         ]
+      },
+      {
+         "name": "save",
+         "title": "Save to flash",
+         "type": "action",
+         "tip": "Save settings to thermostat, applies on reset"
+      },
+      {
+         "name": "load",
+         "title": "Load from flash",
+         "type": "action",
+         "tip": "Load settings from flash"
+      }
+   ]
+}

pythermostat/pythermostat/gui/view/settings_tree_view.py

@@ -0,0 +1,302 @@
+from functools import partial
+from PyQt6.QtCore import pyqtSignal, QObject, QSignalBlocker, pyqtSlot
+import pyqtgraph.parametertree.parameterTypes as pTypes
+from pyqtgraph.parametertree import (
+    Parameter,
+    registerParameterType,
+)
+from qasync import asyncSlot
+from pythermostat.autotune import PIDAutotuneState
+
+
+class MutexParameter(pTypes.ListParameter):
+    """
+    Mutually exclusive parameter where only one of its children is visible at a time, list selectable.
+
+    The ordering of the list items determines which children will be visible.
+    """
+
+    def __init__(self, **opts):
+        super().__init__(**opts)
+
+        self.sigValueChanged.connect(self.show_chosen_child)
+        self.sigValueChanged.emit(self, self.opts["value"])
+
+    def _get_param_from_value(self, value):
+        if isinstance(self.opts["limits"], dict):
+            values_list = list(self.opts["limits"].values())
+        else:
+            values_list = self.opts["limits"]
+
+        return self.children()[values_list.index(value)]
+
+    @pyqtSlot(object, object)
+    def show_chosen_child(self, value):
+        for param in self.children():
+            param.hide()
+
+        child_to_show = self._get_param_from_value(value.value())
+        child_to_show.show()
+
+        if child_to_show.opts.get("triggerOnShow", None):
+            child_to_show.sigValueChanged.emit(child_to_show, child_to_show.value())
+
+
+registerParameterType("mutex", MutexParameter)
+
+
+class SettingsTreeView(QObject):
+    def __init__(
+        self,
+        thermostat,
+        autotuners,
+        info_box,
+        trees_ui,
+        param_tree,
+        parent=None,
+    ):
+        super().__init__(parent)
+
+        self.thermostat = thermostat
+        self.autotuners = autotuners
+        self.info_box = info_box
+        self.trees_ui = trees_ui
+        self.NUM_CHANNELS = len(trees_ui)
+
+        self.THERMOSTAT_PARAMETERS = [param_tree for i in range(self.NUM_CHANNELS)]
+
+        self.params = [
+            Parameter.create(
+                name=f"Thermostat Channel {ch} Parameters",
+                type="group",
+                value=ch,
+                children=self.THERMOSTAT_PARAMETERS[ch],
+            )
+            for ch in range(self.NUM_CHANNELS)
+        ]
+
+        for i, param in enumerate(self.params):
+            param.channel = i
+
+        for i, tree in enumerate(self.trees_ui):
+            tree.setHeaderHidden(True)
+            tree.setParameters(self.params[i], showTop=False)
+            self.params[i].setValue = self._setValue
+            self.params[i].sigTreeStateChanged.connect(self.send_command)
+
+            self.params[i].child("save").sigActivated.connect(
+                partial(self.save_settings, i)
+            )
+            self.params[i].child("load").sigActivated.connect(
+                partial(self.load_settings, i)
+            )
+            self.params[i].child("pid", "pid_autotune", "run_pid").sigActivated.connect(
+                partial(self.pid_auto_tune_request, i)
+            )
+
+        self.thermostat.pid_update.connect(self.update_pid)
+        self.thermostat.report_update.connect(self.update_report)
+        self.thermostat.thermistor_update.connect(self.update_thermistor)
+        self.thermostat.output_update.connect(self.update_output)
+        self.thermostat.postfilter_update.connect(self.update_postfilter)
+        self.autotuners.autotune_state_changed.connect(self.update_pid_autotune)
+
+    def _setValue(self, value, blockSignal=None):
+        """
+        Implement 'lock' mechanism for Parameter Type
+
+        Modified from the source
+        """
+        try:
+            if blockSignal is not None:
+                self.sigValueChanged.disconnect(blockSignal)
+            value = self._interpretValue(value)
+            if fn.eq(self.opts["value"], value):
+                return value
+
+            if "lock" in self.opts.keys():
+                if self.opts["lock"]:
+                    return value
+            self.opts["value"] = value
+            self.sigValueChanged.emit(
+                self, value
+            )  # value might change after signal is received by tree item
+        finally:
+            if blockSignal is not None:
+                self.sigValueChanged.connect(blockSignal)
+
+        return self.opts["value"]
+
+    def change_params_title(self, channel, path, title):
+        self.params[channel].child(*path).setOpts(title=title)
+
+    @asyncSlot(object, object)
+    async def send_command(self, param, changes):
+        """Translates parameter tree changes into thermostat set_param calls"""
+        ch = param.channel
+
+        for inner_param, change, data in changes:
+            if change == "value":
+                new_value = data
+                if "thermostat:set_param" in inner_param.opts:
+                    if inner_param.opts.get("suffix", None) == "mA":
+                        new_value /= 1000  # Given in mA
+
+                    thermostat_param = inner_param.opts["thermostat:set_param"]
+
+                    # Handle thermostat command irregularities
+                    match inner_param.name(), new_value:
+                        case "rate", None:
+                            thermostat_param = thermostat_param.copy()
+                            thermostat_param["field"] = "off"
+                            new_value = ""
+                        case "control_method", "constant_current":
+                            return
+                        case "control_method", "temperature_pid":
+                            new_value = ""
+
+                    inner_param.setOpts(lock=True)
+                    await self.thermostat.set_param(
+                        channel=ch, value=new_value, **thermostat_param
+                    )
+                    inner_param.setOpts(lock=False)
+
+                if "pid_autotune" in inner_param.opts:
+                    auto_tuner_param = inner_param.opts["pid_autotune"]
+                    self.autotuners.set_params(auto_tuner_param, ch, new_value)
+
+    @pyqtSlot(list)
+    def update_pid(self, pid_settings):
+        for settings in pid_settings:
+            channel = settings["channel"]
+            with QSignalBlocker(self.params[channel]):
+                self.params[channel].child("pid", "kp").setValue(
+                    settings["parameters"]["kp"]
+                )
+                self.params[channel].child("pid", "ki").setValue(
+                    settings["parameters"]["ki"]
+                )
+                self.params[channel].child("pid", "kd").setValue(
+                    settings["parameters"]["kd"]
+                )
+                self.params[channel].child(
+                    "pid", "pid_output_clamping", "output_min"
+                ).setValue(settings["parameters"]["output_min"] * 1000)
+                self.params[channel].child(
+                    "pid", "pid_output_clamping", "output_max"
+                ).setValue(settings["parameters"]["output_max"] * 1000)
+                self.params[channel].child(
+                    "output", "control_method", "target"
+                ).setValue(settings["target"])
+
+    @pyqtSlot(list)
+    def update_report(self, report_data):
+        for settings in report_data:
+            channel = settings["channel"]
+            with QSignalBlocker(self.params[channel]):
+                self.params[channel].child("output", "control_method").setValue(
+                    "temperature_pid" if settings["pid_engaged"] else "constant_current"
+                )
+                self.params[channel].child(
+                    "output", "control_method", "i_set"
+                ).setValue(settings["i_set"] * 1000)
+                if settings["temperature"] is not None:
+                    self.params[channel].child("readings", "temperature").setValue(
+                        settings["temperature"]
+                    )
+                    if settings["tec_i"] is not None:
+                        self.params[channel].child("readings", "tec_i").setValue(
+                            settings["tec_i"] * 1000
+                        )
+
+    @pyqtSlot(list)
+    def update_thermistor(self, sh_data):
+        for sh_param in sh_data:
+            channel = sh_param["channel"]
+            with QSignalBlocker(self.params[channel]):
+                self.params[channel].child("thermistor", "t0").setValue(
+                    sh_param["params"]["t0"] - 273.15
+                )
+                self.params[channel].child("thermistor", "r0").setValue(
+                    sh_param["params"]["r0"]
+                )
+                self.params[channel].child("thermistor", "b").setValue(
+                    sh_param["params"]["b"]
+                )
+
+    @pyqtSlot(list)
+    def update_output(self, output_data):
+        for output_params in output_data:
+            channel = output_params["channel"]
+            with QSignalBlocker(self.params[channel]):
+                self.params[channel].child("output", "limits", "max_v").setValue(
+                    output_params["max_v"]
+                )
+                self.params[channel].child("output", "limits", "max_i_pos").setValue(
+                    output_params["max_i_pos"] * 1000
+                )
+                self.params[channel].child("output", "limits", "max_i_neg").setValue(
+                    output_params["max_i_neg"] * 1000
+                )
+
+    @pyqtSlot(list)
+    def update_postfilter(self, postfilter_data):
+        for postfilter_params in postfilter_data:
+            channel = postfilter_params["channel"]
+            with QSignalBlocker(self.params[channel]):
+                self.params[channel].child("thermistor", "rate").setValue(
+                    postfilter_params["rate"]
+                )
+
+    def update_pid_autotune(self, ch, state):
+        match state:
+            case PIDAutotuneState.OFF:
+                self.change_params_title(ch, ("pid", "pid_autotune", "run_pid"), "Run")
+            case (
+                PIDAutotuneState.READY
+                | PIDAutotuneState.RELAY_STEP_UP
+                | PIDAutotuneState.RELAY_STEP_DOWN
+            ):
+                self.change_params_title(ch, ("pid", "pid_autotune", "run_pid"), "Stop")
+            case PIDAutotuneState.SUCCEEDED:
+                self.info_box.display_info_box(
+                    "PID Autotune Success",
+                    f"Channel {ch} PID Settings has been loaded to Thermostat. Regulating temperature.",
+                )
+            case PIDAutotuneState.FAILED:
+                self.info_box.display_info_box(
+                    "PID Autotune Failed",
+                    f"Channel {ch} PID Autotune has failed.",
+                )
+
+    @asyncSlot(int)
+    async def load_settings(self, ch):
+        await self.thermostat.load_cfg(ch)
+
+        self.info_box.display_info_box(
+            f"Channel {ch} settings loaded",
+            f"Channel {ch} settings has been loaded from flash.",
+        )
+
+    @asyncSlot(int)
+    async def save_settings(self, ch):
+        await self.thermostat.save_cfg(ch)
+
+        self.info_box.display_info_box(
+            f"Channel {ch} settings saved",
+            f"Channel {ch} settings has been saved to flash.\n"
+            "It will be loaded on Thermostat reset, or when settings are explicitly loaded.",
+        )
+
+    @asyncSlot()
+    async def pid_auto_tune_request(self, ch=0):
+        match self.autotuners.get_state(ch):
+            case PIDAutotuneState.OFF | PIDAutotuneState.FAILED:
+                self.autotuners.load_params_and_set_ready(ch)
+
+            case (
+                PIDAutotuneState.READY
+                | PIDAutotuneState.RELAY_STEP_UP
+                | PIDAutotuneState.RELAY_STEP_DOWN
+            ):
+                await self.autotuners.stop_pid_from_running(ch)

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

pythermostat/pythermostat/gui/view/zero_limits_warning_view.py

@@ -0,0 +1,50 @@
+from PyQt6.QtCore import pyqtSlot, QObject
+from PyQt6 import QtWidgets, QtGui
+
+
+class ZeroLimitsWarningView(QObject):
+    def __init__(self, thermostat, style, limit_warning):
+        super().__init__()
+        self._thermostat = thermostat
+        self._thermostat.output_update.connect(self.set_limits_warning)
+        self._lbl = limit_warning
+        self._style = style
+
+    @pyqtSlot(list)
+    def set_limits_warning(self, output_data: list):
+        channels_zeroed_limits = [set() for i in range(self._thermostat.NUM_CHANNELS)]
+
+        for output_params in output_data:
+            channel = output_params["channel"]
+            for limit in "max_i_pos", "max_i_neg", "max_v":
+                if output_params[limit] == 0.0:
+                    channels_zeroed_limits[channel].add(limit)
+
+        channel_disabled = [False, False]
+        report_str = "The following output limit(s) are set to zero:\n"
+        for ch, zeroed_limits in enumerate(channels_zeroed_limits):
+            if {"max_i_pos", "max_i_neg"}.issubset(zeroed_limits):
+                report_str += "Max Cooling Current, Max Heating Current"
+                channel_disabled[ch] = True
+
+            if "max_v" in zeroed_limits:
+                if channel_disabled[ch]:
+                    report_str += ", "
+                report_str += "Max Voltage Difference"
+                channel_disabled[ch] = True
+
+            if channel_disabled[ch]:
+                report_str += f" for Channel {ch}\n"
+
+        report_str += (
+            "\nThese limit(s) are restricting the channel(s) from producing current."
+        )
+
+        if True in channel_disabled:
+            pixmapi = getattr(QtWidgets.QStyle.StandardPixmap, "SP_MessageBoxWarning")
+            icon = self._style.standardIcon(pixmapi)
+            self._lbl.setPixmap(icon.pixmap(16, 16))
+            self._lbl.setToolTip(report_str)
+        else:
+            self._lbl.setPixmap(QtGui.QPixmap())
+            self._lbl.setToolTip(None)

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
+
+    thermostat = Client()
+    target_temperature = thermostat.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(thermostat):
+        global last_packet_time
+        while True:
+            data = thermostat.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=(thermostat,))
+    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/ad5680.rs

@@ -1,12 +1,9 @@
-use stm32f4xx_hal::{
-    hal::{
-        blocking::spi::Transfer,
-        digital::v2::OutputPin,
-    },
-    time::MegaHertz,
-    spi,
-};
 use crate::timer::sleep;
+use stm32f4xx_hal::{
+    hal::{blocking::spi::Transfer, digital::v2::OutputPin},
+    spi,
+    time::MegaHertz,
+};
 
 /// SPI Mode 1
 pub const SPI_MODE: spi::Mode = spi::Mode {
@@ -27,11 +24,8 @@ pub struct Dac<SPI: Transfer<u8>, S: OutputPin> {
 impl<SPI: Transfer<u8>, S: OutputPin> Dac<SPI, S> {
     pub fn new(spi: SPI, mut sync: S) -> Self {
         let _ = sync.set_low();
-        
-        Dac {
-            spi,
-            sync,
-        }
+
+        Dac { spi, sync }
     }
 
     fn write(&mut self, buf: &mut [u8]) -> Result<(), SPI::Error> {
@@ -47,11 +41,7 @@ impl<SPI: Transfer<u8>, S: OutputPin> Dac<SPI, S> {
 
     pub fn set(&mut self, value: u32) -> Result<u32, SPI::Error> {
         let value = value.min(MAX_VALUE);
-        let mut buf = [
-            (value >> 14) as u8,
-            (value >> 6) as u8,
-            (value << 2) as u8,
-        ];
+        let mut buf = [(value >> 14) as u8, (value >> 6) as u8, (value << 2) as u8];
         self.write(&mut buf)?;
         Ok(value)
     }

src/ad7172/adc.rs

@@ -1,18 +1,12 @@
-use core::fmt;
-use log::{info, warn};
-use stm32f4xx_hal::hal::{
-    blocking::spi::Transfer,
-    digital::v2::OutputPin,
-};
-use uom::si::{
-    f64::ElectricPotential,
-    electric_potential::volt,
-};
 use super::{
+    checksum::{Checksum, ChecksumMode},
     regs::{self, Register, RegisterData},
-    checksum::{ChecksumMode, Checksum},
-    Mode, Input, RefSource, PostFilter, DigitalFilterOrder,
+    DigitalFilterOrder, Input, Mode, PostFilter, RefSource,
 };
+use core::{fmt, marker::PhantomData};
+use log::{info, warn};
+use stm32f4xx_hal::hal::{blocking::spi::Transfer, digital::v2::OutputPin};
+use uom::si::f64::ElectricPotential;
 
 /// AD7172-2 implementation
 ///
@@ -27,7 +21,8 @@ impl<SPI: Transfer<u8, Error = E>, NSS: OutputPin, E: fmt::Debug> Adc<SPI, NSS>
     pub fn new(spi: SPI, mut nss: NSS) -> Result<Self, SPI::Error> {
         let _ = nss.set_high();
         let mut adc = Adc {
-            spi, nss,
+            spi,
+            nss,
             checksum_mode: ChecksumMode::Off,
         };
         adc.reset()?;
@@ -55,8 +50,7 @@ impl<SPI: Transfer<u8, Error = E>, NSS: OutputPin, E: fmt::Debug> Adc<SPI, NSS>
 
     /// `0x00DX` for AD7172-2
     pub fn identify(&mut self) -> Result<u16, SPI::Error> {
-        self.read_reg(&regs::Id)
-            .map(|id| id.id())
+        self.read_reg(&regs::Id).map(|id| id.id())
     }
 
     pub fn set_checksum_mode(&mut self, mode: ChecksumMode) -> Result<(), SPI::Error> {
@@ -76,7 +70,10 @@ impl<SPI: Transfer<u8, Error = E>, NSS: OutputPin, E: fmt::Debug> Adc<SPI, NSS>
     }
 
     pub fn setup_channel(
-        &mut self, index: u8, in_pos: Input, in_neg: Input
+        &mut self,
+        index: u8,
+        in_pos: Input,
+        in_neg: Input,
     ) -> Result<(), SPI::Error> {
         self.update_reg(&regs::SetupCon { index }, |data| {
             data.set_bipolar(false);
@@ -106,7 +103,11 @@ impl<SPI: Transfer<u8, Error = E>, NSS: OutputPin, E: fmt::Debug> Adc<SPI, NSS>
         let offset = self.read_reg(&regs::Offset { index })?.offset();
         let gain = self.read_reg(&regs::Gain { index })?.gain();
         let bipolar = self.read_reg(&regs::SetupCon { index })?.bipolar();
-        Ok(ChannelCalibration { offset, gain, bipolar })
+        Ok(ChannelCalibration {
+            offset,
+            gain,
+            bipolar,
+        })
     }
 
     pub fn start_continuous_conversion(&mut self) -> Result<(), SPI::Error> {
@@ -119,44 +120,43 @@ impl<SPI: Transfer<u8, Error = E>, NSS: OutputPin, E: fmt::Debug> Adc<SPI, NSS>
     }
 
     pub fn get_postfilter(&mut self, index: u8) -> Result<Option<PostFilter>, SPI::Error> {
-        self.read_reg(&regs::FiltCon { index })
-            .map(|data| {
-                if data.enh_filt_en() {
-                    Some(data.enh_filt())
-                } else {
-                    None
-                }
-            })
+        self.read_reg(&regs::FiltCon { index }).map(|data| {
+            if data.enh_filt_en() {
+                Some(data.enh_filt())
+            } else {
+                None
+            }
+        })
     }
 
-    pub fn set_postfilter(&mut self, index: u8, filter: Option<PostFilter>) -> Result<(), SPI::Error> {
-        self.update_reg(&regs::FiltCon { index }, |data| {
-            match filter {
-                None => data.set_enh_filt_en(false),
-                Some(filter) => {
-                    data.set_enh_filt_en(true);
-                    data.set_enh_filt(filter);
-                }
+    pub fn set_postfilter(
+        &mut self,
+        index: u8,
+        filter: Option<PostFilter>,
+    ) -> Result<(), SPI::Error> {
+        self.update_reg(&regs::FiltCon { index }, |data| match filter {
+            None => data.set_enh_filt_en(false),
+            Some(filter) => {
+                data.set_enh_filt_en(true);
+                data.set_enh_filt(filter);
             }
         })
     }
 
     /// Returns the channel the data is from
     pub fn data_ready(&mut self) -> Result<Option<u8>, SPI::Error> {
-        self.read_reg(&regs::Status)
-            .map(|status| {
-                if status.ready() {
-                    Some(status.channel())
-                } else {
-                    None
-                }
-            })
+        self.read_reg(&regs::Status).map(|status| {
+            if status.ready() {
+                Some(status.channel())
+            } else {
+                None
+            }
+        })
     }
 
     /// Get data
     pub fn read_data(&mut self) -> Result<u32, SPI::Error> {
-        self.read_reg(&regs::Data)
-            .map(|data| data.data())
+        self.read_reg(&regs::Data).map(|data| data.data())
     }
 
     fn read_reg<R: regs::Register>(&mut self, reg: &R) -> Result<R::Data, SPI::Error> {
@@ -175,12 +175,21 @@ impl<SPI: Transfer<u8, Error = E>, NSS: OutputPin, E: fmt::Debug> Adc<SPI, NSS>
                 break;
             }
             // Retry
-            warn!("read_reg {:02X}: checksum error: {:?}!={:?}, retrying", reg.address(), checksum_expected, checksum_in);
+            warn!(
+                "read_reg {:02X}: checksum error: {:?}!={:?}, retrying",
+                reg.address(),
+                checksum_expected,
+                checksum_in
+            );
         }
         Ok(reg_data)
     }
 
-    fn write_reg<R: regs::Register>(&mut self, reg: &R, reg_data: &mut R::Data) -> Result<(), SPI::Error> {
+    fn write_reg<R: regs::Register>(
+        &mut self,
+        reg: &R,
+        reg_data: &mut R::Data,
+    ) -> Result<(), SPI::Error> {
         loop {
             let address = reg.address();
             let mut checksum = Checksum::new(match self.checksum_mode {
@@ -190,7 +199,7 @@ impl<SPI: Transfer<u8, Error = E>, NSS: OutputPin, E: fmt::Debug> Adc<SPI, NSS>
                 ChecksumMode::Crc => ChecksumMode::Crc,
             });
             checksum.feed(&[address]);
-            checksum.feed(&reg_data);
+            checksum.feed(reg_data);
             let checksum_out = checksum.result();
 
             let mut data = reg_data.clone();
@@ -201,7 +210,10 @@ impl<SPI: Transfer<u8, Error = E>, NSS: OutputPin, E: fmt::Debug> Adc<SPI, NSS>
             if *readback_data == **reg_data {
                 return Ok(());
             }
-            warn!("write_reg {:02X}: readback error, {:?}!={:?}, retrying", address, &*readback_data, &**reg_data);
+            warn!(
+                "write_reg {:02X}: readback error, {:?}!={:?}, retrying",
+                address, &*readback_data, &**reg_data
+            );
         }
     }
 
@@ -225,7 +237,12 @@ impl<SPI: Transfer<u8, Error = E>, NSS: OutputPin, E: fmt::Debug> Adc<SPI, NSS>
         Ok(())
     }
 
-    fn transfer<'w>(&mut self, addr: u8, reg_data: &'w mut [u8], checksum: Option<u8>) -> Result<Option<u8>, SPI::Error> {
+    fn transfer(
+        &mut self,
+        addr: u8,
+        reg_data: &mut [u8],
+        checksum: Option<u8>,
+    ) -> Result<Option<u8>, SPI::Error> {
         let mut addr_buf = [addr];
 
         let _ = self.nss.set_low();
@@ -234,8 +251,7 @@ impl<SPI: Transfer<u8, Error = E>, NSS: OutputPin, E: fmt::Debug> Adc<SPI, NSS>
             Err(e) => Err(e),
         };
         let result = match (result, checksum) {
-            (Ok(_), None) =>
-                Ok(None),
+            (Ok(_), None) => Ok(None),
             (Ok(_), Some(checksum_out)) => {
                 let mut checksum_buf = [checksum_out; 1];
                 match self.spi.transfer(&mut checksum_buf) {
@@ -243,8 +259,7 @@ impl<SPI: Transfer<u8, Error = E>, NSS: OutputPin, E: fmt::Debug> Adc<SPI, NSS>
                     Err(e) => Err(e),
                 }
             }
-            (Err(e), _) =>
-                Err(e),
+            (Err(e), _) => Err(e),
         };
         let _ = self.nss.set_high();
 
@@ -268,9 +283,13 @@ impl ChannelCalibration {
         };
         let data = data / (self.gain as f64 / (0x40_0000 as f64));
         let data = data + (self.offset as i32 - 0x80_0000) as f64;
-        let data = data / (2 << 23) as f64;
+        let data = data / (1 << 23) as f64;
 
-        const V_REF: f64 = 3.3;
-        ElectricPotential::new::<volt>(data * V_REF / 0.75)
+        const V_REF: ElectricPotential = ElectricPotential {
+            dimension: PhantomData,
+            units: PhantomData,
+            value: 3.3,
+        };
+        data * V_REF / 0.75
     }
 }

src/ad7172/checksum.rs

@@ -29,13 +29,13 @@ impl Checksum {
 
     fn feed_byte(&mut self, input: u8) {
         match self.mode {
-            ChecksumMode::Off => {},
+            ChecksumMode::Off => {}
             ChecksumMode::Xor => self.state ^= input,
             ChecksumMode::Crc => {
                 for i in 0..8 {
                     let input_mask = 0x80 >> i;
-                    self.state = (self.state << 1) ^
-                        if ((self.state & 0x80) != 0) != ((input & input_mask) != 0) {
+                    self.state = (self.state << 1)
+                        ^ if ((self.state & 0x80) != 0) != ((input & input_mask) != 0) {
                             0x07 /* x8 + x2 + x + 1 */
                         } else {
                             0
@@ -54,7 +54,7 @@ impl Checksum {
     pub fn result(&self) -> Option<u8> {
         match self.mode {
             ChecksumMode::Off => None,
-            _ => Some(self.state)
+            _ => Some(self.state),
         }
     }
 }

src/ad7172/mod.rs

@@ -1,13 +1,10 @@
 use core::fmt;
 use num_traits::float::Float;
-use serde::{Serialize, Deserialize};
-use stm32f4xx_hal::{
-    time::MegaHertz,
-    spi,
-};
+use serde::{Deserialize, Serialize};
+use stm32f4xx_hal::{spi, time::MegaHertz};
 
-pub mod regs;
 mod checksum;
+pub mod regs;
 pub use checksum::ChecksumMode;
 mod adc;
 pub use adc::*;
@@ -22,7 +19,6 @@ pub const SPI_CLOCK: MegaHertz = MegaHertz(2);
 
 pub const MAX_VALUE: u32 = 0xFF_FFFF;
 
-
 #[derive(Clone, Copy, Debug)]
 #[repr(u8)]
 pub enum Mode {
@@ -105,7 +101,8 @@ impl fmt::Display for Input {
             RefPos => "ref+",
             RefNeg => "ref-",
             _ => "<INVALID>",
-        }.fmt(fmt)
+        }
+        .fmt(fmt)
     }
 }
 
@@ -124,9 +121,9 @@ pub enum RefSource {
 impl From<u8> for RefSource {
     fn from(x: u8) -> Self {
         match x {
-            0 => RefSource::External,
-            1 => RefSource::Internal,
-            2 => RefSource::Avdd1MinusAvss,
+            0b00 => RefSource::External,
+            0b10 => RefSource::Internal,
+            0b11 => RefSource::Avdd1MinusAvss,
             _ => RefSource::Invalid,
         }
     }
@@ -141,28 +138,42 @@ impl fmt::Display for RefSource {
             Internal => "internal",
             Avdd1MinusAvss => "avdd1-avss",
             _ => "<INVALID>",
-        }.fmt(fmt)
+        }
+        .fmt(fmt)
     }
 }
 
 #[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]
 #[repr(u8)]
+/// Simultaneous Rejection of 50 Hz +/- 1 Hz and 60 Hz +/- 1 Hz
 pub enum PostFilter {
-    /// 27 SPS, 47 dB rejection, 36.7 ms settling
+    /// Output Data Rate: 27.27 SPS,
+    /// Settling Time: 36.67 ms,
+    /// Rejection: 47 dB
     F27SPS = 0b010,
-    /// 21.25 SPS, 62 dB rejection, 40 ms settling
-    F21SPS = 0b011,
-    /// 20 SPS, 86 dB rejection, 50 ms settling
+
+    /// Output Data Rate: 25 SPS,
+    /// Settling Time: 40.0 ms,
+    /// Rejection: 62 dB
+    F25SPS = 0b011,
+
+    /// Output Data Rate: 20 SPS,
+    /// Settling Time: 50.0 ms,
+    /// Rejection: 85 dB
     F20SPS = 0b101,
-    /// 16.67 SPS, 92 dB rejection, 60 ms settling
+
+    /// Output Data Rate: 16.667 SPS,
+    /// Settling Time: 60.0 ms,
+    /// Rejection: 90 dB
     F16SPS = 0b110,
+
     Invalid = 0b111,
 }
 
 impl PostFilter {
     pub const VALID_VALUES: &'static [Self] = &[
         PostFilter::F27SPS,
-        PostFilter::F21SPS,
+        PostFilter::F25SPS,
         PostFilter::F20SPS,
         PostFilter::F16SPS,
     ];
@@ -184,10 +195,10 @@ impl PostFilter {
     /// Samples per Second