LiquidGUI [1.3.0.0]

- Linux fixes.

.gitignore

@@ -3,3 +3,4 @@ dist
 build
 .venv
 LiquidGUI.spec
+.idea

.vscode/launch.json

@@ -4,9 +4,17 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
+        {
+            "name": "Python: LiquidCTL",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/main.pyw",
+            "console": "integratedTerminal",
+            "justMyCode": true
+        },
         {
             "name": "Python: Current File",
-            "type": "python",
+            "type": "debugpy",
             "request": "launch",
             "program": "${file}",
             "console": "integratedTerminal",

MessageHandler.py

@@ -0,0 +1,11 @@
+from PySide6.QtWidgets import QMessageBox
+
+@staticmethod
+class MessageHandler():
+    def ShowNoDevicesFoundError(self):
+        msg = QMessageBox()
+        msg.setWindowTitle("LiquidGUI Error")
+        msg.setText("No suitable devices could be detected. Please ensure you have a cooler \
+compatible with LiquidCTL, and connected to the system.")
+        msg.setIcon(QMessageBox.Icon.Warning)
+        msg.exec()

build.bat

@@ -1,4 +1,4 @@
 @echo off
 call .venv\Scripts\activate.bat
 pyside6-rcc.exe resources.qrc -o resources.py
-pyinstaller.exe main.pyw --onefile --paths .venv\Lib\site-packages --icon resources\LiquidGUI.ico --name LiquidGUI
+pyinstaller.exe main.pyw --onefile --paths .venv\Lib\site-packages --icon resources\LiquidGUI.ico --name LiquidGUI --version-file file_version_info.txt

build.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+pyside6-rcc resources.qrc -o resources.py
+pyinstaller main.pyw --onefile --icon resources/LiquidGUI.png --name LiquidGUI

common.py

@@ -0,0 +1,22 @@
+class MinMaxCurrent:
+    def __init__(self):
+        self.min = 0
+        self.max = 0
+        self.cur = 0
+
+    def builder(self, _cur: int, _unit: str):
+        self.cur = _cur
+
+        if 0 in [self.max, self.min]:
+            self.max = _cur
+            self.min = _cur
+
+        if self.cur > self.max:
+            self.max = _cur
+
+        if self.cur < self.min:
+            self.min = _cur
+
+        return (f"🟢 Current: {self.cur}{_unit}\n"
+                f"Min: {self.min}{_unit} / "
+                f"Max: {self.max}{_unit}")

file_version_info.txt

@@ -0,0 +1,44 @@
+# UTF-8
+#
+# For more details about fixed file info 'ffi' see:
+# http://msdn.microsoft.com/en-us/library/ms646997.aspx
+
+VSVersionInfo(
+  ffi=FixedFileInfo(
+    # filevers and prodvers should be always a tuple with four items: (1, 2, 3, 4)
+    # Set not needed items to zero 0. Must always contain 4 elements.
+    filevers=(1,1,3,0),
+    prodvers=(1,1,3,0),
+    # Contains a bitmask that specifies the valid bits 'flags'r
+    mask=0x3f,
+    # Contains a bitmask that specifies the Boolean attributes of the file.
+    flags=0x0,
+    # The operating system for which this file was designed.
+    # 0x4 - NT and there is no need to change it.
+    OS=0x40004,
+    # The general type of file.
+    # 0x1 - the file is an application.
+    fileType=0x1,
+    # The function of the file.
+    # 0x0 - the function is not defined for this fileType
+    subtype=0x0,
+    # Creation date and time stamp.
+    date=(0, 0)
+    ),
+  kids=[
+    StringFileInfo(
+      [
+      StringTable(
+        u'040904B0',
+        [StringStruct(u'CompanyName', u'Fil Sapia'),
+        StringStruct(u'FileDescription', u'LiquidGUI'),
+        StringStruct(u'FileVersion', u'1.1.3.0'),
+        StringStruct(u'InternalName', u'LiquidGUI'),
+        StringStruct(u'LegalCopyright', u'© Fil Sapia. All rights reserved.'),
+        StringStruct(u'OriginalFilename', u'LiquidGUI.exe'),
+        StringStruct(u'ProductName', u'LiquidGUI'),
+        StringStruct(u'ProductVersion', u'1.1.3.0')])
+      ]), 
+    VarFileInfo([VarStruct(u'Translation', [0, 1200, 1033, 1252])])
+  ]
+)

globals.py

@@ -0,0 +1,8 @@
+import platform
+
+os = None
+_platform = platform.platform()
+if _platform.startswith("Linux"):
+    os = "Linux"
+elif _platform.startswith("Windows"):
+    os = "Windows"

helpers/liquidctl_helper_linux.py

@@ -0,0 +1,33 @@
+from interfaces.liquidctl_helper_interface import LiquidCTL_Helper_Interface
+import subprocess
+import re
+
+class LiquidCTL_Helper(LiquidCTL_Helper_Interface):
+    device_name =       str()
+    device_temp =       0
+    device_fanSpeed =   0
+    device_pumpSpeed =  0
+    device_fwVers =     str()
+
+    devices = None
+
+    def ForceInit(self):
+        NotImplemented
+
+    def TestConnectionState(self):
+        output = subprocess.run(["liquidctl", "status"], stdout=subprocess.PIPE, universal_newlines=True)
+        if len(output.stdout) > 0:
+            return False
+        else:
+            return True
+
+    def Update(self):
+        output = subprocess.run(["liquidctl", "status"], stdout=subprocess.PIPE, universal_newlines=True)
+        self.device_name = str(re.search(r'^[^\n]*', output.stdout).group(0))
+        self.device_temp = float(re.search(r'Liquid temperature\s+(\d+\.?\d*)', output.stdout).group(1))
+        self.device_fanSpeed = int(re.search(r'Fan speed\s+(\d+)', output.stdout).group(1))
+        self.device_pumpSpeed = int(re.search(r'Pump speed\s+(\d+)', output.stdout).group(1))
+
+
+    def SetFanSpeed(self, speed):
+        NotImplemented

helpers/liquidctl_helper_windows.py

@@ -0,0 +1,50 @@
+from interfaces.liquidctl_helper_interface import LiquidCTL_Helper_Interface
+from liquidctl import find_liquidctl_devices, cli # type: ignore
+
+class LiquidCTL_Helper(LiquidCTL_Helper_Interface):
+    device_name =       str()
+    device_temp =       0
+    device_fanSpeed =   0
+    device_pumpSpeed =  0
+    device_fwVers =     str()
+
+    devices = find_liquidctl_devices()
+    try:
+        for dev in devices:
+            with dev.connect():
+                #print(f'{dev.description}')
+                device_name = dev.description
+                device_fwVers = ''.join(map(str, dev.firmware_version))
+    except:
+        pass
+
+    def ForceInit(self):
+        init_status = self.dev.initialize()
+        if init_status:
+            for key, value, unit in init_status:
+                #print(f'- {key}: {value} {unit}')
+                device_fwVers = value
+
+    def TestConnectionState(self):
+        if self.device_name != None:
+            return False
+        else:
+            return True
+
+    def Update(self):
+        with self.dev.connect():
+            status = self.dev.get_status()
+            for key, value, unit in status:
+                #print(f'- {key}: {value} {unit}')
+                if key == "Liquid temperature":
+                    self.device_temp = value
+                elif key == "Fan speed":
+                    self.device_fanSpeed = value
+                elif key == "Pump speed":
+                    self.device_pumpSpeed = value
+
+    def SetFanSpeed(self, speed):
+        with self.dev.connect():
+            cli._device_set_speed(self.dev, args={"<temperature>": [],
+                                                "<channel>": "fan",
+                                                "<percentage>": [str(speed)]})

helpers/vitals_helper.py

@@ -0,0 +1,28 @@
+from interfaces.vitals_helper_interface import VitalsHelperInterface
+from enum import Enum
+import psutil
+
+
+class VitalsHelperLinux(VitalsHelperInterface):
+    class HWSensor(Enum):
+        lin_cpu_amd = ("k10temp", "Tctl")
+        lin_gpu_amd = ("amdgpu", "edge")
+        lin_mobo_asus = ("asus_wmi_sensors", "Motherboard Temperature")
+
+    def get_temps(self, _hw_sensor: HWSensor):
+        temps = psutil.sensors_temperatures()
+
+        if _hw_sensor.value[0] in temps:
+            for entry in temps[_hw_sensor.value[0]]:
+                if entry.label == _hw_sensor.value[1]:
+                    return round(entry.current, 2)
+
+class VitalsHelperWindows(VitalsHelperInterface):
+    def __init__(self):
+        print(f"{self.__class__.__name__} is not Implemented")
+    
+    class HWSensor(Enum):
+        pass
+
+    def get_temps(self, _hw_sensor: HWSensor):
+        return 0

interfaces/liquidctl_helper_interface.py

@@ -0,0 +1,48 @@
+from abc import ABC, abstractmethod, abstractproperty
+
+class LiquidCTL_Helper_Interface(ABC):
+    @property
+    @abstractmethod
+    def device_name(self) -> str:
+        pass
+
+    @property
+    @abstractmethod
+    def device_temp(self) -> float:
+        pass
+
+    @property
+    @abstractmethod
+    def device_fanSpeed(self) -> float:
+        pass
+
+    @property
+    @abstractmethod
+    def device_pumpSpeed(self) -> float:
+        pass
+
+    @property
+    @abstractmethod
+    def device_fwVers(self) -> str:
+        pass
+
+    @property
+    @abstractmethod
+    def devices(self) -> None:
+        pass
+
+    @abstractmethod
+    def ForceInit(self) -> None:
+        pass
+
+    @abstractmethod
+    def TestConnectionState(self) -> None:
+        pass
+
+    @abstractmethod
+    def Update(self) -> None:
+        pass
+
+    @abstractmethod
+    def SetFanSpeed(self, speed) -> None:
+        pass

interfaces/vitals_helper_interface.py

@@ -0,0 +1,8 @@
+from abc import ABC, abstractmethod
+
+
+class VitalsHelperInterface(ABC):
+    @abstractmethod
+    def get_temps(self, HWSensor):
+        """ Return Temperatures """
+        pass

liquidctl_worker.py

@@ -1,32 +0,0 @@
-from liquidctl import find_liquidctl_devices
-
-class LiquidCTL_Init():
-    device_name =       None
-    device_temp =       0
-    device_fanSpeed =   0
-    device_pumpSpeed =  0
-    device_fwVers =     0
-
-    devices = find_liquidctl_devices()
-    for dev in devices:
-        with dev.connect():
-            #print(f'{dev.description}')
-            device_name = dev.description
-            init_status = dev.initialize()
-
-            if init_status:
-                for key, value, unit in init_status:
-                    #print(f'- {key}: {value} {unit}')
-                    device_fwVers = value
-
-    def Update(self):
-        with self.dev.connect():
-                status = self.dev.get_status()
-                for key, value, unit in status:
-                    #print(f'- {key}: {value} {unit}')
-                    if key == "Liquid temperature":
-                        self.device_temp = value
-                    elif key == "Fan speed":
-                        self.device_fanSpeed = value
-                    elif key == "Pump speed":
-                        self.device_pumpSpeed = value

main.pyw

@@ -1,83 +1,195 @@
+# External Dependencies v####################################
 import sys
-import qdarktheme
+from PySide6.QtWidgets import (QApplication,
-import win32mica
+                               QMainWindow,
-import liquidctl_worker
+                               QWidget,
+                               QVBoxLayout,
+                               QProgressBar,
+                               QPushButton)
+from PySide6.QtCore import (Qt,
+                            QTimer,
+                            QThreadPool)
+from PySide6.QtGui import QIcon
+## Internal Imports #########################################
 import resources
-from PySide6.QtWidgets import QApplication, QMainWindow, QWidget, QVBoxLayout, QLabel, QProgressBar, QGroupBox
+import common
-from PySide6.QtCore import Qt, QTimer, QThreadPool
+from MessageHandler import MessageHandler
-from PySide6.QtGui import QFont, QIcon
+## Platform Imports #########################################
+import globals
+from styles import Labels
+if globals.os == "Windows":
+    from helpers.liquidctl_helper_windows import LiquidCTL_Helper
+    from helpers.vitals_helper import VitalsHelperWindows as VitalsHelper
+    import win32mica # type: ignore
+    import darkdetect # type: ignore
+elif globals.os == "Linux":
+    from helpers.liquidctl_helper_linux import LiquidCTL_Helper
+    from helpers.vitals_helper import VitalsHelperLinux as VitalsHelper
+
 
 class MainWindow(QMainWindow):
-    def __init__(self):
+    """ Main application window. """
+
+    def __init__(self, lctl):
         super(MainWindow, self).__init__()
-        self.setWindowTitle("LiquidGUI (v.1.0.0.1)")
+        self.setWindowTitle("LiquidGUI (v.1.3.0.0) DEV")
-        self.setFixedSize(450, 300)
+        self.setFixedSize(450, 700)
-        self.setWindowFlags(Qt.WindowType.Dialog)
-        widget = QWidget(self)
 
-        font_style = QFont("Calibri", 16, weight=QFont.Weight.Bold)
+        self._lctl = lctl
+        self.__vitals_helper = VitalsHelper()
 
-        self.lbl_device_name = QLabel()
+        # Widgets ##########################################
-        self.lbl_device_name.setFont(font_style)
+        self.lbl_device_name = Labels.MainLabel()
-        self.lbl_temp = QLabel("Liquid Temperature:")
+
-        self.prg_temp = QProgressBar(format="%v°C",
+        self.lbl_cpu_temp = Labels.SubLabel(value="💻 CPU Temp:")
+        self.min_max_cur_cpu_temp = common.MinMaxCurrent()
+        self.prg_cpu_temp = QProgressBar(textVisible=False,
+                                         minimum=0,
+                                         maximum=105)
+        self.lbl_value_prg_cpu_temp = Labels.SubLabelValue()
+
+        self.lbl_temp = Labels.SubLabel(value="💧 Liquid Temperature:")
+        self.min_max_cur_temp = common.MinMaxCurrent()
+        self.prg_temp = QProgressBar(textVisible=False,
                                      minimum=0,
                                      maximum=50)
-        self.lbl_fanSpeed = QLabel("Fan Speed:")
+        self.lbl_value_prg_temp = Labels.SubLabelValue()
-        self.prg_fanSpeed = QProgressBar(format="%v rpm",
+
+        self.lbl_fanspeed = Labels.SubLabel(value="🍃 Fan Speed:")
+        self.min_max_cur_fanspeed = common.MinMaxCurrent()
+        self.prg_fanspeed = QProgressBar(textVisible=False,
                                          minimum=520,
                                          maximum=1700)
-        self.lbl_pumpSpeed = QLabel("Pump Speed:")
+        self.lbl_value_prg_fanspeed = Labels.SubLabelValue()
-        self.prg_pumpSpeed = QProgressBar(format="%v rpm",
+
+        self.lbl_pumpspeed = Labels.SubLabel(value="⛽ Pump Speed:")
+        self.min_max_cur_pumpspeed = common.MinMaxCurrent()
+        self.prg_pumpspeed = QProgressBar(textVisible=False,
                                           minimum=1900,
                                           maximum=2700)
-        self.lbl_fwVers = QLabel()
+        self.lbl_value_prg_pumpspeed = Labels.SubLabelValue()
 
+        self.btn_reset_min_max = QPushButton("Reset Min/Max")
+        self.btn_reset_min_max.clicked.connect(self.on_reset_min_max)
+
+        self.lbl_fwvers = Labels.SubLabelValue()
+
+        # Layout ##########################################
+        widget = QWidget(self)
         layout = QVBoxLayout(widget)
         layout.addWidget(self.lbl_device_name)
+        layout.addWidget(self.lbl_cpu_temp)
+        layout.addWidget(self.prg_cpu_temp)
+        layout.addWidget(self.lbl_value_prg_cpu_temp)
         layout.addWidget(self.lbl_temp)
         layout.addWidget(self.prg_temp)
-        layout.addWidget(self.lbl_fanSpeed)
+        layout.addWidget(self.lbl_value_prg_temp)
-        layout.addWidget(self.prg_fanSpeed)
+        layout.addWidget(self.lbl_fanspeed)
-        layout.addWidget(self.lbl_pumpSpeed)
+        layout.addWidget(self.prg_fanspeed)
-        layout.addWidget(self.prg_pumpSpeed)
+        layout.addWidget(self.lbl_value_prg_fanspeed)
-        layout.addWidget(self.lbl_fwVers)
+        layout.addWidget(self.lbl_pumpspeed)
+        layout.addWidget(self.prg_pumpspeed)
+        layout.addWidget(self.lbl_value_prg_pumpspeed)
+        layout.addWidget(self.lbl_fwvers)
+        layout.addWidget(self.btn_reset_min_max)
+
         layout.setSpacing(10)
 
         self.setLayout(layout)
         self.setCentralWidget(widget)
-        self.setContentsMargins(40, 20, 40, 20)
+        self.setContentsMargins(20, 20, 20, 20)
 
+        # Threading #######################################################################
         self.thread_manager = QThreadPool()
 
         self.timer = QTimer()
         self.timer.setInterval(1000)
-        self.timer.timeout.connect(lambda: self.thread_manager.start(lctl_worker.Update))
+        self.timer.timeout.connect(lambda: self.thread_manager.start(self._lctl.Update))
         self.timer.timeout.connect(self.update_widgets)
         self.timer.start()
 
+    def on_reset_min_max(self):
+        """ Pauses the timer and creates new instances of MinMaxCurrent """
+        self.timer.stop()
+        self.min_max_cur_temp = common.MinMaxCurrent()
+        self.min_max_cur_fanspeed = common.MinMaxCurrent()
+        self.min_max_cur_pumpspeed = common.MinMaxCurrent()
+        self.min_max_cur_cpu_temp = common.MinMaxCurrent()
+        self.timer.start()
 
     def update_widgets(self):
-        self.lbl_device_name.setText(lctl_worker.device_name)
+        """ Update widgets using LiquidCTL library."""
-        self.prg_temp.setValue(lctl_worker.device_temp)
-        self.prg_fanSpeed.setValue(lctl_worker.device_fanSpeed)
-        self.prg_pumpSpeed.setValue(lctl_worker.device_pumpSpeed)
-        if lctl_worker.device_fwVers != 0 or None:
-            self.lbl_fwVers.setText(f"Firmware: v{lctl_worker.device_fwVers}")
 
-app = QApplication(sys.argv)
+        # Platform Specific Widgets #######################################################
+        if globals.os == "Windows":
+            self.__vitals_helper()
+        elif globals.os == "Linux":
+            self.lbl_value_prg_cpu_temp.setText(
+                self.min_max_cur_cpu_temp.builder(
+                    self.__vitals_helper.get_temps(
+                        self.__vitals_helper.HWSensor.lin_cpu_amd), "°C"))
         
-icon = QIcon(":/icons/LiquidGUI.ico")
+            self.prg_cpu_temp.setValue(
-app.setWindowIcon(icon)
+                self.__vitals_helper.get_temps(
+                    self.__vitals_helper.HWSensor.lin_cpu_amd))
 
-lctl_worker = liquidctl_worker.LiquidCTL_Init()
+        # Cross Platform Widgets ##########################################################
+        self.lbl_device_name.setText(
+            self._lctl.device_name)
 
-window = MainWindow()
+        self.prg_temp.setValue(
-window.setWindowIcon(icon)
+            self._lctl.device_temp)
-window.setAttribute(Qt.WidgetAttribute.WA_TranslucentBackground)
 
-qdarktheme.setup_theme("dark", custom_colors={"background": "#00000000"})
+        self.lbl_value_prg_temp.setText(
-win32mica.ApplyMica(window.winId(), win32mica.MICAMODE.DARK)
+            self.min_max_cur_temp.builder(
+                self._lctl.device_temp, "°C"))
         
-window.show()
+        self.prg_fanspeed.setValue(
-app.exec()
+            self._lctl.device_fanSpeed)
+
+        self.lbl_value_prg_fanspeed.setText(
+            self.min_max_cur_fanspeed.builder(
+                self._lctl.device_fanSpeed, " rpm"))
+        
+        self.prg_pumpspeed.setValue(
+            self._lctl.device_pumpSpeed)
+
+        self.lbl_value_prg_pumpspeed.setText(
+            self.min_max_cur_pumpspeed.builder(
+                self._lctl.device_pumpSpeed, " rpm"))
+        
+        if len(self._lctl.device_fwVers) > 0:
+            self.lbl_fwvers.setText(f"Firmware: v{self._lctl.device_fwVers}")
+
+
+def main():
+    """ Initialize application and setup window parameters. """
+    app = QApplication(sys.argv)
+    window = MainWindow(LiquidCTL_Helper())
+
+    if globals.os == "Windows":
+        window.setAttribute(Qt.WidgetAttribute.WA_TranslucentBackground)
+        icon = QIcon(":/icons/LiquidGUI.ico")
+
+        if darkdetect.isDark():
+            win32mica.ApplyMica(window.winId(), win32mica.MicaTheme.DARK)
+        elif darkdetect.isLight():
+            win32mica.ApplyMica(window.winId(), win32mica.MicaTheme.LIGHT)
+
+    elif globals.os == "Linux":
+        app.setDesktopFileName("LiquidGUI")
+        icon = QIcon(":/icons/LiquidGUI.png")
+
+    app.setWindowIcon(icon)
+
+    # Show error and quit app if no devices are found
+    if window._lctl.TestConnectionState():
+        MessageHandler().ShowNoDevicesFoundError()
+        sys.exit(1)
+    else:
+        window.show()
+        app.exec()
+
+
+if __name__ == "__main__":
+    main()

metadata.yml

@@ -0,0 +1,12 @@
+Version: 1.1.0.1
+CompanyName: Fil Sapia
+FileDescription: LiquidGUI
+InternalName: LiquidGUI
+LegalCopyright: © Fil Sapia. All rights reserved.
+OriginalFilename: LiquidGUI.exe
+ProductName: LiquidGUI
+Translation:
+  - langID: 0
+    charsetID: 1200
+  - langID: 1033
+    charsetID: 1252

resources.qrc

@@ -2,5 +2,6 @@
 <RCC version="1.0">
     <qresource prefix="icons">
         <file alias="LiquidGUI.ico">resources/LiquidGUI.ico</file>
+        <file alias="LiquidGUI.png">resources/LiquidGUI.png</file>
     </qresource>
 </RCC>

setup.py

@@ -0,0 +1,12 @@
+from setuptools import setup
+
+setup(
+    name='LiquidGUI',
+    version='1.1.3.0',
+    packages=[''],
+    url='',
+    license='',
+    author='Fil Sapia',
+    author_email='filippo333@gmail.com',
+    description=''
+)

styles/Labels.py

@@ -0,0 +1,46 @@
+from PySide6.QtWidgets import QLabel
+from PySide6.QtGui import QFont
+from PySide6.QtCore import Qt
+import globals
+
+def _set_os_family_font(ClassName: str):
+    _font = None
+
+    if globals.os == "Linux":
+        if ClassName == MainLabel.__name__ or SubLabel.__name__:
+            _font = "Noto Sans"
+        elif ClassName == SubLabelValue.__name__:
+            _font = "Noto Sans Mono"
+    elif globals.os == "Windows":
+        if ClassName == MainLabel.__name__ or SubLabel.__name__:
+            _font = "Calibri"
+        elif ClassName == SubLabelValue.__name__:
+            _font = "Cascadia Code"
+
+    return _font
+
+
+class MainLabel(QLabel):
+    def __init__(self):
+        super().__init__()
+        self.setAlignment(Qt.AlignmentFlag.AlignCenter)
+        self.setFont(QFont(_set_os_family_font(__class__.__name__),
+                          16,
+                          weight=QFont.Weight.ExtraBold))
+        
+class SubLabel(QLabel):
+    """ Formatting for sub-labels. """
+
+    def __init__(self, value):
+        super().__init__()
+        self.setFont(QFont(_set_os_family_font(__class__.__name__),
+                           12,
+                           weight=QFont.Weight.Thin))
+        self.setText(value)
+
+class SubLabelValue(QLabel):
+    """ Formatting for values. """
+    def __init__(self):
+        super().__init__()
+        self.setAlignment(Qt.AlignmentFlag.AlignRight)
+        self.setFont(QFont(_set_os_family_font(__class__.__name__), 8))