Here are some tips to get you started.
Spoolman holds 3 different types of data:
To add a new spool to the database, start by creating a
Optionally, you can also generate a
You have the option to link other 3D printer services to Spoolman, like Moonraker, which can automatically monitor filament usage and update the Spool objects for you. Refer to the
Here you can add extra custom fields to your entities.
Once a field is added, you can not change its key or type, and for choice type fields you can not remove choices or change the multi choice state. If you remove a field, the associated data for all entities will be deleted.
The key is what other programs read/write the data as, so if your custom field is supposed to integrate with a third-party program, make sure to set it correctly. Default value is only applied to new items.
Extra fields can not be sorted or filtered in the table views.
", "params": { "key": "Key", "name": "Name", "field_type": "Type", "unit": "Unit", "order": "Order", "default_value": "Default Value", "choices": "Choices", "multi_choice": "Multi Choice" }, "field_type": { "text": "Text", "integer": "Integer", "integer_range": "Integer Range", "float": "Float", "float_range": "Float Range", "datetime": "Datetime", "boolean": "Boolean", "choice": "Choice" }, "boolean_true": "Yes", "boolean_false": "No", "choices_missing_error": "You cannot remove choices. The following choices are missing: {{choices}}", "non_unique_key_error": "The key must be unique.", "key_not_changed": "Please change the key to something else.", "delete_confirm": "Delete field {{name}}?", "delete_confirm_description": "This will delete the field and all associated data for all entities." } }, "documentTitle": { "default": "Spoolman", "suffix": " | Spoolman", "home": { "list": "Home | Spoolman" }, "help": { "list": "Help | Spoolman" }, "locations": { "list": "Locations | Spoolman" }, "filament": { "list": "Filaments | Spoolman", "show": "#{{id}} Show Filament | Spoolman", "edit": "#{{id}} Edit Filament | Spoolman", "create": "Create Filament | Spoolman", "clone": "#{{id}} Clone Filament | Spoolman" }, "spool": { "list": "Spools | Spoolman", "show": "#{{id}} Show Spool | Spoolman", "edit": "#{{id}} Edit Spool | Spoolman", "create": "Create Spool | Spoolman", "clone": "#{{id}} Clone Spool | Spoolman" }, "vendor": { "list": "Manufacturers | Spoolman", "show": "#{{id}} Show Manufacturer | Spoolman", "edit": "#{{id}} Edit Manufacturer | Spoolman", "create": "Create Manufacturer | Spoolman", "clone": "#{{id}} Clone Manufacturer | Spoolman" } }, "locations": { "locations": "Locations", "new_location": "New Location", "no_location": "No Location", "no_locations_help": "This page lets you organize your spools in locations, add some spools to get started!" }, "print-queue": { "print-queue": "Print Queue" }, "print_queue": { "title": "Print Queue", "pending_jobs": "Pending Jobs", "needs_weighing": "Spools Needing Weigh-In", "recent_history": "Recent History", "no_pending_jobs": "No pending print jobs", "no_history": "No completed or cancelled jobs yet", "fields": { "filename": "Filename", "spool": "Spool", "filament_used": "Filament Used", "created": "Created", "finished": "Finished", "status": "Status" }, "status": { "pending": "Pending", "completed": "Completed", "cancelled": "Cancelled" }, "stats": { "pending": "Pending", "needs_weighing": "Need Weigh-In", "completed_today": "Completed Today", "total_jobs": "Total Jobs" }, "complete": "Complete", "cancel": "Cancel", "cancel_job": "Cancel Job", "weigh_in": "Weigh In", "clear_flag": "Clear Flag", "clear_flag_tooltip": "Mark as weighed without updating weight", "confirm_complete": "Complete Print Job?", "confirm_complete_description": "This will deduct {{grams}}g from the spool.", "confirm_cancel": "Cancel Print Job?", "confirm_cancel_description": "The spool will be flagged for manual weigh-in since filament usage is unknown.", "confirm_delete": "Delete Print Job?", "confirm_delete_description": "This will permanently remove this job from history.", "job_completed": "Print job completed", "job_complete_error": "Failed to complete print job", "job_cancelled": "Print job cancelled - spool flagged for weigh-in", "job_cancel_error": "Failed to cancel print job", "job_deleted": "Print job deleted", "weighing_cleared": "Weigh-in flag cleared" } }