controller: VNC toggle, gated on the Desktop running

Add a VNC toggle to the Controller (both UIs) that starts/stops whichever VNC
backend is installed: wayvnc for Wayland (Raspberry Pi OS), RealVNC for X11.

Runtime-only, like the Desktop toggle: the unit is never enabled, so VNC does
not return after a reboot. Users who want it permanently on can enable it with
raspi-config.

VNC serves the desktop session, so starting it without a desktop gives clients
a blank screen. The gate lives in the backend, not just the UI, so curl callers
get it too (409, distinct from a systemctl failure). Stopping is never gated so
a running VNC server can't be stranded on with no way to turn it off.

Backend selection deliberately avoids raspi-config's live-compositor probe
(pgrep labwc), which reports X11 — and would pick the wrong backend — whenever
the desktop is stopped. wayvnc also requires its config to exist; that is
checked directly rather than via the unit's ConditionResult, which reports 'no'
for any unit that has never been started.

Extracts _unit_properties()/_systemctl_unit() so Desktop and VNC share one
systemd probe and start/stop path.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Roland 2026-07-29 16:53:45 -06:00 • committed by lrnselfreliance
parent a0fa03e6c5
commit 2328524ab2
14 changed files with 816 additions and 43 deletions

View file

@ -27,6 +27,8 @@ from controller.api.schemas import (
TimezoneSetRequest,
TimezoneSetResponse,
TimezoneStatusResponse,
VncActionResponse,
VncStatusResponse,
)
from controller.lib.admin import (
block_bluetooth,
@ -34,6 +36,7 @@ from controller.lib.admin import (
enable_throttle,
get_bluetooth_status_dict,
get_desktop_status_dict,
get_vnc_status_dict,
get_device_hotspot_protocols,
get_hotspot_device,
get_hotspot_password,
@ -49,8 +52,10 @@ from controller.lib.admin import (
shutdown_system,
start_desktop,
start_hotspot,
start_vnc,
stop_desktop,
stop_hotspot,
stop_vnc,
unblock_bluetooth,
update_hotspot_settings,
)
@ -180,6 +185,34 @@ async def desktop_stop() -> DesktopActionResponse:
return DesktopActionResponse(**result)
# --- VNC ---
@router.get("/api/vnc/status", response_model=VncStatusResponse)
async def vnc_status() -> VncStatusResponse:
"""Get VNC server status."""
return VncStatusResponse(**await get_vnc_status_dict())
@router.post("/api/vnc/start", response_model=VncActionResponse)
async def vnc_start() -> VncActionResponse:
"""Start the VNC server; requires a running desktop."""
result = await start_vnc()
if not result.get("success"):
# 409 distinguishes "the desktop is not running" from a systemctl failure.
status_code = 409 if result.get("precondition_failed") else 500
raise HTTPException(status_code=status_code, detail=result.get("error", "Failed"))
return VncActionResponse(success=True)
@router.post("/api/vnc/stop", response_model=VncActionResponse)
async def vnc_stop() -> VncActionResponse:
"""Stop the VNC server; allowed even when the desktop is stopped."""
result = await stop_vnc()
if not result.get("success"):
raise HTTPException(status_code=500, detail=result.get("error", "Failed"))
return VncActionResponse(success=True)
# --- Samba ---
@router.get("/api/samba/status", response_model=SambaStatusResponse)