OctoPrint-BitBang 0.2.6__tar.gz → 0.2.8__tar.gz

{octoprint_bitbang-0.2.6 → octoprint_bitbang-0.2.8/OctoPrint_BitBang.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OctoPrint-BitBang
-Version: 0.2.6
+Version: 0.2.8
 Summary: Remote OctoPrint access with live H.264 video via BitBang WebRTC
 Author-email: Rich LeGrand <rich.m.legrand@gmail.com>
 License-Expression: MIT
@@ -24,9 +24,6 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: bitbang>=0.1.53
-Requires-Dist: aiohttp>=3.8.0
-Requires-Dist: Pillow>=9.0.0
-Requires-Dist: numpy>=1.20.0
 Requires-Dist: aiortc<1.11
 Requires-Dist: av<12; platform_machine == "armv7l"
 Dynamic: license-file
@@ -118,12 +115,20 @@ All settings live in **Settings → BitBang**:
 | Setting | Effect |
 |---|---|
 | Enabled | Toggle BitBang remote access |
-| PIN | Optional 4+ digit PIN prompt on the remote URL |
+| PIN | **Required by default.** At least 4 characters; prompted on the remote URL. Remote access stays **off** until a PIN is set (or "Allow no PIN" is ticked). |
+| Allow no PIN | Expose remote access with no PIN (not recommended — anyone with the link can control the printer) |
 | Camera | Auto-detect, or select from dropdown list |
 | Resolution | VGA → HD (depending on what selected camera supports) |
 | Flip horizontal / vertical | Flip video if necessary |
 
-All settings take effect on OctoPrint restart. Full-screen button and brightness slider are overlaid on the video window (Control tab) and update immediately.
+Changes to the PIN and Enabled settings take effect immediately (no OctoPrint restart). Full-screen button and brightness slider are overlaid on the video window (Control tab) and update immediately.
+
+### Set a PIN (required)
+
+BitBang exposes a public link to your printer, so it is protected by a PIN. On
+first install a **setup wizard** prompts you to choose one — remote access does
+not start until you do (fail-closed). You can change it any time under
+**Settings → BitBang**.
 
 ## How it works
 

{octoprint_bitbang-0.2.6 → octoprint_bitbang-0.2.8}/OctoPrint_BitBang.egg-info/SOURCES.txt

@@ -28,4 +28,5 @@ octoprint_bitbang/static/favicon.png
 octoprint_bitbang/static/js/bitbang.js
 octoprint_bitbang/templates/bitbang_navbar.jinja2
 octoprint_bitbang/templates/bitbang_settings.jinja2
-octoprint_bitbang/templates/bitbang_webcam.jinja2
+octoprint_bitbang/templates/bitbang_webcam.jinja2
+octoprint_bitbang/templates/bitbang_wizard.jinja2

{octoprint_bitbang-0.2.6 → octoprint_bitbang-0.2.8}/OctoPrint_BitBang.egg-info/requires.txt

@@ -1,7 +1,4 @@
 bitbang>=0.1.53
-aiohttp>=3.8.0
-Pillow>=9.0.0
-numpy>=1.20.0
 aiortc<1.11
 
 [:platform_machine == "armv7l"]

{octoprint_bitbang-0.2.6/OctoPrint_BitBang.egg-info → octoprint_bitbang-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OctoPrint-BitBang
-Version: 0.2.6
+Version: 0.2.8
 Summary: Remote OctoPrint access with live H.264 video via BitBang WebRTC
 Author-email: Rich LeGrand <rich.m.legrand@gmail.com>
 License-Expression: MIT
@@ -24,9 +24,6 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: bitbang>=0.1.53
-Requires-Dist: aiohttp>=3.8.0
-Requires-Dist: Pillow>=9.0.0
-Requires-Dist: numpy>=1.20.0
 Requires-Dist: aiortc<1.11
 Requires-Dist: av<12; platform_machine == "armv7l"
 Dynamic: license-file
@@ -118,12 +115,20 @@ All settings live in **Settings → BitBang**:
 | Setting | Effect |
 |---|---|
 | Enabled | Toggle BitBang remote access |
-| PIN | Optional 4+ digit PIN prompt on the remote URL |
+| PIN | **Required by default.** At least 4 characters; prompted on the remote URL. Remote access stays **off** until a PIN is set (or "Allow no PIN" is ticked). |
+| Allow no PIN | Expose remote access with no PIN (not recommended — anyone with the link can control the printer) |
 | Camera | Auto-detect, or select from dropdown list |
 | Resolution | VGA → HD (depending on what selected camera supports) |
 | Flip horizontal / vertical | Flip video if necessary |
 
-All settings take effect on OctoPrint restart. Full-screen button and brightness slider are overlaid on the video window (Control tab) and update immediately.
+Changes to the PIN and Enabled settings take effect immediately (no OctoPrint restart). Full-screen button and brightness slider are overlaid on the video window (Control tab) and update immediately.
+
+### Set a PIN (required)
+
+BitBang exposes a public link to your printer, so it is protected by a PIN. On
+first install a **setup wizard** prompts you to choose one — remote access does
+not start until you do (fail-closed). You can change it any time under
+**Settings → BitBang**.
 
 ## How it works
 

{octoprint_bitbang-0.2.6 → octoprint_bitbang-0.2.8}/README.md

@@ -85,12 +85,20 @@ All settings live in **Settings → BitBang**:
 | Setting | Effect |
 |---|---|
 | Enabled | Toggle BitBang remote access |
-| PIN | Optional 4+ digit PIN prompt on the remote URL |
+| PIN | **Required by default.** At least 4 characters; prompted on the remote URL. Remote access stays **off** until a PIN is set (or "Allow no PIN" is ticked). |
+| Allow no PIN | Expose remote access with no PIN (not recommended — anyone with the link can control the printer) |
 | Camera | Auto-detect, or select from dropdown list |
 | Resolution | VGA → HD (depending on what selected camera supports) |
 | Flip horizontal / vertical | Flip video if necessary |
 
-All settings take effect on OctoPrint restart. Full-screen button and brightness slider are overlaid on the video window (Control tab) and update immediately.
+Changes to the PIN and Enabled settings take effect immediately (no OctoPrint restart). Full-screen button and brightness slider are overlaid on the video window (Control tab) and update immediately.
+
+### Set a PIN (required)
+
+BitBang exposes a public link to your printer, so it is protected by a PIN. On
+first install a **setup wizard** prompts you to choose one — remote access does
+not start until you do (fail-closed). You can change it any time under
+**Settings → BitBang**.
 
 ## How it works
 

{octoprint_bitbang-0.2.6 → octoprint_bitbang-0.2.8}/octoprint_bitbang/__init__.py

@@ -4,8 +4,15 @@ Remote OctoPrint access with live H.264 video via BitBang WebRTC.
 No account, no subscription, no port forwarding. One shareable link.
 """
 
+from importlib.metadata import PackageNotFoundError, version
+
 __plugin_name__ = "BitBang"
-__plugin_version__ = "0.2.6"
+try:
+    # Single source of truth: read the version from the installed package
+    # metadata (declared once in pyproject.toml) rather than duplicating it here.
+    __plugin_version__ = version("OctoPrint-BitBang")
+except PackageNotFoundError:  # running from a source checkout, not pip-installed
+    __plugin_version__ = "0.0.0+unknown"
 __plugin_description__ = "Remote OctoPrint access with live H.264 video via BitBang WebRTC. No account, no port forwarding, one shareable link."
 __plugin_url__ = "https://github.com/richlegrand/OctoPrint-BitBang"
 __plugin_author__ = "Rich LeGrand"

{octoprint_bitbang-0.2.6 → octoprint_bitbang-0.2.8}/octoprint_bitbang/_plugin.py

@@ -47,6 +47,12 @@ except ImportError as e:
     )
 
 
+# A PIN must be empty (remote access then gated/off) or at least this many
+# characters. Mirrored by the wizard/settings JS; enforced server-side in
+# on_settings_save as the authoritative backstop.
+MIN_PIN_LENGTH = 4
+
+
 class BitBangPlugin(
     octoprint.plugin.StartupPlugin,
     octoprint.plugin.ShutdownPlugin,
@@ -55,12 +61,14 @@ class BitBangPlugin(
     octoprint.plugin.AssetPlugin,
     octoprint.plugin.BlueprintPlugin,
     octoprint.plugin.WebcamProviderPlugin,
+    octoprint.plugin.WizardPlugin,
 ):
     def __init__(self):
         super().__init__()
         self._adapter = None
         self._thread = None
         self._local_pcs = set()  # track local WebRTC peer connections
+        self._running = False  # whether the remote-access proxy is live
 
     def on_shutdown(self):
         # Release the camera cleanly when OctoPrint shuts down via its own
@@ -93,8 +101,30 @@ class BitBangPlugin(
         if not self._settings.get_boolean(["enabled"]):
             self._logger.info("BitBang disabled in settings")
             return
+        if not self._remote_access_allowed():
+            self._logger.warning(
+                "BitBang: remote access NOT started — no PIN is set. Set a PIN "
+                "in the BitBang settings (or, advanced, explicitly allow running "
+                "without one) to enable remote access."
+            )
+            return
         self._start_bitbang()
 
+    def _remote_access_allowed(self):
+        """Secure-by-default gate. The public tunnel is only exposed when a
+        PIN protects it, or the user has explicitly opted into running without
+        one. An empty PIN with no opt-in means remote access stays OFF — this
+        is the enforcement behind the setup wizard (which merely prompts).
+
+        Without this, anyone holding the share URL reaches OctoPrint with no
+        BitBang-layer auth; for users who enabled OctoPrint's autologinLocal
+        that is a full remote takeover (see the X-Forwarded-For handling in
+        the Go proxy)."""
+        pin = (self._settings.get(["pin"]) or "").strip()
+        if pin:
+            return True
+        return self._settings.get_boolean(["allow_no_pin"])
+
     def _probe_picamera2_sensor(self):
         # Cache before the adapter opens the camera — picamera2 can't be
         # opened twice, so the resolutions endpoint relies on this.
@@ -201,11 +231,15 @@ class BitBangPlugin(
         self._settings.set(["url"], url)
         self._settings.save()
         self._logger.info(f"BitBang remote access: {url}")
+        # Push the URL to the frontend so the navbar reflects it live, instead
+        # of the browser polling the settings API.
+        self._plugin_manager.send_plugin_message(self._identifier, {"url": url})
 
         # Split-transport: a supervised Go proxy (data + HTTP/WS over native-SCTP
         # pion) owns the transport under our shared identity, and our camera
         # track is fed into a video PeerConnection over a socketpair relay.
         self._start_video_bridge()
+        self._running = True
 
     def _run_aiortc_loop(self):
         """Bare asyncio loop for aiortc. Replaces the adapter's own bitbang
@@ -331,6 +365,39 @@ class BitBangPlugin(
             time.sleep(backoff)
             backoff = min(backoff * 2, 30)
 
+    def _stop_bitbang(self):
+        """Tear down the remote-access proxy (Go subprocess supervisor +
+        aiortc loop + camera). Best-effort; each step is independently
+        guarded so a failure in one doesn't strand the others."""
+        self._running = False
+        # Tell the supervisor not to respawn, then kill the current proxy.
+        self._go_stop = True
+        proc = getattr(self, "_go_proc", None)
+        if proc is not None and proc.poll() is None:
+            try:
+                proc.terminate()
+            except Exception:
+                pass
+        # Release the camera.
+        try:
+            player = getattr(self._adapter, "player", None) if self._adapter else None
+            if player is not None:
+                player.stop()
+        except Exception as e:
+            self._logger.warning(f"BitBang: error stopping camera: {e}")
+        # Stop the aiortc event loop so its thread can exit.
+        try:
+            loop = getattr(self._adapter, "_loop", None) if self._adapter else None
+            if loop is not None and loop.is_running():
+                loop.call_soon_threadsafe(loop.stop)
+        except Exception:
+            pass
+        self._adapter = None
+        # Clear the persisted URL so the navbar doesn't show a dead link.
+        self._settings.set(["url"], "")
+        self._settings.save()
+        self._plugin_manager.send_plugin_message(self._identifier, {"url": ""})
+
     # -- Local WebRTC video signaling --
 
     @octoprint.plugin.BlueprintPlugin.route("/ice-servers", methods=["GET"])
@@ -753,6 +820,9 @@ class BitBangPlugin(
         return {
             "enabled": True,
             "pin": "",
+            # Explicit opt-in to expose remote access with NO PIN. Default
+            # False so a fresh install is gated until the wizard runs.
+            "allow_no_pin": False,
             "url": "",
             "camera_device": "",
             "camera_resolution": "640x480",
@@ -762,16 +832,99 @@ class BitBangPlugin(
             "signaling_server": "bitba.ng",
         }
 
+    def on_settings_save(self, data):
+        # Server-side PIN-policy backstop. The wizard/settings JS validates
+        # too, but this is authoritative: a non-empty PIN below the minimum
+        # length is rejected (the prior value is kept) rather than persisted.
+        if data.get("pin"):
+            pin = str(data["pin"]).strip()
+            if 0 < len(pin) < MIN_PIN_LENGTH:
+                self._logger.warning(
+                    "BitBang: rejected PIN shorter than %d characters",
+                    MIN_PIN_LENGTH,
+                )
+                data["pin"] = self._settings.get(["pin"])
+            else:
+                data["pin"] = pin
+
+        # Snapshot gate-relevant state, save, then reconcile if it changed so
+        # the wizard's "set a PIN" takes effect without an OctoPrint restart.
+        before = self._gate_state()
+        octoprint.plugin.SettingsPlugin.on_settings_save(self, data)
+        if self._gate_state() != before:
+            self._reconcile_remote_access()
+
+    def _gate_state(self):
+        """The tuple of settings that determines whether/how the proxy runs."""
+        return (
+            self._settings.get_boolean(["enabled"]),
+            (self._settings.get(["pin"]) or "").strip(),
+            self._settings.get_boolean(["allow_no_pin"]),
+        )
+
+    def _reconcile_remote_access(self):
+        """Bring the running proxy in line with current settings. Best-effort
+        and defensive: on any failure the user can still restart OctoPrint to
+        pick up the change (the prior behavior)."""
+        if _VIDEO_IMPORT_ERROR:
+            return  # video stack unavailable; nothing to start/stop
+        try:
+            should_run = self._settings.get_boolean(["enabled"]) and self._remote_access_allowed()
+            if should_run and not self._running:
+                self._logger.info("BitBang: remote access now permitted — starting")
+                self._start_bitbang()
+            elif not should_run and self._running:
+                self._logger.info("BitBang: remote access no longer permitted — stopping")
+                self._stop_bitbang()
+            elif should_run and self._running:
+                # Still running, but the PIN may have changed. The Go proxy
+                # reads -pin fresh on each spawn, so bouncing the subprocess
+                # (the supervisor respawns it) applies the new PIN.
+                self._logger.info("BitBang: PIN/config changed — restarting proxy")
+                self._restart_go_proxy()
+        except Exception as e:
+            self._logger.warning(
+                "BitBang: live reconcile failed (%s); restart OctoPrint to apply", e
+            )
+
+    def _restart_go_proxy(self):
+        """Bounce just the Go subprocess; the supervisor loop respawns it with
+        the current -pin. Falls back to a full restart if no proc is tracked."""
+        proc = getattr(self, "_go_proc", None)
+        if proc is not None and proc.poll() is None:
+            proc.terminate()
+        else:
+            self._stop_bitbang()
+            if self._settings.get_boolean(["enabled"]) and self._remote_access_allowed():
+                self._start_bitbang()
+
     def get_template_configs(self):
         return [
-            {"type": "settings", "custom_bindings": False},
-            {"type": "navbar", "custom_bindings": False},
+            {"type": "settings", "custom_bindings": True},
+            {"type": "navbar", "custom_bindings": True},
+            {"type": "wizard", "name": "BitBang", "template": "bitbang_wizard.jinja2"},
             # Render the live view as a proper webcam provider template so
             # OctoPrint shows it only when "BitBang Camera" is the selected
             # webcam -- no DOM-replacing the classic webcam.
             {"type": "webcam", "name": "BitBang Camera", "template": "bitbang_webcam.jinja2"},
         ]
 
+    # -- Setup wizard (secure-by-default PIN prompt) --
+
+    def is_wizard_required(self):
+        # Show the wizard whenever remote access would be enabled but is
+        # currently ungated (no PIN, no explicit opt-out). Covers fresh
+        # installs and existing no-PIN users on upgrade.
+        return self._settings.get_boolean(["enabled"]) and not self._remote_access_allowed()
+
+    def get_wizard_version(self):
+        # Bump to re-show the wizard to users who already cleared an older
+        # version (e.g. if the PIN policy changes again).
+        return 1
+
+    def get_wizard_details(self):
+        return {"required": self.is_wizard_required()}
+
     def get_template_vars(self):
         return {"plugin_version": __plugin_version__}
 

{octoprint_bitbang-0.2.6 → octoprint_bitbang-0.2.8}/octoprint_bitbang/static/js/bitbang.js

@@ -321,3 +321,133 @@
         }
     });
 })();
+
+/*
+ * Settings + navbar viewmodel.
+ *
+ * The navbar link and the camera/resolution dropdowns used to read plugin
+ * state via raw fetch('/api/settings') + manual DOM. This binds them through
+ * the standard settingsViewModel and Knockout instead: settings come from the
+ * settings observable, camera lists from the plugin's blueprint endpoints, and
+ * the live remote URL arrives via a plugin message (no polling).
+ */
+function BitBangViewModel(parameters) {
+    var self = this;
+    self.settings = parameters[0];
+
+    self.cameras = ko.observableArray([]);
+    self.resolutions = ko.observableArray([]);
+    self.remoteUrl = ko.observable("");
+
+    function bb() { return self.settings.settings.plugins.bitbang; }
+
+    self.loadResolutions = function (device) {
+        return OctoPrint.get(
+            "plugin/bitbang/resolutions?device=" + encodeURIComponent(device || "")
+        ).done(function (resolutions) {
+            self.resolutions(resolutions);
+            // Keep the saved resolution if it's still valid for this device,
+            // otherwise fall back to the first available.
+            if (resolutions.indexOf(bb().camera_resolution()) < 0) {
+                bb().camera_resolution(resolutions[0] || "");
+            }
+        });
+    };
+
+    self.loadCameras = function () {
+        return OctoPrint.get("plugin/bitbang/cameras").done(function (cameras) {
+            // Lead with an explicit auto-detect entry (value "") so the saved
+            // empty setting round-trips cleanly.
+            self.cameras([{ device: "", name: "Auto-detect" }].concat(cameras));
+            self.loadResolutions(bb().camera_device());
+        });
+    };
+
+    self.refreshCameras = function () { self.loadCameras(); };
+
+    self.showUrl = function () {
+        var url = self.remoteUrl();
+        if (url) {
+            window.prompt("BitBang URL (Ctrl+C to copy):", url);
+        } else {
+            alert("BitBang URL not available yet");
+        }
+    };
+
+    // Repopulate the dropdowns each time the settings dialog opens.
+    self.onSettingsShown = function () { self.loadCameras(); };
+
+    self.onStartupComplete = function () {
+        self.remoteUrl(bb().url() || "");
+        // Reload resolutions whenever the selected camera changes.
+        bb().camera_device.subscribe(function (device) {
+            self.loadResolutions(device);
+        });
+    };
+
+    // The plugin pushes the remote URL when BitBang connects, so the navbar
+    // reflects it live.
+    self.onDataUpdaterPluginMessage = function (plugin, data) {
+        if (plugin === "bitbang" && data && data.url !== undefined) {
+            self.remoteUrl(data.url);
+        }
+    };
+}
+
+OCTOPRINT_VIEWMODELS.push({
+    construct: BitBangViewModel,
+    dependencies: ["settingsViewModel"],
+    elements: ["#navbar_plugin_bitbang", "#settings_plugin_bitbang"]
+});
+
+/*
+ * Setup-wizard viewmodel. The wizard fields bind directly to the shared
+ * settings observables, so OctoPrint persists them on Finish (which then
+ * runs the server-side PIN-length backstop in on_settings_save). This VM
+ * only supplies live validation feedback for the PIN field.
+ */
+function BitBangWizardViewModel(parameters) {
+    var self = this;
+    self.settings = parameters[0];
+
+    function bb() {
+        var plugins = self.settings.settings.plugins;
+        return plugins && plugins.bitbang ? plugins.bitbang : null;
+    }
+
+    function pinOk() {
+        var b = bb();
+        if (!b) return true;
+        return b.allow_no_pin() || (b.pin() || "").trim().length >= 4;
+    }
+
+    self.pinTooShort = ko.pureComputed(function () {
+        var b = bb();
+        if (!b) return false;
+        var pin = (b.pin() || "").trim();
+        return pin.length > 0 && pin.length < 4;
+    });
+
+    // Set once the user tries to finish without a usable PIN. Drives the
+    // blocking message; clears reactively once they set a valid PIN or
+    // tick the no-PIN opt-out.
+    self.finishAttempted = ko.observable(false);
+    self.finishBlocked = ko.pureComputed(function () {
+        return self.finishAttempted() && !pinOk();
+    });
+
+    // Veto the wizard's Finish button unless a valid PIN is set (or the user
+    // explicitly opted out). Returning false keeps the dialog open — see
+    // OctoPrint wizard.js onBeforeWizardFinish.
+    self.onBeforeWizardFinish = function () {
+        if (pinOk()) return true;
+        self.finishAttempted(true);
+        return false;
+    };
+}
+
+OCTOPRINT_VIEWMODELS.push({
+    construct: BitBangWizardViewModel,
+    dependencies: ["settingsViewModel"],
+    elements: ["#wizard_plugin_bitbang"]
+});

octoprint_bitbang-0.2.8/octoprint_bitbang/templates/bitbang_navbar.jinja2

@@ -0,0 +1,4 @@
+<a href="javascript:void(0)" title="BitBang remote access"
+   data-bind="visible: settings.settings.plugins.bitbang.enabled, click: showUrl">
+    <i class="fas fa-link"></i> <span class="hidden-phone">BitBang</span>
+</a>

octoprint_bitbang-0.2.8/octoprint_bitbang/templates/bitbang_settings.jinja2

@@ -0,0 +1,110 @@
+<div id="settings_bitbang">
+    <h3>BitBang Remote Access</h3>
+
+    <form class="form-horizontal">
+        <div class="control-group">
+            <label class="control-label">Enabled</label>
+            <div class="controls">
+                <input type="checkbox" data-bind="checked: settings.settings.plugins.bitbang.enabled">
+            </div>
+        </div>
+
+        <div class="control-group">
+            <label class="control-label">PIN Protection</label>
+            <div class="controls">
+                <input type="text" class="input-medium"
+                       data-bind="value: settings.settings.plugins.bitbang.pin"
+                       placeholder="At least 4 characters">
+                <span class="help-inline">
+                    Protects remote access. At least 4 characters. Leave empty
+                    only if you tick &ldquo;allow no PIN&rdquo; below &mdash;
+                    otherwise remote access stays disabled.
+                </span>
+            </div>
+        </div>
+
+        <div class="control-group">
+            <div class="controls">
+                <label class="checkbox">
+                    <input type="checkbox"
+                           data-bind="checked: settings.settings.plugins.bitbang.allow_no_pin">
+                    Allow remote access without a PIN (not recommended)
+                </label>
+                <span class="help-block muted">
+                    Anyone who has the share link could control this printer.
+                </span>
+            </div>
+        </div>
+
+        <div class="control-group">
+            <label class="control-label">Remote URL</label>
+            <div class="controls">
+                <span data-bind="visible: settings.settings.plugins.bitbang.url()">
+                    <a data-bind="attr: {href: settings.settings.plugins.bitbang.url()}, text: settings.settings.plugins.bitbang.url()"
+                       target="_blank" rel="noopener"></a>
+                </span>
+                <span data-bind="visible: !settings.settings.plugins.bitbang.url()" class="muted">
+                    URL will appear after BitBang connects
+                </span>
+                <span class="help-inline">Share this link for remote access</span>
+            </div>
+        </div>
+
+        <h3>Camera</h3>
+
+        <div class="control-group">
+            <label class="control-label">Camera</label>
+            <div class="controls">
+                <select class="input-xlarge"
+                        data-bind="options: cameras,
+                                   optionsText: function(c) { return c.device ? c.name + ' (' + c.device + ')' : c.name; },
+                                   optionsValue: 'device',
+                                   value: settings.settings.plugins.bitbang.camera_device,
+                                   valueAllowUnset: true"></select>
+                <button class="btn btn-mini" type="button" data-bind="click: refreshCameras" title="Refresh camera list">
+                    <i class="fas fa-sync"></i>
+                </button>
+            </div>
+        </div>
+
+        <div class="control-group">
+            <label class="control-label">Resolution</label>
+            <div class="controls">
+                <select class="input-medium"
+                        data-bind="options: resolutions,
+                                   value: settings.settings.plugins.bitbang.camera_resolution,
+                                   valueAllowUnset: true"></select>
+            </div>
+        </div>
+
+        <div class="control-group">
+            <label class="control-label">Image orientation</label>
+            <div class="controls">
+                <label class="checkbox inline">
+                    <input type="checkbox" data-bind="checked: settings.settings.plugins.bitbang.flip_horizontal">
+                    Flip horizontal
+                </label>
+                <label class="checkbox inline">
+                    <input type="checkbox" data-bind="checked: settings.settings.plugins.bitbang.flip_vertical">
+                    Flip vertical
+                </label>
+            </div>
+        </div>
+
+        <h3>Advanced</h3>
+
+        <div class="control-group">
+            <label class="control-label">Signaling server</label>
+            <div class="controls">
+                <input type="text" class="input-xlarge"
+                       data-bind="value: settings.settings.plugins.bitbang.signaling_server">
+                <span class="help-inline">Default <code>bitba.ng</code>. To use your own <a href="https://github.com/richlegrand/bitbang-server" target="_blank" rel="noopener">bitbang-server</a>, replace with the hostname (e.g. <code>signaling.example.com</code>).</span>
+            </div>
+        </div>
+    </form>
+
+    <div class="alert alert-info" style="margin-top: 16px;">
+        <i class="fas fa-info-circle"></i>
+        <strong>Restart OctoPrint</strong> after changing settings for them to take effect.
+    </div>
+</div>

octoprint_bitbang-0.2.8/octoprint_bitbang/templates/bitbang_wizard.jinja2

@@ -0,0 +1,47 @@
+<div id="wizard_plugin_bitbang">
+    <h3>Secure your BitBang remote access</h3>
+    <p>
+        BitBang gives this OctoPrint a private link you can use to reach it from
+        anywhere. Protect that link with a PIN so only you can connect &mdash; we
+        recommend at least {{ 4 }} characters.
+    </p>
+
+    <form class="form-horizontal">
+        <div class="control-group">
+            <label class="control-label">PIN</label>
+            <div class="controls">
+                <input type="text" class="input-medium"
+                       data-bind="value: settings.settings.plugins.bitbang.pin, valueUpdate: 'afterkeydown'"
+                       placeholder="At least 4 characters">
+                <span class="help-inline" style="color: #b94a48;"
+                      data-bind="visible: pinTooShort">
+                    PIN must be at least 4 characters.
+                </span>
+            </div>
+        </div>
+
+        <div class="control-group">
+            <div class="controls">
+                <label class="checkbox">
+                    <input type="checkbox"
+                           data-bind="checked: settings.settings.plugins.bitbang.allow_no_pin">
+                    Advanced: run without a PIN
+                </label>
+                <span class="help-block muted">
+                    Not recommended &mdash; anyone who has the link could control
+                    this printer.
+                </span>
+            </div>
+        </div>
+    </form>
+
+    <p class="muted">
+        Until you set a PIN (or tick the box above), BitBang remote access stays
+        disabled.
+    </p>
+
+    <div class="alert alert-error" data-bind="visible: finishBlocked" style="display: none;">
+        Set a PIN of at least 4 characters, or tick &ldquo;run without a
+        PIN&rdquo; above, before finishing.
+    </div>
+</div>

{octoprint_bitbang-0.2.6 → octoprint_bitbang-0.2.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "OctoPrint-BitBang"
-version = "0.2.6"
+version = "0.2.8"
 description = "Remote OctoPrint access with live H.264 video via BitBang WebRTC"
 readme = "README.md"
 license = "MIT"
@@ -27,9 +27,6 @@ classifiers = [
 ]
 dependencies = [
     "bitbang>=0.1.53",
-    "aiohttp>=3.8.0",
-    "Pillow>=9.0.0",
-    "numpy>=1.20.0",
     # aiortc/av come transitively via bitbang. aiortc<1.11 already caps av<14.
     # 32-bit (armv7l) has NO PyAV wheels at any in-range version, so av builds
     # from source against the system FFmpeg (Bookworm 5.1); av<12 lands it on the

{octoprint_bitbang-0.2.6 → octoprint_bitbang-0.2.8}/setup.py

@@ -1,2 +1,2 @@
 from setuptools import setup
-setup()
+setup(license="MIT")

octoprint_bitbang-0.2.6/octoprint_bitbang/templates/bitbang_navbar.jinja2

@@ -1,29 +0,0 @@
-<a id="bitbang_navbar_link" href="javascript:void(0)" title="BitBang remote access" style="display:none" onclick="
-    fetch('/api/settings')
-        .then(function(r) { return r.json(); })
-        .then(function(data) {
-            var url = data.plugins && data.plugins.bitbang && data.plugins.bitbang.url;
-            if (url) {
-                prompt('BitBang URL (Ctrl+C to copy):', url);
-            } else {
-                alert('BitBang URL not available yet');
-            }
-        })
-        .catch(function() { alert('Could not load settings'); });
-">
-    <i id="bitbang_navbar_icon" class="fas fa-link"></i> <span class="hidden-phone">BitBang</span>
-</a>
-<script>
-(function () {
-    fetch('/api/settings')
-        .then(function (r) { return r.json(); })
-        .then(function (data) {
-            var enabled = data.plugins && data.plugins.bitbang && data.plugins.bitbang.enabled;
-            if (enabled) {
-                var link = document.getElementById('bitbang_navbar_link');
-                if (link) link.style.display = '';
-            }
-        })
-        .catch(function () {});
-})();
-</script>

octoprint_bitbang-0.2.6/octoprint_bitbang/templates/bitbang_settings.jinja2

@@ -1,169 +0,0 @@
-<div id="settings_bitbang">
-    <h3>BitBang Remote Access</h3>
-
-    <form class="form-horizontal">
-        <div class="control-group">
-            <label class="control-label">Enabled</label>
-            <div class="controls">
-                <input type="checkbox" data-bind="checked: settings.plugins.bitbang.enabled">
-            </div>
-        </div>
-
-        <div class="control-group">
-            <label class="control-label">PIN Protection</label>
-            <div class="controls">
-                <input type="text" class="input-medium"
-                       data-bind="value: settings.plugins.bitbang.pin"
-                       placeholder="Empty to disable">
-                <span class="help-inline">Optional PIN to protect remote access</span>
-            </div>
-        </div>
-
-        <div class="control-group">
-            <label class="control-label">Remote URL</label>
-            <div class="controls">
-                <span data-bind="visible: settings.plugins.bitbang.url()">
-                    <a data-bind="attr: {href: settings.plugins.bitbang.url()}, text: settings.plugins.bitbang.url()"
-                       target="_blank" rel="noopener"></a>
-                </span>
-                <span data-bind="visible: !settings.plugins.bitbang.url()" class="muted">
-                    URL will appear after BitBang connects
-                </span>
-                <span class="help-inline">Share this link for remote access</span>
-            </div>
-        </div>
-
-        <h3>Camera</h3>
-
-        <div class="control-group">
-            <label class="control-label">Camera</label>
-            <div class="controls">
-                <select id="bitbang_camera_select" class="input-xlarge"
-                        data-bind="value: settings.plugins.bitbang.camera_device, valueAllowUnset: true">
-                    <option value="">Auto-detect</option>
-                </select>
-                <button class="btn btn-mini" id="bitbang_refresh_cameras" type="button">
-                    <i class="fas fa-sync"></i>
-                </button>
-            </div>
-        </div>
-
-        <div class="control-group">
-            <label class="control-label">Resolution</label>
-            <div class="controls">
-                <select id="bitbang_resolution_select" class="input-medium"
-                        data-bind="value: settings.plugins.bitbang.camera_resolution, valueAllowUnset: true">
-                    <option value="640x480">640x480</option>
-                </select>
-            </div>
-        </div>
-
-        <div class="control-group">
-            <label class="control-label">Image orientation</label>
-            <div class="controls">
-                <label class="checkbox inline">
-                    <input type="checkbox" data-bind="checked: settings.plugins.bitbang.flip_horizontal">
-                    Flip horizontal
-                </label>
-                <label class="checkbox inline">
-                    <input type="checkbox" data-bind="checked: settings.plugins.bitbang.flip_vertical">
-                    Flip vertical
-                </label>
-            </div>
-        </div>
-
-        <h3>Advanced</h3>
-
-        <div class="control-group">
-            <label class="control-label">Signaling server</label>
-            <div class="controls">
-                <input type="text" class="input-xlarge"
-                       data-bind="value: settings.plugins.bitbang.signaling_server">
-                <span class="help-inline">Default <code>bitba.ng</code>. To use your own <a href="https://github.com/richlegrand/bitbang-server" target="_blank" rel="noopener">bitbang-server</a>, replace with the hostname (e.g. <code>signaling.example.com</code>).</span>
-            </div>
-        </div>
-    </form>
-
-    <div class="alert alert-info" style="margin-top: 16px;">
-        <i class="fas fa-info-circle"></i>
-        <strong>Restart OctoPrint</strong> after changing settings for them to take effect.
-    </div>
-</div>
-
-<script>
-(function () {
-    var cameraSelect = document.getElementById("bitbang_camera_select");
-    var resolutionSelect = document.getElementById("bitbang_resolution_select");
-    var refreshBtn = document.getElementById("bitbang_refresh_cameras");
-    if (!cameraSelect || !resolutionSelect) return;
-
-    // Set a <select> and notify Knockout's value binding — it doesn't see
-    // options added via raw DOM, so without the dispatched 'change' the
-    // observable (and thus the saved setting) won't follow the selection.
-    // Suppress the camera change handler during programmatic sets so we don't
-    // reload resolutions twice.
-    function setSelect(sel, value) {
-        var ok = value && Array.prototype.some.call(
-            sel.options, function (o) { return o.value === value; });
-        sel._suppress = true;
-        if (ok) sel.value = value;
-        sel.dispatchEvent(new Event("change"));
-        sel._suppress = false;
-    }
-
-    function loadResolutions(device, wanted) {
-        return fetch("/plugin/bitbang/resolutions?device=" + encodeURIComponent(device || ""))
-            .then(function (r) { return r.json(); })
-            .then(function (resolutions) {
-                resolutionSelect.innerHTML = "";
-                resolutions.forEach(function (res) {
-                    var opt = document.createElement("option");
-                    opt.value = res;
-                    opt.textContent = res;
-                    resolutionSelect.appendChild(opt);
-                });
-                setSelect(resolutionSelect,
-                          resolutions.indexOf(wanted) >= 0 ? wanted : resolutions[0]);
-            })
-            .catch(function () {});
-    }
-
-    function loadCameras(wantedCamera, wantedRes) {
-        return fetch("/plugin/bitbang/cameras")
-            .then(function (r) { return r.json(); })
-            .then(function (cameras) {
-                while (cameraSelect.options.length > 1) cameraSelect.remove(1);
-                cameras.forEach(function (cam) {
-                    var opt = document.createElement("option");
-                    opt.value = cam.device;
-                    opt.textContent = cam.name + " (" + cam.device + ")";
-                    cameraSelect.appendChild(opt);
-                });
-                setSelect(cameraSelect, wantedCamera);
-                return loadResolutions(cameraSelect.value, wantedRes);
-            })
-            .catch(function () {});
-    }
-
-    cameraSelect.addEventListener("change", function () {
-        if (cameraSelect._suppress) return;   // programmatic set — skip reload
-        loadResolutions(cameraSelect.value, resolutionSelect.value);
-    });
-
-    if (refreshBtn) {
-        refreshBtn.addEventListener("click", function () {
-            loadCameras(cameraSelect.value, resolutionSelect.value);
-        });
-    }
-
-    // Populate from the SAVED config — not the (Knockout-clobbered) DOM value —
-    // so the dropdowns reflect what's persisted and a Save round-trips cleanly.
-    fetch("/api/settings")
-        .then(function (r) { return r.json(); })
-        .then(function (s) {
-            var bb = (s.plugins && s.plugins.bitbang) || {};
-            loadCameras(bb.camera_device || "", bb.camera_resolution || "");
-        })
-        .catch(function () { loadCameras("", ""); });
-})();
-</script>