From 0940520ded6cf03204b7e25b936f6019d67be91c Mon Sep 17 00:00:00 2001 From: atse Date: Mon, 23 Sep 2024 17:12:34 +0800 Subject: [PATCH] README: Document swap status in report --- README.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 10fd042..d184676 100644 --- a/README.md +++ b/README.md @@ -256,21 +256,22 @@ Use the bare `report` command to obtain a single report. Enable continuous reporting with `report mode on`. Reports are JSON objects with the following keys. -| Key | Unit | Description | -| --- | :---: | --- | -| `channel` | Integer | Channel `0`, or `1` | -| `time` | Seconds | Temperature measurement time | -| `adc` | Volts | AD7172 input | -| `sens` | Ohms | Thermistor resistance derived from `adc` | -| `temperature` | Degrees Celsius | Steinhart-Hart 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` | -| `dac_feedback` | Volts | ADC measurement of the AD5680 output | -| `i_tec` | Volts | MAX1968 TEC current monitor | -| `tec_i` | Amperes | TEC output current feedback derived from `i_tec` | -| `tec_u_meas` | Volts | Measurement of the voltage across the TEC | -| `pid_output` | Amperes | PID control output | +| Key | Unit | Description | +| --- | :---: | --- | +| `channel` | Integer | Channel `0`, or `1` | +| `time` | Seconds | Temperature measurement time | +| `adc` | Volts | AD7172 input | +| `sens` | Ohms | Thermistor resistance derived from `adc` | +| `temperature` | Degrees Celsius | Steinhart-Hart conversion result derived from `sens` | +| `pid_engaged` | Boolean | `true` if in closed-loop mode | +| `current_swapped` | Boolean | `true` if TEC current direction is swapped relative to front panel | +| `i_set` | Amperes | TEC output current | +| `dac_value` | Volts | AD5680 output derived from `i_set` | +| `dac_feedback` | Volts | ADC measurement of the AD5680 output | +| `i_tec` | Volts | MAX1968 TEC current monitor | +| `tec_i` | Amperes | TEC output current feedback derived from `i_tec` | +| `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].