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

ctrl_panel: Add and improve tooltips and titles

Browse Source 
For users' better understanding of what the parameters do
This commit is contained in:
atse 2024-06-20 16:13:27 +08:00
parent 6a38f9b5a6
commit dafde57e23
2 changed files with 46 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -42,6 +42,13 @@ class MutexParameter(pTypes.ListParameter):
registerParameterType("mutex", MutexParameter) registerParameterType("mutex", MutexParameter)
def set_tree_label_tips(tree):
for item in tree.listAllItems():
p = item.param
if "tip" in p.opts:
item.setToolTip(0, p.opts["tip"])
class CtrlPanel(QObject): class CtrlPanel(QObject):
set_zero_limits_warning_sig = pyqtSignal(list) set_zero_limits_warning_sig = pyqtSignal(list)
@ -79,6 +86,8 @@ class CtrlPanel(QObject):
self.params[i].setValue = self._setValue self.params[i].setValue = self._setValue
self.params[i].sigTreeStateChanged.connect(sigTreeStateChanged_handle) self.params[i].sigTreeStateChanged.connect(sigTreeStateChanged_handle)
set_tree_label_tips(tree)
for handle in sigActivated_handles[i]: for handle in sigActivated_handles[i]:
self.params[i].child(*handle[0]).sigActivated.connect(handle[1]) self.params[i].child(*handle[0]).sigActivated.connect(handle[1])

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

@ -5,7 +5,8 @@
"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",
@ -13,13 +14,15 @@
"type": "float", "type": "float",
"suffix": "mA", "suffix": "mA",
"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",
@ -33,6 +36,7 @@
"topic": "pwm", "topic": "pwm",
"field": "pid" "field": "pid"
}, },
"tip": "Select control method of output",
"children": [ "children": [
{ {
"name": "i_set", "name": "i_set",
@ -51,11 +55,12 @@
"topic": "pwm", "topic": "pwm",
"field": "i_set" "field": "i_set"
}, },
"tip": "The set current through TEC",
"lock": false "lock": false
}, },
{ {
"name": "target", "name": "target",
"title": "Set Temperature", "title": "Setpoint",
"type": "float", "type": "float",
"value": 25, "value": 25,
"step": 0.1, "step": 0.1,
@ -68,6 +73,7 @@
"topic": "pid", "topic": "pid",
"field": "target" "field": "target"
}, },
"tip": "The temperature setpoint of the TEC",
"lock": false "lock": false
} }
] ]
@ -77,6 +83,7 @@
"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",
@ -94,6 +101,7 @@
"topic": "pwm", "topic": "pwm",
"field": "max_i_pos" "field": "max_i_pos"
}, },
"tip": "The maximum cooling (+ve) current through the output pins",
"lock": false "lock": false
}, },
{ {
@ -112,11 +120,12 @@
"topic": "pwm", "topic": "pwm",
"field": "max_i_neg" "field": "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",
"type": "float", "type": "float",
"value": 0, "value": 0,
"step": 0.1, "step": 0.1,
@ -130,6 +139,7 @@
"topic": "pwm", "topic": "pwm",
"field": "max_v" "field": "max_v"
}, },
"tip": "The maximum voltage (in both directions) across the output pins",
"lock": false "lock": false
} }
] ]
@ -141,7 +151,7 @@
"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",
@ -158,6 +168,7 @@
"topic": "s-h", "topic": "s-h",
"field": "t0" "field": "t0"
}, },
"tip": "The base temperature",
"lock": false "lock": false
}, },
{ {
@ -172,6 +183,7 @@
"topic": "s-h", "topic": "s-h",
"field": "r0" "field": "r0"
}, },
"tip": "The resistance of the thermistor at base temperature T₀",
"lock": false "lock": false
}, },
{ {
@ -186,6 +198,7 @@
"topic": "s-h", "topic": "s-h",
"field": "b" "field": "b"
}, },
"tip": "The Beta Parameter",
"lock": false "lock": false
}, },
{ {
@ -204,6 +217,7 @@
"21.25 Hz": 21.25, "21.25 Hz": 21.25,
"27 Hz": 27.0 "27 Hz": 27.0
}, },
"tip": "Adjust the output data rate of the enhanced 50 Hz & 60 Hz rejection filter\n(Helps avoid mains interference)",
"lock": false "lock": false
} }
] ]
@ -213,6 +227,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",
@ -224,6 +239,7 @@
"topic": "pid", "topic": "pid",
"field": "kp" "field": "kp"
}, },
"tip": "Proportional gain",
"lock": false "lock": false
}, },
{ {
@ -236,6 +252,7 @@
"topic": "pid", "topic": "pid",
"field": "ki" "field": "ki"
}, },
"tip": "Integral gain",
"lock": false "lock": false
}, },
{ {
@ -248,6 +265,7 @@
"topic": "pid", "topic": "pid",
"field": "kd" "field": "kd"
}, },
"tip": "Differential gain",
"lock": false "lock": false
}, },
{ {
@ -255,6 +273,7 @@
"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",
@ -271,6 +290,7 @@
"topic": "pid", "topic": "pid",
"field": "output_min" "field": "output_min"
}, },
"tip": "Minimum PID output",
"lock": false "lock": false
}, },
{ {
@ -288,6 +308,7 @@
"topic": "pid", "topic": "pid",
"field": "output_max" "field": "output_max"
}, },
"tip": "Maximum PID output",
"lock": false "lock": false
} }
] ]
@ -297,6 +318,7 @@
"title": "PID Auto Tune", "title": "PID Auto Tune",
"expanded": false, "expanded": false,
"type": "group", "type": "group",
"tip": "Automatically tune PID parameters",
"children": [ "children": [
{ {
"name": "target_temp", "name": "target_temp",
@ -305,7 +327,8 @@
"value": 20, "value": 20,
"step": 0.1, "step": 0.1,
"format": "{value:.4f} °C", "format": "{value:.4f} °C",
"pid_autotune": "target_temp" "pid_autotune": "target_temp",
"tip": "The target temperature to autotune for"
}, },
{ {
"name": "test_current", "name": "test_current",
@ -319,7 +342,8 @@
2000 2000
], ],
"suffix": "mA", "suffix": "mA",
"pid_autotune": "test_current" "pid_autotune": "test_current",
"tip": "The testing current when autotuning"
}, },
{ {
"name": "temp_swing", "name": "temp_swing",
@ -329,7 +353,8 @@
"step": 0.1, "step": 0.1,
"prefix": "±", "prefix": "±",
"format": "{value:.4f} °C", "format": "{value:.4f} °C",
"pid_autotune": "temp_swing" "pid_autotune": "temp_swing",
"tip": "The temperature swing around the target"
}, },
{ {
"name": "lookback", "name": "lookback",
@ -338,13 +363,14 @@
"value": 3.0, "value": 3.0,
"step": 0.1, "step": 0.1,
"format": "{value:.4f} s", "format": "{value:.4f} s",
"pid_autotune": "lookback" "pid_autotune": "lookback",
"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"
} }
] ]
} }
@ -360,7 +386,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"
} }
] ]
} }