Merge pull request #112 from mathoudebine/feature/111-add-a-tray-icon

Feature/111 add a tray icon

Author: mathoudebine

config.yaml

@@ -47,7 +47,7 @@ display:
   DISPLAY_REVERSE: false
 
   # Display resolution in portrait orientation
-  # Do not use this setting to rotate display! Use DISPLAY_REVERSE
+  # Do not use this setting to rotate display! The selected theme handles landscape/portrait orientation
   DISPLAY_WIDTH: 320  # Do not change unless you have a good reason
   DISPLAY_HEIGHT: 480  # Do not change unless you have a good reason
 

library/stats.py

@@ -19,7 +19,14 @@
 if HW_SENSORS == "PYTHON":
     import library.sensors.sensors_python as sensors
 elif HW_SENSORS == "LHM":
-    import library.sensors.sensors_librehardwaremonitor as sensors
+    if platform.system() == 'Windows':
+        import library.sensors.sensors_librehardwaremonitor as sensors
+    else:
+        logger.error("LibreHardwareMonitor integration is only available on Windows")
+        try:
+            sys.exit(0)
+        except:
+            os._exit(0)
 elif HW_SENSORS == "STUB":
     import library.sensors.sensors_stub as sensors
 elif HW_SENSORS == "AUTO":

main.py

@@ -3,6 +3,7 @@
 # https://github.com/mathoudebine/turing-smart-screen-python
 import locale
 import os
+import platform
 import signal
 import sys
 import time
@@ -15,6 +16,13 @@
     except:
         os._exit(0)
 
+from PIL import Image
+
+try:
+    import pystray
+except:
+    pass
+
 from library.log import logger
 import library.scheduler as scheduler
 from library.display import display
@@ -24,9 +32,8 @@
     # Apply system locale to this program
     locale.setlocale(locale.LC_ALL, '')
 
-    def sighandler(signum, frame):
-        logger.info(" Caught signal %d, exiting" % signum)
 
+    def clean_stop(tray_icon=None):
         # Do not stop the program now in case data transmission was in progress
         # Instead, ask the scheduler to empty the action queue before stopping
         scheduler.STOPPING = True
@@ -41,13 +48,47 @@ def sighandler(signum, frame):
 
         logger.debug("(%.1fs)" % (5 - wait_time))
 
+        # Remove tray icon just before exit
+        if tray_icon:
+            tray_icon.visible = False
+
         # We force the exit to avoid waiting for other scheduled tasks: they may have a long delay!
         try:
             sys.exit(0)
         except:
             os._exit(0)
 
 
+    def sighandler(signum, frame=None):
+        logger.info("Caught signal %d, exiting" % signum)
+        clean_stop()
+
+
+    def on_exit_tray(tray_icon, item):
+        logger.info("Exit from tray icon")
+        clean_stop(tray_icon)
+
+
+    # Create a tray icon for the program, with an Exit entry in menu
+    try:
+        tray_icon = pystray.Icon(
+            name='Turing System Monitor',
+            title='Turing System Monitor',
+            icon=Image.open("res/icons/monitor-icon-17865/64.png"),
+            menu=pystray.Menu(
+                pystray.MenuItem(
+                    'Exit',
+                    on_exit_tray))
+        )
+
+        # For platforms != macOS, display the tray icon now with non-blocking function
+        if platform.system() != "Darwin":
+            tray_icon.run_detached()
+            logger.info("Tray icon has been displayed")
+    except:
+        tray_icon = None
+        logger.warning("Tray icon is not supported on your platform")
+
     # Set the signal handlers, to send a complete frame to the LCD before exit
     signal.signal(signal.SIGINT, sighandler)
     signal.signal(signal.SIGTERM, sighandler)
@@ -81,3 +122,7 @@ def sighandler(signum, frame):
     scheduler.NetStats()
     scheduler.DateStats()
     scheduler.QueueHandler()
+
+    if tray_icon and platform.system() == "Darwin":
+        # For macOS: display the tray icon now with blocking function
+        tray_icon.run()

requirements.txt

@@ -4,6 +4,7 @@ pyserial~=3.5     # Serial linl to communicate with the display
 PyYAML~=6.0       # For themes files
 psutil~=5.9.4     # CPU / disk / network metrics
 GPUtil~=1.4.0     # Nvidia GPU
+pystray~=0.19.4   # Tray icon (all OS)
 
 # Following packages are for AMD GPU on Linux
 # Note: you may need to manually install Cython first

res/icons/monitor-icon-17865/128.png

@@ -0,0 +1,5 @@
+Icon by <a href="https://freeicons.io/profile/730">Anu Rocks</a> on <a href="https://freeicons.io">freeicons.io</a>
+
+https://freeicons.io/regular-life-icons/monitor-icon-17865
+
+This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution 3.0 Unported License</a>.