Performance: Move to 3.11 and tidy up for Balena (hzeller#2)

* zooom zoom
* bleep
* tweak; remove zlib, but libjpeg is required at runtime
* rm emu
* tbh
* rewrite for merge to 0.5.0

Author: cr3ative

CHANGELOG.md

@@ -7,13 +7,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 # v0.5.0
 ## (2023-06-29)
 
+* Upgrade: Switch Python version and base OS: Python 3.11 on Alpine
 * New feature: `showDepartureNumbers` option - Adds 1st / 2nd / 3rd prefix as per UK train departures
 * New feature: `firstDepartureBold` option - toggle bold of first departure line as this is regional
 * New feature: `targetFPS` option - configurable FPS regulator (zero to disable)
 * Development UX: `fpsTime` option - Adjusts how frequently the Effecive FPS is displayed
-* Development UX: `emulator` option - Emulator mode via pygame
 * Development UX: `headless` option - Run using emulated serial port (Useful for optimisation checks)
-* Development UX: Skip NRE attribution sleep in any dev mode (headless/emulator)
+* Development UX: Skip NRE attribution sleep in emulation mode
+* Development UX: Simplify Dockerfile slightly in an attempt to be Balena-y
 * Performance: Seconds now render every 0.1 second, rather than a hotspot (reduce CPU)
 * Performance: All "in-loop" TTF font rendering is now cached (reduce CPU)
 * Fix: screen1Platform/screen2Platform being required incorrectly on the env

Dockerfile

@@ -1,32 +1,31 @@
-FROM balenalib/raspberry-pi-debian-python:3.7-buster-run AS builder
+FROM balenalib/raspberry-pi-alpine-python:3.11.2-3.15-build as builder
 
 WORKDIR /usr/src/app
 
-RUN mkdir -p /usr/src/debian-rootfs
-
-RUN install_packages apt-rdepends
-
-RUN apt-get update && \
-        apt-get download \
-        $(apt-rdepends tzdata python3 libopenjp2-7 libfreetype6-dev libjpeg-dev libtiff5 libxcb1 | grep -v "^ " | sed 's/debconf-2.0/debconf/g' | sed 's/^libc-dev$/libc6-dev/g' | sed 's/^libz-dev$/zlib1g-dev/g')
-
-RUN for pkg in *.deb; \
-      do dpkg-deb  -x $pkg /usr/src/debian-rootfs; \
-      done
+# Shared libraries
+RUN apk add freetype-dev libjpeg-turbo-dev
 
+# Install the required python packages, and save the compiled result to an output folder
+# This requires gcc/etc which is why we do it in the build image and save the result for the run image
 COPY ./requirements.txt .
-RUN pip install -t /usr/src/python-packages -r requirements.txt --no-cache-dir --extra-index-url=https://www.piwheels.org/simple
-
+RUN pip install --target=/usr/src/python-packages -r requirements.txt --no-cache-dir --config-settings="pillow=--disable-zlib"
 
-FROM busybox:stable
+# Grab the "run" image for the device, which is much lighter weight
+FROM balenalib/raspberry-pi-alpine-python:3.11.2-3.15-run
 
-
-COPY --from=builder /usr/src/debian-rootfs ./
+# Copy in the compiled packages
 COPY --from=builder /usr/src/python-packages/ /usr/src/python-packages/
 
-COPY VERSION ./
+# Shared libraries
+RUN apk add freetype-dev libjpeg-turbo-dev
 
+# And the app
+WORKDIR /usr/src/app
 COPY src ./src
-ENV PYTHONPATH=/usr/src/python-packages/
+COPY VERSION .
+
+# Tell python where to find these mysterious precompiled packages
+ENV PYTHONPATH=/usr/src/python-packages
 
-CMD ["python3", "src/main.py"]
+# And off we go
+CMD ["python3", "src/main.py"]

balena.yml

@@ -72,5 +72,6 @@ data:
     - showDepartureNumbers: False
     - firstDepartureBold: True
     - targetFPS: 70
-version: 0.4.0
+    - fpsTime: 10
+version: 0.5.0
 

docs/04-configuration.md

@@ -24,7 +24,6 @@ These environment variables are specified using the [balenaCloud dashboard](http
 | `screen2Platform` | `2` (sets the platform you want to have displayed on the second display)
 | `individualStationDepartureTime` | `False` (Displays the estimated or scheduled time of the service at each leg of a journey)
 | `fpsTime` | `4` (adjusts how often the effective FPS is displayed)
-| `emulator` | `True` (outputs to pygame emulator rather than serial; useful for running on a development machine)
 | `headless` | `True` (outputs to noop serial device rather than serial port; useful for running on a development machine)
 | `showDepartureNumbers` | `True` (adds 1st / 2nd / 3rd as per UK train departures)
 | `firstDepartureBold` | `False` (makes the first departure use either the bold or normal font)

requirements.txt

@@ -1,5 +1,4 @@
 luma.oled
-luma.emulator
 timeloop
 requests
-xmltodict
+xmltodict

src/config.py

@@ -16,9 +16,6 @@ def loadConfig():
     data["headless"] = False
     if os.getenv("headless") == "True":
         data["headless"] = True
-    data["emulator"] = False
-    if os.getenv("emulator") == "True":
-        data["emulator"] = True
     data["dualScreen"] = False
     if os.getenv("dualScreen") == "True":
         data["dualScreen"] = True

src/main.py

@@ -13,7 +13,6 @@
 from luma.core.interface.serial import spi, noop
 from luma.core.render import canvas
 from luma.oled.device import ssd1322
-from luma.emulator.device import pygame
 from luma.core.virtual import viewport, snapshot
 from luma.core.sprite_system import framerate_regulator
 
@@ -392,16 +391,12 @@ def drawSignage(device, width, height, data):
 
     print('Starting Train Departure Display v' + version_file.read())
     config = loadConfig()
-    if config['emulator']:
-        print('Emulating using pygame; frames will be locked to 60fps')
-        device = pygame(256, 64)
+    if config['headless']:
+        print('Headless mode, running main loop without serial comms')
+        serial = noop()
     else:
-        if config['headless']:
-            print('Headless mode, running main loop without serial comms')
-            serial = noop()
-        else:
-            serial = spi(port=0)
-        device = ssd1322(serial, mode="1", rotate=config['screenRotation'])
+        serial = spi(port=0)
+    device = ssd1322(serial, mode="1", rotate=config['screenRotation'])
 
     if config['dualScreen']:
         serial1 = spi(port=1, gpio_DC=5, gpio_RST=6)
@@ -426,7 +421,7 @@ def drawSignage(device, width, height, data):
     if config['dualScreen']:
         virtual = drawStartup(device1, width=widgetWidth, height=widgetHeight)
         virtual.refresh()
-    if config['emulator'] is not True and config['headless'] is not True:
+    if config['headless'] is not True:
         time.sleep(5)
 
     timeAtStart = time.time() - config["refreshTime"]