Blame
|
1 | # Plugin: SpoolmanDB Import |
||||||
| 2 | ||||||||
| 3 | The **SpoolmanDB Import Plugin** allows you to import filament data from the [SpoolmanDB community database](https://github.com/Donkie/SpoolmanDB) directly into FilaMan. SpoolmanDB is an open, community-maintained database containing filament information from numerous manufacturers. |
|||||||
| 4 | ||||||||
|
5 | **Installation:** → [Admin: Plugin Management](/Docs/En/11-Admin#115-system-plugin-management) |
||||||
|
6 | |||||||
| 7 | --- |
|||||||
| 8 | ||||||||
| 9 | ## Overview |
|||||||
| 10 | ||||||||
| 11 | | Property | Value | |
|||||||
| 12 | |----------|-------| |
|||||||
| 13 | | **Plugin Type** | Import | |
|||||||
| 14 | | **Author** | FilaMan | |
|||||||
| 15 | | **Source** | [Fire-Devils/filaman-plugins](https://github.com/Fire-Devils/filaman-plugins) (Registry) | |
|||||||
| 16 | | **Data Source** | [SpoolmanDB](https://github.com/Donkie/SpoolmanDB) (GitHub) | |
|||||||
| 17 | | **Capabilities** | Manufacturer import, Filament import, Color import, Diameter filter | |
|||||||
| 18 | ||||||||
| 19 | --- |
|||||||
| 20 | ||||||||
| 21 | ## What is SpoolmanDB? |
|||||||
| 22 | ||||||||
| 23 | [SpoolmanDB](https://github.com/Donkie/SpoolmanDB) is a community-maintained open-source database containing filament information from many manufacturers. It includes: |
|||||||
| 24 | ||||||||
| 25 | - Manufacturer names |
|||||||
| 26 | - Filament names and material types |
|||||||
| 27 | - Colors (single and multi-color) |
|||||||
| 28 | - Diameter, weight, and density |
|||||||
| 29 | - Recommended extruder and bed temperatures |
|||||||
| 30 | - Spool weight and spool material |
|||||||
| 31 | - Surface properties (translucent, glow, etc.) |
|||||||
| 32 | ||||||||
| 33 | --- |
|||||||
| 34 | ||||||||
| 35 | ## Import Page |
|||||||
| 36 | ||||||||
| 37 | After installing the plugin, you can find the import page at: |
|||||||
| 38 | ||||||||
| 39 | **Admin → System → SpoolmanDB Import** |
|||||||
| 40 | ||||||||
| 41 | The import page guides you through the process in three steps. |
|||||||
| 42 | ||||||||
| 43 | --- |
|||||||
| 44 | ||||||||
| 45 | ## Step 1: Choose Import Mode |
|||||||
| 46 | ||||||||
| 47 | ### Diameter Filter |
|||||||
| 48 | ||||||||
| 49 | Before selecting the import mode, you can optionally filter by **diameter**: |
|||||||
| 50 | ||||||||
| 51 | | Option | Description | |
|||||||
| 52 | |--------|-------------| |
|||||||
| 53 | | **All diameters** | No filtering | |
|||||||
| 54 | | **1.75 mm** | Only 1.75 mm filaments (default) | |
|||||||
| 55 | | **2.85 mm** | Only 2.85 mm filaments | |
|||||||
| 56 | ||||||||
| 57 | ### Import Modes |
|||||||
| 58 | ||||||||
| 59 | | Mode | Description | |
|||||||
| 60 | |------|-------------| |
|||||||
| 61 | | **Import all** | Imports all filaments and manufacturers from SpoolmanDB | |
|||||||
| 62 | | **By manufacturer** | Imports all filaments from a specific manufacturer — select the manufacturer from the dropdown | |
|||||||
| 63 | | **Single filament** | Imports a specific filament — select manufacturer (optional filter) and filament | |
|||||||
| 64 | ||||||||
| 65 | --- |
|||||||
| 66 | ||||||||
| 67 | ## Step 2: Preview |
|||||||
| 68 | ||||||||
| 69 | After selecting the import mode, you can load a **preview**. Depending on the mode, it shows: |
|||||||
| 70 | ||||||||
| 71 | - **Import all:** Total count of manufacturers and filaments |
|||||||
| 72 | - **By manufacturer:** Table listing all filaments from the chosen manufacturer (name, material, diameter) |
|||||||
| 73 | - **Single filament:** Detail view with all available information (manufacturer, name, material, diameter, weight, density, color, temperatures) |
|||||||
| 74 | ||||||||
| 75 | > **Tip:** Review the preview carefully before starting the import. |
|||||||
| 76 | ||||||||
| 77 | --- |
|||||||
| 78 | ||||||||
| 79 | ## Step 3: Execute Import |
|||||||
| 80 | ||||||||
| 81 | Click **"Start Import"** to import the selected data into FilaMan. |
|||||||
| 82 | ||||||||
| 83 | ### What Gets Imported? |
|||||||
| 84 | ||||||||
| 85 | | Data | Description | |
|||||||
| 86 | |------|-------------| |
|||||||
| 87 | | **Manufacturers** | Created as new manufacturers in FilaMan (if not already present) | |
|||||||
| 88 | | **Filaments** | Created as new filaments with all available information | |
|||||||
| 89 | | **Colors** | Created as new colors in color management (if not already present) | |
|||||||
| 90 | ||||||||
| 91 | ### Duplicate Detection |
|||||||
| 92 | ||||||||
| 93 | - **Manufacturers** are matched by name (case-insensitive) — existing ones are skipped |
|||||||
| 94 | - **Filaments** are matched by SpoolmanDB ID — previously imported ones are skipped |
|||||||
| 95 | - **Colors** are matched by hex code — existing ones are reused |
|||||||
| 96 | ||||||||
| 97 | > **Important:** Existing data in FilaMan is **never** overwritten or modified. The import only creates new entries. |
|||||||
| 98 | ||||||||
| 99 | ### Import Result |
|||||||
| 100 | ||||||||
| 101 | After the import completes, a summary is displayed: |
|||||||
| 102 | ||||||||
| 103 | | Category | Display | |
|||||||
| 104 | |----------|---------| |
|||||||
| 105 | | **Manufacturers** | Count created / skipped | |
|||||||
| 106 | | **Filaments** | Count created / skipped | |
|||||||
| 107 | | **Colors** | Count created / skipped | |
|||||||
| 108 | | **Errors** | List of any errors (e.g. missing manufacturer assignment) | |
|||||||
| 109 | ||||||||
| 110 | --- |
|||||||
| 111 | ||||||||
| 112 | ## Imported Data |
|||||||
| 113 | ||||||||
| 114 | The following filament fields are imported from SpoolmanDB (if available): |
|||||||
| 115 | ||||||||
| 116 | | SpoolmanDB Field | FilaMan Field | |
|||||||
| 117 | |-----------------|---------------| |
|||||||
| 118 | | `manufacturer` | Manufacturer | |
|||||||
| 119 | | `name` + `material` | Designation | |
|||||||
| 120 | | `material` | Material type | |
|||||||
| 121 | | `fill` | Material subgroup (e.g. glass fiber, carbon) | |
|||||||
| 122 | | `diameter` | Diameter | |
|||||||
| 123 | | `weight` | Raw material weight | |
|||||||
| 124 | | `spool_weight` | Default spool weight | |
|||||||
| 125 | | `spool_type` | Spool material | |
|||||||
| 126 | | `density` | Density | |
|||||||
| 127 | | `color_hex` / `color_hexes` | Colors (single/multi-color) | |
|||||||
| 128 | | `multi_color_direction` | Multi-color style (gradient/striped) | |
|||||||
| 129 | | `translucent` / `glow` / `finish` | Finish type | |
|||||||
| 130 | | `extruder_temp`, `bed_temp` etc. | Extra fields (custom_fields) | |
|||||||
| 131 | ||||||||
| 132 | --- |
|||||||
| 133 | ||||||||
|
134 | ← [Back: Plugin: BambuLab](/Docs/En/14-Plugin-Bambulab) | [Next: Plugin: Spoolman API →](/Docs/En/16-Plugin-Spoolmanapi) |
||||||