Commit 240011

2026-04-08 20:25:37 Manuel Weiser: docs: Add FilaManDB integration details and update related sections in user manuals
docs/de/00-inhalt.md ..
@@ 29,6 29,7 @@
| 15 | [Plugin: SpoolmanDB Import](/Docs/De/15-Plugin-Spoolmandb) | Filamente aus der SpoolmanDB importieren |
| 16 | [Plugin: Spoolman API](/Docs/De/16-Plugin-Spoolmanapi) | Spoolman-kompatible API für externe Tools |
| 17 | [Plugin: Bambuddy](/Docs/De/17-Plugin-Bambuddy) | Bambuddy-Integration: Inventory-Sync und Verbrauchsmeldung |
+ | 18 | [FilaManDB Community-Datenbank](/Docs/De/18-Filamandb) | Filamente und Hersteller aus der Community-Datenbank importieren |
| 20 | [Installation auf dem Raspberry Pi](/Docs/De/20-Installation-Raspberry-Pi) | Schritt-für-Schritt-Anleitung für Einsteiger |
---
docs/de/05-hersteller.md ..
@@ 26,13 26,30 @@
Das Dropdown **„All Materials"** filtert die Herstellerliste nach einem bestimmten Filamentmaterial (z. B. nur PLA-Hersteller anzeigen).
### Hersteller hinzufügen
- Klicken Sie oben rechts auf **„Add Manufacturer"**. Es öffnet sich ein Dialog/Formular mit folgenden Feldern:
- - **Name** – Pflichtfeld: Herstellername (z. B. „Prusament")
- - **URL** – Optionale Website-Adresse des Herstellers
+ Klicken Sie oben rechts auf **„Add Manufacturer"**. Es öffnet sich ein Dialog mit zwei Erstellungsmodi:
+
+ #### Aus FilaManDB erstellen (empfohlen)
+
+ > **Voraussetzung:** Das FilamentDB-Plugin muss unter [Admin → System](/Docs/De/11-Admin) aktiviert sein. Ist das Plugin nicht aktiv, wird nur der manuelle Modus angezeigt.
+
+ 1. Wählen Sie den Modus **„Aus FilaManDB erstellen"** (Radio-Button oben im Dialog)
+ 2. Geben Sie im Suchfeld mindestens 2 Zeichen ein – es erscheint ein Dropdown mit Treffern aus der [FilaManDB Community-Datenbank](/Docs/De/18-Filamandb)
+ 3. Klicken Sie auf den gewünschten Hersteller
+ 4. **Name** und **Website** werden automatisch vorausgefüllt
+ 5. Das **Hersteller-Logo** wird ebenfalls automatisch heruntergeladen, falls in der FilaManDB vorhanden
+
+ #### Manuell erstellen
+
+ 1. Wählen Sie den Modus **„Manuell erstellen"**
+ 2. Füllen Sie die Felder aus:
+ - **Name** – Pflichtfeld: Herstellername (z. B. „Prusament")
+ - **URL** – Optionale Website-Adresse des Herstellers
### Hersteller bearbeiten
Klicken Sie in der Tabelle in der Spalte **ACTIONS** auf das **Stift-Symbol** neben einem Hersteller.
+ Wenn das FilamentDB-Plugin aktiviert ist, steht im Bearbeitungsdialog zusätzlich der Button **„Aus FilaManDB laden"** zur Verfügung. Damit können Sie die Herstellerdaten (Name, Website, Logo) mit den aktuellen Daten aus der Community-Datenbank aktualisieren.
+
### Hersteller löschen
Klicken Sie in der Spalte **ACTIONS** auf das **Papierkorb-Symbol**. Ein Hersteller kann nur gelöscht werden, wenn ihm keine Filamente mehr zugeordnet sind.
docs/de/06-filamente.md ..
@@ 38,6 38,20 @@
- **Price per kg** – Preis für Wertberechnung (optional)
- **Article Number** – Artikelnummer (optional)
+ #### Aus FilaManDB laden
+
+ > **Voraussetzung:** Das FilamentDB-Plugin muss unter [Admin → System](/Docs/De/11-Admin) aktiviert sein.
+
+ Nachdem Sie einen **Hersteller** ausgewählt haben, erscheint der Button **„Aus FilaManDB laden"**:
+
+ 1. Klicken Sie auf den Button – es öffnet sich ein Suchfeld
+ 2. Geben Sie den Filamentnamen ein (mind. 2 Zeichen) – ein Dropdown zeigt passende Filamente aus der [FilaManDB Community-Datenbank](/Docs/De/18-Filamandb)
+ 3. Wählen Sie das gewünschte Filament aus
+ 4. Alle Felder werden automatisch vorausgefüllt: Bezeichnung, Material, Durchmesser, Farben, Preis usw.
+ 5. Falls der Hersteller oder einzelne Farben noch nicht in Ihrem System existieren, werden diese **automatisch angelegt**
+
+ > **Tipp:** Sie können die vorausgefüllten Daten vor dem Speichern beliebig anpassen.
+
### Farbverwaltung
Über den Button **„Manage Colors"** oben rechts gelangen Sie zur [Farbverwaltung](/Docs/De/12-Farbverwaltung), wo Sie Farben anlegen und verwalten können.
docs/de/07-spulen.md ..
@@ 43,6 43,25 @@
- **Notes** – Freitextnotiz
- **Zusatzfelder** – Falls vom Administrator konfiguriert
+ #### Spulenprofil aus FilaManDB laden
+
+ > **Voraussetzung:** Das FilamentDB-Plugin muss unter [Admin → System](/Docs/De/11-Admin) aktiviert sein.
+
+ Im Bereich der Spulendaten (Leergewicht, Durchmesser, Breite) steht der Button **„Aus FilaManDB laden"** zur Verfügung:
+
+ 1. Klicken Sie auf den Button – es öffnet sich ein Suchfeld
+ 2. Suchen Sie nach einem Spulenprofil (z. B. nach Herstellername oder Materialtyp)
+ 3. Falls verfügbar, wird ein **Bild des Spulenprofils** angezeigt
+ 4. Wählen Sie das passende Profil aus – die Spulendaten werden automatisch übernommen:
+ - **Leergewicht** (Empty Weight)
+ - **Außendurchmesser** (Outer Diameter)
+ - **Breite** (Width)
+ - **Material** der Spule
+
+ Diese Funktion steht sowohl beim **Erstellen** als auch beim **Bearbeiten** von Spulen zur Verfügung.
+
+ → Weitere Informationen: [Kapitel 18: FilaManDB Community-Datenbank](/Docs/De/18-Filamandb)
+
### Spule bearbeiten
In der Aktionsspalte können Sie:
- ✏️ **Bearbeiten** – Spuleninformationen ändern (z. B. Restgewicht nach dem Druck aktualisieren)
/dev/null .. docs/de/18-filamandb.md
@@ 0,0 1,120 @@
+ # 18. FilaManDB – Community-Datenbank
+
+ **URL (Admin-Import):** `http(s)://url/admin/system/filamentdb-import`
+
+ Die **FilaManDB** ist eine öffentliche Community-Datenbank unter [db.filaman.app](https://db.filaman.app), die Filamentdaten zahlreicher Hersteller enthält – inklusive Materialien, Farben, Spulenprofile und Logos.
+
+ FilaMan bietet zwei Wege, diese Datenbank zu nutzen:
+
+ 1. **Massen-Import** (Admin-Bereich) – Viele Hersteller und Filamente auf einmal importieren
+ 2. **Inline-Lookup** (in Formularen) – Einzelne Einträge direkt beim Erstellen/Bearbeiten aus der FilaManDB laden
+
+ > **Voraussetzung:** Das eingebaute Plugin **„FilamentDB Import"** muss unter [Admin → System](/Docs/De/11-Admin) aktiviert sein. Es handelt sich um ein Builtin-Plugin, das nicht deinstalliert werden kann.
+
+ ---
+
+ ## 18.1 Massen-Import (Admin-Bereich)
+
+ Der Massen-Import ist ein **3-Schritt-Assistent** im Admin-Bereich, über den sich große Mengen an Hersteller-, Filament- und Farbdaten aus der FilaManDB importieren lassen.
+
+ ### Schritt 1: Hersteller auswählen
+
+ 1. Klicken Sie auf **„Vorschau laden"** – FilaMan lädt die verfügbaren Daten aus der FilaManDB (Hersteller, Materialien, Farben, Filamente, Spulenprofile)
+ 2. Eine **Zusammenfassung** zeigt die verfügbare Datenmenge an
+ 3. Optional: Über den **Material-Filter** können Sie die Herstellerliste auf bestimmte Materialtypen einschränken (z. B. nur Hersteller, die PLA anbieten)
+ 4. Wählen Sie die gewünschten Hersteller per Checkbox aus
+ - Bereits in FilaMan vorhandene Hersteller werden mit **„Already exists"** markiert
+ - Buttons: **„Select all"**, **„Select all new"** (nur neue), **„Deselect all"**
+
+ ### Schritt 2: Filamente auswählen
+
+ 1. Nach der Herstellerauswahl werden die zugehörigen Filamente geladen
+ 2. Für jeden ausgewählten Hersteller wird die Liste der verfügbaren Filamente angezeigt
+ 3. Wählen Sie die gewünschten Filamente per Checkbox aus
+
+ ### Schritt 3: Import-Einstellungen & Ausführung
+
+ **Spulenprofil-Ziel:** Wählen Sie, wo die Spulenprofil-Informationen (Leergewicht, Durchmesser, Breite, Material) gespeichert werden sollen:
+
+ | Option | Beschreibung |
+ |--------|--------------|
+ | **Am Filament** | Spulendaten werden an jedem Filament gespeichert |
+ | **Am Hersteller** | Spulendaten werden einmalig am Hersteller gespeichert |
+ | **Beides** | Spulendaten werden sowohl am Filament als auch am Hersteller gespeichert |
+
+ Klicken Sie auf **„Import starten"**, um den Import durchzuführen. Nach Abschluss wird eine **Ergebnis-Zusammenfassung** angezeigt:
+
+ | Kategorie | Anzeige |
+ |-----------|---------|
+ | **Hersteller** | Erstellt / Übersprungen / Fehlgeschlagen |
+ | **Logos** | Heruntergeladen / Fehlgeschlagen |
+ | **Farben** | Erstellt / Übersprungen |
+ | **Filamente** | Erstellt / Übersprungen / Fehlgeschlagen |
+
+ Falls Warnungen oder Fehler aufgetreten sind, werden diese ebenfalls angezeigt.
+
+ ---
+
+ ## 18.2 Vorhandene Filamente aktualisieren
+
+ Wenn bereits Filamente importiert wurden und sich Daten in der FilaManDB geändert haben, können diese aktualisiert werden:
+
+ 1. Aktivieren Sie den Toggle **„Vorhandene aktualisieren"** im Import-Assistenten
+ 2. FilaMan berechnet automatisch einen **Diff** (Vergleich) zwischen den lokalen und den aktuellen FilaManDB-Daten
+ 3. Änderungen werden als Tabelle angezeigt: **Feldname**, **Aktueller Wert**, **Neuer Wert**
+ 4. Nur tatsächlich geänderte Filamente werden aktualisiert
+
+ ---
+
+ ## 18.3 Fuzzy-Matching
+
+ Beim Import erkennt FilaMan bereits vorhandene Filamente auch dann, wenn der Name **leicht abweicht** (z. B. durch Tippfehler, unterschiedliche Schreibweisen oder fehlende Sonderzeichen).
+
+ **So funktioniert es:**
+ - Die Namen werden normalisiert (Kleinschreibung, Sonderzeichen entfernt) und in einzelne Wörter (Tokens) aufgeteilt
+ - Zwei Namen gelten als übereinstimmend, wenn mindestens **75 %** der Wörter übereinstimmen
+ - Fuzzy-Treffer werden im Import visuell hervorgehoben
+
+ > **Beispiel:** „Prusament PLA Galaxy Black" und „Prusament PLA Galaxy-Black 1.75mm" werden als übereinstimmend erkannt.
+
+ ---
+
+ ## 18.4 Inline-Lookup in Formularen
+
+ Neben dem Massen-Import bietet FilaMan auch die Möglichkeit, **einzelne Einträge direkt in den Formularen** aus der FilaManDB zu laden. Diese Funktion ist auf folgenden Seiten verfügbar:
+
+ ### Hersteller erstellen / bearbeiten
+
+ Beim Erstellen eines neuen Herstellers können Sie zwischen zwei Modi wählen:
+ - **„Aus FilaManDB erstellen"** – Suchen Sie in der Community-Datenbank und übernehmen Sie Name, Website und Logo
+ - **„Manuell erstellen"** – Geben Sie die Daten wie bisher von Hand ein
+
+ Auch beim **Bearbeiten** eines vorhandenen Herstellers steht der Button **„Aus FilaManDB laden"** zur Verfügung, um die Daten zu aktualisieren.
+
+ → Siehe [Kapitel 5: Hersteller](/Docs/De/05-Hersteller)
+
+ ### Filament erstellen / bearbeiten
+
+ Nach Auswahl eines Herstellers erscheint der Button **„Aus FilaManDB laden"**. Damit können Sie:
+ - Ein Filament in der Community-Datenbank suchen
+ - Alle Felder werden automatisch vorausgefüllt (Bezeichnung, Material, Durchmesser, Farben, Preis usw.)
+ - Falls der Hersteller oder Farben noch nicht lokal existieren, werden diese automatisch angelegt
+
+ → Siehe [Kapitel 6: Filamente](/Docs/De/06-Filamente)
+
+ ### Spule erstellen / bearbeiten
+
+ Beim Erstellen oder Bearbeiten einer Spule steht der Button **„Aus FilaManDB laden"** für die **Spulenprofil-Daten** zur Verfügung:
+ - Suchen Sie nach einem Spulenprofil (z. B. nach Hersteller oder Material)
+ - Leergewicht, Durchmesser und Breite werden automatisch übernommen
+ - Falls verfügbar, wird ein Bild des Spulenprofils angezeigt
+
+ → Siehe [Kapitel 7: Spulen](/Docs/De/07-Spulen)
+
+ ---
+
+ > **Hinweis:** Alle FilaManDB-Buttons und -Funktionen werden nur angezeigt, wenn das FilamentDB-Plugin unter [Admin → System](/Docs/De/11-Admin) aktiviert ist.
+
+ ---
+
+ ← [Zurück: Plugin: Bambuddy](/Docs/De/17-Plugin-Bambuddy) | [Weiter: Installation auf dem Raspberry Pi →](/Docs/De/20-Installation-Raspberry-Pi)
docs/en/00-contents.md ..
@@ 29,6 29,7 @@
| 15 | [Plugin: SpoolmanDB Import](/Docs/En/15-Plugin-Spoolmandb) | Import filaments from the SpoolmanDB database |
| 16 | [Plugin: Spoolman API](/Docs/En/16-Plugin-Spoolmanapi) | Spoolman-compatible API for external tools |
| 17 | [Plugin: Bambuddy](/Docs/En/17-Plugin-Bambuddy) | Bambuddy integration: inventory sync and consumption reporting |
+ | 18 | [FilaManDB Community Database](/Docs/En/18-Filamandb) | Import filaments and manufacturers from the community database |
| 20 | [Installation on Raspberry Pi](/Docs/En/20-Installation-Raspberry-Pi) | Step-by-step guide for beginners |
---
docs/en/05-manufacturers.md ..
@@ 26,13 26,30 @@
The **"All Materials"** dropdown filters the manufacturer list by a specific filament material (e.g. show only PLA manufacturers).
### Add a Manufacturer
- Click **"Add Manufacturer"** in the top right. A dialog will open with the following fields:
- - **Name** – Required: manufacturer name (e.g. "Prusament")
- - **URL** – Optional website address of the manufacturer
+ Click **"Add Manufacturer"** in the top right. A dialog will open with two creation modes:
+
+ #### Create from FilaManDB (recommended)
+
+ > **Prerequisite:** The FilamentDB plugin must be enabled under [Admin → System](/Docs/En/11-Admin). If the plugin is not active, only the manual mode is shown.
+
+ 1. Select the **"Create from FilaManDB"** mode (radio button at the top of the dialog)
+ 2. Type at least 2 characters in the search field – a dropdown appears with matches from the [FilaManDB community database](/Docs/En/18-Filamandb)
+ 3. Click on the desired manufacturer
+ 4. **Name** and **website** are automatically pre-filled
+ 5. The **manufacturer logo** is also automatically downloaded if available in the FilaManDB
+
+ #### Manual entry
+
+ 1. Select the **"Manual entry"** mode
+ 2. Fill in the fields:
+ - **Name** – Required: manufacturer name (e.g. "Prusament")
+ - **URL** – Optional website address of the manufacturer
### Edit a Manufacturer
Click the **pencil icon** in the **ACTIONS** column next to a manufacturer.
+ When the FilamentDB plugin is enabled, the **"Load from FilaManDB"** button is available in the edit dialog. Use it to update the manufacturer data (name, website, logo) with the latest data from the community database.
+
### Delete a Manufacturer
Click the **trash icon** in the **ACTIONS** column. A manufacturer can only be deleted if no filaments are assigned to it.
docs/en/06-filaments.md ..
@@ 38,6 38,20 @@
- **Price per kg** – Price for value calculation (optional)
- **Article Number** – Article number (optional)
+ #### Load from FilaManDB
+
+ > **Prerequisite:** The FilamentDB plugin must be enabled under [Admin → System](/Docs/En/11-Admin).
+
+ After selecting a **manufacturer**, the **"Load from FilaManDB"** button appears:
+
+ 1. Click the button – a search field opens
+ 2. Enter the filament name (at least 2 characters) – a dropdown shows matching filaments from the [FilaManDB community database](/Docs/En/18-Filamandb)
+ 3. Select the desired filament
+ 4. All fields are automatically pre-filled: designation, material, diameter, colors, price, etc.
+ 5. If the manufacturer or individual colors do not yet exist in your system, they are **automatically created**
+
+ > **Tip:** You can adjust the pre-filled data as needed before saving.
+
### Color Management
Click **"Manage Colors"** in the top right to go to the [Color Management](/Docs/En/12-Colors) page, where you can create and manage colors.
docs/en/07-spools.md ..
@@ 43,6 43,25 @@
- **Notes** – Free-text note
- **Extra Fields** – If configured by the administrator
+ #### Load Spool Profile from FilaManDB
+
+ > **Prerequisite:** The FilamentDB plugin must be enabled under [Admin → System](/Docs/En/11-Admin).
+
+ In the spool data section (empty weight, diameter, width), the **"Load from FilaManDB"** button is available:
+
+ 1. Click the button – a search field opens
+ 2. Search for a spool profile (e.g. by manufacturer name or material type)
+ 3. If available, an **image of the spool profile** is displayed
+ 4. Select the matching profile – the spool data is automatically applied:
+ - **Empty Weight**
+ - **Outer Diameter**
+ - **Width**
+ - **Spool Material**
+
+ This feature is available both when **creating** and when **editing** spools.
+
+ → More information: [Chapter 18: FilaManDB Community Database](/Docs/En/18-Filamandb)
+
### Edit / Delete a Spool
In the actions column you can:
- ✏️ **Edit** – Update spool information (e.g. remaining weight after printing)
/dev/null .. docs/en/18-filamandb.md
@@ 0,0 1,120 @@
+ # 18. FilaManDB – Community Database
+
+ **URL (Admin Import):** `http(s)://url/admin/system/filamentdb-import`
+
+ The **FilaManDB** is a public community database at [db.filaman.app](https://db.filaman.app) that contains filament data from numerous manufacturers – including materials, colors, spool profiles, and logos.
+
+ FilaMan offers two ways to use this database:
+
+ 1. **Bulk Import** (Admin area) – Import many manufacturers and filaments at once
+ 2. **Inline Lookup** (in forms) – Load individual entries directly from the FilaManDB when creating or editing
+
+ > **Prerequisite:** The built-in plugin **"FilamentDB Import"** must be enabled under [Admin → System](/Docs/En/11-Admin). It is a built-in plugin that cannot be uninstalled.
+
+ ---
+
+ ## 18.1 Bulk Import (Admin Area)
+
+ The bulk import is a **3-step wizard** in the admin area that allows you to import large amounts of manufacturer, filament, and color data from the FilaManDB.
+
+ ### Step 1: Select Manufacturers
+
+ 1. Click **"Load Preview"** – FilaMan loads the available data from the FilaManDB (manufacturers, materials, colors, filaments, spool profiles)
+ 2. A **summary** shows the amount of available data
+ 3. Optional: Use the **material filter** to narrow the manufacturer list to specific material types (e.g. only manufacturers offering PLA)
+ 4. Select the desired manufacturers via checkboxes
+ - Manufacturers already present in FilaMan are marked with **"Already exists"**
+ - Buttons: **"Select all"**, **"Select all new"** (only new ones), **"Deselect all"**
+
+ ### Step 2: Select Filaments
+
+ 1. After selecting manufacturers, the associated filaments are loaded
+ 2. For each selected manufacturer, the list of available filaments is displayed
+ 3. Select the desired filaments via checkboxes
+
+ ### Step 3: Import Settings & Execution
+
+ **Spool profile target:** Choose where spool profile information (empty weight, diameter, width, material) should be stored:
+
+ | Option | Description |
+ |--------|-------------|
+ | **On Filament** | Spool data is stored on each filament |
+ | **On Manufacturer** | Spool data is stored once on the manufacturer |
+ | **Both** | Spool data is stored on both the filament and the manufacturer |
+
+ Click **"Start Import"** to execute the import. After completion, a **result summary** is displayed:
+
+ | Category | Display |
+ |----------|---------|
+ | **Manufacturers** | Created / Skipped / Failed |
+ | **Logos** | Downloaded / Failed |
+ | **Colors** | Created / Skipped |
+ | **Filaments** | Created / Skipped / Failed |
+
+ Any warnings or errors that occurred are also displayed.
+
+ ---
+
+ ## 18.2 Updating Existing Filaments
+
+ If filaments have already been imported and data has changed in the FilaManDB, they can be updated:
+
+ 1. Enable the **"Update existing"** toggle in the import wizard
+ 2. FilaMan automatically calculates a **diff** (comparison) between the local and current FilaManDB data
+ 3. Changes are displayed as a table: **Field Name**, **Current Value**, **New Value**
+ 4. Only actually changed filaments will be updated
+
+ ---
+
+ ## 18.3 Fuzzy Matching
+
+ During import, FilaMan recognizes existing filaments even when the name **differs slightly** (e.g. due to typos, different spellings, or missing special characters).
+
+ **How it works:**
+ - Names are normalized (lowercase, special characters removed) and split into individual words (tokens)
+ - Two names are considered matching if at least **75%** of the tokens overlap
+ - Fuzzy matches are visually highlighted in the import
+
+ > **Example:** "Prusament PLA Galaxy Black" and "Prusament PLA Galaxy-Black 1.75mm" are recognized as matching.
+
+ ---
+
+ ## 18.4 Inline Lookup in Forms
+
+ In addition to the bulk import, FilaMan also allows you to **load individual entries directly in forms** from the FilaManDB. This feature is available on the following pages:
+
+ ### Creating / Editing Manufacturers
+
+ When creating a new manufacturer, you can choose between two modes:
+ - **"Create from FilaManDB"** – Search the community database and import name, website, and logo
+ - **"Manual entry"** – Enter the data manually as before
+
+ When **editing** an existing manufacturer, the **"Load from FilaManDB"** button is also available to update the data.
+
+ → See [Chapter 5: Manufacturers](/Docs/En/05-Manufacturers)
+
+ ### Creating / Editing Filaments
+
+ After selecting a manufacturer, the **"Load from FilaManDB"** button appears. With it you can:
+ - Search for a filament in the community database
+ - All fields are automatically pre-filled (designation, material, diameter, colors, price, etc.)
+ - If the manufacturer or colors do not yet exist locally, they are automatically created
+
+ → See [Chapter 6: Filaments](/Docs/En/06-Filaments)
+
+ ### Creating / Editing Spools
+
+ When creating or editing a spool, the **"Load from FilaManDB"** button is available for **spool profile data**:
+ - Search for a spool profile (e.g. by manufacturer or material)
+ - Empty weight, diameter, and width are automatically applied
+ - If available, an image of the spool profile is displayed
+
+ → See [Chapter 7: Spools](/Docs/En/07-Spools)
+
+ ---
+
+ > **Note:** All FilaManDB buttons and features are only displayed when the FilamentDB plugin is enabled under [Admin → System](/Docs/En/11-Admin).
+
+ ---
+
+ ← [Back: Plugin: Bambuddy](/Docs/En/17-Plugin-Bambuddy) | [Next: Installation on Raspberry Pi →](/Docs/En/20-Installation-Raspberry-Pi)
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9