Create Bambuddy assignments from InvenTree spools
This commit is contained in:
22
README.md
22
README.md
@@ -99,9 +99,10 @@ Recommended InvenTree structure for the current setup:
|
||||
|
||||
The service deliberately starts with `FILAMENT_DRY_RUN=true`. In dry-run mode it reads both systems and reports what it would create, move, or subtract, but it does not write filament changes. Switch to `FILAMENT_DRY_RUN=false` only after `/filament/status` and `/sync/filament?dry_run=true` show the expected mapping.
|
||||
|
||||
Filament sync has three independent parts:
|
||||
Filament sync has four independent parts:
|
||||
|
||||
- spool catalog sync: InvenTree stock items create/update Bambuddy spools;
|
||||
- assignment sync: InvenTree printer locations create Bambuddy spool assignments;
|
||||
- location sync: Bambuddy assignments move InvenTree stock to printer locations; returning unassigned loaded spools to storage is optional;
|
||||
- usage sync: Bambuddy usage history subtracts grams from the matching InvenTree stock item.
|
||||
|
||||
@@ -233,9 +234,13 @@ FILAMENT_LOADED_LOCATION_ID=72
|
||||
FILAMENT_PRINTER_LOCATION_MAP=B1:93,B2:94,B3:95,B4:96
|
||||
FILAMENT_BATCH_SOURCE=tag_uid
|
||||
FILAMENT_SYNC_SPOOLS=true
|
||||
FILAMENT_SYNC_ASSIGNMENTS=true
|
||||
FILAMENT_SYNC_LOCATIONS=true
|
||||
FILAMENT_SYNC_USAGE=true
|
||||
FILAMENT_RETURN_UNASSIGNED_TO_STORAGE=false
|
||||
FILAMENT_PRINTER_ID_MAP=
|
||||
FILAMENT_ASSIGNMENT_DEFAULT_AMS_ID=0
|
||||
FILAMENT_ASSIGNMENT_START_TRAY_ID=0
|
||||
FILAMENT_USAGE_LIMIT=200
|
||||
FILAMENT_USAGE_SUCCESS_STATUSES=success,completed,complete,done
|
||||
FILAMENT_DEFAULT_MATERIAL=PLA
|
||||
@@ -306,6 +311,9 @@ Do not commit `.env`. It contains API tokens and is ignored by git.
|
||||
`FILAMENT_SYNC_SPOOLS`
|
||||
: Creates/updates Bambuddy spool records from InvenTree stock.
|
||||
|
||||
`FILAMENT_SYNC_ASSIGNMENTS`
|
||||
: Creates Bambuddy assignments from InvenTree stock items currently stored in printer locations.
|
||||
|
||||
`FILAMENT_SYNC_LOCATIONS`
|
||||
: Moves InvenTree stock items between storage and printer locations from Bambuddy assignments.
|
||||
|
||||
@@ -315,6 +323,15 @@ Do not commit `.env`. It contains API tokens and is ignored by git.
|
||||
`FILAMENT_RETURN_UNASSIGNED_TO_STORAGE`
|
||||
: When `true`, known Bambuddy spools that are no longer assigned are moved from printer locations back to storage. Keep this `false` until Bambuddy assignments are reliable.
|
||||
|
||||
`FILAMENT_PRINTER_ID_MAP`
|
||||
: Optional explicit printer-name to Bambuddy printer-ID map, for example `B1:5,B2:2,B3:3,B4:4`. If empty, printer IDs are auto-detected from Bambuddy printer names.
|
||||
|
||||
`FILAMENT_ASSIGNMENT_DEFAULT_AMS_ID`
|
||||
: AMS ID used when creating Bambuddy assignments from InvenTree printer locations. Default is `0`.
|
||||
|
||||
`FILAMENT_ASSIGNMENT_START_TRAY_ID`
|
||||
: First tray ID used for each printer when assigning multiple InvenTree-loaded spools. Default is `0`.
|
||||
|
||||
## InvenTree IDs
|
||||
|
||||
Use numeric IDs for target category and stock location. You can find them from the InvenTree UI URL or API.
|
||||
@@ -389,6 +406,7 @@ To also run filament tracking automatically:
|
||||
FILAMENT_TRACKING_ENABLED=true
|
||||
FILAMENT_DRY_RUN=true
|
||||
FILAMENT_SYNC_SPOOLS=true
|
||||
FILAMENT_SYNC_ASSIGNMENTS=true
|
||||
FILAMENT_SYNC_LOCATIONS=true
|
||||
FILAMENT_SYNC_USAGE=true
|
||||
FILAMENT_RETURN_UNASSIGNED_TO_STORAGE=false
|
||||
@@ -452,6 +470,7 @@ Run individual filament steps:
|
||||
|
||||
```powershell
|
||||
curl.exe -X POST -H "X-Service-Token: change-me" http://localhost:8088/sync/filament/spools
|
||||
curl.exe -X POST -H "X-Service-Token: change-me" http://localhost:8088/sync/filament/assignments
|
||||
curl.exe -X POST -H "X-Service-Token: change-me" http://localhost:8088/sync/filament/locations
|
||||
curl.exe -X POST -H "X-Service-Token: change-me" http://localhost:8088/sync/filament/usage
|
||||
```
|
||||
@@ -467,6 +486,7 @@ POST /sync/archive/{archive_id}
|
||||
POST /sync/backfill
|
||||
POST /sync/filament
|
||||
POST /sync/filament/spools
|
||||
POST /sync/filament/assignments
|
||||
POST /sync/filament/locations
|
||||
POST /sync/filament/usage
|
||||
POST /webhooks/bambuddy
|
||||
|
||||
Reference in New Issue
Block a user