beebium-server 0.1.5__py3-none-win_amd64.whl

beebium/server/__init__.py

@@ -0,0 +1,44 @@
+# Copyright 2026 Robert Smallshire <robert@smallshire.org.uk>
+#
+# This file is part of Beebium.
+#
+# Beebium is free software: you can redistribute it and/or modify it under the terms of the
+# GNU General Public License as published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version. Beebium is distributed in the hope that it will
+# be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# You should have received a copy of the GNU General Public License along with Beebium.
+# If not, see <https://www.gnu.org/licenses/>.
+
+"""Prebuilt Beebium server binaries, shipped as a platform wheel.
+
+    import beebium.server
+
+    beebium.server.__version__
+    beebium.server.executable_filepath(variant="model-b")   # ensured executable
+    beebium.server.rom_dirpath()
+    beebium.server.preset_dirpath()
+    beebium.server.variants()
+    beebium.server.bundle_dirpath()
+
+This package is dependency-free and usable without the `beebium` client; the
+client discovers it (when installed) as one of its server installations.
+"""
+
+from beebium.server._paths import (
+    __version__,
+    bundle_dirpath,
+    executable_filepath,
+    preset_dirpath,
+    rom_dirpath,
+    variants,
+)
+
+__all__ = [
+    "__version__",
+    "bundle_dirpath",
+    "executable_filepath",
+    "preset_dirpath",
+    "rom_dirpath",
+    "variants",
+]

beebium/server/_bundle/bin/extensions/acorn-rtc/manifest.json

@@ -0,0 +1,26 @@
+{
+    "name": "acorn-rtc",
+    "display_name": "Acorn Real-Time Clock",
+    "description": "Acorn User Port Real Time Clock Module (SAF3019P)",
+    "library": "acorn-rtc",
+    "attaches_to": ["user-port"],
+    "cli": "acorn-rtc",
+    "parameters": [
+        {
+            "key": "time",
+            "type": "string",
+            "description": "Set emulated clock to absolute datetime (e.g. 1985-03-15T10:30)"
+        },
+        {
+            "key": "offset",
+            "type": "string",
+            "description": "Offset from host local time (e.g. -10y, +5h, -365d)"
+        },
+        {
+            "key": "layout",
+            "type": "string",
+            "description": "Register layout: '4bit-year-in-r1' (Acorn original), '7bit-year-in-r7' (L3 v1.26), '7bit-year-in-r1r5' (BeebMaster Y2KFIX)",
+            "default": "4bit-year-in-r1"
+        }
+    ]
+}

beebium/server/_bundle/bin/extensions/acorn-scsi/manifest.json

@@ -0,0 +1,9 @@
+{
+    "name": "acorn-scsi",
+    "display_name": "Acorn SCSI Host Adapter",
+    "description": "Acorn SCSI Host Adapter for 1 MHz bus (0xFC40-0xFC43)",
+    "library": "acorn-scsi",
+    "attaches_to": ["1mhz-bus"],
+    "cli": "acorn-scsi",
+    "provides": ["scsi"]
+}

beebium/server/_bundle/bin/extensions/ip232-serial/manifest.json

@@ -0,0 +1,43 @@
+{
+    "name": "ip232-serial",
+    "display_name": "IP232 Serial",
+    "description": "Connect the BBC serial port (RS423) to a tcpser-style IP232 server over TCP",
+    "library": "ip232-serial",
+    "attaches_to": ["serial-port"],
+    "cli": "ip232-serial",
+    "parameters": [
+        {
+            "key": "url",
+            "type": "string",
+            "description": "IP232 server endpoint as [scheme://]host:port (e.g. url=\"ip232://bbs.example.com:25232\"); alternative to host/port, cannot be combined with them"
+        },
+        {
+            "key": "host",
+            "type": "string",
+            "description": "IP232 server hostname or address (default localhost; alternative to url)"
+        },
+        {
+            "key": "port",
+            "type": "integer",
+            "description": "IP232 server TCP port (default 25232; alternative to url)"
+        },
+        {
+            "key": "mode",
+            "type": "string",
+            "default": "ip232",
+            "description": "'ip232' (0xFF-escaped, persistent connection) or 'raw' (pure byte pipe, connect/disconnect on RTS)"
+        },
+        {
+            "key": "handshake",
+            "type": "boolean",
+            "default": "true",
+            "description": "convey the BBC's RTS line to the server via the 0xFF escape (ip232 mode only)"
+        },
+        {
+            "key": "tx_buffer",
+            "type": "integer",
+            "default": "4096",
+            "description": "transmit buffer size in bytes; the BBC's /CTS asserts at/above it"
+        }
+    ]
+}

beebium/server/_bundle/bin/extensions/loopback-serial/manifest.json

@@ -0,0 +1,8 @@
+{
+    "name": "loopback-serial",
+    "display_name": "Loopback Serial",
+    "description": "Echo bytes the BBC transmits straight back to its serial receiver",
+    "library": "loopback-serial",
+    "attaches_to": ["serial-port"],
+    "cli": "loopback-serial"
+}

beebium/server/_bundle/bin/extensions/piconet/manifest.json

@@ -0,0 +1,16 @@
+{
+    "name": "piconet",
+    "display_name": "Piconet",
+    "description": "Piconet USB-CDC bridge to a real Econet network",
+    "library": "piconet",
+    "cli": "piconet",
+    "extension_kind": "econet-transport",
+    "parameters": [
+        {
+            "key": "device_path",
+            "type": "filepath",
+            "description": "Serial device path (e.g. /dev/tty.usbmodem101)",
+            "required": true
+        }
+    ]
+}

beebium/server/_bundle/bin/extensions/rfc2217-client-serial/manifest.json

@@ -0,0 +1,55 @@
+{
+    "name": "rfc2217-client-serial",
+    "display_name": "RFC 2217 Serial (client)",
+    "description": "Connect the BBC serial port (RS423) to a remote RFC 2217 access server over TCP",
+    "library": "rfc2217-client-serial",
+    "attaches_to": ["serial-port"],
+    "cli": "rfc2217-client-serial",
+    "parameters": [
+        {
+            "key": "url",
+            "type": "string",
+            "description": "Access-server endpoint as [scheme://]host:port (e.g. url=\"rfc2217://ser2net.local:4001\"); alternative to host/port, cannot be combined with them"
+        },
+        {
+            "key": "host",
+            "type": "string",
+            "description": "RFC 2217 access-server hostname or address (alternative to url)"
+        },
+        {
+            "key": "port",
+            "type": "integer",
+            "description": "RFC 2217 access-server TCP port (alternative to url)"
+        },
+        {
+            "key": "baud",
+            "type": "integer",
+            "default": "19200",
+            "description": "baud rate to set on the remote UART (real hardware)"
+        },
+        {
+            "key": "framing",
+            "type": "string",
+            "default": "8N1",
+            "description": "remote UART framing as <data><parity><stop> (data 5-8; parity N/O/E/M/S; stop 1/2), e.g. 8N1 or 7E1"
+        },
+        {
+            "key": "flow",
+            "type": "string",
+            "default": "none",
+            "description": "remote UART flow control: none, rtscts (hardware) or xonxoff"
+        },
+        {
+            "key": "dtr",
+            "type": "boolean",
+            "default": "true",
+            "description": "assert DTR on the remote UART (many devices/modems need it; the BBC connector has no DTR pin)"
+        },
+        {
+            "key": "tx_buffer",
+            "type": "integer",
+            "default": "4096",
+            "description": "transmit buffer size in bytes; the BBC's /CTS asserts at/above it"
+        }
+    ]
+}

beebium/server/_bundle/bin/extensions/rfc2217-server-serial/manifest.json

@@ -0,0 +1,28 @@
+{
+    "name": "rfc2217-server-serial",
+    "display_name": "RFC 2217 Serial (server)",
+    "description": "Expose the emulated BBC serial port (RS423) to RFC 2217 clients over TCP",
+    "library": "rfc2217-server-serial",
+    "attaches_to": ["serial-port"],
+    "cli": "rfc2217-server-serial",
+    "parameters": [
+        {
+            "key": "bind",
+            "type": "string",
+            "default": "127.0.0.1",
+            "description": "listen address; the service is UNAUTHENTICATED plain Telnet, so bind to a wider address only behind SSH/WireGuard"
+        },
+        {
+            "key": "port",
+            "type": "integer",
+            "required": true,
+            "description": "TCP port to listen on"
+        },
+        {
+            "key": "tx_buffer",
+            "type": "integer",
+            "default": "4096",
+            "description": "transmit buffer size in bytes; the BBC's /CTS asserts at/above it"
+        }
+    ]
+}

beebium/server/_bundle/bin/extensions/rpc-serial/manifest.json

@@ -0,0 +1,16 @@
+{
+    "name": "rpc-serial",
+    "display_name": "RPC Serial",
+    "description": "Client-driven serial peer: inject/collect bytes via the RpcSerial service",
+    "library": "rpc-serial",
+    "attaches_to": ["serial-port"],
+    "cli": "rpc-serial",
+    "parameters": [
+        {
+            "key": "tx_buffer",
+            "type": "integer",
+            "default": "4096",
+            "description": "transmit buffer size in bytes; the BBC's /CTS asserts at/above it"
+        }
+    ]
+}

beebium/server/_bundle/bin/extensions/scsi-hard-disc/manifest.json

@@ -0,0 +1,28 @@
+{
+    "name": "scsi-hard-disc",
+    "display_name": "SCSI Hard Disc",
+    "description": "SCSI hard disc target (DAT+DSC image)",
+    "library": "scsi-hard-disc",
+    "attaches_to": ["scsi"],
+    "cli": "scsi-hdd",
+    "parameters": [
+        {
+            "key": "scsi-id",
+            "type": "integer",
+            "position": 0,
+            "default": "0",
+            "description": "SCSI target ID (0-7)"
+        },
+        {
+            "key": "image",
+            "type": "filepath",
+            "position": 1,
+            "description": "Path to DAT disc image file"
+        },
+        {
+            "key": "adapter-id",
+            "type": "string",
+            "description": "ID of SCSI adapter to attach to"
+        }
+    ]
+}

beebium/server/_bundle/bin/extensions/test-scratch-ram/manifest.json

@@ -0,0 +1,7 @@
+{
+    "name": "test-scratch-ram",
+    "display_name": "Test Scratch RAM",
+    "description": "8 bytes of scratch RAM at 0xFC50 for framework testing",
+    "library": "test-scratch-ram",
+    "attaches_to": ["1mhz-bus"]
+}

beebium/server/_bundle/share/beebium/presets/model-b-disc.preset.beebium

@@ -0,0 +1,19 @@
+{
+  "model": "model-b",
+  "name": "BBC Model B (Disc)",
+  "release_date": "1982",
+  "storage": {
+    "fdc_socket": {
+      "id": "acorn-1770"
+    }
+  },
+  "sideways_bank": {
+    "slots": [
+      {
+        "slot": 14,
+        "type": "rom",
+        "image_uri": "acorn-dfs_2_26.rom"
+      }
+    ]
+  }
+}

beebium/server/_bundle/share/beebium/presets/model-b-plus-128k.preset.beebium

@@ -0,0 +1,5 @@
+{
+  "model": "model-b-plus-128k",
+  "name": "BBC Model B+ 128K",
+  "release_date": "1985-06"
+}

beebium/server/_bundle/share/beebium/presets/model-b-plus.preset.beebium

@@ -0,0 +1,5 @@
+{
+  "model": "model-b-plus",
+  "name": "BBC Model B+ 64K",
+  "release_date": "1985-06"
+}

beebium/server/_bundle/share/beebium/presets/model-b-romram-disc.preset.beebium

@@ -0,0 +1,19 @@
+{
+  "model": "model-b-romram",
+  "name": "BBC Model B with ROM/RAM Board (Disc)",
+  "release_date": "1984",
+  "storage": {
+    "fdc_socket": {
+      "id": "acorn-1770"
+    }
+  },
+  "sideways_bank": {
+    "slots": [
+      {
+        "slot": 14,
+        "type": "rom",
+        "image_uri": "acorn-dfs_2_26.rom"
+      }
+    ]
+  }
+}

beebium/server/_bundle/share/beebium/presets/model-b.preset.beebium

@@ -0,0 +1,5 @@
+{
+  "model": "model-b",
+  "name": "BBC Model B",
+  "release_date": "1981-12"
+}

beebium/server/_launch.py

@@ -0,0 +1,57 @@
+# Copyright 2026 Robert Smallshire <robert@smallshire.org.uk>
+#
+# This file is part of Beebium.
+#
+# Beebium is free software: you can redistribute it and/or modify it under the terms of the
+# GNU General Public License as published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version. Beebium is distributed in the hope that it will
+# be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# You should have received a copy of the GNU General Public License along with Beebium.
+# If not, see <https://www.gnu.org/licenses/>.
+
+"""Console-script entry points for the bundled server binaries.
+
+`pip install beebium-server` puts `beebium-model-b` (and the three other
+variants) on PATH. On POSIX each is a thin ``os.execv`` of the matching binary,
+so signals, exit code and stdout behave exactly as the bare binary. Windows has
+no exec that preserves console signal semantics -- ``os.execv`` there spawns a
+fresh process and mishandles Ctrl-C and the exit code for the shim -- so on
+Windows the server is run as a child and its exit code is propagated. Either
+way a client that needs precise signal delivery should launch the binary from
+beebium.server.executable_filepath() directly rather than through the shim.
+"""
+
+from __future__ import annotations
+
+import os
+import sys
+
+from beebium.server._paths import executable_filepath
+
+
+def _exec(variant: str) -> None:
+    filepath = executable_filepath(variant)
+    argv = [str(filepath), *sys.argv[1:]]
+    if sys.platform == "win32":
+        import subprocess
+
+        completed = subprocess.run(argv)
+        sys.exit(completed.returncode)
+    os.execv(str(filepath), argv)
+
+
+def model_b() -> None:
+    _exec("model-b")
+
+
+def model_b_plus() -> None:
+    _exec("model-b-plus")
+
+
+def model_b_plus_128k() -> None:
+    _exec("model-b-plus-128k")
+
+
+def model_b_romram() -> None:
+    _exec("model-b-romram")

beebium/server/_paths.py

@@ -0,0 +1,89 @@
+# Copyright 2026 Robert Smallshire <robert@smallshire.org.uk>
+#
+# This file is part of Beebium.
+#
+# Beebium is free software: you can redistribute it and/or modify it under the terms of the
+# GNU General Public License as published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version. Beebium is distributed in the hope that it will
+# be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# You should have received a copy of the GNU General Public License along with Beebium.
+# If not, see <https://www.gnu.org/licenses/>.
+
+"""Locate the server binaries and data shipped inside this wheel.
+
+The bundle under ``_bundle/`` is the release tarball laid out verbatim
+(``bin/ lib/ share/``), so the server's own relative discovery of ROMs, presets,
+extensions and ABI libraries works unchanged -- the binaries do not know they
+are inside a Python package.
+"""
+
+from __future__ import annotations
+
+import os
+import sys
+from pathlib import Path
+
+from beebium.server._version import __version__
+
+__all__ = [
+    "__version__",
+    "bundle_dirpath",
+    "executable_filepath",
+    "preset_dirpath",
+    "rom_dirpath",
+    "variants",
+]
+
+# The machine variants, as the suffix of the binary name (beebium-<variant>).
+# "model-b" is the default everywhere, matching the client.
+_VARIANTS = ("model-b", "model-b-plus", "model-b-plus-128k", "model-b-romram")
+
+
+def variants() -> tuple[str, ...]:
+    """The machine variants shipped in this wheel."""
+    return _VARIANTS
+
+
+def bundle_dirpath() -> Path:
+    """Path to the bundled install tree (its ``bin/ lib/ share/`` root)."""
+    return Path(__file__).resolve().parent / "_bundle"
+
+
+def _executable_name(variant: str) -> str:
+    name = f"beebium-{variant}"
+    if sys.platform == "win32":
+        name += ".exe"
+    return name
+
+
+def executable_filepath(variant: str = "model-b") -> Path:
+    """Path to a bundled server executable, ensured executable.
+
+    Zip entries carry Unix mode bits and pip preserves them, so the binary
+    normally arrives executable. As belt and braces this repairs a missing
+    execute bit (a one-time, idempotent chmod) for installers that drop it.
+
+    Raises:
+        ValueError: if ``variant`` is not one of ``variants()``.
+        FileNotFoundError: if the binary is missing from the bundle.
+    """
+    if variant not in _VARIANTS:
+        raise ValueError(f"unknown variant {variant!r}; expected one of {', '.join(_VARIANTS)}")
+    filepath = bundle_dirpath() / "bin" / _executable_name(variant)
+    if not filepath.exists():
+        raise FileNotFoundError(f"server binary not found in the bundle: {filepath}")
+    if sys.platform != "win32" and not os.access(filepath, os.X_OK):
+        mode = filepath.stat().st_mode
+        filepath.chmod(mode | 0o111)  # add execute for user/group/other
+    return filepath
+
+
+def rom_dirpath() -> Path:
+    """Path to the bundled ROM directory (``share/beebium/roms``)."""
+    return bundle_dirpath() / "share" / "beebium" / "roms"
+
+
+def preset_dirpath() -> Path:
+    """Path to the bundled preset directory (``share/beebium/presets``)."""
+    return bundle_dirpath() / "share" / "beebium" / "presets"

beebium/server/_version.py

@@ -0,0 +1,15 @@
+# Copyright 2026 Robert Smallshire <robert@smallshire.org.uk>
+#
+# This file is part of Beebium.
+#
+# Beebium is free software: you can redistribute it and/or modify it under the terms of the
+# GNU General Public License as published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version. Beebium is distributed in the hope that it will
+# be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# You should have received a copy of the GNU General Public License along with Beebium.
+# If not, see <https://www.gnu.org/licenses/>.
+
+"""Single source of truth for the beebium-server version (bumped by bump-my-version)."""
+
+__version__ = "0.1.5"