Rank near-colour matches by how they look, and share one filament type table (#2804)

Three follow-ups to #2804, all bearing on one decision: which spool a print
uses when the exact colour is not loaded.

Colour ranking is now perceptual. The ranking added in #2804 measured RGB
distance, which rates a colour by how far apart the numbers are rather than
how far apart they look, and it overweights blue badly enough to invert the
answer: against a required #1E4821 green, a purple #38202F is the nearer of
two eligible spools by RGB and four times the further once measured properly.
Both sides now use CIEDE2000 -- perceptual_color_distance in
backend/app/utils/color_utils.py and colorDistance in amsHelpers.ts, kept
structurally identical so they can be read side by side. Verified against the
Sharma/Wu/Dalal published reference set, all 31 pairs to 1e-4, and the two
implementations agree to within 1e-9 across 800 sampled pairs. Eligibility is
untouched, still the per-channel RGB box, so this only reorders spools that
already qualified.

Type matching now agrees between the interface and the scheduler. Bambu
firmware treats PA-CF, PA12-CF and PAHT-CF as one material and the scheduler
has always matched them accordingly, but the interface compared raw type
strings and called that same pairing a mismatch. The badge contradicted what
the printer was about to do, and the manual override picker, which groups by
canonical type, offered the very spool the badge then rejected. The fifteen
comparison sites in useFilamentMapping.ts, useMultiPrinterFilamentMapping.ts
and PrinterSelector.tsx now call filamentTypesCompatible.

The pipeline pre-flight reads the matcher's table instead of its own copy.
That copy had drifted into disagreeing in both directions: it aliased PLA
Basic to PLA where the matcher never has, so a run could clear the check and
then fail to map its slots, and it lacked the nylon grouping, so it flagged
runs the matcher handles without complaint. A check whose job is to predict
dispatch is wrong whenever it disagrees with dispatch, whichever way it leans,
so it and the scheduler now both read backend/app/utils/filament_types.py.

That canonicaliser deliberately does not strip surrounding whitespace. It
looks like a free improvement, but it would collapse a junk tray_type to ""
just as a 3MF declaring no filament type yields "", and a typeless requirement
would start matching a junk-typed tray instead of reporting the slot unmapped.
Padded type strings are worth handling on their own terms, with that case
addressed.

One behaviour change outside the ranking: the pre-flight is stricter for a
printer reporting a product name such as "PLA Basic" where the generic
material belongs, which it now flags rather than passes. Rare in practice,
since the printer reports material and product name in separate fields, and it
is the answer the matcher would give. Nothing about which spool a print
actually uses changed outside the colour ranking itself.

Adds 203 backend and 6 frontend tests. The #2804 tie-break test now uses
identical colours: two colours at equal RGB distance are not perceptually
tied, which is rather the point.
This commit is contained in:
maziggy
2026-08-13 12:04:56 +02:00
parent 4f7a02b393
commit e6842e1d3c
18 changed files with 946 additions and 255 deletions
+8 -30
View File
@@ -36,6 +36,7 @@ from sqlalchemy.ext.asyncio import AsyncSession
from backend.app.models.local_preset import LocalPreset
from backend.app.models.printer import Printer
from backend.app.models.slicer_pipeline import SlicerPipeline
from backend.app.utils.filament_types import canonical_filament_type
IssueKind = Literal[
"printer_not_set",
@@ -80,36 +81,13 @@ class EligibilityReport:
printer_reports: tuple[PerPrinterReport, ...] = ()
# Same equivalence map as print_scheduler._canonical_filament_type but kept
# local so this module has no upward dependency on the scheduler. Mirrors the
# scheduler's behaviour: BBL-prefixed product names normalise to the base type
# (e.g. "PLA Basic" → "PLA"). When the scheduler's map gets a new alias, this
# one needs the same entry.
_FILAMENT_EQUIV_MAP = {
"PLA": "PLA",
"PLA BASIC": "PLA",
"PLA MATTE": "PLA",
"PLA SILK": "PLA",
"PLA PRO": "PLA",
"PLA TOUGH": "PLA",
"PETG": "PETG",
"PETG HF": "PETG",
"PETG BASIC": "PETG",
"PETG TRANSLUCENT": "PETG",
"ABS": "ABS",
"ASA": "ASA",
"TPU": "TPU",
"TPU 95A": "TPU",
"PC": "PC",
"PA": "PA",
"PA-CF": "PA",
"PVA": "PVA",
}
def _canonical(ftype: str) -> str:
upper = (ftype or "").strip().upper()
return _FILAMENT_EQUIV_MAP.get(upper, upper)
# This module's whole job is to predict what the dispatch matcher will do, so
# it reads type equivalence from the same table the matcher does rather than
# keeping a copy. The copy it used to keep had drifted into disagreeing in both
# directions — it aliased "PLA Basic" to "PLA" where the matcher does not, so a
# job could pass here and then fail on type; and it lacked the PA12-CF/PAHT-CF
# grouping the matcher has, so a job the matcher handles fine was flagged.
_canonical = canonical_filament_type
def _normalise_colour(colour: str | None) -> str:
+21 -43
View File
@@ -55,6 +55,8 @@ from backend.app.services.printer_manager import (
supports_drying_while_printing,
)
from backend.app.services.smart_plug_manager import smart_plug_manager
from backend.app.utils.color_utils import perceptual_color_distance
from backend.app.utils.filament_types import canonical_filament_type
from backend.app.utils.filename import derive_remote_filename
from backend.app.utils.printer_models import (
is_gcode_compatible,
@@ -227,23 +229,6 @@ _ACTIVE_PRINT_STATES: frozenset[str] = frozenset({"PREPARE", "SLICING", "RUNNING
# force-reconnect on the very next attempt — while still bounding the loop.
DISPATCH_MAX_ATTEMPTS = 3
# Filament type equivalence groups — types within the same group are
# interchangeable on the printer side (Bambu Lab firmware treats them as compatible).
_FILAMENT_TYPE_GROUPS: list[list[str]] = [
["PA-CF", "PA12-CF", "PAHT-CF"],
]
_FILAMENT_EQUIV_MAP: dict[str, str] = {}
for _group in _FILAMENT_TYPE_GROUPS:
_canonical = _group[0].upper()
for _t in _group:
_FILAMENT_EQUIV_MAP[_t.upper()] = _canonical
def _canonical_filament_type(ftype: str) -> str:
"""Return canonical type for equivalence matching."""
upper = ftype.upper()
return _FILAMENT_EQUIV_MAP.get(upper, upper)
@dataclass(slots=True)
class _ModelCandidate:
@@ -2141,18 +2126,16 @@ class PrintScheduler:
tray_type = tray.get("tray_type")
if tray_type:
color_norm = (tray.get("tray_color", "") or "").replace("#", "").lower()[:6]
loaded.append(
(_canonical_filament_type(tray_type), color_norm, tray.get("tray_info_idx", "") or "")
)
loaded.append((canonical_filament_type(tray_type), color_norm, tray.get("tray_info_idx", "") or ""))
for vt in status.raw_data.get("vt_tray") or []:
vt_type = vt.get("tray_type")
if vt_type:
color_norm = (vt.get("tray_color", "") or "").replace("#", "").lower()[:6]
loaded.append((_canonical_filament_type(vt_type), color_norm, vt.get("tray_info_idx", "") or ""))
loaded.append((canonical_filament_type(vt_type), color_norm, vt.get("tray_info_idx", "") or ""))
missing = []
for o in force_overrides:
o_type = _canonical_filament_type(o.get("type") or "")
o_type = canonical_filament_type(o.get("type") or "")
o_color = (o.get("color") or "").replace("#", "").lower()[:6]
o_idx = o.get("tray_info_idx") or ""
satisfied = any(
@@ -2189,18 +2172,18 @@ class PrintScheduler:
for tray in ams_unit.get("tray", []):
tray_type = tray.get("tray_type")
if tray_type:
loaded_types.add(_canonical_filament_type(tray_type))
loaded_types.add(canonical_filament_type(tray_type))
# Check external spool(s) (virtual tray, stored in raw_data["vt_tray"] as list)
for vt in status.raw_data.get("vt_tray") or []:
vt_type = vt.get("tray_type")
if vt_type:
loaded_types.add(_canonical_filament_type(vt_type))
loaded_types.add(canonical_filament_type(vt_type))
# Find which required types are missing (using canonical type for equivalence)
missing = []
for req_type in required_types:
if _canonical_filament_type(req_type) not in loaded_types:
if canonical_filament_type(req_type) not in loaded_types:
missing.append(req_type)
return missing
@@ -2741,29 +2724,24 @@ class PrintScheduler:
return color.replace("#", "").lower()[:6]
def _color_distance(self, color1: str | None, color2: str | None) -> float | None:
"""Euclidean RGB distance, or None when either colour is unusable.
"""Perceptual (CIEDE2000) distance, or None when either colour is unusable.
Ranks the candidates ``_colors_are_similar`` admits (#2804). Eligibility
stays the per-channel box that shipped — this only decides which of
several eligible spools is closest, so nothing becomes usable or
unusable because of it.
Alpha is dropped by ``_normalize_color_for_compare``, deliberately: the
alpha a slicer writes for a transparent filament is not a colour the
user chose, and counting it would stop a transparent filament matching
itself.
It ranks by how far apart the colours *look*, not how far apart their
numbers are. RGB distance overweights blue badly enough to invert the
answer: against a required ``#1E4821`` green, a purple ``#38202F`` is
the nearer of two eligible spools by RGB and the further by a factor of
four once measured perceptually.
Alpha is ignored, deliberately: the alpha a slicer writes for a
transparent filament is not a colour the user chose, and counting it
would stop a transparent filament matching itself.
"""
hex1 = self._normalize_color_for_compare(color1)
hex2 = self._normalize_color_for_compare(color2)
if not hex1 or not hex2 or len(hex1) < 6 or len(hex2) < 6:
return None
try:
dr = int(hex1[0:2], 16) - int(hex2[0:2], 16)
dg = int(hex1[2:4], 16) - int(hex2[2:4], 16)
db = int(hex1[4:6], 16) - int(hex2[4:6], 16)
except ValueError:
return None
return (dr * dr + dg * dg + db * db) ** 0.5
return perceptual_color_distance(color1, color2)
def _colors_are_similar(self, color1: str | None, color2: str | None, threshold: int = 40) -> bool:
"""Check if two colors are visually similar within a threshold."""
@@ -3055,7 +3033,7 @@ class PrintScheduler:
if not idx_match and not exact_match and not similar_match and not type_only_match:
for f in available:
f_type = (f.get("type") or "").upper()
if _canonical_filament_type(f_type) != _canonical_filament_type(req_type):
if canonical_filament_type(f_type) != canonical_filament_type(req_type):
continue
# Type matches - check color
@@ -3104,7 +3082,7 @@ class PrintScheduler:
match["global_tray_id"],
bucket,
req.get("slot_id"),
f" (colour distance {similar_distance:.1f})" if bucket == "similar_color" else "",
f" (deltaE {similar_distance:.2f})" if bucket == "similar_color" else "",
)
else:
logger.info(