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

Compare commits

base: linuswck:8ac4a32106d2c04984a3b4b8c08a1c1eabfb1cf6
Branches Tags
linuswck:master
linuswck:gui_dev-ctrl_panel
linuswck:gui_dev
linuswck:fix_incorrect_dac_cal
linuswck:fix_wrong_current_limit_duty_cycle_cal
linuswck:save_i_set_into_ch_cfg
linuswck:clamp_set_fns_to_design_spec
linuswck:pid_setpoint_kick_fix
linuswck:improve_adc_readings
linuswck:GUI
linuswck:softspi
M-Labs:master
M-Labs:dev-gui
M-Labs:GUI
M-Labs:softspi
..
compare: linuswck:e1fdc86e4093b5ea386bec991c4fa81c87b58a6a
Branches Tags
linuswck:gui_dev-ctrl_panel
linuswck:gui_dev
linuswck:fix_incorrect_dac_cal
linuswck:fix_wrong_current_limit_duty_cycle_cal
linuswck:save_i_set_into_ch_cfg
linuswck:clamp_set_fns_to_design_spec
linuswck:pid_setpoint_kick_fix
linuswck:improve_adc_readings
linuswck:master
linuswck:GUI
linuswck:softspi
M-Labs:master
M-Labs:dev-gui
M-Labs:GUI
M-Labs:softspi

10 Commits
8ac4a32106 ... e1fdc86e40

Author SHA1 Message Date
atse
e1fdc86e40 ctrl_panel: Keep i_set visible when PID engaged 
Since i_set is also plotted, we would also want to see its precise value
too.
 2024-07-19 14:50:11 +08:00
atse
89b908fab1 ctrl_panel: Remove MutexParameter 
Use the standard ListParamenter instead, and hook up UI changes
elsewhere.
 2024-07-19 14:50:11 +08:00
atse
a1c260d52e ctrl_panel: Limits fixes 
* PID Autotune test current should be positive

* Maximum absolute voltage should be 4 V not 5 V
 2024-07-19 14:50:06 +08:00
atse
d76e015893 ctrl_panel: Code cleanup 
* Remove unnecessary duplication of `THERMOSTAT_PARAMETERS`

* i -> ch

* Separate ParameterTree and Parameter initiation

* Remove extra "channel" option to root parameters, as the "value"
option is already the channel number
 2024-07-19 11:27:22 +08:00
atse
c4eb1a2eef ctrl_panel: PID Auto Tune -> PID Autotune 2024-07-19 11:12:54 +08:00
atse
39018d2360 ctrl_panel: Stop crushing spinboxes 
It might not be the case on some themes, but on the default Qt theme the
spinbox are a bit too short for the containing numbers. See
https://github.com/pyqtgraph/pyqtgraph/issues/701.
 2024-07-19 11:12:52 +08:00
atse
25c7a070d9 ctrl_panel: Approriate units for measured current 
Allow the readonly display of current to vary its SI prefix in the unit,
since as a display entry it won't have the unit adjustment problem.
 2024-07-19 11:12:40 +08:00
atse
8a4d861672 ctrl_panel: Pin down units for editable fields 
Avoids awkward value editing
 2024-07-19 11:12:38 +08:00
atse
b668c699fb ctrl_panel: Improve postfilter description 2024-07-19 11:11:59 +08:00
atse
eb3719044f ctrl_panel: Add tooltips 
For users' better understanding of what the parameters do
 2024-07-19 11:11:55 +08:00
3 changed files with 120 additions and 104 deletions
Show Stats Expand all files Collapse all files

76
pytec/pytec/gui/view/ctrl_panel.py
View File

@ -6,40 +6,11 @@ from pyqtgraph.parametertree import (
) )
class MutexParameter(pTypes.ListParameter): def set_tree_label_tips(tree):
""" for item in tree.listAllItems():
Mutually exclusive parameter where only one of its children is visible at a time, list selectable. p = item.param
if "tip" in p.opts:
The ordering of the list items determines which children will be visible. item.setToolTip(0, p.opts["tip"])
"""
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 CtrlPanel(QObject): class CtrlPanel(QObject):
@ -58,29 +29,40 @@ class CtrlPanel(QObject):
self.trees_ui = trees_ui self.trees_ui = trees_ui
self.NUM_CHANNELS = len(trees_ui) self.NUM_CHANNELS = len(trees_ui)
self.THERMOSTAT_PARAMETERS = [param_tree for i in range(self.NUM_CHANNELS)]
self.params = [ self.params = [
Parameter.create( Parameter.create(
name=f"Thermostat Channel {ch} Parameters", name=f"Thermostat Channel {ch} Parameters",
type="group", type="group",
value=ch, value=ch,
children=self.THERMOSTAT_PARAMETERS[ch], children=param_tree,
) )
for ch in range(self.NUM_CHANNELS) for ch in range(self.NUM_CHANNELS)
] ]
for i, param in enumerate(self.params): for ch, tree in enumerate(self.trees_ui):
param.channel = i
for i, tree in enumerate(self.trees_ui):
tree.setHeaderHidden(True) tree.setHeaderHidden(True)
tree.setParameters(self.params[i], showTop=False) tree.setParameters(self.params[ch], showTop=False)
self.params[i].setValue = self._setValue
self.params[i].sigTreeStateChanged.connect(sigTreeStateChanged_handle)
for handle in sigActivated_handles[i]: set_tree_label_tips(tree)
self.params[i].child(*handle[0]).sigActivated.connect(handle[1])
for ch, param in enumerate(self.params):
self.params[ch].setValue = self._setValue
param.sigTreeStateChanged.connect(sigTreeStateChanged_handle)
for handle in sigActivated_handles[ch]:
param.child(*handle[0]).sigActivated.connect(handle[1])
param.child("output", "control_method").sigValueChanged.connect(
lambda param, value: param.child("i_set").setWritable(
value == "constant_current"
)
)
param.child("output", "control_method").sigValueChanged.connect(
lambda param, value: param.child("target").show(
value == "temperature_pid"
)
)
def _setValue(self, value, blockSignal=None): def _setValue(self, value, blockSignal=None):
""" """
@ -152,7 +134,7 @@ class CtrlPanel(QObject):
) )
if settings["tec_i"] is not None: if settings["tec_i"] is not None:
self.params[channel].child("tec_i").setValue( self.params[channel].child("tec_i").setValue(
settings["tec_i"] * 1000 settings["tec_i"]
) )
@pyqtSlot("QVariantList") @pyqtSlot("QVariantList")

136
pytec/pytec/gui/view/param_tree.json
View File

@ -5,26 +5,30 @@
"title": "Temperature", "title": "Temperature",
"type": "float", "type": "float",
"format": "{value:.4f} °C", "format": "{value:.4f} °C",
"readonly": true "readonly": true,
"tip": "The measured temperature at the thermistor"
}, },
{ {
"name": "tec_i", "name": "tec_i",
"title": "Current through TEC", "title": "Current through TEC",
"type": "float", "type": "float",
"suffix": "mA", "siPrefix": true,
"suffix": "A",
"decimals": 6, "decimals": 6,
"readonly": true "readonly": true,
"tip": "The measured current through the TEC"
}, },
{ {
"name": "output", "name": "output",
"title": "Output Settings", "title": "Output Settings",
"expanded": true, "expanded": true,
"type": "group", "type": "group",
"tip": "Settings of the output to the TEC",
"children": [ "children": [
{ {
"name": "control_method", "name": "control_method",
"title": "Control Method", "title": "Control Method",
"type": "mutex", "type": "list",
"limits": { "limits": {
"Constant Current": "constant_current", "Constant Current": "constant_current",
"Temperature PID": "temperature_pid" "Temperature PID": "temperature_pid"
@ -37,10 +41,11 @@
"pid" "pid"
] ]
], ],
"tip": "Select control method of output",
"children": [ "children": [
{ {
"name": "i_set", "name": "i_set",
"title": "Set Current", "title": "Set Current (mA)",
"type": "float", "type": "float",
"value": 0, "value": 0,
"step": 100, "step": 100,
@ -50,30 +55,34 @@
], ],
"triggerOnShow": true, "triggerOnShow": true,
"decimals": 6, "decimals": 6,
"suffix": "mA", "compactHeight": false,
"param": [ "param": [
"pwm", "pwm",
"ch", "ch",
"i_set" "i_set"
], ],
"tip": "The set current through TEC",
"lock": false "lock": false
}, },
{ {
"name": "target", "name": "target",
"title": "Set Temperature", "title": "Setpoint (°C)",
"type": "float", "type": "float",
"visible": false,
"value": 25, "value": 25,
"step": 0.1, "step": 0.1,
"limits": [ "limits": [
-273, -273,
300 300
], ],
"format": "{value:.4f} °C", "format": "{value:.4f}",
"compactHeight": false,
"param": [ "param": [
"pid", "pid",
"ch", "ch",
"target" "target"
], ],
"tip": "The temperature setpoint of the TEC",
"lock": false "lock": false
} }
] ]
@ -83,62 +92,66 @@
"title": "Limits", "title": "Limits",
"expanded": true, "expanded": true,
"type": "group", "type": "group",
"tip": "The limits of output, with the polarity at the front panel as reference",
"children": [ "children": [
{ {
"name": "max_i_pos", "name": "max_i_pos",
"title": "Max Cooling Current", "title": "Max Cooling Current (mA)",
"type": "float", "type": "float",
"value": 0, "value": 0,
"step": 100, "step": 100,
"decimals": 6, "decimals": 6,
"compactHeight": false,
"limits": [ "limits": [
0, 0,
2000 2000
], ],
"suffix": "mA",
"param": [ "param": [
"pwm", "pwm",
"ch", "ch",
"max_i_pos" "max_i_pos"
], ],
"tip": "The maximum cooling (+ve) current through the output pins",
"lock": false "lock": false
}, },
{ {
"name": "max_i_neg", "name": "max_i_neg",
"title": "Max Heating Current", "title": "Max Heating Current (mA)",
"type": "float", "type": "float",
"value": 0, "value": 0,
"step": 100, "step": 100,
"decimals": 6, "decimals": 6,
"compactHeight": false,
"limits": [ "limits": [
0, 0,
2000 2000
], ],
"suffix": "mA",
"param": [ "param": [
"pwm", "pwm",
"ch", "ch",
"max_i_neg" "max_i_neg"
], ],
"tip": "The maximum heating (-ve) current through the output pins",
"lock": false "lock": false
}, },
{ {
"name": "max_v", "name": "max_v",
"title": "Max Voltage Difference", "title": "Max Absolute Voltage (V)",
"type": "float", "type": "float",
"value": 0, "value": 0,
"step": 0.1, "step": 0.1,
"limits": [ "limits": [
0, 0,
5 4
], ],
"siPrefix": true, "siPrefix": true,
"suffix": "V", "compactHeight": false,
"param": [ "param": [
"pwm", "pwm",
"ch", "ch",
"max_v" "max_v"
], ],
"tip": "The maximum voltage (in both directions) across the output pins",
"lock": false "lock": false
} }
] ]
@ -150,11 +163,11 @@
"title": "Thermistor Settings", "title": "Thermistor Settings",
"expanded": true, "expanded": true,
"type": "group", "type": "group",
"tip": "Settings of the connected Thermistor", "tip": "Settings of the connected thermistor\n- Parameters for the resistance to temperature conversion (with the B-Parameter equation)\n- Settings for the 50/60 Hz filter with the thermistor",
"children": [ "children": [
{ {
"name": "t0", "name": "t0",
"title": "T₀", "title": "T₀ (°C)",
"type": "float", "type": "float",
"value": 25, "value": 25,
"step": 0.1, "step": 0.1,
@ -162,47 +175,51 @@
-100, -100,
100 100
], ],
"format": "{value:.4f} °C", "format": "{value:.4f}",
"compactHeight": false,
"param": [ "param": [
"s-h", "s-h",
"ch", "ch",
"t0" "t0"
], ],
"tip": "The base temperature",
"lock": false "lock": false
}, },
{ {
"name": "r0", "name": "r0",
"title": "R₀", "title": "R₀ (Ω)",
"type": "float", "type": "float",
"value": 10000, "value": 10000,
"step": 1, "step": 1,
"siPrefix": true, "siPrefix": true,
"suffix": "Ω", "compactHeight": false,
"param": [ "param": [
"s-h", "s-h",
"ch", "ch",
"r0" "r0"
], ],
"tip": "The resistance of the thermistor at base temperature T₀",
"lock": false "lock": false
}, },
{ {
"name": "b", "name": "b",
"title": "B", "title": "B (K)",
"type": "float", "type": "float",
"value": 3950, "value": 3950,
"step": 1, "step": 1,
"suffix": "K",
"decimals": 4, "decimals": 4,
"compactHeight": false,
"param": [ "param": [
"s-h", "s-h",
"ch", "ch",
"b" "b"
], ],
"tip": "The Beta Parameter",
"lock": false "lock": false
}, },
{ {
"name": "rate", "name": "rate",
"title": "Postfilter Rate", "title": "50/60 Hz filter rejection",
"type": "list", "type": "list",
"value": 16.67, "value": 16.67,
"param": [ "param": [
@ -212,11 +229,12 @@
], ],
"limits": { "limits": {
"Off": null, "Off": null,
"16.67 Hz": 16.67, "47 dB @ 10.41 Hz": 27.0,
"20 Hz": 20.0, "62 dB @ 9.1 Hz": 21.25,
"21.25 Hz": 21.25, "86 dB @ 10 Hz": 20.0,
"27 Hz": 27.0 "92 dB @ 8.4 Hz": 16.67
}, },
"tip": "Trade off effective sampling rate and rejection of (50±1) Hz and (60±1) Hz",
"lock": false "lock": false
} }
] ]
@ -226,6 +244,7 @@
"title": "PID Settings", "title": "PID Settings",
"expanded": true, "expanded": true,
"type": "group", "type": "group",
"tip": "Settings of PID parameters and clamping",
"children": [ "children": [
{ {
"name": "kp", "name": "kp",
@ -233,37 +252,41 @@
"type": "float", "type": "float",
"step": 0.1, "step": 0.1,
"suffix": "", "suffix": "",
"compactHeight": false,
"param": [ "param": [
"pid", "pid",
"ch", "ch",
"kp" "kp"
], ],
"tip": "Proportional gain",
"lock": false "lock": false
}, },
{ {
"name": "ki", "name": "ki",
"title": "Ki", "title": "Ki (Hz)",
"type": "float", "type": "float",
"step": 0.1, "step": 0.1,
"suffix": "Hz", "compactHeight": false,
"param": [ "param": [
"pid", "pid",
"ch", "ch",
"ki" "ki"
], ],
"tip": "Integral gain",
"lock": false "lock": false
}, },
{ {
"name": "kd", "name": "kd",
"title": "Kd", "title": "Kd (s)",
"type": "float", "type": "float",
"step": 0.1, "step": 0.1,
"suffix": "s", "compactHeight": false,
"param": [ "param": [
"pid", "pid",
"ch", "ch",
"kd" "kd"
], ],
"tip": "Differential gain",
"lock": false "lock": false
}, },
{ {
@ -271,10 +294,11 @@
"title": "PID Output Clamping", "title": "PID Output Clamping",
"expanded": true, "expanded": true,
"type": "group", "type": "group",
"tip": "Clamps PID outputs to specified range\nCould be different than output limits",
"children": [ "children": [
{ {
"name": "output_min", "name": "output_min",
"title": "Minimum", "title": "Minimum (mA)",
"type": "float", "type": "float",
"step": 100, "step": 100,
"limits": [ "limits": [
@ -282,17 +306,18 @@
2000 2000
], ],
"decimals": 6, "decimals": 6,
"suffix": "mA", "compactHeight": false,
"param": [ "param": [
"pid", "pid",
"ch", "ch",
"output_min" "output_min"
], ],
"tip": "Minimum PID output",
"lock": false "lock": false
}, },
{ {
"name": "output_max", "name": "output_max",
"title": "Maximum", "title": "Maximum (mA)",
"type": "float", "type": "float",
"step": 100, "step": 100,
"limits": [ "limits": [
@ -300,81 +325,90 @@
2000 2000
], ],
"decimals": 6, "decimals": 6,
"suffix": "mA", "compactHeight": false,
"param": [ "param": [
"pid", "pid",
"ch", "ch",
"output_max" "output_max"
], ],
"tip": "Maximum PID output",
"lock": false "lock": false
} }
] ]
}, },
{ {
"name": "pid_autotune", "name": "pid_autotune",
"title": "PID Auto Tune", "title": "PID Autotune",
"expanded": false, "expanded": false,
"type": "group", "type": "group",
"tip": "Automatically tune PID parameters",
"children": [ "children": [
{ {
"name": "target_temp", "name": "target_temp",
"title": "Target Temperature", "title": "Target Temperature (°C)",
"type": "float", "type": "float",
"value": 20, "value": 20,
"step": 0.1, "step": 0.1,
"format": "{value:.4f} °C", "format": "{value:.4f}",
"compactHeight": false,
"pid_autotune": [ "pid_autotune": [
"target_temp", "target_temp",
"ch" "ch"
] ],
"tip": "The target temperature to autotune for"
}, },
{ {
"name": "test_current", "name": "test_current",
"title": "Test Current", "title": "Test Current (mA)",
"type": "float", "type": "float",
"value": 0, "value": 0,
"decimals": 6, "decimals": 6,
"compactHeight": false,
"step": 100, "step": 100,
"limits": [ "limits": [
-2000, 0,
2000 2000
], ],
"suffix": "mA",
"pid_autotune": [ "pid_autotune": [
"test_current", "test_current",
"ch" "ch"
] ],
"tip": "The testing current when autotuning"
}, },
{ {
"name": "temp_swing", "name": "temp_swing",
"title": "Temperature Swing", "title": "Temperature Swing (°C)",
"type": "float", "type": "float",
"value": 1.5, "value": 1.5,
"step": 0.1, "step": 0.1,
"prefix": "±", "prefix": "±",
"format": "{value:.4f} °C", "format": "{value:.4f}",
"compactHeight": false,
"pid_autotune": [ "pid_autotune": [
"temp_swing", "temp_swing",
"ch" "ch"
] ],
"tip": "The temperature swing around the target"
}, },
{ {
"name": "lookback", "name": "lookback",
"title": "Lookback", "title": "Lookback (s)",
"type": "float", "type": "float",
"value": 3.0, "value": 3.0,
"step": 0.1, "step": 0.1,
"format": "{value:.4f} s", "format": "{value:.4f}",
"compactHeight": false,
"pid_autotune": [ "pid_autotune": [
"lookback", "lookback",
"ch" "ch"
] ],
"tip": "Amount of time referenced for tuning"
}, },
{ {
"name": "run_pid", "name": "run_pid",
"title": "Run", "title": "Run",
"type": "action", "type": "action",
"tip": "Run" "tip": "Run PID Autotune with above settings"
} }
] ]
} }
@ -390,7 +424,7 @@
"name": "load", "name": "load",
"title": "Load from flash", "title": "Load from flash",
"type": "action", "type": "action",
"tip": "Load settings from flash" "tip": "Load settings from thermostat"
} }
] ]
} }

12
pytec/tec_qt.py
View File

@ -82,7 +82,7 @@ class MainWindow(QtWidgets.QMainWindow):
[["load"], partial(self.thermostat.load_cfg, ch)], [["load"], partial(self.thermostat.load_cfg, ch)],
[ [
["pid", "pid_autotune", "run_pid"], ["pid", "pid_autotune", "run_pid"],
partial(self.pid_auto_tune_request, ch), partial(self.pid_autotune_request, ch),
], ],
] ]
for ch in range(self.NUM_CHANNELS) for ch in range(self.NUM_CHANNELS)
@ -262,12 +262,12 @@ class MainWindow(QtWidgets.QMainWindow):
@asyncSlot(object, object) @asyncSlot(object, object)
async def send_command(self, param, changes): async def send_command(self, param, changes):
"""Translates parameter tree changes into thermostat set_param calls""" """Translates parameter tree changes into thermostat set_param calls"""
ch = param.channel ch = param.value()
for inner_param, change, data in changes: for inner_param, change, data in changes:
if change == "value": if change == "value":
if inner_param.opts.get("param", None) is not None: if inner_param.opts.get("param", None) is not None:
if inner_param.opts.get("suffix", None) == "mA": if inner_param.opts.get("title", None).endswith(" (mA)"):
data /= 1000 # Given in mA data /= 1000 # Given in mA
thermostat_param = inner_param.opts["param"] thermostat_param = inner_param.opts["param"]
@ -283,10 +283,10 @@ class MainWindow(QtWidgets.QMainWindow):
param.child(*param.childPath(inner_param)).setOpts(lock=False) param.child(*param.childPath(inner_param)).setOpts(lock=False)
if inner_param.opts.get("pid_autotune", None) is not None: if inner_param.opts.get("pid_autotune", None) is not None:
auto_tuner_param = inner_param.opts["pid_autotune"][0] autotuner_param = inner_param.opts["pid_autotune"][0]
if inner_param.opts["pid_autotune"][1] != "ch": if inner_param.opts["pid_autotune"][1] != "ch":
ch = inner_param.opts["pid_autotune"][1] ch = inner_param.opts["pid_autotune"][1]
self.autotuners.set_params(auto_tuner_param, ch, data) self.autotuners.set_params(autotuner_param, ch, data)
if inner_param.opts.get("activaters", None) is not None: if inner_param.opts.get("activaters", None) is not None:
activater = inner_param.opts["activaters"][ activater = inner_param.opts["activaters"][
@ -298,7 +298,7 @@ class MainWindow(QtWidgets.QMainWindow):
await self.client.set_param(*activater) await self.client.set_param(*activater)
@asyncSlot() @asyncSlot()
async def pid_auto_tune_request(self, ch=0): async def pid_autotune_request(self, ch=0):
match self.autotuners.get_state(ch): match self.autotuners.get_state(ch):
case PIDAutotuneState.STATE_OFF | PIDAutotuneState.STATE_FAILED: case PIDAutotuneState.STATE_OFF | PIDAutotuneState.STATE_FAILED:
self.autotuners.load_params_and_set_ready(ch) self.autotuners.load_params_and_set_ready(ch)