atse/thermostat
1
0
Fork 0
forked from M-Labs/thermostat
Code Issues Pull Requests Activity

README: Document swap status in report

Browse Source
This commit is contained in:
atse 2024-09-23 17:12:34 +08:00
parent 2c6b8e8186
commit 0940520ded
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -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 continuous reporting with `report mode on`. Reports are JSON objects
with the following keys. with the following keys.
| Key | Unit | Description | | Key | Unit | Description |
| --- | :---: | --- | | --- | :---: | --- |
| `channel` | Integer | Channel `0`, or `1` | | `channel` | Integer | Channel `0`, or `1` |
| `time` | Seconds | Temperature measurement time | | `time` | Seconds | Temperature measurement time |
| `adc` | Volts | AD7172 input | | `adc` | Volts | AD7172 input |
| `sens` | Ohms | Thermistor resistance derived from `adc` | | `sens` | Ohms | Thermistor resistance derived from `adc` |
| `temperature` | Degrees Celsius | Steinhart-Hart conversion result derived from `sens` | | `temperature` | Degrees Celsius | Steinhart-Hart conversion result derived from `sens` |
| `pid_engaged` | Boolean | `true` if in closed-loop mode | | `pid_engaged` | Boolean | `true` if in closed-loop mode |
| `i_set` | Amperes | TEC output current | | `current_swapped` | Boolean | `true` if TEC current direction is swapped relative to front panel |
| `dac_value` | Volts | AD5680 output derived from `i_set` | | `i_set` | Amperes | TEC output current |
| `dac_feedback` | Volts | ADC measurement of the AD5680 output | | `dac_value` | Volts | AD5680 output derived from `i_set` |
| `i_tec` | Volts | MAX1968 TEC current monitor | | `dac_feedback` | Volts | ADC measurement of the AD5680 output |
| `tec_i` | Amperes | TEC output current feedback derived from `i_tec` | | `i_tec` | Volts | MAX1968 TEC current monitor |
| `tec_u_meas` | Volts | Measurement of the voltage across the TEC | | `tec_i` | Amperes | TEC output current feedback derived from `i_tec` |
| `pid_output` | Amperes | PID control output | | `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: 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].