From 3030c39076f84bb656b18766dd1070ba3687776e Mon Sep 17 00:00:00 2001 From: topquark12 Date: Thu, 7 Jan 2021 10:27:01 +0800 Subject: [PATCH] docs: update --- README.md | 4 ++++ documentation/Hardware setup.md | 3 +++ documentation/PID tuning.md | 4 ++++ 3 files changed, 11 insertions(+) create mode 100644 documentation/Hardware setup.md diff --git a/README.md b/README.md index ebc0c51..1d2ee71 100644 --- a/README.md +++ b/README.md @@ -252,3 +252,7 @@ with the following keys. | `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 | + +## PID Tuning + +The thermostat implements a PID control loop for each of the TEC channels, more details on setting up the PID control loop can be found [here](./documentation/PID%20tuning.md). diff --git a/documentation/Hardware setup.md b/documentation/Hardware setup.md new file mode 100644 index 0000000..278dc9a --- /dev/null +++ b/documentation/Hardware setup.md @@ -0,0 +1,3 @@ +# Hardware Setup + +## \ No newline at end of file diff --git a/documentation/PID tuning.md b/documentation/PID tuning.md index 922bdfb..5f02e05 100644 --- a/documentation/PID tuning.md +++ b/documentation/PID tuning.md @@ -1,5 +1,9 @@ # PID Tuning +## Note on hardware setup + +When using a TEC module with the Thermostat, the Thermostat expects the thermal load (where the thermistor is connected) to heat up when a positive current flow from the TEC + terminal, through the TEC, to the TEC - terminal, and vice versa. + ## Real time plot When tuning Thermostat PID parameters, it is helpful to view the temperature, PID output and other data in the form of a real time graph.