Add a webserver for simulated screen, fix issue for tuple not iterable in Python < 3.9

Author: mathoudebine

.gitignore

@@ -132,4 +132,7 @@ dmypy.json
 .idea/
 
 # Git mergetool backup
-*.orig
+*.orig
+
+# Simulated display capture
+screencap.png

library/lcd_comm.py

@@ -2,6 +2,7 @@
 import threading
 from abc import ABC, abstractmethod
 from enum import IntEnum
+from typing import Tuple
 
 import serial
 from PIL import Image, ImageDraw, ImageFont
@@ -119,7 +120,7 @@ def SetBrightness(self, level: int):
         pass
 
     @abstractmethod
-    def SetBackplateLedColor(self, led_color: tuple[int, int, int]):
+    def SetBackplateLedColor(self, led_color: Tuple[int, int, int] = (255, 255, 255)):
         pass
 
     @abstractmethod
@@ -147,8 +148,8 @@ def DisplayText(
             y: int = 0,
             font: str = "roboto-mono/RobotoMono-Regular.ttf",
             font_size: int = 20,
-            font_color: tuple[int, int, int] = (0, 0, 0),
-            background_color: tuple[int, int, int] = (255, 255, 255),
+            font_color: Tuple[int, int, int] = (0, 0, 0),
+            background_color: Tuple[int, int, int] = (255, 255, 255),
             background_image: str = None
     ):
         # Convert text to bitmap using PIL and display it
@@ -195,9 +196,9 @@ def DisplayText(
 
     def DisplayProgressBar(self, x: int, y: int, width: int, height: int, min_value: int = 0, max_value: int = 100,
                            value: int = 50,
-                           bar_color: tuple[int, int, int] = (0, 0, 0),
+                           bar_color: Tuple[int, int, int] = (0, 0, 0),
                            bar_outline: bool = True,
-                           background_color: tuple[int, int, int] = (255, 255, 255),
+                           background_color: Tuple[int, int, int] = (255, 255, 255),
                            background_image: str = None):
         # Generate a progress bar and display it
         # Provide the background image path to display progress bar with transparent background

library/lcd_comm_rev_a.py

@@ -88,7 +88,7 @@ def SetBrightness(self, level: int = 25):
         # Level : 0 (brightest) - 255 (darkest)
         self.SendCommand(Command.SET_BRIGHTNESS, level_absolute, 0, 0, 0)
 
-    def SetBackplateLedColor(self, led_color: tuple[int, int, int] = (255, 255, 255)):
+    def SetBackplateLedColor(self, led_color: Tuple[int, int, int] = (255, 255, 255)):
         logger.info("HW revision A does not support backplate LED color setting")
         pass
 

library/lcd_comm_rev_b.py

@@ -147,7 +147,7 @@ def SetBrightness(self, level_user: int = 25):
 
         self.SendCommand(Command.SET_BRIGHTNESS, payload=[level])
 
-    def SetBackplateLedColor(self, led_color: tuple[int, int, int] = (255, 255, 255)):
+    def SetBackplateLedColor(self, led_color: Tuple[int, int, int] = (255, 255, 255)):
         if self.is_flagship():
             self.SendCommand(Command.SET_LIGHTING, payload=led_color)
         else:

library/lcd_simulated.py

@@ -1,6 +1,36 @@
+import mimetypes
+from http.server import BaseHTTPRequestHandler, HTTPServer
+
 from library.lcd_comm import *
 
 
+# This webserver offer a blank page displaying simulated screen with auto-refresh
+class SimulatedLcdWebServer(BaseHTTPRequestHandler):
+    def log_message(self, format, *args):
+        return
+
+    def do_GET(self):
+        if self.path == "/":
+            self.send_response(200)
+            self.send_header("Content-type", "text/html")
+            self.end_headers()
+            self.wfile.write(bytes("<img src=\"screencap.png\" id=\"myImage\" />", "utf-8"))
+            self.wfile.write(bytes("<script>", "utf-8"))
+            self.wfile.write(bytes("setInterval(function() {", "utf-8"))
+            self.wfile.write(bytes("    var myImageElement = document.getElementById('myImage');", "utf-8"))
+            self.wfile.write(bytes("    myImageElement.src = 'screencap.png?rand=' + Math.random();", "utf-8"))
+            self.wfile.write(bytes("}, 250);", "utf-8"))
+            self.wfile.write(bytes("</script>", "utf-8"))
+        elif self.path.startswith("/screencap.png"):
+            imgfile = open("screencap.png", 'rb').read()
+            mimetype = mimetypes.MimeTypes().guess_type("screencap.png")[0]
+            self.send_response(200)
+            self.send_header('Content-type', mimetype)
+            self.end_headers()
+            self.wfile.write(imgfile)
+
+
+# Simulated display: write on a screencap.png file instead of serial port
 class LcdSimulated(LcdComm):
     def __init__(self, com_port: str = "AUTO", display_width: int = 320, display_height: int = 480,
                  update_queue: queue.Queue = None):
@@ -9,6 +39,11 @@ def __init__(self, com_port: str = "AUTO", display_width: int = 320, display_hei
         self.screen_image.save("screencap.png", "PNG")
         self.orientation = Orientation.PORTRAIT
 
+        webServer = HTTPServer(("localhost", 5678), SimulatedLcdWebServer)
+        logger.debug("To see your simulated screen, open http://%s:%s" % ("localhost", 5678))
+
+        threading.Thread(target=webServer.serve_forever).start()
+
     @staticmethod
     def auto_detect_com_port():
         return None
@@ -31,7 +66,7 @@ def ScreenOn(self):
     def SetBrightness(self, level: int = 25):
         pass
 
-    def SetBackplateLedColor(self, led_color: tuple[int, int, int] = (255, 255, 255)):
+    def SetBackplateLedColor(self, led_color: Tuple[int, int, int] = (255, 255, 255)):
         pass
 
     def SetOrientation(self, orientation: Orientation = Orientation.PORTRAIT):