Merge pull request #100 from mathoudebine/feature/52-openhardwaremonitorlibrehardwaremonitor-integration

LibreHardwareMonitor integration for Windows platform

Author: mathoudebine

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

@@ -34,6 +34,9 @@ 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

.gitignore

@@ -136,3 +136,6 @@ dmypy.json
 
 # Simulated display capture
 screencap.png
+tmp
+
+external/LibreHardwareMonitor/LibreHardwareMonitorLib.sys

config.yaml

@@ -2,35 +2,53 @@
 config:
   # Configuration values to set up basic communication
   # Set your COM port e.g. COM3 for Windows, /dev/ttyACM0 for Linux...
+  # Use AUTO for COM port auto-discovery (may not work on every setup)
   # COM_PORT: "/dev/ttyACM0"
   # COM_PORT: "COM3"
   COM_PORT: "AUTO"
 
   # Theme to use (located in res/themes)
-  # THEME: Terminal
-  # THEME: Landscape6Grid
-  # THEME: Cyberpunk
-  # THEME: bash-dark-green
+  # Available themes:
+  # - 3.5inchTheme2
+  # - Terminal
+  # - Landscape6Grid
+  # - Cyberpunk
+  # - bash-dark-green
   THEME: 3.5inchTheme2
 
-  # Network metrics
-  # Put the interface name or let it blank if the card does not exist
+  # 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
+  HW_SENSORS: AUTO
+
+  # Network interfaces
   # Linux/MacOS interfaces are named "eth0", "wlan0", "wlp1s0", "enp2s0"...
   # For Windows use the interfaces pretty name: "Ethernet 2", "Wi-Fi", ...
-  ETH: "eth0" # Ethernet Card
-  WLO: "wlan0" # Wi-Fi Card
+  # Leave the fields empty if the card does not exist on your setup
+  ETH: "" # Ethernet Card
+  WLO: "" # Wi-Fi Card
 
 display:
-  # Display resolution in portrait orientation
-  # Do not use this setting to rotate display! Display orientation is managed by themes
-  DISPLAY_WIDTH: 320
-  DISPLAY_HEIGHT: 480
+  # Display revision: A or B (for "flagship" version, use B) or SIMU for simulated LCD (image written in screencap.png)
+  # To identify your revision: https://github.com/mathoudebine/turing-smart-screen-python/wiki/Hardware-revisions
+  REVISION: A
 
   # Display Brightness
   # Set this as the desired %, 0 being completely dark and 100 being max brightness
-  # Warning: screen can get very hot at high brightness!
+  # Warning: revision A display can get hot at high brightness!
   BRIGHTNESS: 20
 
-  # Display revision: A or B (for "flagship" version, use B) or SIMU for simulated LCD (image written in screencap.png)
-  # To identify your revision: https://github.com/mathoudebine/turing-smart-screen-python/wiki/Hardware-revisions
-  REVISION: A
+  # Display reverse: true/false
+  # Set to true to reverse display orientation (landscape <-> reverse landscape, portrait <-> reverse portrait)
+  # Note: Display basic orientation (portrait or landscape) is defined by the theme you have selected
+  DISPLAY_REVERSE: false
+
+  # Display resolution in portrait orientation
+  # Do not use this setting to rotate display! Use DISPLAY_REVERSE
+  DISPLAY_WIDTH: 320  # Do not change unless you have a good reason
+  DISPLAY_HEIGHT: 480  # Do not change unless you have a good reason
+
+