forked from M-Labs/thermostat
482 lines
20 KiB
Python
482 lines
20 KiB
Python
from PyQt6 import QtWidgets, QtGui
|
|
from PyQt6.QtCore import pyqtSignal, QObject, QSignalBlocker, pyqtSlot
|
|
from pyqtgraph.parametertree import Parameter, ParameterTree, ParameterItem, registerParameterType
|
|
import pyqtgraph as pg
|
|
from pglive.sources.data_connector import DataConnector
|
|
from pglive.kwargs import Axis
|
|
from pglive.sources.live_plot import LiveLinePlot
|
|
from pglive.sources.live_plot_widget import LivePlotWidget
|
|
from pglive.sources.live_axis import LiveAxis
|
|
import sys
|
|
import argparse
|
|
import logging
|
|
import asyncio
|
|
from pytec.aioclient import Client
|
|
import qasync
|
|
from qasync import asyncSlot, asyncClose
|
|
|
|
# pyuic6 -x tec_qt.ui -o ui_tec_qt.py
|
|
from ui_tec_qt import Ui_MainWindow
|
|
|
|
|
|
class CommandsParameter(Parameter):
|
|
pass
|
|
|
|
|
|
THERMOSTAT_PARAMETERS = [[
|
|
{'name': 'Constant Current', 'type': 'float', 'value': 0, 'step': 0.1, 'limits': (-3, 3), 'siPrefix': True,
|
|
'suffix': 'A', 'commands': [f'pwm {ch} i_set {{value}}']},
|
|
{'name': 'Temperature PID', 'type': 'bool', 'value': False, 'commands': [f'pwm {ch} pid'], 'payload': ch,
|
|
'children': [
|
|
{'name': 'Set Temperature', 'type': 'float', 'value': 25, 'step': 0.1, 'limits': (-273, 300), 'siPrefix': True,
|
|
'suffix': '°C', 'commands': [f'pid {ch} target {{value}}'], 'payload': ch},
|
|
]},
|
|
{'name': 'Output Config', 'expanded': False, 'type': 'group', 'children': [
|
|
{'name': 'Max Current', 'type': 'float', 'value': 0, 'step': 0.1, 'limits': (0, 3), 'siPrefix': True,
|
|
'suffix': 'A', 'commands': [f'pwm {ch} max_i_pos {{value}}', f'pwm {ch} max_i_neg {{value}}',
|
|
f'pid {ch} output_min -{{value}}', f'pid {ch} output_max {{value}}']},
|
|
{'name': 'Max Voltage', 'type': 'float', 'value': 0, 'step': 0.1, 'limits': (0, 5), 'siPrefix': True,
|
|
'suffix': 'V', 'commands': [f'pwm {ch} max_v {{value}}']},
|
|
]},
|
|
{'name': 'Thermistor Config', 'expanded': False, 'type': 'group', 'children': [
|
|
{'name': 'T₀', 'type': 'float', 'value': 25, 'step': 0.1, 'limits': (-100, 100), 'siPrefix': True,
|
|
'suffix': '°C', 'commands': [f's-h {ch} t0 {{value}}']},
|
|
{'name': 'R₀', 'type': 'float', 'value': 10000, 'step': 1, 'siPrefix': True, 'suffix': 'Ω',
|
|
'commands': [f's-h {ch} r0 {{value}}']},
|
|
{'name': 'β', 'type': 'float', 'value': 3950, 'step': 1, 'suffix': 'K', 'commands': [f's-h {ch} b {{value}}']},
|
|
]},
|
|
{'name': 'Postfilter Config', 'expanded': False, 'type': 'group', 'children': [
|
|
{'name': 'Rate', 'type': 'float', 'value': 16.67, 'step': 0.01, 'suffix': 'Hz',
|
|
'commands': [f'postfilter {ch} rate {{value}}']},
|
|
]},
|
|
{'name': 'PID Config', 'expanded': False, 'type': 'group', 'children': [
|
|
{'name': 'Kp', 'type': 'float', 'value': 0, 'step': 0.1, 'suffix': '°C/A', 'commands': [f'pid {ch} kp {{value}}']},
|
|
{'name': 'Ki', 'type': 'float', 'value': 0, 'step': 0.1, 'suffix': '°C/C', 'commands': [f'pid {ch} ki {{value}}']},
|
|
{'name': 'Kd', 'type': 'float', 'value': 0, 'step': 0.1, 'suffix': '°Cs²/C', 'commands': [f'pid {ch} kd {{value}}']},
|
|
{'name': 'PID Auto Tune', 'expanded': False, 'type': 'group', 'children': [
|
|
{'name': 'Target Temperature', 'type': 'float', 'value': 20, 'step': 0.1, 'siPrefix': True, 'suffix': '°C'},
|
|
{'name': 'Test Current', 'type': 'float', 'value': 1, 'step': 0.1, 'siPrefix': True, 'suffix': 'A'},
|
|
{'name': 'Temperature Swing', 'type': 'float', 'value': 1.5, 'step': 0.1, 'siPrefix': True, 'prefix': '±', 'suffix': '°C'},
|
|
{'name': 'Run', 'type': 'action', 'tip': 'Run'},
|
|
]},
|
|
]},
|
|
{'name': 'Save to flash', 'type': 'action', 'tip': 'Save config to flash', 'commands': [f'save {ch}']}
|
|
] for ch in range(2)]
|
|
|
|
|
|
params = [
|
|
CommandsParameter.create(name='Thermostat Params 0', type='group', children=THERMOSTAT_PARAMETERS[0]),
|
|
CommandsParameter.create(name='Thermostat Params 1', type='group', children=THERMOSTAT_PARAMETERS[1]),
|
|
]
|
|
|
|
|
|
def get_argparser():
|
|
parser = argparse.ArgumentParser(description="ARTIQ master")
|
|
|
|
parser.add_argument("--connect", default=None, action="store_true",
|
|
help="Automatically connect to the specified Thermostat in IP:port format")
|
|
parser.add_argument('IP', metavar="ip", default=None, nargs='?')
|
|
parser.add_argument('PORT', metavar="port", default=None, nargs='?')
|
|
parser.add_argument("-l", "--log", dest="logLevel", choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'],
|
|
help="Set the logging level")
|
|
|
|
return parser
|
|
|
|
|
|
class ClientWatcher(QObject):
|
|
fan_update = pyqtSignal(dict)
|
|
pwm_update = pyqtSignal(list)
|
|
report_update = pyqtSignal(list)
|
|
pid_update = pyqtSignal(list)
|
|
thermistor_update = pyqtSignal(list)
|
|
postfilter_update = pyqtSignal(list)
|
|
|
|
def __init__(self, parent, client, update_s):
|
|
self.update_s = update_s
|
|
self.client = client
|
|
self.watch_task = None
|
|
self.poll_for_report = True
|
|
super().__init__(parent)
|
|
|
|
async def run(self):
|
|
loop = asyncio.get_running_loop()
|
|
while True:
|
|
time = loop.time()
|
|
await self.update_params()
|
|
await asyncio.sleep(self.update_s - (loop.time() - time))
|
|
|
|
async def update_params(self):
|
|
self.fan_update.emit(await self.client.fan())
|
|
self.pwm_update.emit(await self.client.get_pwm())
|
|
if self.poll_for_report:
|
|
self.report_update.emit(await self.client._command("report"))
|
|
self.pid_update.emit(await self.client.get_pid())
|
|
self.thermistor_update.emit(await self.client.get_steinhart_hart())
|
|
self.postfilter_update.emit(await self.client.get_postfilter())
|
|
|
|
def start_watching(self):
|
|
self.watch_task = asyncio.create_task(self.run())
|
|
|
|
def is_watching(self):
|
|
return self.watch_task is not None
|
|
|
|
@pyqtSlot()
|
|
def stop_watching(self):
|
|
if self.watch_task is not None:
|
|
self.watch_task.cancel()
|
|
self.watch_task = None
|
|
|
|
def set_report_polling(self, enabled: bool):
|
|
self.poll_for_report = enabled
|
|
|
|
@pyqtSlot(float)
|
|
def set_update_s(self, update_s):
|
|
self.update_s = update_s
|
|
|
|
|
|
class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow):
|
|
|
|
"""The maximum number of sample points to store."""
|
|
DEFAULT_MAX_SAMPLES = 1000
|
|
|
|
def __init__(self, args):
|
|
super().__init__()
|
|
|
|
self.setupUi(self)
|
|
|
|
self.max_samples = self.DEFAULT_MAX_SAMPLES
|
|
|
|
self._set_up_context_menu()
|
|
|
|
self.fan_power_slider.valueChanged.connect(self.fan_set)
|
|
self.fan_auto_box.stateChanged.connect(self.fan_auto_set)
|
|
|
|
self._set_param_tree()
|
|
|
|
self.ch0_t_plot = LiveLinePlot()
|
|
self.ch0_i_plot = LiveLinePlot()
|
|
self.ch1_t_plot = LiveLinePlot()
|
|
self.ch1_i_plot = LiveLinePlot()
|
|
|
|
self.ch0_t_line = self.ch0_t_graph.getPlotItem().addLine(label='{value} °C')
|
|
self.ch0_t_line.setVisible(False)
|
|
self.ch1_t_line = self.ch1_t_graph.getPlotItem().addLine(label='{value} °C')
|
|
self.ch1_t_line.setVisible(False)
|
|
|
|
self._set_up_graphs()
|
|
|
|
self.ch0_t_connector = DataConnector(self.ch0_t_plot, max_points=self.DEFAULT_MAX_SAMPLES)
|
|
self.ch0_i_connector = DataConnector(self.ch0_i_plot, max_points=self.DEFAULT_MAX_SAMPLES)
|
|
self.ch1_t_connector = DataConnector(self.ch1_t_plot, max_points=self.DEFAULT_MAX_SAMPLES)
|
|
self.ch1_i_connector = DataConnector(self.ch1_i_plot, max_points=self.DEFAULT_MAX_SAMPLES)
|
|
|
|
self.fan_pwm_recommended = False
|
|
|
|
self.tec_client = Client()
|
|
self.client_watcher = ClientWatcher(self, self.tec_client, self.report_refresh_spin.value())
|
|
self.client_watcher.fan_update.connect(self.fan_update)
|
|
self.client_watcher.report_update.connect(self.plot)
|
|
self.client_watcher.report_update.connect(self.update_report)
|
|
self.client_watcher.pid_update.connect(self.update_pid)
|
|
self.client_watcher.pwm_update.connect(self.update_pwm)
|
|
self.client_watcher.thermistor_update.connect(self.update_thermistor)
|
|
self.client_watcher.postfilter_update.connect(self.update_postfilter)
|
|
self.report_apply_btn.clicked.connect(
|
|
lambda: self.client_watcher.set_update_s(self.report_refresh_spin.value())
|
|
)
|
|
|
|
self.report_mode_task = None
|
|
|
|
if args.connect:
|
|
if args.IP:
|
|
self.ip_set_line.setText(args.IP)
|
|
if args.PORT:
|
|
self.port_set_spin.setValue(int(args.PORT))
|
|
self.connect_btn.click()
|
|
|
|
def _set_up_context_menu(self):
|
|
self.menu = QtWidgets.QMenu()
|
|
self.menu.setTitle('Thermostat settings')
|
|
|
|
port = QtWidgets.QWidgetAction(self.menu)
|
|
port.setDefaultWidget(self.port_set_spin)
|
|
self.menu.addAction(port)
|
|
self.menu.port = port
|
|
|
|
fan = QtWidgets.QWidgetAction(self.menu)
|
|
fan.setDefaultWidget(self.fan_group)
|
|
self.menu.addAction(fan)
|
|
self.menu.fan = fan
|
|
|
|
self.thermostat_settings.setMenu(self.menu)
|
|
|
|
clear = QtGui.QAction("Clear graphs", self.menu)
|
|
clear.triggered.connect(self.clear_graphs)
|
|
self.menu.addAction(clear)
|
|
self.menu.clear = clear
|
|
|
|
self.samples_spinbox = QtWidgets.QSpinBox()
|
|
self.samples_spinbox.setRange(2, 100000)
|
|
self.samples_spinbox.setSuffix(' samples')
|
|
self.samples_spinbox.setValue(self.max_samples)
|
|
self.samples_spinbox.valueChanged.connect(self.set_max_samples)
|
|
|
|
limit_samples = QtWidgets.QWidgetAction(self.menu)
|
|
limit_samples.setDefaultWidget(self.samples_spinbox)
|
|
self.menu.addAction(limit_samples)
|
|
self.menu.limit_samples = limit_samples
|
|
|
|
@pyqtSlot(int)
|
|
def set_max_samples(self, samples: int):
|
|
self.ch0_t_connector.max_points = samples
|
|
self.ch0_i_connector.max_points = samples
|
|
self.ch1_t_connector.max_points = samples
|
|
self.ch1_i_connector.max_points = samples
|
|
|
|
def _set_up_graphs(self):
|
|
for graph in self.ch0_t_graph, self.ch0_i_graph, self.ch1_t_graph, self.ch1_i_graph:
|
|
time_axis = LiveAxis('bottom', text="Time since Thermostat reset", **{Axis.TICK_FORMAT: Axis.DURATION})
|
|
time_axis.showLabel()
|
|
graph.setAxisItems({'bottom': time_axis})
|
|
|
|
graph.add_crosshair(pg.mkPen(color='red', width=1), {'color': 'green'})
|
|
|
|
for graph in self.ch0_t_graph, self.ch1_t_graph:
|
|
temperature_axis = LiveAxis('left', text="Temperature", units="°C")
|
|
temperature_axis.showLabel()
|
|
graph.setAxisItems({'left': temperature_axis})
|
|
|
|
for graph in self.ch0_i_graph, self.ch1_i_graph:
|
|
current_axis = LiveAxis('left', text="Current", units="A")
|
|
current_axis.showLabel()
|
|
graph.setAxisItems({'left': current_axis})
|
|
|
|
self.ch0_t_graph.addItem(self.ch0_t_plot)
|
|
self.ch0_i_graph.addItem(self.ch0_i_plot)
|
|
self.ch1_t_graph.addItem(self.ch1_t_plot)
|
|
self.ch1_i_graph.addItem(self.ch1_i_plot)
|
|
|
|
def clear_graphs(self):
|
|
for connector in self.ch0_t_connector, self.ch0_i_connector, self.ch1_t_connector, self.ch1_i_connector:
|
|
connector.clear()
|
|
|
|
async def _on_connection_changed(self, result):
|
|
self.graph_group.setEnabled(result)
|
|
self.fan_group.setEnabled(result)
|
|
self.report_group.setEnabled(result)
|
|
|
|
self.ip_set_line.setEnabled(not result)
|
|
self.port_set_spin.setEnabled(not result)
|
|
self.connect_btn.setText("Disconnect" if result else "Connect")
|
|
if result:
|
|
self.client_watcher.start_watching()
|
|
self._status(await self.tec_client.hw_rev())
|
|
self.fan_update(await self.tec_client.fan())
|
|
else:
|
|
self.status_lbl.setText("Disconnected")
|
|
self.fan_pwm_warning.setPixmap(QtGui.QPixmap())
|
|
self.fan_pwm_warning.setToolTip("")
|
|
self.clear_graphs()
|
|
self.report_box.setChecked(False)
|
|
await self.stop_report_mode()
|
|
self.client_watcher.stop_watching()
|
|
|
|
def _set_fan_pwm_warning(self):
|
|
if self.fan_power_slider.value() != 100:
|
|
pixmapi = getattr(QtWidgets.QStyle.StandardPixmap, "SP_MessageBoxWarning")
|
|
icon = self.style().standardIcon(pixmapi)
|
|
self.fan_pwm_warning.setPixmap(icon.pixmap(16, 16))
|
|
self.fan_pwm_warning.setToolTip("Throttling the fan (not recommended on this hardware rev)")
|
|
else:
|
|
self.fan_pwm_warning.setPixmap(QtGui.QPixmap())
|
|
self.fan_pwm_warning.setToolTip("")
|
|
|
|
def _status(self, hw_rev_d: dict):
|
|
logging.debug(hw_rev_d)
|
|
self.status_lbl.setText(f"Connected to Thermostat v{hw_rev_d['rev']['major']}.{hw_rev_d['rev']['minor']}")
|
|
self.fan_group.setEnabled(hw_rev_d["settings"]["fan_available"])
|
|
self.fan_pwm_recommended = hw_rev_d["settings"]["fan_pwm_recommended"]
|
|
|
|
@pyqtSlot(dict)
|
|
def fan_update(self, fan_settings: dict):
|
|
logging.debug(fan_settings)
|
|
if fan_settings is None:
|
|
return
|
|
with QSignalBlocker(self.fan_power_slider):
|
|
self.fan_power_slider.setValue(fan_settings["fan_pwm"] or 100) # 0 = PWM off = full strength
|
|
with QSignalBlocker(self.fan_auto_box):
|
|
self.fan_auto_box.setChecked(fan_settings["auto_mode"])
|
|
if not self.fan_pwm_recommended:
|
|
self._set_fan_pwm_warning()
|
|
|
|
@asyncSlot(int)
|
|
async def fan_set(self, value):
|
|
if not self.tec_client.is_connected():
|
|
return
|
|
if self.fan_auto_box.isChecked():
|
|
with QSignalBlocker(self.fan_auto_box):
|
|
self.fan_auto_box.setChecked(False)
|
|
await self.tec_client.set_param("fan", value)
|
|
if not self.fan_pwm_recommended:
|
|
self._set_fan_pwm_warning()
|
|
|
|
@asyncSlot(int)
|
|
async def fan_auto_set(self, enabled):
|
|
if not self.tec_client.is_connected():
|
|
return
|
|
if enabled:
|
|
await self.tec_client.set_param("fan", "auto")
|
|
self.fan_update(await self.tec_client.fan())
|
|
else:
|
|
await self.tec_client.set_param("fan", self.fan_power_slider.value())
|
|
|
|
@asyncSlot(int)
|
|
async def on_report_box_stateChanged(self, enabled):
|
|
self.client_watcher.set_report_polling(not enabled)
|
|
if enabled:
|
|
self.report_mode_task = asyncio.create_task(self.report_mode())
|
|
else:
|
|
self.tec_client.stop_report_mode()
|
|
await self.report_mode_task
|
|
self.report_mode_task = None
|
|
|
|
async def report_mode(self):
|
|
async for report in self.tec_client.report_mode():
|
|
self.client_watcher.report_update.emit(report)
|
|
|
|
async def stop_report_mode(self):
|
|
if self.report_mode_task is not None:
|
|
self.tec_client.stop_report_mode()
|
|
await self.report_mode_task
|
|
self.report_mode_task = None
|
|
|
|
@asyncClose
|
|
async def closeEvent(self, event):
|
|
await self.stop_report_mode()
|
|
self.client_watcher.stop_watching()
|
|
await self.tec_client.disconnect()
|
|
|
|
@asyncSlot()
|
|
async def on_connect_btn_clicked(self):
|
|
ip, port = self.ip_set_line.text(), self.port_set_spin.value()
|
|
try:
|
|
if not (self.tec_client.is_connecting() or self.tec_client.is_connected()):
|
|
self.status_lbl.setText("Connecting...")
|
|
self.connect_btn.setText("Stop")
|
|
self.ip_set_line.setEnabled(False)
|
|
self.port_set_spin.setEnabled(False)
|
|
|
|
connected = await self.tec_client.connect(host=ip, port=port, timeout=30)
|
|
if not connected:
|
|
return
|
|
await self._on_connection_changed(True)
|
|
else:
|
|
await self._on_connection_changed(False)
|
|
await self.tec_client.disconnect()
|
|
|
|
except (OSError, TimeoutError) as e:
|
|
logging.error(f"Failed communicating to {ip}:{port}: {e}")
|
|
await self._on_connection_changed(False)
|
|
await self.tec_client.disconnect()
|
|
|
|
@pyqtSlot(list)
|
|
def plot(self, report):
|
|
for channel in range(2):
|
|
temperature = report[channel]['temperature']
|
|
current = report[channel]['tec_i']
|
|
time = report[channel]['time']
|
|
|
|
if temperature is not None and current is not None:
|
|
getattr(self, f'ch{channel}_t_connector').cb_append_data_point(temperature, time)
|
|
getattr(self, f'ch{channel}_i_connector').cb_append_data_point(current, time)
|
|
|
|
@asyncSlot(object, object)
|
|
async def send_command(self, param, changes):
|
|
for param, change, data in changes:
|
|
if param.name() == 'Temperature PID' and not data:
|
|
ch = param.opts["payload"]
|
|
await self.tec_client.set_param('pwm', ch, 'i_set', params[ch].child('Constant Current').value())
|
|
line = getattr(self, f'ch{ch}_t_line')
|
|
line.setVisible(False)
|
|
elif param.opts.get("commands", None) is not None:
|
|
if param.name() == 'Temperature PID':
|
|
getattr(self, f'ch{param.opts["payload"]}_t_line').setVisible(True)
|
|
elif param.name() == 'Set Temperature':
|
|
getattr(self, f'ch{param.opts["payload"]}_t_line').setValue(data)
|
|
await asyncio.gather(*[self.tec_client._command(x.format(value=data)) for x in param.opts["commands"]])
|
|
|
|
def _set_param_tree(self):
|
|
for i, tree in enumerate((self.ch0_tree, self.ch1_tree)):
|
|
tree.setParameters(params[i], showTop=False)
|
|
params[i].sigTreeStateChanged.connect(self.send_command)
|
|
|
|
@pyqtSlot(list)
|
|
def update_pid(self, pid_settings):
|
|
for settings in pid_settings:
|
|
channel = settings["channel"]
|
|
with QSignalBlocker(params[channel]):
|
|
params[channel].child("PID Config", "Kp").setValue(settings["parameters"]["kp"])
|
|
params[channel].child("PID Config", "Ki").setValue(settings["parameters"]["ki"])
|
|
params[channel].child("PID Config", "Kd").setValue(settings["parameters"]["kd"])
|
|
if params[channel].child("Temperature PID").value():
|
|
params[channel].child("Temperature PID", "Set Temperature").setValue(settings["target"])
|
|
getattr(self, f'ch{channel}_t_line').setValue(settings["target"])
|
|
|
|
@pyqtSlot(list)
|
|
def update_report(self, report_data):
|
|
for settings in report_data:
|
|
channel = settings["channel"]
|
|
with QSignalBlocker(params[channel]):
|
|
params[channel].child("Temperature PID").setValue(settings["pid_engaged"])
|
|
getattr(self, f'ch{channel}_t_line').setVisible(settings["pid_engaged"])
|
|
if not settings["pid_engaged"]:
|
|
params[channel].child("Constant Current").setValue(settings["i_set"])
|
|
|
|
@pyqtSlot(list)
|
|
def update_thermistor(self, sh_data):
|
|
for sh_param in sh_data:
|
|
channel = sh_param["channel"]
|
|
with QSignalBlocker(params[channel]):
|
|
params[channel].child("Thermistor Config", "T₀").setValue(sh_param["params"]["t0"] - 273.15)
|
|
params[channel].child("Thermistor Config", "R₀").setValue(sh_param["params"]["r0"])
|
|
params[channel].child("Thermistor Config", "β").setValue(sh_param["params"]["b"])
|
|
|
|
@pyqtSlot(list)
|
|
def update_pwm(self, pwm_data):
|
|
for pwm_params in pwm_data:
|
|
channel = pwm_params["channel"]
|
|
with QSignalBlocker(params[channel]):
|
|
params[channel].child("Output Config", "Max Voltage").setValue(pwm_params["max_v"]["value"])
|
|
params[channel].child("Output Config", "Max Current").setValue(pwm_params["max_i_pos"]["value"])
|
|
|
|
@pyqtSlot(list)
|
|
def update_postfilter(self, postfilter_data):
|
|
for postfilter_params in postfilter_data:
|
|
channel = postfilter_params["channel"]
|
|
with QSignalBlocker(params[channel]):
|
|
params[channel].child("Postfilter Config", "Rate").setValue(postfilter_params["rate"])
|
|
|
|
|
|
async def coro_main():
|
|
args = get_argparser().parse_args()
|
|
if args.logLevel:
|
|
logging.basicConfig(level=getattr(logging, args.logLevel))
|
|
|
|
app_quit_event = asyncio.Event()
|
|
|
|
app = QtWidgets.QApplication.instance()
|
|
app.aboutToQuit.connect(app_quit_event.set)
|
|
|
|
main_window = MainWindow(args)
|
|
main_window.show()
|
|
|
|
await app_quit_event.wait()
|
|
|
|
|
|
def main():
|
|
qasync.run(coro_main())
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|