feat: webserver: redirect / to /index.html

Signed-off-by: Matthias Blankertz <matthias@blankertz.org>
feat: webserver: keep alive; move playback write prot to handler
2025-12-16 21:01:18 +01:00 · 2025-12-16 20:48:01 +01:00 · 2025-12-16 20:41:40 +01:00 · 2025-12-16 20:41:40 +01:00 · 2025-12-16 20:41:40 +01:00 · 2025-12-16 20:41:40 +01:00
11 changed files with 352 additions and 58 deletions
--- a/.gitea/workflows/build.yaml
+++ b/.gitea/workflows/build.yaml
@@ -11,8 +11,10 @@ jobs:
        uses: actions/checkout@v4
      - name: Initialize submodules
        run: cd software && ./update-submodules.sh
      - name: Prepare venv
        run: python -m venv build-venv && source build-venv/bin/activate && pip install freezefs
      - name: Build
-        run: cd software && ./build.sh
+        run: source build-venv/bin/activate && cd software && ./build.sh
      - name: Upload firmware
        uses: actions/upload-artifact@v3
        with:
--- a/software/boards/RPI_PICO_W/manifest.py
+++ b/software/boards/RPI_PICO_W/manifest.py
@@ -22,3 +22,5 @@ module("mp3player.py", "../../src")
 module("webserver.py", "../../src")
 package("utils", base_path="../../src")
 package("nfc", base_path="../../src")
 module("frozen_frontend.py", "../../build")
--- a/software/build.sh
+++ b/software/build.sh
@@ -25,6 +25,11 @@ mkdir  "$FS_STAGE_DIR"/fs
 trap 'rm -rf $FS_STAGE_DIR' EXIT
 tools/mklittlefs/mklittlefs -p 256 -s 868352 -c "$FS_STAGE_DIR"/fs "$FS_STAGE_DIR"/filesystem.bin
 FRONTEND_STAGE_DIR=$(mktemp -d)
 trap 'rm -rf $FRONTEND_STAGE_DIR' EXIT
 gzip -c frontend/index.html > "$FRONTEND_STAGE_DIR"/index.html.gz
 python -m freezefs "$FRONTEND_STAGE_DIR" build/frozen_frontend.py --target=/frontend
 for hwconfig in boards/RPI_PICO_W/manifest-*.py; do
    hwconfig_base=$(basename "$hwconfig")
    hwname=${hwconfig_base##manifest-}
--- a/software/frontend/index.html
+++ b/software/frontend/index.html
@@ -0,0 +1,249 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
 <meta charset="UTF-8">
 <title>Device Admin</title>
 <style>
    body {
        font-family: Arial, sans-serif;
        padding: 20px;
        max-width: 700px;
        margin: auto;
    }
    /* Navigation */
    nav button {
        margin: 5px;
        padding: 10px 16px;
        cursor: pointer;
    }
    /* Screens */
    .screen {
        display: none;
        margin-top: 20px;
    }
    .screen.active {
        display: block;
    }
    /* Config editor UI */
    label {
        font-weight: bold;
        margin-top: 12px;
        display: block;
    }
    input {
        width: 100%;
        padding: 6px;
        box-sizing: border-box;
        margin-top: 4px;
    }
    .nested {
        margin-left: 20px;
        border-left: 2px solid #ddd;
        padding-left: 10px;
        margin-top: 10px;
    }
 </style>
 </head>
 <body>
 <h1>Device Admin</h1>
 <nav>
    <button onclick="showScreen('menu')">🏠 Main Menu</button>
    <button onclick="showScreen('config')">⚙️ Config Editor</button>
 </nav>
 <!-- MAIN MENU -->
 <div id="screen-menu" class="screen active">
    <h2>Main Menu</h2>
    <p>Select a tool:</p>
    <ul>
        <li><button onclick="showScreen('config')">Open Config Editor</button></li>
        <!-- More screens can be added later -->
    </ul>
 </div>
 <!-- CONFIG EDITOR SCREEN -->
 <div id="screen-config" class="screen">
    <h2>Configuration Editor</h2>
    <div id="config-container">Loading…</div>
    <button id="save-btn" disabled>Save</button>
 </div>
 <script>
 /* -----------------------------
   Screen switching
 ----------------------------- */
 function showScreen(name) {
    document.querySelectorAll('.screen').forEach(s => s.classList.remove('active'));
    document.getElementById('screen-' + name).classList.add('active');
    if (name === "config") {
        loadConfig(); // refresh most up-to-date config
    }
 }
 /* -----------------------------
   CONFIG EDITOR LOGIC
 ----------------------------- */
 async function loadConfig() {
    const container = document.getElementById('config-container');
    container.innerHTML = "Loading…";
    document.getElementById('save-btn').disabled = true;
    try {
        const res = await fetch('/api/v1/config');
        const config = await res.json();
        renderConfigForm(config);
    } catch (err) {
        container.innerHTML = "Failed to load config: " + err;
    }
 }
 function renderConfigForm(config) {
    const container = document.getElementById('config-container');
    container.innerHTML = "";
    container.appendChild(renderObject(config, "root"));
    document.getElementById('save-btn').disabled = false;
 }
 const config_names = {
    'root.IDLE_TIMEOUT_SECS': 'Idle Timeout (seconds)',
    'root.BUTTON_MAP': 'Button map',
    'root.BUTTON_MAP.NEXT': 'Next track',
    'root.BUTTON_MAP.PREV': 'Previous track',
    'root.BUTTON_MAP.VOLUP': 'Volume up',
    'root.BUTTON_MAP.VOLDOWN': 'Volume down',
    'root.BUTTON_MAP.PLAY_PAUSE': 'Play/Pause',
    'root.TAG_TIMEOUT_SECS': 'Tag removal timeout (seconds)',
    'root.TAGMODE': 'Tag mode',
    'root.LED_COUNT': 'Length of WS2182 (Neopixel) LED chain'
 };
 const config_input_override = {
    'root.TAGMODE': {
        'element': 'select',
        'values': {
            'tagremains': 'Play until tag is removed',
            'tagstartstop': 'Present tag once to start, present again to stop playback'
        }
    },
    'root.IDLE_TIMEOUT_SECS': {
        'input-type': 'number'
    },
    'root.TAG_TIMEOUT_SECS': {
        'input-type': 'number'
    },
    'root.LED_COUNT': {
        'input-type': 'number'
    },
 };
 function renderObject(obj, path) {
    const wrapper = document.createElement('div');
    Object.entries(obj).forEach(([key, value]) => {
        const currentPath = path + '.' + key;
        const label = document.createElement('label');
        if (currentPath in config_names) {
            label.textContent = config_names[currentPath];
        } else {
            label.textContent = key;
        }
        if (value !== null && typeof value === 'object') {
            wrapper.appendChild(label);
            const nested = document.createElement('div');
            nested.className = "nested";
            nested.appendChild(renderObject(value, currentPath));
            wrapper.appendChild(nested);
        } else {
            wrapper.appendChild(label);
            if (currentPath in config_input_override && 'element' in config_input_override[currentPath]) {
                const override = config_input_override[currentPath];
                if (override['element'] === 'select') {
                    const input = document.createElement('select');
                    input.dataset.path = currentPath;
                    for (const val in override.values) {
                        const option = document.createElement('option');
                        option.value = val;
                        option.textContent = override.values[val];
                        if (val === value) {
                            option.selected = true;
                        }
                        input.appendChild(option);
                    }
                    wrapper.appendChild(input);
                }
            } else {
                const input = document.createElement('input');
                if (currentPath in config_input_override && 'input-type' in config_input_override[currentPath]) {
                    input.type = config_input_override[currentPath]['input-type'];
                }
                input.value = value === null ? "" : value;
                input.dataset.path = currentPath;
                wrapper.appendChild(input);
            }
        }
    });
    return wrapper;
 }
 function serializeConfig(rootObj) {
    const inputs = document.querySelectorAll("input[data-path], select[data-path]");
    inputs.forEach(input => {
        const path = input.dataset.path.split('.').slice(1); // remove "root"
        let current = rootObj;
        for (let i = 0; i < path.length - 1; i++) {
            current = current[path[i]];
        }
        let val = input.value.trim();
        if (val === "") val = null;
        else if (!isNaN(val)) val = Number(val);
        current[path[path.length - 1]] = val;
    });
    return rootObj;
 }
 document.getElementById('save-btn').addEventListener('click', async () => {
    const res = await fetch('/api/v1/config');
    const original = await res.json();
    const updated = serializeConfig(original);
    try {
        const saveRes = await fetch('/api/v1/config', {
            method: 'PUT',
            headers: { 'Content-Type': 'application/json' },
            body: JSON.stringify(updated, null, 2)
        });
        if (!saveRes.ok) {
            alert("Failed to save config: " + await saveRes.text());
            return;
        }
        alert("Configuration saved successfully!");
    } catch (err) {
        alert("Error saving configuration: " + err);
    }
 });
 // Load main menu by default
 showScreen('menu');
 </script>
 </body>
 </html>
--- a/software/src/app.py
+++ b/software/src/app.py
@@ -51,7 +51,7 @@ class PlayerApp:
        self.playlist_db = deps.playlistdb(self)
        self.hwconfig = deps.hwconfig(self)
        self.leds = deps.leds(self)
-        self.tag_mode = self.playlist_db.getSetting('tagmode')
+        self.tag_mode = self.config.get_tagmode()
        self.playing_tag = None
        self.playlist = None
        self.buttons = deps.buttons(self) if deps.buttons is not None else None
@@ -116,6 +116,10 @@ class PlayerApp:
            # Check again in a minute
            self.timer_manager.schedule(time.ticks_ms() + self.idle_timeout_ms, self.onIdleTimeout)
    def reset_idle_timeout(self):
        if not self.playing:
            self.timer_manager.schedule(time.ticks_ms() + self.idle_timeout_ms, self.onIdleTimeout)
    def is_playing(self) -> bool:
        return self.playing
--- a/software/src/main.py
+++ b/software/src/main.py
@@ -14,6 +14,7 @@ import ubinascii
 # Own modules
 import app
 from audiocore import AudioContext
 import frozen_frontend  # noqa: F401
 from mfrc522 import MFRC522
 from mp3player import MP3Player
 from nfc import Nfc
--- a/software/src/utils/config.py
+++ b/software/src/utils/config.py
@@ -21,7 +21,8 @@ class Configuration:
            'VOLDOWN': 2,
            'PREV': None,
            'NEXT': 1,
-        }
+        },
        'TAGMODE': 'tagremains'
    }
    def __init__(self, config_path='/config.json'):
@@ -29,6 +30,7 @@ class Configuration:
        try:
            with open(self.config_path, 'r') as conf_file:
                self.config = json.load(conf_file)
            self._merge_configs(self.DEFAULT_CONFIG, self.config)
        except OSError as ex:
            if ex.errno == ENOENT:
                self.config = Configuration.DEFAULT_CONFIG
@@ -50,6 +52,16 @@ class Configuration:
                raise
        os.sync()
    def _merge_configs(self, default, config):
        for k in default.keys():
            if k not in config:
                if isinstance(default[k], dict):
                    config[k] = default[k].copy()
                else:
                    config[k] = default[k]
            elif isinstance(default[k], dict):
                self._merge_configs(default[k], config[k])
    def _save(self):
        with open(self.config_path + '.new', 'w') as conf_file:
            json.dump(self.config, conf_file)
@@ -58,7 +70,7 @@ class Configuration:
        os.sync()
    def _get(self, key):
-        return self.config.get(key, self.DEFAULT_CONFIG[key])
+        return self.config[key]
    def get_led_count(self) -> int:
        return self._get('LED_COUNT')
@@ -72,6 +84,9 @@ class Configuration:
    def get_button_map(self) -> Mapping[str, int | None]:
        return self._get('BUTTON_MAP')
    def get_tagmode(self) -> str:
        return self._get('TAGMODE')
    # For the web API
    def get_config(self) -> Mapping[str, Any]:
        return self.config
@@ -87,5 +102,8 @@ class Configuration:
    def set_config(self, config):
        self._validate(self.DEFAULT_CONFIG, config)
        if 'TAGMODE' in config and config['TAGMODE'] not in ['tagremains', 'tagstartstop']:
            raise ValueError("Invalid TAGMODE: Must be 'tagremains' or 'tagstartstop'")
        self._merge_configs(self.config, config)
        self.config = config
        self._save()
--- a/software/src/utils/playlistdb.py
+++ b/software/src/utils/playlistdb.py
@@ -31,9 +31,6 @@ class BTreeDB(IPlaylistDB):
    PERSIST_NO = b'no'
    PERSIST_TRACK = b'track'
    PERSIST_OFFSET = b'offset'
    DEFAULT_SETTINGS = {
        b'tagmode': b'tagremains'
    }
    class Playlist(IPlaylist):
        def __init__(self, parent: "BTreeDB", tag: bytes, pos: int, persist, shuffle):
@@ -282,11 +279,6 @@ class BTreeDB(IPlaylistDB):
        self._savePlaylist(tag, entries, persist, shuffle)
        return self.getPlaylistForTag(tag)
    def getSetting(self, key: bytes | str) -> str:
        if type(key) is str:
            key = key.encode()
        return self.db.get(b'settings/' + key, self.DEFAULT_SETTINGS[key]).decode()
    def validate(self, dump=False):
        """
        Validate the structure of the playlist database.
@@ -306,8 +298,7 @@ class BTreeDB(IPlaylistDB):
                fail(f'Malformed key {k!r}')
                continue
            if fields[0] == b'settings':
-                val = self.db[k].decode()
+                # Legacy, not used any more
                print(f'Setting {fields[1].decode()} = {val}')
                continue
            if last_tag != fields[0]:
                last_tag = fields[0]
--- a/software/src/utils/timer.py
+++ b/software/src/utils/timer.py
@@ -50,29 +50,36 @@ class TimerManager(object):
        heapq.heapify(self.timers)
        return i
    def _next_timeout(self):
        if len(self.timers) == 0:
            if self.timer_debug:
                print("timer: worker: queue empty")
            return None
        cur_nearest = self.timers[0][0]
        next_timeout = cur_nearest - time.ticks_ms()
        if self.timer_debug:
            if next_timeout > 0:
                print(f"timer: worker: next is {self.timers[0]}, sleep {next_timeout} ms")
            else:
                print(f"timer: worker: {self.timers[0]} elapsed @{cur_nearest}, delay {-next_timeout} ms")
        return next_timeout
    async def _wait(self, timeout):
        try:
            await asyncio.wait_for_ms(self.worker_event.wait(), timeout)
            if self.timer_debug:
                print("timer: worker: event")
            # got woken up due to event
            self.worker_event.clear()
            return True
        except asyncio.TimeoutError:
            return False
    async def _timer_worker(self):
        while True:
-            if len(self.timers) == 0:
+            next_timeout = self._next_timeout()
-                # Nothing to do
+            if next_timeout is None or next_timeout > 0:
-                await self.worker_event.wait()
+                await self._wait(next_timeout)
                if self.timer_debug:
                    print("_timer_worker: event 0")
                self.worker_event.clear()
                continue
            cur_nearest = self.timers[0][0]
            wait_time = cur_nearest - time.ticks_ms()
            if wait_time > 0:
                if self.timer_debug:
                    print(f"_timer_worker: next is {self.timers[0]}, sleep {wait_time} ms")
                try:
                    await asyncio.wait_for_ms(self.worker_event.wait(), wait_time)
                    if self.timer_debug:
                        print("_timer_worker: event 1")
                    # got woken up due to event
                    self.worker_event.clear()
                    continue
                except asyncio.TimeoutError:
                    pass
            else:
                _, callback = heapq.heappop(self.timers)
                safe_callback(callback, "timer callback")
--- a/software/src/webserver.py
+++ b/software/src/webserver.py
@@ -5,7 +5,7 @@ Copyright (c) 2024-2025 Stefan Kratochwil <Kratochwil-LA@gmx.de>
 import asyncio
-from microdot import Microdot
+from microdot import Microdot, redirect, send_file
 webapp = Microdot()
 server = None
@@ -20,7 +20,14 @@ def start_webserver(config_, app_):
    app = app_
-@webapp.route('/')
+@webapp.before_request
 async def before_request_handler(request):
    if request.method in ['PUT', 'POST'] and app.is_playing():
        return "Cannot write to device while playback is active", 503
    app.reset_idle_timeout()
@webapp.route('/api/v1/hello')
 async def index(request):
    print("wohoo, a guest :)")
    print(f"  app: {request.app}")
@@ -52,10 +59,26 @@ async def config_get(request):
@webapp.route('/api/v1/config', methods=['PUT'])
 async def config_put(request):
    if app.is_playing():
        return 503
    try:
        config.set_config(request.json)
    except ValueError as ex:
        return str(ex), 400
    return '', 204
@webapp.route('/', methods=['GET'])
 async def root_get(request):
    return redirect('/index.html')
@webapp.route('/index.html', methods=['GET'])
 async def index_get(request):
    return send_file('/frontend/index.html.gz', content_type='text/html', compressed='gzip')
@webapp.route('/static/<path:path>', methods=['GET'])
 async def static(request, path):
    if '..' in path:
        # directory traversal is not allowed
        return 'Not found', 404
    return send_file('/frontend/static/' + path, max_age=86400)
--- a/software/tests/test_playerapp.py
+++ b/software/tests/test_playerapp.py
@@ -136,6 +136,9 @@ class FakeConfig:
    def get_tag_timeout(self):
        return 5
    def get_tagmode(self):
        return 'tagremains'
 def fake_open(filename, mode):
    return FakeFile(filename, mode)
@@ -226,18 +229,16 @@ def test_playlist_unknown_tag(micropythonify, faketimermanager, monkeypatch):
 def test_tagmode_startstop(micropythonify, faketimermanager, monkeypatch):
-    class MyFakePlaylistDb(FakePlaylistDb):
+    class FakeStartStopConfig(FakeConfig):
-        def __init__(self, tracklist=[b'test/path.mp3']):
+        def __init__(self):
-            super().__init__(tracklist)
+            super().__init__()
-        def getSetting(self, key: bytes | str):
+        def get_tagmode(self):
-            if key == 'tagmode':
+            return 'tagstartstop'
                return 'tagstartstop'
            return None
-    fake_db = MyFakePlaylistDb()
+    fake_db = FakePlaylistDb([b'test/path.mp3'])
    fake_mp3 = FakeMp3Player()
-    deps = _makedeps(mp3player=fake_mp3, playlistdb=fake_db)
+    deps = _makedeps(mp3player=fake_mp3, playlistdb=fake_db, config=FakeStartStopConfig)
    app.PlayerApp(deps)
    with monkeypatch.context() as m:
        m.setattr(builtins, 'open', fake_open)
@@ -264,16 +265,7 @@ def test_tagmode_startstop(micropythonify, faketimermanager, monkeypatch):
 def test_tagmode_remains(micropythonify, faketimermanager, monkeypatch):
-    class MyFakePlaylistDb(FakePlaylistDb):
+    fake_db = FakePlaylistDb([b'test/path.mp3'])
        def __init__(self, tracklist=[b'test/path.mp3']):
            super().__init__(tracklist)
        def getSetting(self, key: bytes | str):
            if key == 'tagmode':
                return 'tagremains'
            return None
    fake_db = MyFakePlaylistDb()
    fake_mp3 = FakeMp3Player()
    deps = _makedeps(mp3player=fake_mp3, playlistdb=fake_db)
    app.PlayerApp(deps)
Author	SHA1	Message	Date
Matthias Blankertz	b20a31ccf4	feat: webserver: redirect / to /index.html All checks were successful Build RPi Pico firmware image / Build-Firmware (push) Successful in 4m41s Details Check code formatting / Check-C-Format (push) Successful in 7s Details Check code formatting / Check-Python-Flake8 (push) Successful in 9s Details Check code formatting / Check-Bash-Shellcheck (push) Successful in 4s Details Run unit tests on host / Run-Unit-Tests (push) Successful in 7s Details Run pytests / Check-Pytest (push) Successful in 10s Details Signed-off-by: Matthias Blankertz <matthias@blankertz.org>	2025-12-16 21:01:18 +01:00
Matthias Blankertz	8a2d621c7d	feat: webserver: keep alive; move playback write prot to handler - Reset the app idle timer when interacting with the webapp, so that the device does not turn off while the web ui is used. - Handle denying put/post while playback is active centrally in the before_request handler, so that it does not need to be copy/pasted into every request handler. Signed-off-by: Matthias Blankertz <matthias@blankertz.org>	2025-12-16 20:48:01 +01:00
Matthias Blankertz	93ea5036dc	feat: config frontend Implement nicer configuration UI: - Show human-readable names for config settings - Show error message received from server if storing settings fails - Show appropriate input elements for enum choice and numerical inputs Signed-off-by: Matthias Blankertz <matthias@blankertz.org>	2025-12-16 20:41:40 +01:00
Matthias Blankertz	aee5a48967	fix: config: Merge defaults into config at load time Merge defaults into config at load time to ensure that all config options show up in the configuration dialog, even if they were added after the local configuration was last changed. Also use the merge method to merge the local config with the new config in set_config, ensuring the config contains all keys even if the submitted config leaves some out. Signed-off-by: Matthias Blankertz <matthias@blankertz.org>	2025-12-16 20:41:40 +01:00
Matthias Blankertz	936020df58	feat: Add and deploy frontend Signed-off-by: Matthias Blankertz <matthias@blankertz.org>	2025-12-16 20:41:40 +01:00
Matthias Blankertz	e447902001	feat: Move tagmode setting to config.json, remove playlistdb settings All checks were successful Build RPi Pico firmware image / Build-Firmware (push) Successful in 4m35s Details Check code formatting / Check-C-Format (push) Successful in 7s Details Check code formatting / Check-Python-Flake8 (push) Successful in 9s Details Check code formatting / Check-Bash-Shellcheck (push) Successful in 6s Details Run unit tests on host / Run-Unit-Tests (push) Successful in 8s Details Run pytests / Check-Pytest (push) Successful in 10s Details Signed-off-by: Matthias Blankertz <matthias@blankertz.org>	2025-12-16 20:41:40 +01:00
Matthias Blankertz	768b630722	Merge pull request 'misc-stability-improvements' (#56 ) from misc-stability-improvements into main All checks were successful Build RPi Pico firmware image / Build-Firmware (push) Successful in 4m36s Details Check code formatting / Check-C-Format (push) Successful in 7s Details Check code formatting / Check-Python-Flake8 (push) Successful in 10s Details Check code formatting / Check-Bash-Shellcheck (push) Successful in 5s Details Run unit tests on host / Run-Unit-Tests (push) Successful in 7s Details Run pytests / Check-Pytest (push) Successful in 10s Details Reviewed-on: #56 Reviewed-by: Stefan Kratochwil <kratochwil-la@gmx.de>	2025-12-16 19:25:44 +00:00
Matthias Blankertz	e0ff9c54bc	refactor: timer: split out two helpers from _timer_worker All checks were successful Build RPi Pico firmware image / Build-Firmware (push) Successful in 4m35s Details Check code formatting / Check-C-Format (push) Successful in 8s Details Check code formatting / Check-Python-Flake8 (push) Successful in 10s Details Check code formatting / Check-Bash-Shellcheck (push) Successful in 5s Details Run unit tests on host / Run-Unit-Tests (push) Successful in 8s Details Run pytests / Check-Pytest (push) Successful in 11s Details Signed-off-by: Matthias Blankertz <matthias@blankertz.org>	2025-12-16 20:19:30 +01:00