starred/bambuddy-maziggy-1
1
0
Fork 0
mirror of https://github.com/maziggy/bambuddy.git synced 2026-05-09 08:25:54 +02:00
Code Issues 44 Projects Packages Wiki Activity

[PR #686] [MERGED] [Fix]: Properly track filament usage data in Spoolman #1100

New issue
Closed
opened 2026-05-07 00:16:00 +02:00 by BreizhHardware · 0 comments
BreizhHardware commented 2026-05-07 00:16:00 +02:00
Owner
Copy link

📋 Pull Request Information

Original PR: https://github.com/maziggy/bambuddy/pull/686
Author: @shrunbr
Created: 3/12/2026
Status: ✅ Merged
Merged: 3/13/2026
Merged by: @maziggy

Base: dev ← Head: fix/spoolmanTracking

📝 Commits (10+)

  • 7f0cec0 Fixes '>=' error when attempting to store tracking data for Spoolman spool usage
  • 311e08a Enhance spool tag resolution and fallback mechanisms for printer serial handling.
  • 12597a4 Add tests for fallback tag resolution and global tray ID mapping.
  • 94637ad Enhance store_print_data to support explicit AMS mapping and fallback to queue mapping.
  • b4f2278 Add AMS mapping resolution for print start tracking data.
  • bc7c6b1 Add unit tests for store_print_data to prefer explicit AMS mapping.
  • 49e9217 Enhance cleanup_tracking and _report_partial_usage to support last_layer_num and last_progress parameters for improved partial usage reporting.
  • 24d3a2c Enhance on_print_complete to pass last_layer_num and last_progress to _cleanup_spoolman_tracking for improved tracking accuracy.
  • 386460c Enhance _resolve_global_tray_id to accept ams_trays for improved mapping accuracy and fallback handling.
  • ba21bcc Enhance _report_spool_usage_for_slots to log tray type and external status for improved debugging.

📊 Changes

3 files changed (+323 additions, -50 deletions)

View changed files

📝 backend/app/main.py (+37 -4)
📝 backend/app/services/spoolman_tracking.py (+187 -46)
📝 backend/tests/unit/services/test_spoolman_tracking.py (+99 -0)

📄 Description

Description

Copilot generated summary

This pull request introduces significant improvements to the Spoolman filament usage tracking system, focusing on more accurate spool identification, robust partial usage reporting, and better handling of AMS tray mappings. The changes enhance the reliability of reporting filament usage for both standard and external spools, especially in cases of failed or aborted prints, and ensure deterministic spool tagging by mirroring frontend logic.

Related Issue

Fixes #677

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Code refactoring
  • Performance improvement
  • Test addition or update

Changes Made

backend/app/main.py

  • Added _get_start_ams_mapping(data, archive_id) to prefer ams_mapping from the print-start event (fall back to stored mapping).
  • Pass ams_mapping=_get_start_ams_mapping(...) into Spoolman storage calls at print start (main archive, fallback archive, and other print-start locations) so explicit slot mapping is preserved.
  • When running background cleanup, pass last_layer_num and last_progress from the event into the cleanup call.

backend/app/services/spoolman_tracking.py

  • Added robust identifier/fallback helpers: _is_non_zero_identifier, _to_fixed_hex, _hash_serial_to_hex32 (FNV-1a hashing), _global_tray_id_to_ams_slot, and _get_fallback_spool_tag to generate deterministic fallback spool tags matching frontend behavior.
  • _resolve_spool_tag now accepts printer_serial and global_tray_id, prefers non-zero tray_uuid then non-zero tag_uid, then returns deterministic fallback tag if needed.
  • _resolve_global_tray_id now accepts ams_trays for position-based defaults (sorts tray IDs so external slots and AMS-HT are positioned correctly) and still respects explicit slot_to_tray mappings.
  • store_print_data gains an ams_mapping parameter (prefer explicit mapping passed from print-start over stored queue mapping); cleanup_tracking accepts last_layer_num/last_progress and _report_partial_usage uses those hints when firmware state is reset.
  • Reporting functions (_report_spool_usage_for_slots, _report_partial_usage, report_usage) now fetch printer_serial and pass it into tag resolution; added logging and improved linear/fallback estimation for partial usage.

backend/tests/unit/services/test_spoolman_tracking.py

  • Added imports for AsyncMock, MagicMock, patch, SimpleNamespace, and pytest to support new tests/mocks.
    Extended tests to assert that all-zero tag_uid/tray_uuid are treated as missing and that fallback tags are generated correctly.
  • Added TestFallbackTagHelpers covering hashing, global_tray -> (ams_id, tray_id) mapping, and expected fallback tag outputs for standard, AMS-HT, and external slots.
  • Added TestStorePrintData.async test verifying store_print_data prefers explicit ams_mapping passed in over any queue mapping and that stored tracking.slot_to_tray equals the passed mapping.

Screenshots

Spoolman debug at print start:
spoolman-start-print

Spoolman debug at print end:
spoolman-after-print

Testing

I tested this extensively on my printer. I am happy to report that filament tracking works across all AMS slots and the external slot. It works for mutli-filament prints as well. test_frontend, test_backend and test_docker all pass sucessfully.

  • I have tested this on my local machine
  • I have tested with my printer model: P2S w/ AMS 2 Pro

Checklist

  • My code follows the project's coding style
  • I have commented my code where necessary
  • I have updated the documentation (if needed)
  • My changes generate no new warnings
  • I have tested my changes thoroughly

Additional Notes

There is a HUGE caveat to this change really due to how tracking works in general. When a print is started the 3mf file is downloaded and parsed by Bambuddy, it then determines where the filament changes happen including the initial start. The filament slots that it IDs are based upon the filament slots in your slicer.

image

For example, these are the filaments in my slicer, they are in the exact same order as they are in my AMS

If I flip around # 2 and # 4 for example, and go to print with # 4 which is now red, Bambuddy will tie that back to the filament in the 4th slot of my AMS and tracking data will go against the wrong spool

image

I do believe this is due to the data we're able to extract from 3mf and gcode not due to anything Bambuddy is doing. I found a line in a comment on the extract_filament_properties_from_3mf function in threemf_tools.py which says: filament_id is 1-based (matches slot_id in slice_info.config). That correlates these findings as well.

So for this to work properly, your filament slots in your slicer must match the filament slots in your AMS. These can always be overridden (at least in Bambu Studio) by clicking the "Synchronize filament" button

image

and then choose "Overwriting" at the top and click "Synchronize now" at the bottom

image

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/maziggy/bambuddy/pull/686 **Author:** [@shrunbr](https://github.com/shrunbr) **Created:** 3/12/2026 **Status:** ✅ Merged **Merged:** 3/13/2026 **Merged by:** [@maziggy](https://github.com/maziggy) **Base:** `dev` ← **Head:** `fix/spoolmanTracking` --- ### 📝 Commits (10+) - [`7f0cec0`](https://github.com/maziggy/bambuddy/commit/7f0cec0ac9960785d6e5dae9a7b39936df3f7e91) Fixes '>=' error when attempting to store tracking data for Spoolman spool usage - [`311e08a`](https://github.com/maziggy/bambuddy/commit/311e08a0a89a6de909c65c55c5e3821ccaecf5bb) Enhance spool tag resolution and fallback mechanisms for printer serial handling. - [`12597a4`](https://github.com/maziggy/bambuddy/commit/12597a46ea6aaaa504ef417266a3b021b39e4d9a) Add tests for fallback tag resolution and global tray ID mapping. - [`94637ad`](https://github.com/maziggy/bambuddy/commit/94637adfc691a5d53047f941cba51de072685fc7) Enhance store_print_data to support explicit AMS mapping and fallback to queue mapping. - [`b4f2278`](https://github.com/maziggy/bambuddy/commit/b4f22789db3088572ce19187499339f657bb94c0) Add AMS mapping resolution for print start tracking data. - [`bc7c6b1`](https://github.com/maziggy/bambuddy/commit/bc7c6b125946337196b7eb99cfd8b26816efb109) Add unit tests for store_print_data to prefer explicit AMS mapping. - [`49e9217`](https://github.com/maziggy/bambuddy/commit/49e9217d39860c8718b083ef2040e0df4a248d5d) Enhance cleanup_tracking and _report_partial_usage to support last_layer_num and last_progress parameters for improved partial usage reporting. - [`24d3a2c`](https://github.com/maziggy/bambuddy/commit/24d3a2ce5b6d6ffa63ba223c08e67b5fe055e01b) Enhance on_print_complete to pass last_layer_num and last_progress to _cleanup_spoolman_tracking for improved tracking accuracy. - [`386460c`](https://github.com/maziggy/bambuddy/commit/386460c244881b4940c95a265e1e8fe21c458f87) Enhance _resolve_global_tray_id to accept ams_trays for improved mapping accuracy and fallback handling. - [`ba21bcc`](https://github.com/maziggy/bambuddy/commit/ba21bcc6a09016b60f9b179ededcc1bfe1def78e) Enhance _report_spool_usage_for_slots to log tray type and external status for improved debugging. ### 📊 Changes **3 files changed** (+323 additions, -50 deletions) <details> <summary>View changed files</summary> 📝 `backend/app/main.py` (+37 -4) 📝 `backend/app/services/spoolman_tracking.py` (+187 -46) 📝 `backend/tests/unit/services/test_spoolman_tracking.py` (+99 -0) </details> ### 📄 Description ## Description *Copilot generated summary* This pull request introduces significant improvements to the Spoolman filament usage tracking system, focusing on more accurate spool identification, robust partial usage reporting, and better handling of AMS tray mappings. The changes enhance the reliability of reporting filament usage for both standard and external spools, especially in cases of failed or aborted prints, and ensure deterministic spool tagging by mirroring frontend logic. ## Related Issue <!-- Link to the issue this PR addresses (if applicable) --> Fixes #677 ## Type of Change <!-- Mark the relevant option with an "x" --> - [X] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [X] Test addition or update ## Changes Made <!-- List the specific changes made in this PR --> **backend/app/main.py** - Added _get_start_ams_mapping(data, archive_id) to prefer ams_mapping from the print-start event (fall back to stored mapping). - Pass ams_mapping=_get_start_ams_mapping(...) into Spoolman storage calls at print start (main archive, fallback archive, and other print-start locations) so explicit slot mapping is preserved. - When running background cleanup, pass last_layer_num and last_progress from the event into the cleanup call. **backend/app/services/spoolman_tracking.py** - Added robust identifier/fallback helpers: _is_non_zero_identifier, _to_fixed_hex, _hash_serial_to_hex32 (FNV-1a hashing), _global_tray_id_to_ams_slot, and _get_fallback_spool_tag to generate deterministic fallback spool tags matching frontend behavior. - _resolve_spool_tag now accepts printer_serial and global_tray_id, prefers non-zero tray_uuid then non-zero tag_uid, then returns deterministic fallback tag if needed. - _resolve_global_tray_id now accepts ams_trays for position-based defaults (sorts tray IDs so external slots and AMS-HT are positioned correctly) and still respects explicit slot_to_tray mappings. - store_print_data gains an ams_mapping parameter (prefer explicit mapping passed from print-start over stored queue mapping); cleanup_tracking accepts last_layer_num/last_progress and _report_partial_usage uses those hints when firmware state is reset. - Reporting functions (_report_spool_usage_for_slots, _report_partial_usage, report_usage) now fetch printer_serial and pass it into tag resolution; added logging and improved linear/fallback estimation for partial usage. **backend/tests/unit/services/test_spoolman_tracking.py** - Added imports for AsyncMock, MagicMock, patch, SimpleNamespace, and pytest to support new tests/mocks. Extended tests to assert that all-zero tag_uid/tray_uuid are treated as missing and that fallback tags are generated correctly. - Added TestFallbackTagHelpers covering hashing, global_tray -> (ams_id, tray_id) mapping, and expected fallback tag outputs for standard, AMS-HT, and external slots. - Added TestStorePrintData.async test verifying store_print_data prefers explicit ams_mapping passed in over any queue mapping and that stored tracking.slot_to_tray equals the passed mapping. ## Screenshots Spoolman debug at print start: <img width="2215" height="95" alt="spoolman-start-print" src="https://github.com/user-attachments/assets/edde3ef5-5ae6-45c8-8518-73bfec3ffc7b" /> Spoolman debug at print end: <img width="1387" height="367" alt="spoolman-after-print" src="https://github.com/user-attachments/assets/5f59a600-7152-4d7e-8818-fe64666e6303" /> ## Testing <!-- Describe how you tested your changes --> I tested this extensively on my printer. I am happy to report that filament tracking works across all AMS slots and the external slot. It works for mutli-filament prints as well. `test_frontend`, `test_backend` and `test_docker` all pass sucessfully. - [X] I have tested this on my local machine - [X] I have tested with my printer model: P2S w/ AMS 2 Pro ## Checklist - [X] My code follows the project's coding style - [X] I have commented my code where necessary - [X] I have updated the documentation (if needed) - [X] My changes generate no new warnings - [X] I have tested my changes thoroughly ## Additional Notes <!-- Add any additional information that reviewers should know --> There is a HUGE caveat to this change really due to how tracking works in general. When a print is started the 3mf file is downloaded and parsed by Bambuddy, it then determines where the filament changes happen including the initial start. The filament slots that it IDs are based upon the filament slots in your slicer. <img width="414" height="93" alt="image" src="https://github.com/user-attachments/assets/6e79f614-3b7b-438e-9a77-d190e1458fcb" /> For example, these are the filaments in my slicer, they are in the exact same order as they are in my AMS If I flip around # 2 and # 4 for example, and go to print with # 4 which is now red, Bambuddy will tie that back to the filament in the 4th slot of my AMS and tracking data will go against the wrong spool <img width="413" height="104" alt="image" src="https://github.com/user-attachments/assets/f2775081-7a60-4ad7-8037-c6490fd134d1" /> I do believe this is due to the data we're able to extract from 3mf and gcode not due to anything Bambuddy is doing. I found a line in a comment on the `extract_filament_properties_from_3mf` function in `threemf_tools.py` which says: `filament_id is 1-based (matches slot_id in slice_info.config)`. That correlates these findings as well. So for this to work properly, your filament slots in your slicer must match the filament slots in your AMS. These can always be overridden (at least in Bambu Studio) by clicking the "Synchronize filament" button <img width="417" height="40" alt="image" src="https://github.com/user-attachments/assets/1981877a-7a7b-4d3f-b85d-5e4a3e0328c8" /> and then choose "Overwriting" at the top and click "Synchronize now" at the bottom <img width="664" height="709" alt="image" src="https://github.com/user-attachments/assets/c4d29253-6284-4393-a7f4-80570c5dceda" /> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
BreizhHardware 2026-05-07 00:16:00 +02:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
github-repo-stats
bug-report-assets
dev
0.2.4b3
0.2.4b2
0.2.4b1
pr/1114
0.2.3.2
0.2.3.1
0.2.3
0.2.3b3
0.2.3b2
0.2.3b1
0.2.2.2
0.2.2.1
0.2.2b3
0.2.2
0.2.2b2
0.2.2b1
0.2.1.1
0.2.1
0.2.1b3
0.2.1b2
0.2.1b
0.2.0
0.2.0b
0.1.5-2-ctrl
v0.2.4b4-daily.20260508
v0.2.4b2
v0.2.4b3
v0.2.4b1
v0.2.3.2
v0.2.3.1
v0.2.3
v0.2.3b3
v0.2.3b2
v0.2.3b1-daily.20260407
v0.2.3b1
v0.2.2.2
v0.2.2.1
v0.2.3b1-daily.20260318
v0.2.3b1-daily.20260317
v0.2.3b1-daily.20260316
v0.2.2
v0.2.2b4-daily.20260314
v0.2.2b4-daily.20260313
v0.2.2b3-daily.20260312
v0.2.2b3-1
v0.2.2b2
v0.2.2-b2
v0.2.2b3
v0.2.2-b1
v0.2.2b1
v0.2.1.1
v0.2.1
v0.2.1b3
v0.2.1b2
v0.2.1b
v0.2.0
v0.1.9
v0.1.8.1
v0.1.8
v0.1.7
v0.1.6.2
v0.1.6.1
v0.1.6-hotfix
v0.1.6
v0.1.6b11
v0.1.6b10
v0.1.6b9
v0.1.6b8
v0.1.6b7
v0.1.6b6
v0.1.6b5
v0.1.6b4
v0.1.6b3
v0.1.6b2
v0.1.6b
v0.1.5-final
v0.1.5b7
v0.1.5b6
v0.1.5b5
v0.1.5b4
v0.1.5b3
v0.1.5b2
v0.1.5b
v0.1.4
v0.1.3
v0.1.2-bugfix
v0.1.2-final
v0.1.2
0.1.1
Labels
Clear labels   
A1

   
automated

   
automated

   
bug

   
bug

   
Closed due to inactivity

   
contrib

   
dependencies

   
dependencies

   
duplicate

   
enhancement

   
feedback

   
hold

   
invalid

   
Notes

   
P1S

   
pull-request
Mirrored from GitHub Pull Request

  
security

   
ThumbsUp

   
user-report

   
wontfix
No labels
A1
automated
automated
bug
bug
Closed due to inactivity
contrib
dependencies
dependencies
duplicate
enhancement
feedback
hold
invalid
Notes
P1S
pull-request
security
ThumbsUp
user-report
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/bambuddy-maziggy-1#1100
No description provided.