OctoPrint/OctoPrint
OctoPrint
OctoPrint is a web-based platform for remotely controlling and monitoring 3D printers. It provides a browser dashboard to start, pause, cancel, and track print jobs, while streaming real-time printer status, temperature, and progress updates. The system is built around a plugin-based architecture that allows extending core functionality, and it offers a documented REST API for programmatic printer control and data management.
The platform distinguishes itself through its comprehensive automation and extensibility capabilities. It supports event-driven workflows that automatically execute custom GCODE scripts or system commands in response to printer and server events. A dual REST API and command-line interface provides flexible remote control options, while the plugin system enables community-developed integrations and custom UI controls. OctoPrint also includes a virtual printer simulation for testing and development without physical hardware.
Beyond core control and monitoring, OctoPrint handles file management, GCODE visualization, model slicing through integrated engines, and timelapse recording from connected webcams. It provides user account management with role-based access control, API key authentication, and firmware safety scanning. The system supports configuration backup and restore, automated software updates, and network printer discovery for easy connection setup.
Features
- Remote 3D Printer Managers - Provides a web-based dashboard for remotely monitoring, controlling, and managing 3D printers from any browser.
- File Managers - Provides a file manager for uploading, organizing, deleting, and previewing G-code files on the printer.
- Printer File Managers - OctoPrint removes a specific file from the printer's storage permanently.
- REST API Integrations - Provides a documented HTTP interface for programmatic printer control and data management.
- REST APIs - Ships a documented REST API for programmatic printer control and data management.
- Direct Command Sends - Issues G-code or custom commands to a printer and returns the response for immediate execution.
- Feature Extension Plugins - Installs community or custom plugins to add new features like custom controls, backup, and GCode visualization.
- File and Job Managers - Manages GCode files and controls the print job queue from the web interface.
- Job Controllers - Provides a web interface and API for starting, pausing, canceling, and tracking 3D print jobs.
- 3D Printer Serial Bridges - Manages bidirectional serial communication with printers including command queuing and protocol parsing.
- Serial Connection Establishments - Establishes the serial connection to the 3D printer for communication.
- Serial Parameter Configurations - Configures serial port, baud rate, timeouts, and command handling for printer communication.
- 3D Printer Motion Control - Controls printer axis movement via API calls for positioning.
- Printer File Downloads - OctoPrint streams a stored file from the printer to the requesting client.
- API Access Security - Restricts API access by requiring a valid API key on each request.
- Role-Based Access Controls - Requires login and checks permissions before allowing printer control.
- Role-Based Access Control - Restricts web interface and API actions based on user roles.
- User Role Assignments - Assigns predefined roles to users to control access to printer operations and settings.
- Security and Access Control - Restricts web interface access with user accounts and role-based permissions.
- User Access Controls - Restricts web interface access with user login and authentication options.
- 3D Print Job Lifecycle Controls - Provides REST API endpoints for full lifecycle control of 3D print jobs.
- Dashboard Print Job Controls - Provides a web dashboard to start, pause, cancel, and track print jobs with real-time feedback.
- Print Job Cancellations - Stops the active print operation and resets the printer to an idle state.
- Print Job Pauses - Suspends the current print operation mid-print without canceling the job.
- Print Job Resumes - Resumes a paused print from the exact point where it stopped.
- Print Job Starts - Begins executing a loaded file, transitioning the printer from idle to printing state.
- 3D Printer Plugin Hooks - Extends core functionality through a plugin system with hooks into printer events and UI components.
- Configuration Profiles - Ships a configuration system for printer profiles, serial connections, temperature presets, and slicing parameters.
- GCODE Managers - Provides a tool for uploading, organizing, and slicing 3D model files into printable GCODE instructions.
- REST APIs - Exposes a documented REST API for programmatic printer control, file management, and status queries.
- 3D Print Progress Monitors - Displays real-time status, temperature, and progress of an active print job through the web interface.
- Real-Time Monitors - Streams live status updates, temperatures, and a visual G-code viewer to the browser during a print.
- Printer Configuration - Adjusts printer profiles, slicing parameters, and connection settings through a YAML file or web UI.
- 3D Printer Profile Definitions - Stores and switches between multiple printer definitions including build volume, axes, and tool head settings.
- 3D Printer Profile Switching - Stores and switches between multiple printer configurations including bed size and firmware settings.
- Printer Profile CRUD APIs - Creates, reads, updates, and deletes printer profile definitions storing hardware settings and dimensions.
- Web-Based 3D Printer Settings - Adjusts printer profiles, connection parameters, and slicing options through a web-based configuration panel.
- Temperature Settings - Sets target temperatures for the printer's hotend and heated bed.
- Remote 3D Printer Controllers - Provides a web-based interface to start, pause, cancel, and monitor print jobs on a connected 3D printer.
- Job Status Monitoring - Displays real-time printer status and job progress through a browser-based dashboard.
- 3D Printer Status Streaming - Streams real-time printer status, temperature, and job progress via WebSocket connections.
- Polling Mechanisms - Polls the printer's current state and reports temperature, progress, and connection status in real time.
- REST API Polling - Retrieves real-time temperature, progress, and status data from a connected 3D printer via a REST API.
- G-Code Syntax Validators - Checks uploaded G-Code files for common errors before printing to prevent failures.
- File Upload Management - Transfers files to the printer's storage for later printing or management.
- GCODE File Managers - Provides a dedicated manager for uploading, listing, deleting, and organizing GCODE files on the printer.
- Print File Managers - Uploads, lists, deletes, and organizes GCODE files on the printer's storage for selection and execution.
- GCODE Action Command Triggers - Processes GCODE comments to trigger predefined actions on the printer or host system.
- Integrated Slicing Engines - Integrates slicing engines to convert 3D models into printable GCODE without external tools.
- 3D Printer Event Workflows - Automatically triggers GCODE scripts and actions based on printer lifecycle events.
- Plugin Updaters - Checks for and applies available updates to installed plugins from the web interface.
- Printer Event Shell Executions - Executes shell commands or G-code sequences automatically on printer or system events.
- GCODE Event Scripting - Executes custom GCODE sequences triggered by printer events or user actions.
- 3D Printer Event Automations - Automates GCODE script and system command execution based on printer lifecycle events.
- Extrusions - Controls filament extrusion and retraction for 3D printing.
- Timelapse Recorders - Captures periodic snapshots during prints to render timelapse videos automatically from a connected webcam.
- Webcam Feeds - Streams a live webcam feed alongside real-time print status and temperature data.
- Live Webcam Feeds - Shows a live video stream from a connected webcam alongside the printer status during a print.
- Webcam Stream Configurators - Displays a live video feed from a connected webcam and enables timelapse recording with configurable encoding.
- Webcam Streams - Streams live camera feed and captures timelapse videos during print jobs.
- 3D Printing Slicing Workflows - Converts 3D model files into printer instructions using integrated or external slicing engines.
- Slicing Engine Wrappers - Integrates external slicing engines through a unified API for converting 3D models to GCODE.
- Slice Job Submissions - Submits a model file to a slicing engine and receives the resulting G-code or an error.
- Slicing Profile Managers - Creates, updates, and selects slicing profiles that define print quality and material settings.
- Virtual Printer Simulators - Emulates a physical 3D printer over a serial connection for testing without hardware.
- REST API Configurations - Exposes a REST API endpoint to retrieve current printer configuration settings as JSON.
- REST and CLI Dual Interfaces - Offers both a REST API and command-line interface for remote printer control and automation.
- User Account Management - Creates, edits, and deletes user accounts with permission settings.
- GCODE Scripting Controls - Lets users create custom buttons and scripts that automate printer tasks with GCODE commands.
- Plugin Installation and Management - Lists, enables, disables, and uninstalls plugins from the web interface without manual file manipulation.
- Repository Plugin Installations - Allows browsing and installing plugins directly from the official plugin repository via the web interface.
- Filament Temperature Presets - Stores preset target temperatures for different filament types to quickly set the hotend and bed.
- Backup and Restore - Creates downloadable archives of application configuration and restores them from saved files.
- 3D Print Path Previews - Renders a 3D preview of the print path from uploaded GCode files for visual inspection before printing.
- 3D Printer File Managers - Uploads, organizes, and deletes G-code files on the printer's storage through the web interface.
- Printer Control Panels - Creates custom buttons and sliders on the printer control panel to send GCODE commands or adjust settings.
- GCODE Command Buttons - Allows creating user-defined buttons that send G-code or system commands to the printer.
- File Upload Management - Uploads G-code and other 3D printing files directly through the browser for storage and management.
- Printer File Managers - Uploads, organizes, and deletes GCODE files on the printer through the web interface or API.
