github OctoPrint/OctoPrint 1.3.0
1.3.0 (stable)
on GitHub

latest releases: 1.10.1, 1.10.0, 1.10.0rc4...
7 years ago

Note for plugin authors

As always I've done my best to ensure backwards compatibility with regards to documented functionality and APIs. If you depended on any undocumented quirks/bugs however, those things might have changed, so best check that your plugin still works fine. In general I'd strongly suggest to always keep an eye on OctoPrint's ongoing development for that reason as well.

Features

  • You can now create folders in the file list, upload files into said folders and thus better manage your projects' files.
  • New wizard dialog for system setups that can also be extended by plugins. Replaces the first run dialog for setting up access control and can also be triggered in other cases than only the first run, e.g. if plugins necessitate user input to function properly. Added wizards to help configuring the following components in OctoPrint on first run: access control, webcam URLs & ffmpeg path, server commands (restart, shutdown, reboot), printer profile. Also extended the bundled Cura plugin to add a wizard for its first setup to adjust path and import a slicing profile, and the bundled Software Update plugin to ask the user for details regarding the OctoPrint update configuration. Also see below.
  • New command line interface (CLI). Offers the same functionality as the old one plus:
    • a built-in API client (octoprint client --help)
    • built-in development tools (octoprint dev --help)
    • extendable through plugins implementing the octoprint.cli.commands hook (octoprint plugins --help)
  • New features within the plugin system:
    • Plugins may now give hints in which order various hooks or mixin methods should be called by optionally providing an integer value that will be used for sorting the callbacks prior to execution.
    • Plugins may now define configuration overlays to be applied on top of the default configuration but before config.yaml.
    • New mixin UiPlugin for plugins that want to provide an alternative web interface delivered by the server.
    • New mixin WizardPlugin for plugins that want to provide wizard components to OctoPrint's new wizard dialog.
    • New hook octoprint.cli.commands for registering a command with the new OctoPrint CLI
    • New hook octoprint.comm.protocol.gcode.received for receiving messages from the printer
    • New hook octoprint.printer.factory for providing a custom factory to contruct the global PrinterInterface implementation.
    • New TemplatePlugin template type: wizard
  • New Javascript client library for utilizing the server's API, can be reused by UiPlugins.
  • OctoPrint will now track the current print head position on pause and cancel and provide it as new template variables pause_position/cancel_position for the relevant GCODE scripts. This will allow more intelligent pause codes that park the print head at a rest position during pause and move it back to the exact position it was before the pause on resume (Example). Note that this is NOT enabled by default and for now will necessitate adjusting the pause and resume GCODE scripts yourself since position tracking with multiple extruders or when printing from SD is currently not fool proof thanks to firmware limitations regarding reliable tracking of the various E values and the currently selected tool T. In order to fully implement this feature, the following improvements were also done:
    • New PositionUpdated event when OctoPrint receives a response to an M114 position query.
    • Extended PrintPaused and PrintCancelled events with position data from M114 position query on print interruption/end.
  • Added (optional) firmware auto detection. If enabled (which it is by default), OctoPrint will now send an M115 to the printer on initial connection in order to try to figure out what kind of firmware it is. For FIRMWARE_NAME values containing "repetier" (case insensitive), all Repetier-specific flags will be set on the comm layer. For FIRMWARE_NAME values containing "reprapfirmware" (also case insensitive), all RepRapFirmware-specific flags will be set on the comm layer. For now no other handling will be performed.
  • Added safe mode flag --safe and config setting startOnceInSafeMode that disables all third party plugins when active. The config setting will automatically be removed from config.yaml after the server has started through successfully.
  • Added octoprint config CLI that allows easier manipulation of config.yaml entries from the command line. Example: octoprint config set --bool server.startOnceInSafeMode true

Improvements

  • #1048 - Added "Last print time" to extended file information (see also #1522)
  • #1422 - Added option for post roll for timed timelapse to duplicate last frame instead of capturing new frames. That makes for a faster render at the cost of a still frame at the end of the rendered video. See also #1553.
  • #1551 - Allow to define a custom bounding box for valid printer head movements in the printer profile, to make print dimension check more flexible.
  • #1583 - Strip invalid pip arguments from pip uninstall commands, if provided by the user as additional pip arguments.
  • #1593 - Automatically migrate old manual system commands for restarting OctoPrint and rebooting or shutting down the server to the new system wide configuration settings. Make a backup copy of the old config.yaml before doing so in case a manual rollback is required.
  • New central configuration option for commands to restart OctoPrint and to restart and shut down the system OctoPrint is running on. This allows plugins (like the Software Update Plugin or the Plugin Manager) and core functionality to perform these common administrative tasks without the user needing to define everything redundantly.
  • pip helper now adjusts pip install parameters corresponding to detected pip version:
    • Removes --process-dependency-links when it's not needed
    • Adds --no-use-wheel when it's needed
    • Detects and reports on completely broken versions
  • Better tracking of printer connection state for plugins and scripts:
    • Introduced three new Events Connecting, Disconnecting and PrinterStateChanged.
    • Introduced new GCODE script beforePrinterDisconnected which will get sent before a (controlled) disconnect from the printer. This can be used to send some final commands to the printer before the connection goes down, e.g. M117 Bye from OctoPrint.
    • The communication layer will now wait for the send queue to be fully processed before disconnecting from the printer for good. This way it is ensured that the beforePrinterDisconnected script or any further GCODE injected into it will actually get sent.
  • Additional baud rates to allow for connecting can now be specified along side additional serial ports via the settings dialog and the configuration file.
  • Option to never send checksums (e.g. if the printer firmware doesn't support it), see #949.
  • Added secondary temperature polling interval to use when printer is not printing but a target temperature is set - this way the graph should be more responsive while monitoring a manual heatup.
  • Test buttons for webcam snapshot & stream URL, ffmpeg path and some other settings (see also #183).
  • Temperature graph automatically adjusts its Y axis range if necessary to accomodate the plotted data (see also #632).
  • "Fan on" command now always sends S255 parameter for better compatibility across firmwares.
  • Warn users with a notification if a file is selected for printing that exceeds the current print volume (if the corresponding model data is available, see also #1254)
  • Added option to also display temperatures in Fahrenheit (see also #1258)
  • Better error message when the config.yaml file is invalid during startup
  • API now also allows issuing absolute jogging commands to the printer
  • Printer profile editor dialog refactored to better structure fields and explain where they are used
  • Option to detect z-hops during z-based timelapses and not trigger a snapshot (see also 1148)
  • File rename, move and copy functionality exposed via API, not yet utilized in stock frontend but available in file manager plugin.
  • Try to assure a sound SSL environment for the process at all times
  • Improved caching:
    • Main page and asset files now carry proper ETag and Last-Modified headers to allow for sensible browser-side caching
    • API sets Etag and/or Last-Modified headers on responses to GET requests where possible and feasible to allow for sensible browser-side caching
  • Renamed GcodeFilesViewModel to FilesViewModel - plugin authors should accordingly update their dependencies from gcodeFilesViewModel to filesViewModel. Using the old name still works, but will log a warning and stop working with 1.4.x.
  • Make sure volume.depth for circular beds is forced to volume.width in printer profiles
  • Support for M116
  • Support M114 responses without whitespace between coordinates (protocol consistency - who needs it?).
  • M600 is now marked as a long running command by default.
  • Don't focus files in the file list after deleting a file - made the list too jumpy.
  • Cura plugin: "Test" button to check if path to cura engine is valid.
  • Cura plugin: Wizard component for configuring the path to the CuraEngine binary and for importing the first slicing profile
  • GCODE viewer: Added Layer Up/Down buttons (see also #1306)
  • GCODE viewer: Allow cycling through layer via keyboard (up, down, pgup, pgdown)
  • GCODE viewer: Allow changing size thresholds via settings menu (see also #1308)
  • GCODE viewer: Added support for GCODE arc commands (see also #1382)
  • Language packs: Limit upload dialog for language pack archives to .zip, .tar.gz, .tgz and .tar extensions.
  • Plugin Manager: Adjusted to utilize new pip helper
  • Plugin Manager: Show restart button on install/uninstall notification if restart command is configured and a restart is required
  • Plugin Manager: Track managable vs not managable plugins
  • Plugin Manager: Allow hiding plugins from Plugin Manager via config.yaml.
  • Plugin Manager: Limit upload dialog for plugin archives to .zip, .tar.gz, .tgz and .tar extensions.
  • Plugin Manager: Allow closing of all notifications and close them automatically on detected server disconnect. No need to keep a "Restart needed" message around if a restart is in progress.
  • Software Update plugin: More verbose output for logged in administrators. Will now log the update commands and their output similar to the Plugin Manager install and uninstall dialog.
  • Software Update plugin: CLI for checking for and applying updates
  • Software Update plugin: Wizard component for configuring OctoPrint's update mechanism
  • Software Update plugin: "busy" spinner on check buttons while already checking for updates.
  • Software Update plugin: Prevent update notification when wizard is open.
  • Plugin Manager / Software Update plugin: The "There's a new version of pip" message during plugin installs and software updates is no longer displayed like an error.
  • Plugin Manager / Software Update plugin: The "busy" dialog can no longer be closed accidentally.
  • Timelapse: Better (& earlier) reporting to the user when something's up with the snapshot URL causing issues with capturing timelapse frames and hence making it impossible to render a timelapse movie on print completion.
  • Virtual printer: Usage screen for the !!DEBUG commands on !!DEBUG, !!DEBUG:help or !!DEBUG:?
  • Updated frontend dependencies (possibly relevant for plugin authors):
    • Bootstrap to 2.3.2
    • JQuery to 2.2.4
    • Lodash to 3.10.1
    • SockJS to 1.1.1
  • Better error resilience against errors in UI components.
  • Various improvements in the GCODE interpreter which performs the GCODE analysis
  • Various adjustments towards Python 3 compatibility (still a work in progress though, see also #1411, #1412, #1413, #1414)
  • Various code refactorings
  • Various small UI improvements
  • Various documentation improvements

Bug fixes

  • #1047 - Fixed 90 degree webcam rotation for iOS Safari.
  • #1148 - Fixed retraction z hop setting for Z-triggered timelapses. Was not correctly propagated to the backend and hence not taking effect.
  • #1567 - Invalidate /api/settings cache on change of the user's login state (include user roles into ETag calculation).
  • #1586 - Fixed incompatibility of update script and command line helper with non-ASCII output from called commands.
  • #1588 - Fixed feedback controls again.
  • #1599 - Properly handle exceptions that arise within the update script during runtime.
  • It's not possible anymore to select files that are not machinecode files (e.g. GCODE) for printing on the file API.
  • Changes to a user's personal settings via the UI now propagate across sessions.
  • Improved compatibility of webcam rotation CSS across newer browsers (see also #1436)
  • Fix for system menu not getting properly reloaded after entries changed
  • Invalidate /api/settings cache on change of the currently enabled plugins (by including plugin names into ETag calculation) and/or on change of the current effective config.
  • Fix for /api/settings not being properly invalidated for plugin settings that do not have a representation in config.yaml but are only added at runtime (and hence are not captured by config.effective).
  • Invalidate /api/timelapse cache on change of the current timelapse configuration.
  • Fixed an issue causing the version number not to be properly extracted from sdist tarballs generated under Windows.
  • Get rid of double scroll bar in printer profile editor.
  • Fixed tracking of current byte position in file being streamed from disk. Turns out that self._handle.tell lied to us thanks to line buffering.
  • Fixed select & print not working anymore for SD files thanks to a timing issue.
  • Fixed PrintFailed event payload (was still missing new folder relevant data).
  • Fixed premature parse stop on M114 and M115 responses with ok-prefix.
  • Make sure ?l10n request parameter gets also propagated to API calls as X-Locale header in case of locale sensitive API responses.
  • Fix language mixture due to cached template configs including localized strings; cache per locale.
  • Only insert divider in system menu after core commands if there are custom commands.
  • Fix update of webcam stream URL not being applied due to caching.
  • Fixed a rare race condition causing the new "The settings changed, reload?" popup to show up even when the settings change originated in the same client instance.
  • Fixed a bunch of missing translations.
  • Pinned Tornado version to 4.0.2. Former version requirement was able to pull in a beta version causing issues with websockets due to a bug in permessage-deflate handling. The Tornado requirement needs an update, but we'll leave it at 4.0.2 for 1.3.0 since we'll need to do some migration work for compatibility with anything newer. Potentially related to #1523.
  • Fix a rare race condition in the command line helper and the update script that could cause the code to hang due to waiting on an event that would never be set.
  • Fix issue with handling new settings substructures when they are compared to existing settings data in order to find the structural diff.
  • Fix for the temperature graph not displaying the data history on site reload.

More information

Check out latest releases or
releases around OctoPrint/OctoPrint 1.3.0

Don't miss a new OctoPrint release

NewReleases is sending notifications on new releases.

Get notifications