Spoolman Integration - Migz93/3dq GitHub Wiki

Spoolman Integration

3DQ offers integration with Spoolman, a popular filament management system for 3D printing. This guide explains how to set up and use the Spoolman integration.

What is Spoolman?

Spoolman is an open-source filament manager that helps you track your filament inventory, including:

  • Spools and remaining amounts
  • Vendors and prices
  • Colors and materials
  • Usage history

By integrating Spoolman with 3DQ, you can synchronize your filament data and ensure consistent pricing across systems.

Setting Up the Integration

Prerequisites

  • A running Spoolman instance accessible from your 3DQ server
  • Filament data already configured in Spoolman

Configuration Steps

  1. Navigate to the Settings page in 3DQ
  2. Find the Spoolman Integration section
  3. Toggle Enable Spoolman to ON
  4. Enter your Spoolman URL (e.g., http://localhost:7912 or http://spoolman.local:7912)
  5. Click Test Connection to verify connectivity

If the connection test is successful, you'll see a confirmation message. If not, check your URL and ensure Spoolman is running and accessible.

Synchronizing Filaments

Once the integration is set up, you can synchronize filament data from Spoolman to 3DQ:

  1. Navigate to the Filaments page
  2. Click the Sync with Spoolman button
  3. 3DQ will fetch all filament data from Spoolman and:
    • Add new filaments that don't exist in 3DQ
    • Update existing filaments that were previously synced from Spoolman
    • Leave manually created filaments unchanged

What Gets Synchronized

The following data is synchronized from Spoolman to 3DQ:

  • Filament name
  • Material type
  • Color
  • Price information
  • Diameter
  • Density (if available)

Each synchronized filament is marked with a "Spoolman Synced" flag in the database.

Integration Details

One-Way Synchronization

The integration is one-way only: data flows from Spoolman to 3DQ, not the other way around. Any changes you make to filaments in 3DQ will not be reflected in Spoolman.

Spoolman IDs

When filaments are synchronized from Spoolman, their Spoolman IDs are stored in 3DQ. This allows the system to update the correct filaments during future synchronizations.

API Endpoint

The integration uses the Spoolman API endpoint:

GET {spoolman_url}/api/v1/spool

Troubleshooting

Connection Issues

If you're having trouble connecting to Spoolman:

  1. Verify that your Spoolman URL is correct
  2. Ensure Spoolman is running and accessible
  3. Check for any network restrictions or firewalls
  4. Try accessing the Spoolman web interface directly to confirm it's working

Synchronization Problems

If filaments aren't synchronizing correctly:

  1. Check the Spoolman API response by visiting {spoolman_url}/api/v1/spool in your browser
  2. Ensure your filaments are properly configured in Spoolman
  3. Try disabling and re-enabling the Spoolman integration

Best Practices

  1. Maintain Spoolman as the primary database: Make all filament changes in Spoolman, then sync to 3DQ
  2. Sync regularly: Synchronize before creating new quotes to ensure pricing is up to date
  3. Don't modify synced filaments in 3DQ: This could cause inconsistencies with Spoolman
  4. Use consistent naming: Follow the same naming conventions in both systems
⚠️ **GitHub.com Fallback** ⚠️