Merge pull request #149 from mathoudebine/feature/theme-editor

Theme Editor with preview window

Author: mathoudebine

.github/workflows/themes-screenshot.yml

@@ -0,0 +1,62 @@
+name: System monitor - themes screenshot
+
+on:
+  push:
+    branches:
+      - main
+      - 'releases/**'
+  pull_request:
+
+jobs:
+  system-monitor-theme-screenshot:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -r requirements.txt
+
+    - name: Configure system monitor for screenshot
+      run: |
+        # For tests there is no real HW: use simulated LCD mode
+        sed -i "/REVISION:/c\  REVISION: SIMU" config.yaml
+        
+        # Use static data
+        sed -i "/HW_SENSORS:/c\  HW_SENSORS: STATIC" config.yaml
+
+    - name: Run system monitor for 5 seconds on all themes
+      run: |
+        for dir in res/themes/*/
+        do
+          # Keep only folder name
+          theme=`basename ${dir%*/}`
+        
+          # Setup selected theme in config.yaml
+          echo "Using theme $theme"
+          sed -i "/THEME:/c\  THEME: $theme" config.yaml
+  
+          # Run system-monitor for 5 seconds
+          python3 main.py > output.log 2>&1 &
+          sleep 5
+          killall -9 python3
+        
+          # Rename screen capture
+          cp screencap.png screenshot-$theme.png
+        done
+
+    - name: Archive screenshots
+      uses: actions/upload-artifact@v3
+      with:
+        name: themes-screenshots
+        path: screenshot-*.png

README.md

@@ -49,15 +49,15 @@ Some themes are already included for a quick start!
 * Display configuration using `config.yaml` file: no Python code to edit.
 * Support for all [3.5" smart screen models (Turing and XuanFang)](https://github.com/mathoudebine/turing-smart-screen-python/wiki/Hardware-revisions). Backplate RGB LEDs are also supported for available models!
 * Support [multiple hardware sensors and metrics (CPU/GPU usage, temperatures, memory, disks, etc)](https://github.com/mathoudebine/turing-smart-screen-python/wiki/System-monitor-:-themes#stats-entry) with configurable refresh intervals.
-* Allow [creation of themes (see `res/themes`) with `theme.yaml` files](https://github.com/mathoudebine/turing-smart-screen-python/wiki/System-monitor-:-themes) to be [shared with the community!](https://github.com/mathoudebine/turing-smart-screen-python/discussions/categories/themes)
+* Allow [creation of themes (see `res/themes`) with `theme.yaml` files using theme editor](https://github.com/mathoudebine/turing-smart-screen-python/wiki/System-monitor-:-themes) to be [shared with the community!](https://github.com/mathoudebine/turing-smart-screen-python/discussions/categories/themes)
 * Easy to expand: additional code that pulls specific information can be written in a modular way without impacting existing code.
 * Auto detect comm port. No longer need to hard set it, or if it changes on you then the config is wrong.
 * Tray icon with Exit option, useful when the program is running in background
 
 Screenshots from the latest version using included themes (click on the thumbnails to see a bigger preview):  
 <img src="res/docs/Theme3.5Inch.jpg" height="300" /> <img src="res/docs/ThemeTerminal.jpg" height="300" /> <img src="res/docs/ThemeCyberpunk.png" height="300" /> <img src="res/docs/ThemeBashDarkGreenGpu.png" height="300" /> <img src="res/docs/ThemeLandscape6Grid.jpg" width="300" /> <img src="res/docs/ThemeLandscapeMagicBlue.png" width="300" />
 
-### [> Themes creation/edition](https://github.com/mathoudebine/turing-smart-screen-python/wiki/System-monitor-:-themes)
+### [> Themes creation/edition (using theme editor)](https://github.com/mathoudebine/turing-smart-screen-python/wiki/System-monitor-:-themes)
 ### [> Themes shared by the community](https://github.com/mathoudebine/turing-smart-screen-python/discussions/categories/themes)
 
 ## Control the display from your Python projects

library/config.py

@@ -36,29 +36,37 @@ def load_yaml(configfile):
 PATH = sys.path[0]
 CONFIG_DATA = load_yaml("config.yaml")
 THEME_DEFAULT = load_yaml("res/themes/default.yaml")
+THEME_DATA = None
 
-try:
-    theme_path = "res/themes/" + CONFIG_DATA['config']['THEME'] + "/"
-    logger.info("Loading theme %s from %s" % (CONFIG_DATA['config']['THEME'], theme_path + "theme.yaml"))
-    THEME_DATA = load_yaml(theme_path + "theme.yaml")
-    THEME_DATA['PATH'] = theme_path
-except:
-    logger.error("Theme not found or contains errors!")
-    try:
-        sys.exit(0)
-    except:
-        os._exit(0)
 
 def copy_default(default, theme):
-    "recursively supply default values into a dict of dicts of dicts ...."
-    for k,v in default.items():
+    """recursively supply default values into a dict of dicts of dicts ...."""
+    for k, v in default.items():
         if k not in theme:
             theme[k] = v
         if type(v) == type({}):
             copy_default(default[k], theme[k])
 
 
-copy_default(THEME_DEFAULT, THEME_DATA)
+def load_theme():
+    global THEME_DATA
+    try:
+        theme_path = "res/themes/" + CONFIG_DATA['config']['THEME'] + "/"
+        logger.info("Loading theme %s from %s" % (CONFIG_DATA['config']['THEME'], theme_path + "theme.yaml"))
+        THEME_DATA = load_yaml(theme_path + "theme.yaml")
+        THEME_DATA['PATH'] = theme_path
+    except:
+        logger.error("Theme not found or contains errors!")
+        try:
+            sys.exit(0)
+        except:
+            os._exit(0)
+
+    copy_default(THEME_DEFAULT, THEME_DATA)
+
+
+# Load theme on import
+load_theme()
 
 # Queue containing the serial requests to send to the screen
 update_queue = queue.Queue()

library/display.py

@@ -23,9 +23,6 @@
 from library.lcd.lcd_simulated import LcdSimulated
 from library.log import logger
 
-THEME_DATA = config.THEME_DATA
-CONFIG_DATA = config.CONFIG_DATA
-
 
 def _get_full_path(path, name):
     if name:
@@ -35,47 +32,48 @@ def _get_full_path(path, name):
 
 
 def _get_theme_orientation() -> Orientation:
-    if THEME_DATA["display"]["DISPLAY_ORIENTATION"] == 'portrait':
-        if CONFIG_DATA["display"].get("DISPLAY_REVERSE", False):
+    if config.THEME_DATA["display"]["DISPLAY_ORIENTATION"] == 'portrait':
+        if config.CONFIG_DATA["display"].get("DISPLAY_REVERSE", False):
             return Orientation.REVERSE_PORTRAIT
         else:
             return Orientation.PORTRAIT
-    elif THEME_DATA["display"]["DISPLAY_ORIENTATION"] == 'landscape':
-        if CONFIG_DATA["display"].get("DISPLAY_REVERSE", False):
+    elif config.THEME_DATA["display"]["DISPLAY_ORIENTATION"] == 'landscape':
+        if config.CONFIG_DATA["display"].get("DISPLAY_REVERSE", False):
             return Orientation.REVERSE_LANDSCAPE
         else:
             return Orientation.LANDSCAPE
-    elif THEME_DATA["display"]["DISPLAY_ORIENTATION"] == 'reverse_portrait':
+    elif config.THEME_DATA["display"]["DISPLAY_ORIENTATION"] == 'reverse_portrait':
         logger.warn("'reverse_portrait' is deprecated as DISPLAY_ORIENTATION value in the theme."
                     "Use 'portrait' instead, and use DISPLAY_REVERSE in config.yaml to reverse orientation.")
         return Orientation.REVERSE_PORTRAIT
-    elif THEME_DATA["display"]["DISPLAY_ORIENTATION"] == 'reverse_landscape':
+    elif config.THEME_DATA["display"]["DISPLAY_ORIENTATION"] == 'reverse_landscape':
         logger.warn("'reverse_landscape' is deprecated as DISPLAY_ORIENTATION value in the theme."
                     "Use 'landscape' instead, and use DISPLAY_REVERSE in config.yaml to reverse orientation.")
         return Orientation.REVERSE_LANDSCAPE
     else:
-        logger.warning("Orientation '", THEME_DATA["display"]["DISPLAY_ORIENTATION"], "' unknown, using portrait")
+        logger.warning("Orientation '", config.THEME_DATA["display"]["DISPLAY_ORIENTATION"],
+                       "' unknown, using portrait")
         return Orientation.PORTRAIT
 
 
 class Display:
     def __init__(self):
         self.lcd = None
-        if CONFIG_DATA["display"]["REVISION"] == "A":
-            self.lcd = LcdCommRevA(com_port=CONFIG_DATA['config']['COM_PORT'],
-                                   display_width=CONFIG_DATA["display"]["DISPLAY_WIDTH"],
-                                   display_height=CONFIG_DATA["display"]["DISPLAY_HEIGHT"],
+        if config.CONFIG_DATA["display"]["REVISION"] == "A":
+            self.lcd = LcdCommRevA(com_port=config.CONFIG_DATA['config']['COM_PORT'],
+                                   display_width=config.CONFIG_DATA["display"]["DISPLAY_WIDTH"],
+                                   display_height=config.CONFIG_DATA["display"]["DISPLAY_HEIGHT"],
                                    update_queue=config.update_queue)
-        elif CONFIG_DATA["display"]["REVISION"] == "B":
-            self.lcd = LcdCommRevB(com_port=CONFIG_DATA['config']['COM_PORT'],
-                                   display_width=CONFIG_DATA["display"]["DISPLAY_WIDTH"],
-                                   display_height=CONFIG_DATA["display"]["DISPLAY_HEIGHT"],
+        elif config.CONFIG_DATA["display"]["REVISION"] == "B":
+            self.lcd = LcdCommRevB(com_port=config.CONFIG_DATA['config']['COM_PORT'],
+                                   display_width=config.CONFIG_DATA["display"]["DISPLAY_WIDTH"],
+                                   display_height=config.CONFIG_DATA["display"]["DISPLAY_HEIGHT"],
                                    update_queue=config.update_queue)
-        elif CONFIG_DATA["display"]["REVISION"] == "SIMU":
-            self.lcd = LcdSimulated(display_width=CONFIG_DATA["display"]["DISPLAY_WIDTH"],
-                                    display_height=CONFIG_DATA["display"]["DISPLAY_HEIGHT"])
+        elif config.CONFIG_DATA["display"]["REVISION"] == "SIMU":
+            self.lcd = LcdSimulated(display_width=config.CONFIG_DATA["display"]["DISPLAY_WIDTH"],
+                                    display_height=config.CONFIG_DATA["display"]["DISPLAY_HEIGHT"])
         else:
-            logger.error("Unknown display revision '", CONFIG_DATA["display"]["REVISION"], "'")
+            logger.error("Unknown display revision '", config.CONFIG_DATA["display"]["REVISION"], "'")
 
     def initialize_display(self):
         # Reset screen in case it was in an unstable state (screen is also cleared)
@@ -88,40 +86,41 @@ def initialize_display(self):
         self.lcd.ScreenOn()
 
         # Set brightness
-        self.lcd.SetBrightness(CONFIG_DATA["display"]["BRIGHTNESS"])
+        self.lcd.SetBrightness(config.CONFIG_DATA["display"]["BRIGHTNESS"])
 
         # Set backplate RGB LED color (for supported HW only)
-        self.lcd.SetBackplateLedColor(THEME_DATA['display'].get("DISPLAY_RGB_LED", (255, 255, 255)))
+        self.lcd.SetBackplateLedColor(config.THEME_DATA['display'].get("DISPLAY_RGB_LED", (255, 255, 255)))
 
         # Set orientation
         self.lcd.SetOrientation(_get_theme_orientation())
 
     def display_static_images(self):
-        if THEME_DATA.get('static_images', False):
-            for image in THEME_DATA['static_images']:
+        if config.THEME_DATA.get('static_images', False):
+            for image in config.THEME_DATA['static_images']:
                 logger.debug(f"Drawing Image: {image}")
                 self.lcd.DisplayBitmap(
-                    bitmap_path=THEME_DATA['PATH'] + THEME_DATA['static_images'][image].get("PATH"),
-                    x=THEME_DATA['static_images'][image].get("X", 0),
-                    y=THEME_DATA['static_images'][image].get("Y", 0),
-                    width=THEME_DATA['static_images'][image].get("WIDTH", 0),
-                    height=THEME_DATA['static_images'][image].get("HEIGHT", 0)
+                    bitmap_path=config.THEME_DATA['PATH'] + config.THEME_DATA['static_images'][image].get("PATH"),
+                    x=config.THEME_DATA['static_images'][image].get("X", 0),
+                    y=config.THEME_DATA['static_images'][image].get("Y", 0),
+                    width=config.THEME_DATA['static_images'][image].get("WIDTH", 0),
+                    height=config.THEME_DATA['static_images'][image].get("HEIGHT", 0)
                 )
 
     def display_static_text(self):
-        if THEME_DATA.get('static_text', False):
-            for text in THEME_DATA['static_text']:
+        if config.THEME_DATA.get('static_text', False):
+            for text in config.THEME_DATA['static_text']:
                 logger.debug(f"Drawing Text: {text}")
                 self.lcd.DisplayText(
-                    text=THEME_DATA['static_text'][text].get("TEXT"),
-                    x=THEME_DATA['static_text'][text].get("X", 0),
-                    y=THEME_DATA['static_text'][text].get("Y", 0),
-                    font=THEME_DATA['static_text'][text].get("FONT", "roboto-mono/RobotoMono-Regular.ttf"),
-                    font_size=THEME_DATA['static_text'][text].get("FONT_SIZE", 10),
-                    font_color=THEME_DATA['static_text'][text].get("FONT_COLOR", (0, 0, 0)),
-                    background_color=THEME_DATA['static_text'][text].get("BACKGROUND_COLOR", (255, 255, 255)),
-                    background_image=_get_full_path(THEME_DATA['PATH'],
-                                                    THEME_DATA['static_text'][text].get("BACKGROUND_IMAGE", None))
+                    text=config.THEME_DATA['static_text'][text].get("TEXT"),
+                    x=config.THEME_DATA['static_text'][text].get("X", 0),
+                    y=config.THEME_DATA['static_text'][text].get("Y", 0),
+                    font=config.THEME_DATA['static_text'][text].get("FONT", "roboto-mono/RobotoMono-Regular.ttf"),
+                    font_size=config.THEME_DATA['static_text'][text].get("FONT_SIZE", 10),
+                    font_color=config.THEME_DATA['static_text'][text].get("FONT_COLOR", (0, 0, 0)),
+                    background_color=config.THEME_DATA['static_text'][text].get("BACKGROUND_COLOR", (255, 255, 255)),
+                    background_image=_get_full_path(config.THEME_DATA['PATH'],
+                                                    config.THEME_DATA['static_text'][text].get("BACKGROUND_IMAGE",
+                                                                                               None))
                 )
 
 

library/scheduler.py

@@ -26,9 +26,6 @@
 
 import library.config as config
 import library.stats as stats
-from library.log import logger
-
-THEME_DATA = config.THEME_DATA
 
 STOPPING = False
 
@@ -82,68 +79,68 @@ def wrap(
 
 
 @async_job("CPU_Percentage")
-@schedule(timedelta(seconds=THEME_DATA['STATS']['CPU']['PERCENTAGE'].get("INTERVAL", None)).total_seconds())
+@schedule(timedelta(seconds=config.THEME_DATA['STATS']['CPU']['PERCENTAGE'].get("INTERVAL", None)).total_seconds())
 def CPUPercentage():
     """ Refresh the CPU Percentage """
     # logger.debug("Refresh CPU Percentage")
     stats.CPU.percentage()
 
 
 @async_job("CPU_Frequency")
-@schedule(timedelta(seconds=THEME_DATA['STATS']['CPU']['FREQUENCY'].get("INTERVAL", None)).total_seconds())
+@schedule(timedelta(seconds=config.THEME_DATA['STATS']['CPU']['FREQUENCY'].get("INTERVAL", None)).total_seconds())
 def CPUFrequency():
     """ Refresh the CPU Frequency """
     # logger.debug("Refresh CPU Frequency")
     stats.CPU.frequency()
 
 
 @async_job("CPU_Load")
-@schedule(timedelta(seconds=THEME_DATA['STATS']['CPU']['LOAD'].get("INTERVAL", None)).total_seconds())
+@schedule(timedelta(seconds=config.THEME_DATA['STATS']['CPU']['LOAD'].get("INTERVAL", None)).total_seconds())
 def CPULoad():
     """ Refresh the CPU Load """
     # logger.debug("Refresh CPU Load")
     stats.CPU.load()
 
 
 @async_job("CPU_Load")
-@schedule(timedelta(seconds=THEME_DATA['STATS']['CPU']['TEMPERATURE'].get("INTERVAL", None)).total_seconds())
+@schedule(timedelta(seconds=config.THEME_DATA['STATS']['CPU']['TEMPERATURE'].get("INTERVAL", None)).total_seconds())
 def CPUTemperature():
     """ Refresh the CPU Temperature """
     # logger.debug("Refresh CPU Temperature")
     stats.CPU.temperature()
 
 
 @async_job("GPU_Stats")
-@schedule(timedelta(seconds=THEME_DATA['STATS']['GPU'].get("INTERVAL", None)).total_seconds())
+@schedule(timedelta(seconds=config.THEME_DATA['STATS']['GPU'].get("INTERVAL", None)).total_seconds())
 def GpuStats():
     """ Refresh the GPU Stats """
     # logger.debug("Refresh GPU Stats")
     stats.Gpu.stats()
 
 
 @async_job("Memory_Stats")
-@schedule(timedelta(seconds=THEME_DATA['STATS']['MEMORY'].get("INTERVAL", None)).total_seconds())
+@schedule(timedelta(seconds=config.THEME_DATA['STATS']['MEMORY'].get("INTERVAL", None)).total_seconds())
 def MemoryStats():
     # logger.debug("Refresh memory stats")
     stats.Memory.stats()
 
 
 @async_job("Disk_Stats")
-@schedule(timedelta(seconds=THEME_DATA['STATS']['DISK'].get("INTERVAL", None)).total_seconds())
+@schedule(timedelta(seconds=config.THEME_DATA['STATS']['DISK'].get("INTERVAL", None)).total_seconds())
 def DiskStats():
     # logger.debug("Refresh disk stats")
     stats.Disk.stats()
 
 
 @async_job("Net_Stats")
-@schedule(timedelta(seconds=THEME_DATA['STATS']['NET'].get("INTERVAL", None)).total_seconds())
+@schedule(timedelta(seconds=config.THEME_DATA['STATS']['NET'].get("INTERVAL", None)).total_seconds())
 def NetStats():
     # logger.debug("Refresh net stats")
     stats.Net.stats()
 
 
 @async_job("Date_Stats")
-@schedule(timedelta(seconds=THEME_DATA['STATS']['DATE'].get("INTERVAL", None)).total_seconds())
+@schedule(timedelta(seconds=config.THEME_DATA['STATS']['DATE'].get("INTERVAL", None)).total_seconds())
 def DateStats():
     # logger.debug("Refresh date stats")
     stats.Date.stats()

library/sensors/sensors.py

@@ -36,7 +36,7 @@ def frequency() -> float:
 
     @staticmethod
     @abstractmethod
-    def load() -> Tuple[float, float, float]:  # 1 / 5 / 15min avg
+    def load() -> Tuple[float, float, float]:  # 1 / 5 / 15min avg (%)
         pass
 
     @staticmethod

library/sensors/sensors_librehardwaremonitor.py

@@ -135,7 +135,7 @@ def frequency() -> float:
             return math.nan
 
     @staticmethod
-    def load() -> Tuple[float, float, float]:  # 1 / 5 / 15min avg:
+    def load() -> Tuple[float, float, float]:  # 1 / 5 / 15min avg (%):
         # Get this data from psutil because it is not available from LibreHardwareMonitor
         return psutil.getloadavg()
 

library/sensors/sensors_python.py

@@ -66,7 +66,7 @@ def frequency() -> float:
         return psutil.cpu_freq().current
 
     @staticmethod
-    def load() -> Tuple[float, float, float]:  # 1 / 5 / 15min avg:
+    def load() -> Tuple[float, float, float]:  # 1 / 5 / 15min avg (%):
         return psutil.getloadavg()
 
     @staticmethod

library/sensors/sensors_stub_random.py

@@ -35,7 +35,7 @@ def frequency() -> float:
         return random.uniform(800, 3400)
 
     @staticmethod
-    def load() -> Tuple[float, float, float]:  # 1 / 5 / 15min avg:
+    def load() -> Tuple[float, float, float]:  # 1 / 5 / 15min avg (%):
         return random.uniform(0, 100), random.uniform(0, 100), random.uniform(0, 100)
 
     @staticmethod