Merge pull request #146 from mathoudebine/feature/add-static-stub-data

Feature/add static stub data

Author: mathoudebine

.github/workflows/system-monitor-windows.yml

@@ -40,9 +40,6 @@ jobs:
         echo "Using theme ${{ matrix.theme }}"
         (Get-Content config.yaml) -replace "^  THEME.*$","  THEME: ${{ matrix.theme }}" | Set-Content  config.yaml
 
-        # For tests do not use LibreHardwareMonitor as it needs admin rights
-        (Get-Content config.yaml) -replace "^  HW_SENSORS.*$","  HW_SENSORS: PYTHON" | Set-Content  config.yaml
-
     - name: Run system monitor for 20 seconds
       run: |
         Start-Process -NoNewWindow python3 main.py -RedirectStandardOutput output.log -RedirectStandardError error.log

config.yaml

@@ -22,10 +22,10 @@ config:
 
   # Hardware sensors reading
   # Choose the appropriate method for reading your hardware sensors:
-  # - PYTHON  use Python libraries (psutils, GPUtil...) to read hardware sensors (supports all OS but not all HW)
-  # - LHM     use LibreHardwareMonitor library to read hardware sensors (Windows only - NEEDS ADMIN RIGHTS)
-  # - STUB    use fake random data instead of real hardware sensors
-  # - AUTO    use the best method based on your OS: Windows OS will use LHM, other OS will use Python libraries
+  # - PYTHON         use Python libraries (psutils, GPUtil...) to read hardware sensors (supports all OS but not all HW)
+  # - LHM            use LibreHardwareMonitor library to read hardware sensors (Windows only - NEEDS ADMIN RIGHTS)
+  # - STUB / STATIC  use random/static data instead of real hardware sensors
+  # - AUTO           use the best method based on your OS: Windows OS will use LHM, other OS will use Python libraries
   HW_SENSORS: AUTO
 
   # Network interfaces

library/sensors/sensors_librehardwaremonitor.py

@@ -124,9 +124,15 @@ def frequency() -> float:
             if sensor.SensorType == Hardware.SensorType.Clock:
                 # Keep only real core clocks, ignore effective core clocks
                 if "Core #" in str(sensor.Name) and "Effective" not in str(sensor.Name):
-                    frequencies.append(float(sensor.Value))
-        # Take mean of all core clock as "CPU clock"
-        return mean(frequencies)
+                    if sensor.Value:
+                        frequencies.append(float(sensor.Value))
+
+        if frequencies:
+            # Take mean of all core clock as "CPU clock" (as it is done in Windows Task Manager Performance tab)
+            return mean(frequencies)
+        else:
+            # Frequencies reading is not supported on this CPU
+            return math.nan
 
     @staticmethod
     def load() -> Tuple[float, float, float]:  # 1 / 5 / 15min avg:
@@ -201,8 +207,8 @@ def is_available() -> bool:
         found_nvidia = (get_hw_and_update(Hardware.HardwareType.GpuNvidia) is not None)
         found_intel = (get_hw_and_update(Hardware.HardwareType.GpuIntel) is not None)
 
-        if found_amd and (found_nvidia or found_intel) or (found_nvidia and found_intel):
-            logger.warning(
+        if (found_amd and (found_nvidia or found_intel)) or (found_nvidia and found_intel):
+            logger.info(
                 "Found multiple GPUs on your system. Will use dedicated GPU (AMD/Nvidia) for stats if possible.")
 
         return found_amd or found_nvidia or found_intel

library/sensors/sensors_stub.py renamed to library/sensors/sensors_stub_random.py

@@ -0,0 +1,96 @@
+# turing-smart-screen-python - a Python system monitor and library for 3.5" USB-C displays like Turing Smart Screen or XuanFang
+# https://github.com/mathoudebine/turing-smart-screen-python/
+
+# Copyright (C) 2021-2023  Matthieu Houdebine (mathoudebine)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# This file will use static data instead of real hardware sensors
+# Used for screenshots and tests
+# For all platforms (Linux, Windows, macOS)
+
+from typing import Tuple
+
+import library.sensors.sensors as sensors
+
+
+class Cpu(sensors.Cpu):
+    @staticmethod
+    def percentage(interval: float) -> float:
+        return 18.3
+
+    @staticmethod
+    def frequency() -> float:
+        return 2400.0
+
+    @staticmethod
+    def load() -> Tuple[float, float, float]:  # 1 / 5 / 15min avg:
+        return 25.0, 37.8, 75.6
+
+    @staticmethod
+    def is_temperature_available() -> bool:
+        return True
+
+    @staticmethod
+    def temperature() -> float:
+        return 68.9
+
+
+class Gpu(sensors.Gpu):
+    @staticmethod
+    def stats() -> Tuple[float, float, float, float]:  # load (%) / used mem (%) / used mem (Mb) / temp (°C)
+        return 75.8, 22.7, 1480, 52.3
+
+    @staticmethod
+    def is_available() -> bool:
+        return True
+
+
+class Memory(sensors.Memory):
+    @staticmethod
+    def swap_percent() -> float:
+        return 12.4
+
+    @staticmethod
+    def virtual_percent() -> float:
+        return 37.0
+
+    @staticmethod
+    def virtual_used() -> int:  # In bytes
+        return 5920000000
+
+    @staticmethod
+    def virtual_free() -> int:  # In bytes
+        return 10080000000
+
+
+class Disk(sensors.Disk):
+    @staticmethod
+    def disk_usage_percent() -> float:
+        return 59.0
+
+    @staticmethod
+    def disk_used() -> int:  # In bytes
+        return 1180000000000
+
+    @staticmethod
+    def disk_free() -> int:  # In bytes
+        return 820000000000
+
+
+class Net(sensors.Net):
+    @staticmethod
+    def stats(if_name, interval) -> Tuple[
+        int, int, int, int]:  # up rate (B/s), uploaded (B), dl rate (B/s), downloaded (B)
+        return 2000000, 4857000, 839000000, 5623000000

library/sensors/sensors_stub_static.py

@@ -50,7 +50,11 @@
         except:
             os._exit(0)
 elif HW_SENSORS == "STUB":
-    import library.sensors.sensors_stub as sensors
+    logger.warning("Stub sensors, not real HW sensors")
+    import library.sensors.sensors_stub_random as sensors
+elif HW_SENSORS == "STATIC":
+    logger.warning("Stub sensors, not real HW sensors")
+    import library.sensors.sensors_stub_static as sensors
 elif HW_SENSORS == "AUTO":
     if platform.system() == 'Windows':
         import library.sensors.sensors_librehardwaremonitor as sensors
@@ -119,7 +123,7 @@ def percentage():
     def frequency():
         if THEME_DATA['STATS']['CPU']['FREQUENCY']['TEXT'].get("SHOW", False):
 
-            cpu_freq = f'{int(sensors.Cpu.frequency()) / 1000:.2f}'
+            cpu_freq = f'{sensors.Cpu.frequency() / 1000:.2f}'
             if THEME_DATA['STATS']['CPU']['FREQUENCY']['TEXT'].get("SHOW_UNIT", True):
                 cpu_freq += " GHz"