Files
bambuddy/backend/app/api/routes/spoolbuddy.py
T
maziggy cf2203914d [Feature] SpoolBuddy OTA updates via Bambuddy UI
SpoolBuddy devices can now be updated from Settings → Updates without
  SSH access. The daemon picks up an "update" command via its existing
  heartbeat, runs git fetch/reset + pip install, reports progress back
  to the backend, then exits for systemd to restart with the new code.

  Backend: update_status/update_message fields, trigger + status endpoints
  Daemon: _perform_update() handler, report_update_status() API method
  Frontend: "Apply Update" button with live progress in UpdatesTab
2026-03-22 12:40:25 +01:00

741 lines
25 KiB
Python

"""SpoolBuddy device management API routes."""
import logging
from datetime import datetime, timedelta, timezone
from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession
from backend.app.core.auth import RequirePermissionIfAuthEnabled
from backend.app.core.database import get_db
from backend.app.core.permissions import Permission
from backend.app.core.websocket import ws_manager
from backend.app.models.spoolbuddy_device import SpoolBuddyDevice
from backend.app.models.user import User
from backend.app.schemas.spoolbuddy import (
CalibrationResponse,
DeviceRegisterRequest,
DeviceResponse,
DisplaySettingsRequest,
HeartbeatRequest,
HeartbeatResponse,
ScaleReadingRequest,
SetCalibrationFactorRequest,
SetTareRequest,
TagRemovedRequest,
TagScannedRequest,
UpdateSpoolWeightRequest,
WriteTagRequest,
WriteTagResultRequest,
)
from backend.app.services.spool_tag_matcher import get_spool_by_tag
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/spoolbuddy", tags=["spoolbuddy"])
OFFLINE_THRESHOLD_SECONDS = 30
def _is_online(device: SpoolBuddyDevice) -> bool:
if not device.last_seen:
return False
return (
datetime.now(timezone.utc) - device.last_seen.replace(tzinfo=timezone.utc)
).total_seconds() < OFFLINE_THRESHOLD_SECONDS
def _device_to_response(device: SpoolBuddyDevice) -> DeviceResponse:
return DeviceResponse(
id=device.id,
device_id=device.device_id,
hostname=device.hostname,
ip_address=device.ip_address,
firmware_version=device.firmware_version,
has_nfc=device.has_nfc,
has_scale=device.has_scale,
tare_offset=device.tare_offset,
calibration_factor=device.calibration_factor,
nfc_reader_type=device.nfc_reader_type,
nfc_connection=device.nfc_connection,
display_brightness=device.display_brightness,
display_blank_timeout=device.display_blank_timeout,
has_backlight=device.has_backlight,
last_calibrated_at=device.last_calibrated_at,
last_seen=device.last_seen,
pending_command=device.pending_command,
nfc_ok=device.nfc_ok,
scale_ok=device.scale_ok,
uptime_s=device.uptime_s,
update_status=device.update_status,
update_message=device.update_message,
online=_is_online(device),
created_at=device.created_at,
updated_at=device.updated_at,
)
# --- Device endpoints ---
@router.post("/devices/register", response_model=DeviceResponse)
async def register_device(
req: DeviceRegisterRequest,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""Register or re-register a SpoolBuddy device."""
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == req.device_id))
device = result.scalar_one_or_none()
now = datetime.now(timezone.utc)
if device:
device.hostname = req.hostname
device.ip_address = req.ip_address
device.firmware_version = req.firmware_version
device.has_nfc = req.has_nfc
device.has_scale = req.has_scale
device.nfc_reader_type = req.nfc_reader_type
device.nfc_connection = req.nfc_connection
device.has_backlight = req.has_backlight
device.last_seen = now
logger.info("SpoolBuddy device re-registered: %s (%s)", req.device_id, req.hostname)
else:
device = SpoolBuddyDevice(
device_id=req.device_id,
hostname=req.hostname,
ip_address=req.ip_address,
firmware_version=req.firmware_version,
has_nfc=req.has_nfc,
has_scale=req.has_scale,
tare_offset=req.tare_offset,
calibration_factor=req.calibration_factor,
nfc_reader_type=req.nfc_reader_type,
nfc_connection=req.nfc_connection,
has_backlight=req.has_backlight,
last_seen=now,
)
db.add(device)
logger.info("SpoolBuddy device registered: %s (%s)", req.device_id, req.hostname)
await db.commit()
await db.refresh(device)
await ws_manager.broadcast(
{
"type": "spoolbuddy_online",
"device_id": device.device_id,
"hostname": device.hostname,
}
)
return _device_to_response(device)
@router.get("/devices", response_model=list[DeviceResponse])
async def list_devices(
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_READ),
):
"""List all registered SpoolBuddy devices."""
result = await db.execute(select(SpoolBuddyDevice).order_by(SpoolBuddyDevice.hostname))
devices = list(result.scalars().all())
return [_device_to_response(d) for d in devices]
@router.post("/devices/{device_id}/heartbeat", response_model=HeartbeatResponse)
async def device_heartbeat(
device_id: str,
req: HeartbeatRequest,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""Daemon heartbeat — updates status and returns pending commands."""
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == device_id))
device = result.scalar_one_or_none()
if not device:
raise HTTPException(status_code=404, detail="Device not registered")
was_offline = not _is_online(device)
now = datetime.now(timezone.utc)
device.last_seen = now
device.nfc_ok = req.nfc_ok
device.scale_ok = req.scale_ok
device.uptime_s = req.uptime_s
if req.firmware_version:
device.firmware_version = req.firmware_version
if req.ip_address:
device.ip_address = req.ip_address
if req.nfc_reader_type:
device.nfc_reader_type = req.nfc_reader_type
if req.nfc_connection:
device.nfc_connection = req.nfc_connection
# Return and clear pending command
pending = device.pending_command
pending_write = None
if pending == "write_tag" and device.pending_write_payload:
# Parse the stored JSON payload to include in response
import json
try:
pending_write = json.loads(device.pending_write_payload)
except (json.JSONDecodeError, TypeError):
pending_write = None
# Don't clear write_tag command — it gets cleared by write-result
else:
device.pending_command = None
await db.commit()
if was_offline:
await ws_manager.broadcast(
{
"type": "spoolbuddy_online",
"device_id": device.device_id,
"hostname": device.hostname,
}
)
return HeartbeatResponse(
pending_command=pending,
pending_write_payload=pending_write,
tare_offset=device.tare_offset,
calibration_factor=device.calibration_factor,
display_brightness=device.display_brightness,
display_blank_timeout=device.display_blank_timeout,
)
# --- NFC endpoints ---
@router.post("/nfc/tag-scanned")
async def nfc_tag_scanned(
req: TagScannedRequest,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""RPi reports NFC tag detected — lookup spool and broadcast."""
spool = await get_spool_by_tag(db, req.tag_uid, req.tray_uuid or "")
if spool:
await ws_manager.broadcast(
{
"type": "spoolbuddy_tag_matched",
"device_id": req.device_id,
"tag_uid": req.tag_uid,
"spool": {
"id": spool.id,
"material": spool.material,
"subtype": spool.subtype,
"color_name": spool.color_name,
"rgba": spool.rgba,
"brand": spool.brand,
"label_weight": spool.label_weight,
"core_weight": spool.core_weight,
"weight_used": spool.weight_used,
},
}
)
logger.info("SpoolBuddy tag matched: %s -> spool %d", req.tag_uid, spool.id)
else:
await ws_manager.broadcast(
{
"type": "spoolbuddy_unknown_tag",
"device_id": req.device_id,
"tag_uid": req.tag_uid,
"sak": req.sak,
"tag_type": req.tag_type,
}
)
logger.info("SpoolBuddy unknown tag: %s", req.tag_uid)
return {"status": "ok", "matched": spool is not None, "spool_id": spool.id if spool else None}
@router.post("/nfc/tag-removed")
async def nfc_tag_removed(
req: TagRemovedRequest,
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""RPi reports NFC tag removed — broadcast event."""
await ws_manager.broadcast(
{
"type": "spoolbuddy_tag_removed",
"device_id": req.device_id,
"tag_uid": req.tag_uid,
}
)
return {"status": "ok"}
@router.post("/nfc/write-tag")
async def nfc_write_tag(
req: WriteTagRequest,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""Queue an NFC tag write command for a SpoolBuddy device."""
import json
from backend.app.models.spool import Spool
from backend.app.services.opentag3d import encode_opentag3d
# Find the spool
result = await db.execute(select(Spool).where(Spool.id == req.spool_id))
spool = result.scalar_one_or_none()
if not spool:
raise HTTPException(status_code=404, detail="Spool not found")
# Find the device
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == req.device_id))
device = result.scalar_one_or_none()
if not device:
raise HTTPException(status_code=404, detail="Device not registered")
# Encode OpenTag3D NDEF data
ndef_data = encode_opentag3d(spool)
# Store write payload and set pending command
device.pending_write_payload = json.dumps(
{
"spool_id": spool.id,
"ndef_data_hex": ndef_data.hex(),
}
)
device.pending_command = "write_tag"
await db.commit()
logger.info("Write tag queued for device %s, spool %d (%d bytes)", req.device_id, spool.id, len(ndef_data))
return {"status": "queued"}
@router.post("/nfc/write-result")
async def nfc_write_result(
req: WriteTagResultRequest,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""Handle NFC tag write result from SpoolBuddy daemon."""
# Find the device and clear pending state
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == req.device_id))
device = result.scalar_one_or_none()
if not device:
raise HTTPException(status_code=404, detail="Device not registered")
device.pending_command = None
device.pending_write_payload = None
if req.success:
# Link the tag to the spool
from backend.app.models.spool import Spool
result = await db.execute(select(Spool).where(Spool.id == req.spool_id))
spool = result.scalar_one_or_none()
if spool:
spool.tag_uid = req.tag_uid.upper()
spool.tag_type = "ntag"
spool.data_origin = "opentag3d"
spool.encode_time = datetime.now(timezone.utc)
logger.info("Tag written and linked: spool %d -> tag %s", spool.id, req.tag_uid)
await db.commit()
await ws_manager.broadcast(
{
"type": "spoolbuddy_tag_written",
"device_id": req.device_id,
"spool_id": req.spool_id,
"tag_uid": req.tag_uid,
}
)
else:
await db.commit()
await ws_manager.broadcast(
{
"type": "spoolbuddy_tag_write_failed",
"device_id": req.device_id,
"spool_id": req.spool_id,
"message": req.message,
}
)
logger.warning("Tag write failed for device %s: %s", req.device_id, req.message)
return {"status": "ok"}
@router.post("/devices/{device_id}/cancel-write")
async def cancel_write(
device_id: str,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""Cancel a pending write-tag command."""
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == device_id))
device = result.scalar_one_or_none()
if not device:
raise HTTPException(status_code=404, detail="Device not registered")
if device.pending_command == "write_tag":
device.pending_command = None
device.pending_write_payload = None
await db.commit()
logger.info("Write tag cancelled for device %s", device_id)
return {"status": "ok"}
# --- Scale endpoints ---
@router.post("/scale/reading")
async def scale_reading(
req: ScaleReadingRequest,
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""RPi reports scale weight — broadcast to all clients."""
await ws_manager.broadcast(
{
"type": "spoolbuddy_weight",
"device_id": req.device_id,
"weight_grams": req.weight_grams,
"stable": req.stable,
"raw_adc": req.raw_adc,
}
)
return {"status": "ok"}
@router.post("/scale/update-spool-weight")
async def update_spool_weight(
req: UpdateSpoolWeightRequest,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""Update spool's used weight from scale reading."""
from backend.app.models.spool import Spool
result = await db.execute(select(Spool).where(Spool.id == req.spool_id))
spool = result.scalar_one_or_none()
if not spool:
raise HTTPException(status_code=404, detail="Spool not found")
# net weight = total on scale minus empty spool core
net_filament = max(0, req.weight_grams - spool.core_weight)
spool.weight_used = max(0, spool.label_weight - net_filament)
spool.last_scale_weight = req.weight_grams
spool.last_weighed_at = datetime.now(timezone.utc)
await db.commit()
logger.info(
"SpoolBuddy updated spool %d weight: %.1fg on scale, %.1fg used",
spool.id,
req.weight_grams,
spool.weight_used,
)
return {"status": "ok", "weight_used": spool.weight_used}
# --- Calibration endpoints ---
@router.post("/devices/{device_id}/calibration/tare")
async def tare_scale(
device_id: str,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""Set pending tare command for the device to pick up."""
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == device_id))
device = result.scalar_one_or_none()
if not device:
raise HTTPException(status_code=404, detail="Device not registered")
device.pending_command = "tare"
await db.commit()
return {"status": "ok", "message": "Tare command queued"}
@router.post("/devices/{device_id}/calibration/set-tare")
async def set_tare_offset(
device_id: str,
req: SetTareRequest,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""Store tare offset reported by the daemon after executing a tare."""
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == device_id))
device = result.scalar_one_or_none()
if not device:
raise HTTPException(status_code=404, detail="Device not registered")
device.tare_offset = req.tare_offset
device.last_calibrated_at = datetime.now(timezone.utc)
await db.commit()
logger.info("SpoolBuddy %s tare offset set to %d", device_id, req.tare_offset)
return CalibrationResponse(
tare_offset=device.tare_offset,
calibration_factor=device.calibration_factor,
)
@router.post("/devices/{device_id}/calibration/set-factor")
async def set_calibration_factor(
device_id: str,
req: SetCalibrationFactorRequest,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""Calculate and store calibration factor from a known weight."""
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == device_id))
device = result.scalar_one_or_none()
if not device:
raise HTTPException(status_code=404, detail="Device not registered")
tare = req.tare_raw_adc if req.tare_raw_adc is not None else device.tare_offset
raw_delta = req.raw_adc - tare
if raw_delta == 0:
raise HTTPException(status_code=400, detail="Raw ADC value equals tare offset — place weight on scale")
device.calibration_factor = req.known_weight_grams / raw_delta
if req.tare_raw_adc is not None:
device.tare_offset = tare
device.last_calibrated_at = datetime.now(timezone.utc)
await db.commit()
logger.info(
"SpoolBuddy %s calibration factor set to %.6f (known=%.1fg, raw=%d, tare=%d)",
device_id,
device.calibration_factor,
req.known_weight_grams,
req.raw_adc,
tare,
)
return CalibrationResponse(
tare_offset=device.tare_offset,
calibration_factor=device.calibration_factor,
)
@router.get("/devices/{device_id}/calibration", response_model=CalibrationResponse)
async def get_calibration(
device_id: str,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_READ),
):
"""Get current calibration values for a device."""
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == device_id))
device = result.scalar_one_or_none()
if not device:
raise HTTPException(status_code=404, detail="Device not registered")
return CalibrationResponse(
tare_offset=device.tare_offset,
calibration_factor=device.calibration_factor,
)
# --- Display settings ---
@router.put("/devices/{device_id}/display")
async def update_display_settings(
device_id: str,
req: DisplaySettingsRequest,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""Update display brightness and screen blank timeout for a device."""
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == device_id))
device = result.scalar_one_or_none()
if not device:
raise HTTPException(status_code=404, detail="Device not registered")
device.display_brightness = req.brightness
device.display_blank_timeout = req.blank_timeout
await db.commit()
logger.info(
"SpoolBuddy %s display updated: brightness=%d%%, blank_timeout=%ds",
device_id,
req.brightness,
req.blank_timeout,
)
return {"status": "ok", "brightness": req.brightness, "blank_timeout": req.blank_timeout}
# --- Update check ---
@router.get("/devices/{device_id}/update-check")
async def check_daemon_update(
device_id: str,
include_beta: bool = False,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_READ),
):
"""Check if a newer daemon version is available on GitHub."""
import httpx
from backend.app.api.routes.updates import is_newer_version, parse_version
from backend.app.core.config import GITHUB_REPO
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == device_id))
device = result.scalar_one_or_none()
if not device:
raise HTTPException(status_code=404, detail="Device not registered")
current = device.firmware_version or "0.0.0"
try:
async with httpx.AsyncClient() as client:
response = await client.get(
f"https://api.github.com/repos/{GITHUB_REPO}/releases?per_page=20",
headers={"Accept": "application/vnd.github.v3+json"},
timeout=10.0,
)
response.raise_for_status()
releases = response.json()
release_data = None
for release in releases:
tag = release.get("tag_name", "")
if include_beta:
release_data = release
break
else:
parsed = parse_version(tag)
if parsed[4] == 0: # is_prerelease == 0
release_data = release
break
if not release_data:
return {
"current_version": current,
"latest_version": None,
"update_available": False,
"release_url": None,
}
latest = release_data.get("tag_name", "").lstrip("v")
return {
"current_version": current,
"latest_version": latest,
"update_available": is_newer_version(latest, current),
"release_url": release_data.get("html_url"),
}
except Exception as e:
logger.warning("Failed to check for daemon updates: %s", e)
return {
"current_version": current,
"latest_version": None,
"update_available": False,
"release_url": None,
"error": str(e),
}
@router.post("/devices/{device_id}/update")
async def trigger_daemon_update(
device_id: str,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.SETTINGS_UPDATE),
):
"""Trigger a daemon update on the SpoolBuddy device via pending_command."""
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == device_id))
device = result.scalar_one_or_none()
if not device:
raise HTTPException(status_code=404, detail="Device not registered")
if not _is_online(device):
raise HTTPException(status_code=409, detail="Device is offline")
if device.update_status == "updating":
return {"status": "already_updating", "message": "Update already in progress"}
device.pending_command = "update"
device.update_status = "pending"
device.update_message = "Waiting for device to pick up update command..."
await db.commit()
logger.info("SpoolBuddy %s: update command queued", device_id)
await ws_manager.broadcast(
{
"type": "spoolbuddy_update",
"device_id": device_id,
"update_status": "pending",
}
)
return {"status": "ok", "message": "Update command sent to device"}
@router.post("/devices/{device_id}/update-status")
async def report_update_status(
device_id: str,
req: dict,
db: AsyncSession = Depends(get_db),
_: User | None = RequirePermissionIfAuthEnabled(Permission.INVENTORY_UPDATE),
):
"""Daemon reports update progress back to the backend."""
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.device_id == device_id))
device = result.scalar_one_or_none()
if not device:
raise HTTPException(status_code=404, detail="Device not registered")
status = req.get("status", "")
message = req.get("message", "")
if status in ("updating", "complete", "error"):
device.update_status = status
device.update_message = message[:255] if message else None
if status == "complete":
device.pending_command = None
await db.commit()
logger.info("SpoolBuddy %s: update status=%s msg=%s", device_id, status, message)
await ws_manager.broadcast(
{
"type": "spoolbuddy_update",
"device_id": device_id,
"update_status": status,
"update_message": message,
}
)
return {"status": "ok"}
# --- Background watchdog ---
async def spoolbuddy_watchdog():
"""Check for devices that have gone offline (no heartbeat for 30s).
Called periodically from the main app's background task loop.
"""
from backend.app.core.database import async_session
async with async_session() as db:
result = await db.execute(select(SpoolBuddyDevice).where(SpoolBuddyDevice.last_seen.isnot(None)))
devices = list(result.scalars().all())
threshold = datetime.now(timezone.utc) - timedelta(seconds=OFFLINE_THRESHOLD_SECONDS)
for device in devices:
last_seen = device.last_seen.replace(tzinfo=timezone.utc) if device.last_seen else None
if last_seen and last_seen < threshold:
# Only broadcast once — clear last_seen after marking offline
await ws_manager.broadcast(
{
"type": "spoolbuddy_offline",
"device_id": device.device_id,
}
)
device.last_seen = None
logger.info("SpoolBuddy device offline: %s", device.device_id)
await db.commit()