forked from M-Labs/thermostat
Rename the Pytec library to PyThermostat
Pytec is a misnomer, as the Thermostat is not limited to just controlling TEC modules. The library also interfaces with and controls the Thermostat itself, and not the TEC module directly. See M-Labs/thermostat#149 (comment)
This commit is contained in:
parent
8dd58b364d
commit
6b8a5f5bb8
|
@ -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
|
To use the Python real-time plotting utility, run
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
python pytec/plot.py
|
python pythermostat/plot.py
|
||||||
```
|
```
|
||||||
|
|
||||||
![default view](./assets/default%20view.png)
|
![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
|
## 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
|
To run the auto tuning utility, run
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
python pytec/autotune.py
|
python pythermostat/autotune.py
|
||||||
```
|
```
|
||||||
|
|
||||||
After some time, the auto tuning utility will output the auto tuning results, below is a sample output
|
After some time, the auto tuning utility will output the auto tuning results, below is a sample output
|
||||||
|
|
|
@ -58,10 +58,10 @@
|
||||||
auditable = false;
|
auditable = false;
|
||||||
};
|
};
|
||||||
|
|
||||||
pytec = pkgs.python3Packages.buildPythonPackage {
|
pythermostat = pkgs.python3Packages.buildPythonPackage {
|
||||||
pname = "pytec";
|
pname = "pythermostat";
|
||||||
version = "0.0.0";
|
version = "0.0.0";
|
||||||
src = "${self}/pytec";
|
src = "${self}/pythermostat";
|
||||||
|
|
||||||
propagatedBuildInputs =
|
propagatedBuildInputs =
|
||||||
with pkgs.python3Packages; [
|
with pkgs.python3Packages; [
|
||||||
|
@ -72,7 +72,7 @@
|
||||||
in
|
in
|
||||||
{
|
{
|
||||||
packages.x86_64-linux = {
|
packages.x86_64-linux = {
|
||||||
inherit thermostat pytec;
|
inherit thermostat pythermostat;
|
||||||
default = thermostat;
|
default = thermostat;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
from setuptools import setup, find_packages
|
from setuptools import setup, find_packages
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name="pytec",
|
name="pythermostat",
|
||||||
version="0.0",
|
version="0.0",
|
||||||
author="M-Labs",
|
author="M-Labs",
|
||||||
url="https://git.m-labs.hk/M-Labs/thermostat",
|
url="https://git.m-labs.hk/M-Labs/thermostat",
|
Loading…
Reference in New Issue