CHANGELOG.md

OctoPrint Changelog

1.3.9 (2018-07-25)

Still running OctoPrint 1.3.6? Heads-up!

OctoPrint 1.3.9 includes a couple of dependency updates whose update during switch to 1.3.9 are known to trigger an "update failed" message within OctoPrint's update dialog:

The update did in fact succeed and the issue lies with a change in the underlying update mechanism concerning the dependencies. This problem has been fixed in 1.3.7/1.3.8 and versions prior to 1.3.6 aren't yet affected, so there you won't ever see this message there. If you are still running 1.3.6 though and updating from it, simply run the update a second time through Settings > Software Update > Check for updates and clicking "Update now" in the reshown update notification.

Running NGINX as reverse proxy? Be sure to configure HTTP protocol version 1.1!

OctoPrint 1.3.9 updates the internal webserver Tornado from 4.0.2 to 4.5.3. Among many many fixes and improvements this also includes a change (actually a fix) in the websocket implementation that requires you to tell your NGINX to use HTTP 1.1 instead of the default 1.0 to talk to OctoPrint. You can do this by simply adding

proxy_http_version 1.1;

to the location config. The configuration examples have been adjusted accordingly. See also #2526.

Disabled IPv6 and now there are issues with the server after the update? Bind to IPv4 addresses only!

Starting with this release OctoPrint natively supports IPv6 and will attempt to bind to such addresses if it detects support in the underlying OS. If for whatever reason your OS doesn't support IPv6 even though Python's socket says otherwise, you can tell OctoPrint to bind to an IPv4 address only either via the --host command line parameter or server.host in config.yaml. Use 127.0.0.1 for localhost only, 0.0.0.0 for all IPv4 addresses or whatever specific IPv4 address you want to bind to.

Plugin author and still dependent on the legacy plugin bundling flag? Fix your plugin!

As announced with the release of OctoPrint 1.3.6, the legacy plugin bundling flag has now been removed again. Make sure to check and if necessary fix your plugins if you haven't done that so far!

Improvements

• #652 & #1545 - Added name of user who started a job to job info (see also #2576).
• #1203 & #1905 & #1797 & #2514 - Added support for plugins to override GCODE analysis provider and live print time estimation with their own implementations through two new hooks octoprint.filemanager.analysis.factory and octoprint.printer.estimation.factory.
• #1217 - Software Update Plugin: Block the UI in general when an update is in progress (even in browser windows that didn't start it and logged in as user) so that no prints can be accidentally started during that.
• #1513 - Option to allow sending M0/M1 to the printer instead of swallowing it.
• #2318 - Gcode Viewer: Visualize "current" print head location with a marker.
• #2351 - Support for binding to IPv6 addresses. OctoPrint will now default to binding to :: if IPv6 support is detected, and to 0.0.0.0 if not. Both the intermediary server and Tornado are instructed to bind their sockets to both IP versions. Positive IPv6 support detection relies on
  • socket.has_ipv6 being True
  • socket.IPPROTO_IPV6 and socket.IPV6_V6ONLY being available (or redefined in case of Windows) in order to ensure dual stack binding for the intermediary server)
• #2379 - File and plugin list now use the browser's native scrollbar instead of slimscroll. Slimscroll is still bundled though, in case third party plugins might depend on it.
• #2487 - Improved documentation of system command configuration (see also #2498).
• #2495 - Removed unneeded filter from a template.
• #2498 - Improved documentation of the async flags of custom system commands.
• #2512 - Log files will now contain client IP as provided by first entry in X-Forwarded-For header (or more if server.reverseProxy.trustDownstream is configured accordingly).
• #2518 - Display absolute file upload date and time on hover (see also #2630).
• #2522 - Perform logging to disk asynchronously to avoid slow downs caused by it.
• #2541 - Added link to instructions to reset passwords. Part of solving #1239.
• #2543 - Added --no-cache-dir to pip calls to work around MemoryErrors. See also #2535 and pypa/pip#2984 for more details.
• #2558 - Have the watched folder processor ignore hidden files.
• #2572 - More error resilience in ItemListHelper against empty child elements.
• #2573 - Added M118 to commands to never automatically upper case.
• #2583 - Handle scripts that are part of a job like other lines coming from a job and thus allow them to be kept back using job_on_hold.
• #2597 - Disabled animation on cancel print confirmation.
• #2463 - Added documentation for printingarea and dimensions in gcodeAnalysis data model (see also #2540).
• #2615 - Allowed more granular control over components to be upgraded through the software update plugin in its settings dialog.
• #2620 - Save ItemListHelper page sizes to local storage.
• #2642 - Added methods for adding and updating items to ItemListHelper.
• #2644 - Detect broken symlinks in configured folders on startup (see also further below).
• #2648 - Allowed class methods as callbacks in view models.
• A new API endpoint /api/settings/templates allows (admin only) access to information regarding the loaded templates and their order in the UI. That should allow plugins wishing to offer modification of ordering of tabs, sidebar components and so on to retrieve the data they need for that.
• Have the watched folder processor handle vanished files gracefully.
• Removed legacyPluginAssets flag.
• Improved requirement detection in octoprint_setuptools, added unit tests for that.
• Bundled sockjs-tornado dependency. It hasn't been updated by the author in a while although there exist a number of issues plus patches for them, so we now vendor it.
• Disabled position logging on cancel by default. If you need this, please explicitly enable it, it is causing too many issues in the field with misbehaving firmware.
• Extended URL test API to allow whitelist/blacklist check for the returned content type, used that to verify that the webcam snapshot URL actually returns images.
• Added timeout for position logging on pause/cancel. This should work around firmware which doesn't provide a proper M114 resport that might be unparseable so we won't get stuck in those cases.
• Migrated file storage metadata to json instead of YAML since it performs way way better.
• Added missing linenumber to recognized non-fatal error messages.
• Got rid of some Python 2 only code.
• Added sanity checks for configured folders (see also #2644):
  • on startup: check they are writable, if not revert to defaults
  • on settings save: check they are writable, if not return an HTTP 400
  • in the settings dialog: allow quick check of writability via test buttons
• Never send referrers with links
• Confirmation dialog helper now supports an HTML body.
• Sort serial ports naturally (e.g. tty1, tty2, ..., tty10 instead of tty1, tty10, ...)
• Added paused and resumed action commands, see here for details.
• Added two new hooks for firmware information, octoprint.comm.firmware.info and octoprint.comm.firmware.capabilities.
• Added view model list to OctoPrint.coreui UI module.
• Improved logging of FatalStartupErrors.
• Add sanity check for disabled plugin list (see also #2687 (comment)).
• Improve logging of exceptions triggered inside the state update worker (see also #2715).
• Workaround for a potential pip issue when updating components through the Software Update plugin.
• Fix resend and timeout handling during an active job_on_hold.
• Updated some dependencies:
  • Tornado to 4.5. Version 5 sadly has issues with web socket handling when access behind haproxy. So far no solution has been found, so we stay at 4.5 for now.
  • jQuery to 3.3.1
  • Several other Python dependencies
• Announcement Plugin: Don't reload all notifications if one is marked as read.
• Printer Safety Plugin: Added new detected firmwares:
  • Anycubic Mega
  • Malyan M200
  • CR-10S
  • all Repetier firmware versions prior to 0.92
  • any firmware that reports the THERMAL_PROTECTION capability as disabled to thermal protection warning (see also MarlinFirmware/Marlin#10465)
• Software Update Plugin: Default to force_base = False for version checks.
• Virtual Printer Plugin: Allow defining custom M114 response formats.

Bug fixes

• #2333 (Part 3/3) - Updated to PySerial 3.4 and utilize read and write cancelling to work around disconnect delays.
• #2355 - Fixed non deterministic sorting of files with missing fields (e.g. date for SD card files) in OctoPrint's frontend.
• #2496 - Fixed files API not allowing to walk through the directory tree unless fetching the full listing recursively by making sure that first level children nodes are always provided.
• #2502 - Fixed some invalid HTML
• #2504 & #2532 & #2552 - Fixed various typos
• #2505 - Fixed user switch to _api user on use of the global API key inside the browser.
• #2509 - Properly handle a printer reset while printing and don't get stuck in "Cancelling" state
• #2517 - Fixed baudrate negotiation with printers that need a bit of a delay between connection establishment and probing (e.g. Prusa MK3).
• #2520 - Fixed temperature presets being saved as strings instead of numbers.
• #2533 - Fixed API key copy button being enabled and generate button being disabled when no API key is set.
• #2534 - Fixed stale data in API key/user editor. See also #2604.
• #2539 - Made serial and baud rate lists consistent between connection panel and settings (see also #2606).
• #2547 - Fixed PrintFailed being triggered in case of an error while processing the afterPrintJobDone GCODE script through introduction of Resuming and Finishing states.
• #2549 - Fixed "uninstall plugin" icon in Plugin Manager staying clickable even if disabled.
• #2549 - Fixed issue with detection uninstallation of disabled plugins (see also #2650).
• #2551 - Fixed 0 being allowed for various intervals and timeouts where that values doesn't make sense.
• #2554 - Fixed a JSON example in the docs.
• #2568 - Fixed a dead link in the plugin hooks documentation in the docs.
• #2579 - Fixed print time left of "a couple of seconds" even after the print job has finished.
• #2581 & #2587 - Fixed OctoPrint getting stuck in "Pausing" or "Cancelling" state due to a race condition.
• #2589 - Added missing typePath field on API response for files on the printer's SD card.
• #2591 - Fixed markup of some HTML labels.
• #2595 - Fixed some UI appearance issues.
• #2601 - Properly handle relative paths for selection via printer.select_file.
• #2621 - Fixed framerate not being read from config for rendering unrendered timelapses.
• #2625 - Fixed incompatibility of OctoPrint's plugin subsystem with Python wheels, which are the default mode of installing plugins from pip version 10.0.0 onward.
• #2632 - Fixed race condition in resend handling on missing oks.
• #2675 - Fixed a possible division by zero on SD upload.
• #2677 (regression) - Fix a deadlock when job_on_hold is utilized (causing issues at least with Octolapse)
• #2683 - Fixed two missing spaces in the german translation.
• #2715 (regression) - Fix broken estimator initialization on SD print start and resulting crash of the state update worker.
• #2719 (regression) - Fix live print time estimation
• #2737 (regression) - Fix print button being enabled even though no file is selected.
• #2738 (regression) - Limit the use of the --no-cache-dir argument added to pip calls to such versions of pip that already support it (anything newer than 1.5.6).
• Properly handle absolute paths for recovery data comparison.
• Fixed snapshot test button not resetting on error.
• Fixed decoupling of metadata logs in the file manager.
• Fixed "remember me" and IPv4/IPv6 sessions. This might also solve #1881.
• Removed Repetier resend repetition detection and handling code. It was buggy and introducing issues.
• Fixed script order: beforePrint* should always precede any commands from the print job.
• Only perform write tests on directories where necessary. Especially avoid them on page rendition to prevent misconfigured folders from triggering an HTTP 500. (regression)

Special thanks to all the contributors!

Special thanks to everyone who contributed to this release, especially @benlye, @dadosch, @dforsi, @ganey,@malnvenshorn, @ntoff, @tedder and @vitormhenrique for their PRs.

More information

• Commits
• Release Candidates:
  • 1.3.9rc1
  • 1.3.9rc2
  • 1.3.9rc3
  • 1.3.9rc4
  • A big Thank you! to everyone who reported back on these release candidates this time: arhi, b-morgan, brandstaetter, buchnoun, CapnBry, chatrat12, ChrisHeerschap, christianlupus, chrisWhyTea, Crowlord, ctgreybeard, Cyberwizzard, DrJuJu, ejjenkins, fieldOfView, FormerLurker, four-of-four, Galfinite, gege2b, HFMan, jjlink, jneilliii, JohnOCFII, jwg3, kazibole, larp-welt, McFly99, mod38, ntoff, OutsourcedGuru, paukstelis, pingywon, pscrespo, Rapsey, tech-rat, tedder, thess, Thisismydigitalself, tibmeister

1.3.8 (2018-04-13)

Bug fixes

• #2577 - Pin psutil dependency to version 5.4.3 since 5.4.4 as released today introduces a breaking change.

(Commits)

1.3.7 (2018-04-09)

Improvements

• #324 & #2414 - Native support for the following @ commands: @pause (pauses the print), @resume (resumes the print), @cancel or @abort (cancels the print). More commands can be added through the plugin hooks octoprint.comm.protocol.atcommand.*.
• #1951 - Fixed plugins being able to modify internal state data (e.g. progress, job), causing concurrent modification and resulting run time errors in the printer state processing.
• #2208 - New plugin hook octoprint.comm.protocol.gcode.error to allow plugins to override OctoPrint's handling of Error:/!! messages reported by the firmware. Can be used to "downgrade" errors that aren't actually fatal errors that make the printer halt.
• #2213 - Made sure to prevent accidental configuration of a temperature cutoff value less than 1min for the temperature graph.
• #2250 - Added octoprint.util.ResettableTimer helper class.
• #2287 - Added confirmation for attempting to disconnect during an ongoing print. See also #2466.
• #2302 - Detect invalid tools as reported by firmware and blacklist them for T commands.
• #2317 - Removed capturing of post roll images for time based timelapses, was causing too much confusion and surprise.
• #2335 - First throw at detecting if a print from the printer's SD was started outside of OctoPrint via the printer's control panel. Requires some specific requirements to be fulfilled by the printer's firmware to function properly:
  • Firmware must send a "File opened: ..." message on start of the print
  • Firmware must respond to an immediately sent M27 with SD printing byte <current>/<total>
  • Firmware must stay responsive during ongoing print to allow for regular M27 polls (or push those automatically) or M25 to pause/cancel the print through OctoPrint.
  • Firmware must send Done printing file or respond to M27 with Not SD printing when SD printing finishes (either due to being done or to having been cancelled by the user).
• #2362 - Added option to configure timelapse snapshot timeout.
• #2367 - Added support for //action:cancel action command.
• #2378 - Made GCODE viewer gracefully handle GCODE subcodes.
• #2385 - Made valid boolean trues check case insensitive.
• #2304 & #2405 - Added support to trust Basic Authentication headers for user login. Currently requires manual configuration through config.yaml, see the accessControl.trustBasicAuthentication and accessControl.checkBasicAuthenticationPassword settings.
• #2338 - Allowed plugins to define GCODE script variables using the octoprint.comm.protocol.scripts hook.
• #2406 - Extracted log management into its own bundled plugin and allow fine tuning of log levels.
• #2409 - Added m4v and mkv to the list of accepted timelapse extensions.
• #2444 - Support additional CSS classes on custom control buttons.
• #2448 - Also detect plugins in ~/.octoprint/plugins that are provided as bytecode pyc instead of source py files.
• #2455 - Added option to configure SSL validation for snapshot URL.
• Support M114 response format of RepRapFirmware (uses X:... Y:... Z:... E0:... E1:... instead of X:... Y:... Z:... E:...)
• Added refresh button to connection panel for easy refresh of the available ports to connect to without having to reload the whole page.
• Increased upper bound of PySerial dependency from 2.7 to 3.4. See also #2333.
• Switch to lower communication timeouts if support of the busy protocol by the firmware is detected.
• Refactored serial settings dialog, now has sub tabs and more explanations.
• Allow to disable support for certain firmware capabilities, even if reported as supported by the firmware: busy protocol, temperature auto reporting, SD status auto reporting
• Attached tags to GCODE commands moving through the comm layer and allowed plugins to access and extend these tags through the GCODE hooks. Makes it possible for plugins to detect the origin of a command (streamed file vs. GCODE script vs. user input vs. plugin), the point where it entered the system and so on. Also added a new logger octoprint.util.comm.command_phases that if set to DEBUG will log the lifecycle of commands through the comm layer including tags to octoprint.log. See also the docs here.
• Added new job_on_hold and set_job_on_hold methods on the printer instance, allowing plugins to quickly stall the streaming of a queue. This should be used sparingly - abuse will have significant negative effects on the print job. Read the docs if you plan to utilize this.
• Support extraction of plugin metadata even from disabled and blacklisted plugins through the AST of the module.
• Better logging of printer callback errors and utilization of frozendict for internal printer state propagation in an attempt to narrow down on #1951. Should frozendict cause issues it can be disabled through the settings in config.yaml, just set devel.useFrozenDictForPrinterState to false
• Log comm state changes to octoprint.log.
• Added a regular server heartbeat to the log (every 15min).
• Support SD status auto report by the firmware.
• Added Not SD printing to default "SD status" terminal filters.
• Added custom readline implementation for the serial port. Instead of relying on PySerial's readline that depending on the installed version might only read from the port one byte at the time, we now wait for one byte and then read everything available into a persistent buffer which then is used to fetch lines from.
• Ensure that callViewModelIf doesn't try to call null or uncallable methods.
• Added links to the new Community Forum and the new location of the FAQ.
• Improved pip utility logging, LocalPipHelper wasn't producing output, making it hard to debug such non writable install directories.
• Added a new bundled plugin "Printer Safety Check" that will try to identify printer/printer firmware with known safety issues such as missing thermal runaway protection.
• Plugin Manager: Reduce notification spam. See also #2260.
• Software Update Plugin: Better detection if an update is already running.
• Software Update Plugin: Refer to plugin_softwareupdate_console.log on update errors in log and notification.

Bugfixes

• #2294 - Improved resilience against errors during gathering the file list (e.g. permission errors)
• #2296 - Fixed X-Forwarded-For handling in Flask Login through monkey patched backport.
• #2297 - Return 403 instead of 401 on missing/insufficient credentials.
• #2311 - Fixed server not auto connecting on startup if port is set to AUTO (see also #2311).
• #2316 - Check for valid queue entry in file analysis queue before trying to dequeue, fix for a HTTP 500 on upload of a file not supported for analysis.
• #2321 & #2449 - Fixed wrong queuing order of cancel script & first line from printed file on quick start-cancel-start scenarios by introducing a two new states "Cancelling" and "Pausing".
• #2324 - Fixed 500 error when
• #2333 (Part 1/3) - Workaround for an update problem caused by interaction of pip with dependencies formerly installed as eggs through python setup.py install.
• #2333 (Part 2/3) - If supported by the underlying PySerial version, cancel all reads and writes on disconnect if possible for a faster connection release. Part 3 (forcing an upgrade of PySerial to 3.4 so this should work in more cases) will in OctoPrint 1.3.8.
• #2364 - Fixed firmware error reporting in case of cancelling a print due to a firmware error.
• #2368 - Fixed for incorrect handling of unicode filenames in cura slicer profiles
• #2371 - Removed "just now"/"gerade eben" label from temperature graph to work around a graph resize issue caused by that.
• #2392 - Fixed "Copy all" on terminal tab only working the first time.
• #2406 - Fixed showTab JS function of about dialog.
• #2426 - Made resend logging to octoprint.log unicode safe
• #2442 - Don't even import disabled plugins, use a dummy entry for them just like for backlisted plugins. More resilience against misbehaving plugins.
• #2461 - Fixed OctoPrint not properly disconnecting in case of a firmware error.
• #2494 - Fixed undefined values not saving in the settings.
• #2499 (regression) - Fixed communication error notification lacking the actual error message.
• #2501 (regression) - Fixed a bug causing log downloads to fail with an HTTP 500 error.
• #2506 (regression) - Fixed printer.get_current_data and printer.get_current_job returning frozendict instead of dict instances, causing issues with plugins relying on being able to modify the returned data (e.g. dattas/OctoPrint-DetailedProgress#26).
• #2508 (regression) - Fixed HTTP 500 error on /api/slicing in case of an unconfigured slicer.
• #2524 - Ignore wait while job is on hold.
• #2536 - Fix a wrong state tracking when starting an SD print through the controller, causing a disconnect due to a timeout.
• #2544 (regression) - Fix an exception when connecting to the raw websocket at /sockjs/websocket (instead of /sockjs/<server_id>/<session_id>/websocket).
• #2546 (regression) - Fix the PRINT_FAILED event getting triggered twice on print failure due to disconnect
• Use pkg_resources to determine pip version during environment check instead of import pip; pip.__version__ since the latter causes issues with pip version 9.0.2. In the same spirit make pip.main approach of calling pip in the PipCaller the last resort during auto detection, only after trying pip or pip.exe inside the same folder as the Python executable.
• Use octoprint.util.monotonic_time instead of monotonic.monotonic in comm layer.
• Fixed timelapse not stopping on print failure due to firmware error due to missing PrintFailed event.
• Announcement Plugin: Fixed a missing line break in case of more than three announcements in a notification.
• Docs: Documentation for printer profile related bits and pieces
• Docs: Various fixes of typos and grammar.
• Have OctoPrintJsonEncoder fall back to regular flask JSON encoder, otherwise we might not be able to serialize some data types we need to be able to serialize. (regression)

Known bugs

• #2547 - Error during processing of afterPrintJobDone script will trigger PRINT_FAILED event even though PRINT_DONE event was already triggered

More Information

• Commits
• Release Candidates:
  • 1.3.7rc1
  • 1.3.7rc2
  • 1.3.7rc3
  • 1.3.7rc4
  • A special Thank you! to everyone who reported back on these release candidates this time: aaronkeck, akurz42, andrivet, anthonyst91, arhi, b-morgan, BryanSmithDev, chippypilot, ChrisHeerschap, Crowlord, dforsi, drdelaney, FormerLurker, goeland86, inspiredbylife, jbjones27, jesasi, jneilliii, JohnOCFII, kantlivelong, lnx13, makaper, markwal, MiquelAdell, ml0w, mmotley999, mrhanman, SCiunczyk, tdub415, tedder42, thatjoshguy, wescrockett

1.3.6 (2017-12-12)

Note for upgraders and plugin authors: Change in the bundling of JS assets can lead to issues in plugins

A change to solve issues with plugins bundling JS assets that cause interference with other plugins (e.g. through the declaration of "use strict") and in general to add better isolation and error handling might cause errors for some plugins that go beyond your run-off-the-mill view model and also implicitly declare new globals.

If you happen to run into any such issues, you can switch back to the old way of bundling JS assets via the newly introduced "Settings > Feature > Enable legacy plugin asset bundling" toggle (check it, save the settings, restart the server). This is provided to allow for a minimally invasive adjustment period until affected plugins have been updated.

You can find out more about the change, how to know if a plugin is even affected and what do about it on the OctoBlog.

Improvements

• #203 - Allow selecting the current tab via URL hashs. Also update URL hash when switching tabs, thus adding this to the browser history and allowing quicker back and forth navigation through the browser's back and forward buttons.
• #1026 - Automatically upper case parameters in GCODE commands sent from the Terminal tab. A black list is in place that prevent upper casing of parameters for GCODE commands where it doesn't make sense (default: M117). See also #2177.
• #2050 - New hook octoprint.comm.protocol.temperatures.received that allows plugins to further preprocess/sanitize temperature data received from the printer.
• #2055 - Increased the size of the API key field in the settings.
• #2056 - Added a Copy button to the API key field in the settings and user settings.
• #2094 - Allow UTF-8 display names for uploaded files. The files will still get an ASCII only name on disk, but the UTF-8 name used during upload will also be persisted and shown in the file list. This also allows using emojis in your file and folder names now.
• #2104 - Allow more URL schemes for installing plugins from. Supported schemes should now mirror what pip itself supports: http, https, git, git+http, git+https, git+ssh, git+git, hg+http, hg+https, hg+static-http, hg+ssh, svn, svn+svn, svn+http, svn+https, svn+ssh, bzr+http, bzr+https, bzr+ssh, bzr+sftp, bzr+ftp, bzr+lp.
• #2109 - New decorator @firstrun_only_access for API endpoints that should only be available before first setup has been completed.
• #2111 - Made the file list's scroll bar wider.
• #2131 - Added warning to restart, shutdown, reboot and update confirmations that that may disrupt ongoing prints, even those run from the printer's internal storage/SD. See also #2146 and #2152.
• #2138 - Slightly longer timeout when attempting to read from serial during auto detection via programming mode. Might help with detection of some slower printer controllers under certain circumstances.
• #2200 - Wrap all JS assets of plugins into one anonymous function per plugin. That way plugins using "use strict"; won't cause hard to debug and weird issues with other plugins bundled after them. The down side is that plugins currently relying on implicit declaration of global helper functions or variables (function convert(value) { ... }) to be available outside of their own plugin's JS assets will now run into errors. To compensate for that while affected plugins are adjusted to declare globals explicitly (window.convert = function(value) { ... }), a temporary feature flag was added as "Settings > Features > Enable legacy plugin asset bundling" that switches back to the old form of bundling until plugins you rely on are updated. This flag will be removed again in a later version (currently planned for 1.3.8). See also the note above and #2246.
• #2229 - Added note to printer profile dialog that the nozzle offsets for multi extruder setups are only to be configured if they are not already set in the printer's firmware.
• #2232 - Disable movement distance buttons when not connected to the printer or when printing, since they don't have any use then.
• #2239 - Improved the check summing speed, thus improving the general achievable throughput on the comm layer.
• Allow cancelling of file transfers
• Made check of how old an unrendered timelapse is more lenient buy looking at both the creation and last modification date and using the younger one.
• Made notifications in general auto-close faster.
• Make the first profile saved for a slicer the default profile for that slicer.
• New command server for testing server connections on the JS test API.
• New hook octoprint.accesscontrol.keyvalidator that allows plugins to validate their own customized API keys to be used to access OctoPrint.
• Updated cookiecutter, requests and psutil dependencies.
• Added safety warning to first run wizard.
• More error resilience against broken view models.
• New sub command octoprint safemode. Will set the server.startOnceInSafeMode setting in the config so that the next (re)start of the server after issuing this command will happen in safe mode.
• New sub command octoprint config effective. Will report the effective config.
• New centralized plugin blacklist (opt-in). Allows to prevent plugins/certain versions of plugins known to cause crippling issues with the normal operation of OctoPrint to be disabled from loading, if the user has opted to do so in the settings/wizard.
• Log how to enable serial.log to serial.log if it's disabled. That will hopefully put at least a small dent in the amount of "It's empty!" responses in tickets ;)
• Force new Pypi index URL in requirements.txt as an additional work around against old tooling.
• Prefer plain pip over git for updating OctoPrint.
• Added environment detection and logging on startup. That should give us more information about the environment to produce a reported bug in.
• Added OctoPi support plugin that provides information about the detected OctoPi version. Will only load if OctoPi is detected.
• More dynamic plugin mixin detection. Now using a base class instead of having to list all types manually. Should greatly reduce overhead of adding new mixin types.
• Support leaf merging for file extension tree, allowing to add new file extensions to types registered by default.
• Allow non GCODE SD file transfers if registered as machinecode through e.g. a plugin's file extension hook. Caution: This doesn't make streaming arbitrary files to the printer via serial work magically. It merely allows that, it's up to the firmware to actually be able to handle that. Also, the regular GCODE streaming protocol is used, so if the streamed file contains control characters from that (e.g. M29 to signal the end of the streaming process), stuff will break!
• Added a test button for the online connectivity check.
• Announcements plugin: Added UTM Tags.
• Cura plugin: Less not configured yet logging.
• GCODE viewer: Added advanced options that allow configuring display of bounding boxes, sorting by layers and hiding of empty layers.
• GCODE viewer: Persist all options to local storage so they will be automatically set again the next time the GCODE viewer is used in the same browser.
• Software update: Auto-hide "Everything is up-to-date" notification.
• Easier copying of terminal contents thanks to dedicated copy button.
• Timelapse: #2067 - Added rate limiting to z-based timelapse capturing to prevent issues when accidentally leaving this mode on with vase mode prints.
• Timelapse: Refactored configuration form & added reset button to switch back to currently active settings.
• Timelapse: Sort timelapses by modification instead of creation time (creation time can be newer if a backup restore was done).
• Virtual printer: Support configurable ambient temperature for testing.
• Virtual printer: Support configurable reset lines.
• Virtual printer: Added new debug trigger trigger_missing_lineno.
• Virtual printer: Allow empty/None prepared oks, allowing to simulate lost acknowledgements right on start.
• Docs: #2142 - Added documentation for the bundled virtual printer plugin.
• Docs: #2234 - Added info on how to install under Suse Linux.
• Docs: Added example PyCharm run configuration that includes automatic dependency updates on start.
• Docs: Added information on how to run the test suite.
• Various refactorings
• Various documentation updates
• Fetch plugin blacklist (and also announcements, plugin notices and plugin repository) via https instead of http.

Bug fixes

• #2044 - Fix various typos in strings and comments
• #2048 & #2176 - Fixed various warnings during documentation generation.
• #2077 - Fix an issue with shared nozzles and the temperature graph, causing temperature to not be reported properly when another tool but the first one is selected. See also #2077
• #2108 - Added no-op default action to login form so that username + password aren't sent as GET parameters if for some reason the user tries to log in before the view models are properly bound and thus the AJAX POST submission method is attached.
• #2111 - Prevent file list's scroll bar from fading out.
• #2146 - Fix initialization of temperature graph if it's not on the first tab due to tab reordering.
• #2166 - Workaround for a Firefox bug that causes the Drag-n-Drop overlay to never go away if the file is dragged outside of the browser window.
• #2167 - Fixed grammar of print time estimation tooltip
• #2175 - Cancel printing when an external reset of the printer is detected on the serial connection.
• #2181 - More resilience against non-standard M115 responses.
• #2182 - Don't start tracking non existing or nonfunctional tools if encountering a temperature command referencing said tool. See also kantlivelong/OctoPrint-PSUControl#68.
• #2196 - Marked API key fields as readonly instead of disabled to allow their contents to be copied in Firefox (which wasn't possible before).
• #2203 - Reset temperature offsets to 0 when disconnected from the printer.
• #2206 - Disable pre-configured timelapse if snapshot URL of ffmpeg path are unset.
• #2214 - Fixed temperature fields not selecting in MS Edge on focus.
• #2217 - Fix an issue in octoprint.util causing a crash when running under PyPy instead of CPython.
• #2226 - Handle No Line Number with checksum, Last Line: ... errors from the firmware.
• #2233 - Respond with 411 Length Required when content length is missing on file uploads.
• #2242 - Fixed an issue where print time left could show "1 days" instead of "1 day".
• #2262 (regression) - Fixed a bug causing Error:checksum mismatch, Last Line: ... errors from the firmware to be handled incorrectly.
• #2267 (regression) - Fixed a bug causing the GCODE viewer to not get properly initialized due to a JS error on load if "Also show next layer" was selected.
• #2268 (regression) - Fixed a bug causing a display error with the temperature offsets. If one offset was changed, all others seemed to revert back to 0.
• Fixed cleanup of unrendered timelapses with certain names.
• Fixed a caching issue with the file list API and the slicing API.
• Fixed initial sizing of the temperature graph.
• More resilience against corrupt .metadata.yaml files.
• More resilience against corrupt/invalid entries for system actions.
• More resilience against invalid JSON command requests.
• More resilience against broken packages in the python environment.
• Don't evaluate onWebcamLoaded more than once when switching to the webcam tab.
• Fixed octoprint config sub command.
• Fixed deactivated user accounts being able to login (albeit without a persistent session). Show fitting error instead.
• Fixed temperature auto report after an external reset.
• Don't log full request headers in Tornado on an error.
• Fix displayed notification message for synchronous system commands. Was accidentally swapped with the one for asynchronous system commands.
• GCODE viewer: Fix error on empty layers.
• Virtual printer: Fix resend simuation.
• Docs: Fixed CSS of line numbered listings.
• Docs: Updated mermaid to fix a deprecation warning.
• Fixed ordering of plugin assets, should be alphabetical based on the plugin identifier. (regression)
• Fixed an issue causing redundant software update configuration settings to be written to config.yaml, in turn causing issues when downgrading to <1.3.5. (regression)
• Fixed an issue detecting whether the installed version is a release version or a development version. (regression)

More Information

• Commits
• Release Candidates:
  • 1.3.6rc1
  • 1.3.6rc2
  • 1.3.6rc3
  • A special Thank you! to everyone who reported back on these release candidates this time: andrivet, b-morgan, bjarchi, chippypilot, ChrisHeerschap, cosmith71, Crowlord, ctgreybeard, fiveangle, goeland86, jbjones27, jneilliii, JohnOCFII, Kunsi, Lordxv, malnvenshorn, mcp5500, ntoff, ripp2003 and schorsch3000

1.3.5 (2017-10-16)

Improvements

• #1162 - Allow octoprint.comm.protocol.gcode.queuing hook to return a list of commands.
• #1572 & #1881 - Refactored web interface startup process to minimise risk of race conditions and speed improvements. Also added sequence diagram to the documentation showing the new processing order.
• #1640 - Mouse over temperature graph to get exact data for that time.
• #1679 - Support temperature autoreporting by the firmware instead of polling if the firmware reports to support it. For this to work with Marlin 1.1.0 to 1.1.3 you'll need to explicitly enable EXTENDED_CAPABILITIES_REPORT and AUTO_REPORT_TEMPERATURES in your firmware configuration, otherwise your firmware won't report that it actually supports this feature.
• #1737 - Auto-detect Anet A8 firmware and treat as Repetier Firmware (which it actually appears to be, just renamed - thanks Anet for making this even harder).
• #1842 - Update bundled FontAwesome to 4.7 (see also #1915).
• #1910 - Make last/pause/cancel temperature available for GCODE scripts.
• #1925 - Include configured webcam stream URL in "Webcam stream not loaded" message for logged in users/admins. Slightly different wording for guests vs users vs admins.
• #1941 - Enable "block while dwelling" flag when Malyan firmware is detected since that firmware seems to handle G4 identically to Repetier Firmware instead of Marlin (like it claims to). See also #1762.
• #1946 - Add option to disable position logging on cancel/pause. See "Log position on cancel" and "Log position on pause" under Settings > Serial > Advanced options.
• #1971 - Refactored temperature inputs. They now sport some fancy +/- buttons to increment/decrement the current temperature (which also auto submit after a couple of seconds) and easier editing by keyboard. The temperature offset was also slightly redesigned to make room for that.
• #1975 - Better error reporting when deleting timelapses.
• #2010 - Slight refactoring in the terminal tab: Full width input field, auto focus of input field when just clicking on terminal output.
• #2011 - Centralized online connectivity check (with opt-in of course). None of the bundled plugins will attempt to fetch data from the net when the connectivity check indicates that would fail anyhow. This should improve server startup times and various requests when running isolated.
• #2025 - More verbose logging of asynchronous system commands (e.g. restart/shutdown).
• Allow timelapse configuration through UI even when not connected to the printer (suggested in #1918)
• Disable "Upload to SD" UI elements while printing (suggested in #1914)
• Update bundled SockJS to 1.1.2 incl. source maps
• Set X-Robots HTTP header and remove Server header from all responses, also set robots meta tag in page.
• Don't require to enter programmer mode for printer port autodetection when there's only one possible port candidate anyhow.
• More sensible sorting of baudrates (additionally configured, then 115200, then 250000, then everything else).
• Don't show "Unhandled communication error" on autodetection failure.
• Make timeout after which to unload the webcam stream after navigating away from it configurable (as suggested in #1937)
• Add ToolChange event and tool change GCODE scripts
• Support parsing GCODE subcodes.
• Add octoprint.users.factory hook, allowing plugins to extend/swap out the user manager OctoPrint uses.
• Corewizard: Disable view model and client code if it's not actually required.
• Corewizard: Disable injection of JS files into UI when it's not actually required.
• GCODE analysis: Moved into its own subprocess. That should improve performance on multi core systems.
• GCODE viewer: Ignore coordinates outside bed when zooming/centering on model. Those usually are nozzle priming routines.
• JS Client Lib: Add centralized browser detection as OctoPrint.coreui.browser. Available properties: chrome, firefox, safari, ie, edge, opera as well as mobile and desktop, all of which are boolean values.
• Plugin Manager plugin: Detect if a plugin requires a reconnect to the printer to become fully active/inactive.
• Software Update plugin: Force exact version when updating OctoPrint and tracking releases.
• Software Update plugin: "Devel RCs" release channel now also tracks maintenance RCs. That way people don't have to toggle between the two any more to get all RCs.
• Software Update plugin: bitbucket_commit check type now supports API credentials (see also #1993).
• Wizard: Allow suppressing the "the settings got updated" dialog through subwizards, in case they need to update settings asynchronously as part of their workflow.
• More resilience against expected folders being files.
• More resilience against a wrong user manager class being configured.
• Some code refactoring & cleanup.
• Some HTML & CSS improvements.

Bug fixes

• #1916 - Fix webcam not loading if first/initial tab is "Control"
• #1924 - Filter out source map links from bundled JS webassets.
• #1943 - Fix issue causing unnecessary creation of default printer profile on startup
• #1946 - Decouple writing of print log from everything else. Fixes delay in cancel processing.
• #1963 & #1974 - Allow empty & custom size in print job events. Also fixes an issue with timelapses when printing from SD on printers that require the GPX plugin to work.
• #1996 - Support all line ending variantes in the GCODE viewer. Solves an issue with GCODE generated for Prusa's multi material extruder since that uses only \r for some reason.
• #2007 - Fix issue parsing temperature lines from the printer that contain negative values.
• #2012 - Fix command line interface of Software Update plugin.
• #2017 - Fix issue in GCODE viewer with files that contain a visit to the first layer twice (e.g. brim, then nose dive from higher z for actual model), causing all but the last layer segment to not be rendered.
• #2033 (regression) - Temperature tab: Fix for legend in graph not updating with current values on mouse over.
• #2033 (regression) - Temperature tab: Fix for new temperature inputs not fitting on one line in Firefox.
• #2033 (regression) - Temperature tab & GCODE viewer: Fix for available tools (and offsets) not properly updating on change of printer profile.
• #2033 (regression) - Wizard: Fix sorting of required wizards not properly handling non-ASCII unicode.
• #2035 (regression) - Fix an issue of the server not starting up if there's a file in the analysis backlog. The reason for this is that spawning a new process while the intermediary server is active causes the server port to be blocked (this is due to how subprocessing works by default), in turn leading to an error on startup since the port cannot be bound by the actual server. Since the GCODE analysis takes now place in its own subprocess and hence triggers this problem, it had to be moved until after the actual server has already started up to avoid this problem.
• #2059 (regression) - Fix an issue causing the new temperature controls to wrap on touch enabled devices when the temperature dropdown is opened.
• #2090 (regression) - Fix an issue causing an aborted server startup under Windows if the timing is just right.
• #2135 (regression) - Fix an issue causing import errors inside the GCODE analysis tool in certain environments due to sys.path entries causing relative imports.
• #2136 (regression) - Fix wrong minimum version for sockjs-tornado dependency.
• #2137 (regression) - Fix issue with session cookies getting lost when running an OctoPrint instance on a subpath of another (e.g. octopi.local/ and octopi.local/octoprint2).
• #2140 (regression) - Fix issue with locale dependent sorting of sub wizards during first time setup causing issues leading to the wizard not being able to complete.
• Fix various popup buttons allowing multiple clicks (suggested in #1914)
• Software Update Plugin: Perform server restart asynchronously. Should reduce restart times on updates significantly.
• Don't hex-escape \t, \r or \n in terminal output
• Use client side default printer profile if the default profile could not be found on the server
• Use both "to" and "from" coordinates of a given move for min/max model coordinate calculation in GCODE analysis. Otherwise wrong values could be calculated under certain circumstances.
• Fix potential race condition in resend request handling.
• Fix potential race condition in web socket handling.
• Fix handling of tool offsets in GCODE analysis - diverted too far from firmware implementations, causing wrong calculations.
• Fix FileAdded, FileRemoved, FolderAdded, FolderRemoved events not being fired with the correct event name.
• Fix potential division by zero in progress reporting if the timing was just right.
• Fix sorting order for multiple tools in the "State" panel.
• Fix file position vs. line ending handling in GCODE viewer. Could lead to slightly off file position calculation and hence possibly to the wrong move being plotted when synchronizing with print progress.
• Wizard: Fix onWizardPreventSettingsRefreshDialog callback invocation. (regression)
• Corewizard plugin: Fix firstrunonly wizards (e.g. for printer profile configuration) being displayed again if any of the sub wizards (e.g. for the online check opt-in and configuration) is active. (regression)
• Fix an issue causing rollover of serial.log to fail under Windows. (regression)

More Information

• Commits
• Release Candidates:
  • 1.3.5rc1
  • 1.3.5rc2
  • 1.3.5rc3
  • 1.3.5rc4
  • A special Thank you! to everyone who reported back on these release candidates this time: alexxy, andrivet, b-morgan, BillyBlaze, CapnBry, chippypilot, ctgreybeard, cxt666, DaSTIG, fhbmax, fiveangle, goeland86, JohnOCFII, Kunsi, mgrl, MoonshineSG, nate-ubiquisoft, Neoolog, ntoff, oferfrid, roygilby, SAinc, sbts, thess, tkurbad, tsillini and TylonHH.

1.3.4 (2017-06-01)

Note for owners of Malyan M200/Monoprice Select Mini

OctoPrint's firmware autodetection is now able to detect this printer. Currently when this printer is detected, the following firmware specific features will be enabled automatically:

• Always assume SD card is present (feature.sdAlwaysAvailable)
• Send a checksum with the command: Always (feature.alwaysSendChecksum)

Since the firmware is a very special kind of beast and its sources are so far unavailable, only tests with a real printer will show if those are sufficient settings for communication with this printer to fully function correctly. Thus, if you run into any issues with enabled firmware autodetection on this printer model, please add a comment in #1762 and explain what kind of communication problem you are seeing. Also make sure to include a serial.log!

Bug fixes

• #1942 - Fixed crash on startup in case of an invalid default printer profile combined with "auto-connect on startup" being selected and the printer available to connect to.

More information

• Commits
• Release Candidates:
  • None since this constitutes a hotfix release to fix an apparently very rare bug introduced with 1.3.3 that seems to be affecting a small number of users.

1.3.3 (2017-05-31)

Note for owners of Malyan M200/Monoprice Select Mini

OctoPrint's firmware autodetection is now able to detect this printer. Currently when this printer is detected, the following firmware specific features will be enabled automatically:

• Always assume SD card is present (feature.sdAlwaysAvailable)
• Send a checksum with the command: Always (feature.alwaysSendChecksum)

Since the firmware is a very special kind of beast and its sources are so far unavailable, only tests with a real printer will show if those are sufficient settings for communication with this printer to fully function correctly. Thus, if you run into any issues with enabled firmware autodetection on this printer model, please add a comment in #1762 and explain what kind of communication problem you are seeing. Also make sure to include a serial.log!

Improvements

• #478 - Made webcam stream container fixed height (with selectable aspect ratio) to prevent jumps of the controls beneath it on load.
• #748 - Added delete confirmation and bulk delete for timelapses. See also the discussion in brainstorming ticket #1807.
• #1092 - Added new events to the file manager: FileAdded, FileRemoved, FolderAdded, FolderRemoved. Contrary to the Upload event, FileAdded will always fire when a file was added to storage through the file manager, not only when added through the web interface. Extended documentation accordingly.
• #1521 - Software update plugin: Display timestamp of last version cache refresh in "Advanced options" area.
• #1734 - Treat default/initial printer profile like all other printer profiles, persisting it to disk instead of config.yaml and allowing deletion. OctoPrint will migrate the existing default profile to the new location on first start.
• #1734 - Better communication of what actions are available for printer profiles.
• #1739 - Software update plugin: Added option to hide update notification from users without admin rights, added "ignore" button and note to get in touch with an admit to update notifications for non admin users.
• #1762 - Added Malyan M200/Monoprice Select Mini to firmware autodetection.
• #1811 - Slight rewording and rearrangement in timelapse configuration, better feedback if settings have been saved.
• #1818 - Support both Marlin/Repetier and Smoothieware interpretations of G90 after an M83 in GCODE viewer and analysis. Select "G90/G91 overrides relative extruder mode" in Settings > Features for the Smoothieware interpretation.
• #1858 - Announcement plugin: Images from registered feeds now are lazy loading.
• #1862 - Automatically re-enable fancy terminal functionality when performance recovers.
• #1875 - Marked the command input field in the Terminal tab as not supporting autocomplete to work around an issue in Safari. Note that this is probably only a temporary workaround due to browser vendors working on deprecating autocomplete="off" support and a different solution will need to be found in the future.
• Added link to SerialException FAQ entry to terminal output when such an error is encountered, as suggested in #1876.
• Force refresh of settings on login/logout.
• Made system wide API key management mirror user API key management.
• Make sure to always migrate and merge saved printer profiles with default profile to ensure all parameters are set. Should avoid issues with plugins trying to save outdated/incomplete profiles.
• Added note on lack of language pack repository & to use the wiki for now.
• Earlier validation of file to select for printing.
• Limit verbosity of failed system event handlers.
• Made bundled python client octoprint_client support multiple client instances.
• Disable "Reload" button in the "Please reload" overlay once clicked, added spinner.
• Updated pnotify to 2.1.0.
• Get rid of ridiculous float precision in temperature commands.
• Detect invalid settings data to persist (not a dict), send 400 status in such a case.
• More logging for preemptive caching, to help narrow down any performance issues that might be related to this.
• Further decoupling of some startup tasks from initial server startup thread for better parallelization and improved startup times.
• Announcement plugin: Added combined OctoBlog feed, replacing news and spotlight feed, added corresponding config migration.
• Announcement plugin: Subscribe to all registered feeds by default to ensure better communication flow (all subscriptions but the "Important" channel can however be unsubscribed easily, added corresponding note to the notifications and also a configuration button to the announcement reader).
• Announcement plugin: Auto-hide announcements on logout.
• Announcement plugin: Order channels server-side based on new order config setting.
• Plugin manager: Show warning when disabling a bundled plugin that is not recommended to be disabled, including a reason why disabling it is not recommended. Applies to the bundled announcement, core wizard, discovery and software update plugins.
• Plugin manager: Support for plugin notices for specific plugins from the plugin repository, e.g. to inform users of specific plugins about known issues with the plugin or instruct to update when the software update mechanism of the current plugin version turns out to be misconfigured. Supports matching installed plugin versions and OctoPrint versions to target only affected users.
• Plugin manager: Better visualization of plugins disabled on the repository, no longer shown as "incompatible" but "disabled", with link to the plugin repository page that contains more information.
• Plugin manager: Detect necessity to reinstall a plugin provided through archive URL or upload and immediately do that instead of reporting an "unknown error" without further information.
• Plugin manager: Added freebsd for compatibility check.
• Plugin manager: More general flexibility for OS compatibility check:
  • Support for arbitrary values to match against
  • Allow 1:1 check again sys.platform values (with startswith).
  • Support black listing (!windows) additionally to white listing. A detected OS must match all provided white list elements (if the white list is empty that is considered to be always the case) and none of the black list elements (if the black list is empty that is also considered to be always the case).
• Software update plugin: New check type bitbucket_commit (see also #1898)
• Docs: Now referring to dedicated Jinja 2.8 documentation as hosted at jinja.octoprint.org for all template needs, to avoid confusion when consulting current Jinja documentation as available on its project page (2.9+, which OctoPrint can't upgrade to due to backwards incompatible changes).
• Docs: Better documentation of what kind of input the FileManager accepts for select_file.
• Docs: Specified OctoPrint version required for plugin tutorial.

Bug fixes

• #202 - Fixed an issue with the drag-n-drop area flickering if the mouse was moved too slow while dragging (see also #1867).
• #1671 - Removed obsolete entry of no longer available filter for empty folders from file list options.
• #1821 - Properly reset "Capture post roll images" setting in timelapse configuration when switching from "off" to "timed" timelapse mode.
• #1822 - Properly reset file metadata when a file is overwritten with a new version.
• #1836 - Fixed order of PrintCancelled and PrintFailed events on print cancel.
• #1837 - Fixed a race condition causing OctoPrint trying to read data from the current job on job cancel that was no longer there.
• #1838 - Fixed a rare race condition causing an error right at the very start of a print.
• #1863 - Fixed an issue in the analysis of GCODE files containing coordinate offsets for X, Y or Z via G92, leading to a wrong calculation of the model size thanks to accumulating offsets.
• #1882 - Fixed a rare race condition occurring at the start of streaming a file to the printer's SD card, leading to endless line number mismatches.
• #1884 - CuraEngine plugin: Fixed a potential encoding issue when logging non-ASCII parameters supplied to CuraEngine
• #1891 - Fixed error when handling unicode passwords.
• #1893 - CuraEngine plugin: Fixed handling of multiple consecutive uploads of slicing profiles (see also #1894)
• #1897 - Removed possibility to concurrently try to perform multiple tests of the configured snapshot URL.
• #1906 - Fixed interpretation of G92 in GCODE analysis.
• #1907 - Don't send temperature commands with tool parameter when a shared nozzle is defined.
• #1917 (regression) - Fix job data resetting on print job completion.
• #1918 (regression) - Fix "save as default" checkbox not being disabled when other controls are disabled.
• #1919 (regression) - Fix call to no longer existing function in Plugin Manager UI.
• #1934 (regression) - Fix consecutive timed timelapse captures without configured post roll.
• Fixed API key QR Code being shown (for "n/a" value) when no API key was set.
• Fixed timelapse configuration API not returning 400 status code on some bad parameters.
• Fixed a typo (see also #1826).
• Fixed filter and force parameters on /api/files/<origin>.
• Fixed message catchall * not working in the socket client library.
• Fixed analysis backlog calculation for sub folders.
• Fixed PrinterInterface.is_ready to behave as documented.
• Use black listing instead of white listing again to detect if the daemon sub command is supported or not. Should resolve issues users of FreeBSD and the like where having with octoprint daemon.
• Use pip instead of python setup.py develop in octoprint dev plugin:install command to avoid issues on Windows.
• Docs: Fixed a wrong command in the plugin tutorial (see also #1860).

More information

• Commits
• Release Candidates:
  • 1.3.3rc1
  • 1.3.3rc2
  • 1.3.3rc3

1.3.2 (2017-03-16)

Note for plugin authors

If you maintain a plugin that extends OctoPrint's JavaScript Client Library like demonstrated in e.g. the bundled Software Update Plugin you'll need to update the way you register your plugin to depend on OctoPrintClient and registering your extension as shown here instead of directly writing to OctoPrint.plugins (like it was still done here). That way your extensions will be available on all instances of OctoPrintClient, not just the global instance OctoPrint that gets created on startup of the core web interface.

If all you plugin does with regards to JavaScript is registering a custom view model and you have no idea what I'm talking about regarding extending the client library, no action is necessary. This heads-up is really only relevant if you extended the JavaScript Client Library.

Improvements

• #732 - Have OctoPrint's python setup.py clean build on stock python setup.py clean for better compatibility with packaging systems
• #1506 - Better handle really long "dwell"/G4 commands on Repetier firmware (as for example apparently recommended to use with Wanhao D6 and similar printers for nozzle cooling) by actively stalling communication from OctoPrint's side as well. That way we no longer run into a communication timeout produced by a 5min dwell immediately happily acknowledged by the printer with an ok.
• #1542 - Support for multi-extruder setups with a shared single nozzle and heater (e.g. E3D Cyclops, Diamond hotend, etc).
• #1676 - Trigger line number reset when connected to printer and seeing start message. This should fix issues with printer communication when printer resets but reset goes otherwise undetected.
• #1681 - Support for connecting to multiple OctoPrint instances via the JavaScript Client Library.
• #1712 - Display current folder name in file list if in sub folder.
• #1723 - Ignore leading v or V on plugin version numbers for version checks in plugin manager and software updater (see also #1724)
• #1770 - Better resilience against null bytes received from the printer for whatever reason.
• #1770 - Detect printer as connected even when only receiving a wait instead of ok. Should solve issues with initial connect where printer sends garbage over the line that eats/covers the ok if printer also sends regular wait messages when idle.
• #1780 - Work around for Safari re-opening one copy of the webcam stream after the other and eating up bandwidth unnecessarily (see also #1786)
• #1790 - Removed unused "color" property from printer profile editor.
• #1805 - Better error resilience against invalid print history data from plugins that replace the printer communication.
• Better error resilience in Plugin Manager against wonky version data in repository file.
• Added a "Restart in safe mode" system menu entry that will always be available if the restart command is configured
• CLI: Only offer daemon sub command on Linux (since that it's the only OS it works on)
• Less throttling of analysis of GCODE files from the analysis backlog. Should still leave Pi and friends air to breathe but allow a slightly faster processing of the backlog.
• Added an explanation of safe mode to the docs.
• Log OctoPrint version & plugin list when detecting log rollover.
• Allow UiPlugins to define additional fields for ETag generation.
• Allow UiPlugins utilizing OctoPrint's stock templates to filter out what they don't need.
• Locales contained in translations of plugins will now be registered with the system. That way it's possible to provide translations for the full application through plugins.
• Abort file analysis if file is about to be overwritten
• Software Update Plugin: Refresh cache on startup, prevent concurrent refresh
• More solid parsing of request line number for resend requests. Should improve compatibility with Teacup firmwares. Based on issue reported via PR #300

Bug fixes

• #733 - Fixed multiple event handler commands running concurrently. Now they run one after the other, as expected.
• #1317 - Fixed a color distortion issue when rendering timelapses from higher resolution source snapshots that also need to be rotated by adjusting ffmpeg parameters to avoid an unexpected behaviour when a pixel format and a filter chain are required for processing.
• #1560 - Make sure we don't try to use an empty logging.yaml
• #1631 - Disable "Slice" button in slice dialog if a print is ongoing and a slicer is selected that runs on the same device as OctoPrint. The server would already deny such requests (simply due to performance reasons), but the UI didn't properly reflect that yet.
• #1671 - Removed "Hide empty folders" option from file list. Didn't really add value and caused usability issues.
• #1771 - Fixed _config_version in plugin settings not being properly updated.
• #1732 - Fixed a bug in the documentation for the printer profile API
• #1760 - Fixed missing reselect of selected file when updating via the watched folder, causing wrong progress percentages to be reported.
• #1765 - Fixed watched folder not waiting with file move until file stopped growing, causing wrong progress percentages to be reported.
• #1777 - Fixed z-change based timelapses with Slic3r generated z-hops not properly triggering snapshots.
• #1792 - Don't tell Safari we are "web-app-capable" because that means it will throw away all cookies and the user will have to constantly log in again when using a desktop shortcut for the OctoPrint instance.
• #1812 - Don't scroll up navigation in settings when switching between settings screens, very annoying on smaller resolutions (see also #1814)
• Fix settings helper not allowing to delete values for keys that are present in the local config but not in the defaults.
• Fix wrong replacement value for __progress in registered command line or GCODE event handlers.
• Various fixes in the Software Update Plugin:
  • Don't remove manual software update configurations on settings migration.
  • Properly delete old restart/reboot commands that are now defined globally since config version 4. An issue with the settings helper prevented us from properly deleting them during migration to version 4.
  • Fixed python_checker version check method and python_updater update method.
  • Fixed update configs without a restart of any kind causing an issue due to an undefined variable.
  • Fixed broken doctests.
• Upgrade LESS.min.js from 2.7.1 to 2.7.2 to fix the broken contrast function
• Always create a new user session for requests with an API key
• Fixed an error when reading all user settings via the API
• Fixed a bunch of caching issues for the page, was not properly updated on change of snapshot URL presence, system menu entry presence, gcode viewer enabled/disabled, changes in access control availability.
• Fixed wrong bundling of core and plugin assets
• Software Update Plugin: Fixed wrong ETag calculation
• Disable external heatup detection until firmware is detected
• Fixed login dropdown not closing on click outside of it
• Fixed new user settings getting lost until restart
• Don't call onUserLoggedIn/onUserLoggedOut on user reload

More information

• Commits
• Release Candidates:
  • 1.3.2rc1

1.3.1 (2017-01-25)

Note for upgraders

If you installed OctoPrint manually and used the included init script, you need to update that

The init script so far shipped with OctoPrint contained a bug that causes issues with OctoPrint 1.3.0 and higher. Please update your init script to the fixed version OctoPrint now ships under scripts:

sudo cp /path/to/OctoPrint/scripts/octoprint.init /etc/init.d/octoprint

If you are running OctoPi, this does not apply to you and you do not need to do anything here!

Change in stock terminal filter configuration

1.3.1 fixes an issue with the two terminal filters for suppressing temperature and SD status messages and adds a new filter for filtering out firmware wait messages. These changes will only be active automatically though for stock terminal filter configurations. If you have customized your terminal filters, you'll need to apply these changes manually under "Settings > Terminal filters":

• Changed "Suppress temperature messages" filter, new regex is (Send: (N\d+\s+)?M105)|(Recv: ok (B|T\d*):)
• Changed "Suppress SD status messages" filter, new regex is (Send: (N\d+\s+)?M27)|(Recv: SD printing byte)
• New "Suppress wait responses" filter, regex is Recv: wait

Improvements

• #1607 - Way better support for password managers (e.g. browser built-in, 1Password, Lastpass, Dashlane)
• #1638 - Make confirmation dialog when cancelling a print optional.
• #1656 - Make wording of buttons on print cancel dialog less confusing.
• #1705 - Simplified install process on Mac by removing dependency on pyobjc.
• #1706 - Added a mask icon for Safari pinned tab and touchbar.
• Support extraction of filament diameter for volume calculation from GCODE files sliced through Simplify3D.
• Abort low priority jobs in the file analysis queue when a high priority job comes in - should make file analysis and hence time estimates show up faster for newly uploaded files.
• Added a terminal filter for firmware wait messages to the stock terminal filters. If you did modify your terminal filter configuration, you might want to add this manually:
  • New "Suppress wait responses" filter: Recv: wait

Bug fixes

• #1344 - Fix ProgressBarPlugins to not correctly be triggered for 0% (second try, this time hopefully for good).
• #1637 - Fix issue preventing a folder to be deleted that has a name which is a common prefix of the file currently being printed.
• #1641 - Fix issue with octoprint --daemon not working.
• #1647 - Fix issue with octoprint command throwing an error if an environment variable OCTOPRINT_VERSION was set to its version number.
• #1648 - Added missing websocket-client dependency of octoprint client to install script.
• #1653 - Fix for an issue with the included init script on the BBB (see also #1654)
• #1657 - Fix init script regarding check for configured CONFIGFILE variable.
• #1657 - Don't care about ordering of common parameters (like --basedir, --config) on CLI.
• #1660 - Do not show hint regarding keyboard controls beneath webcam stream if keyboard control feature is disabled.
• #1667 - Fix for matching folders not getting listed in the results when performing a search in the file list.
• #1675 - Fix model size calculation in GCODE analysis, produced wrong values in some cases. Also adjusted calculation to match implementation in GCODE viewer, now both produce identical results.
• #1685 - Cura Plugin: Fix filament extraction from CuraEngine slicing output
• #1692 - Cura Plugin: Fix solid layer calculation (backport from Ultimaker/CuraEngine#140)
• #1693 - Cura Plugin: Support perimeter_before_infill profile setting. Additionally added support for solidarea_speed, raft_airgap_all, raft_surface_thickness, raft_surface_linewidth profile settings and adjusted mapping for engine settings raftAirGapLayer0, raftFanSpeed, raftSurfaceThicknessand raftSurfaceLinewidth according to current mapping in Cura Legacy and adjusted Mach3 GCODE flavor to substitute S with P in temperature commands of generated start code, also like in Cura Legacy.
• #1697 - Pin Jinja to versions <2.9 for now due to a backwards compatibility issue with templates for versions newer than that. Also pushed as a hotfix to 1.3.0 (as 1.3.0post1).
• #1708 - Cura Plugin: Fixed selection of start.gcode for sliced file
• Allow a retraction z-hop of 0 in timelapse configuration.
• Fix files in sub folders to not be processed by the initial analysis backlog check during startup of the server.
• Various fixes in the file analysis queue:
  • High priority items are now really high priority
  • Abort analysis for items that are to be deleted/moved to get around an issue with file access under Windows systems.
• Fix stock terminal filters for suppressing temperature messages and SD status messages to also be able to deal with line number prefixes. If you have added additional terminal filters, you will have to apply this fix manually:
  • Changed "Suppress temperature messages" filter: (Send: (N\d+\s+)?M105)|(Recv: ok (B|T\d*):)
  • Changed "Suppress SD status messages" filter: (Send: (N\d+\s+)?M27)|(Recv: SD printing byte)
• Fix issue in german translation.

More information

• Commits
• Release Candidates:
  • 1.3.1rc1
  • 1.3.1rc2

1.3.0 (2016-12-08)

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] (OctoPrint#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] (OctoPrint#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

• Commits
• Release Candidates:
  • 1.3.0rc1
  • 1.3.0rc2
  • 1.3.0rc3

1.2.18 (2016-11-30)

Improvements

• Allow arbitrary frame rates for creating timelapses. Before, the entered fps value was also directly used as frame rate for the actual video, which could cause problems with any frame rates not specified in the MPEG2 standard. Now OctoPrint will use a standard frame rate for the rendered video and render the timelapse stills into the finished movie with the configured frame rate.
• Limited Cura profile importer to .ini files and clarified the supported versions
• Add support for the R parameter for M109 and M190

Bug fixes

• #1541 - Fix selecting the printer profile to use by default
• #1543 - Fix target temperature propagation from communication layer
• #1567 - Fix issue with restricted settings getting parsed to the wrong data structure in the frontend if loaded anonymously first.
• #1571 - Fix parsing of port number from HTTP Host header for IPv6 addresses
• Fix issue with settings restriction causing internal settings defaults to be changed.

More information

• Commits
• Release Candidates:
  • 1.2.18rc1

1.2.17 (2016-11-08)

Improvements

• Files like config.yaml etc will now persist their permissions, with a lower and upper permission bounds for sanitization (e.g. removing executable flags on configuration files but keeping group read/write permissions if found).
• Log full stack trace on socket connection errors when debug logging for octoprint.server.util.sockjs is enabled
• SettingsPlugins may now mark configuration paths as restricted so that they are not returned on the REST API
• Updated LESS.js version
• Improved the serial.log logging handler to roll over serial log on new connections to the printer instead of continuously appending to the same file. Please note that serial.log is a debugging tool only and should not be left enabled unless you are trying to troubleshoot something in your printer communication.
• Split JS/CSS/LESS asset bundles according into asset bundles for core + bundled plugins ("packed_core.{js|css|less}") and third party plugins ("packed_plugins.{js|css|less}"). That will allow the core UI to still function properly even if an installed third party plugin produces invalid JS and therefore causes a parser error for the whole plugin JS file. See #1544 for an example of such a situation.

Bug fixes

• #1531 - Fixed encoding bug in HTTP request processing triggered by content type headers on form data fields
• Fixed forced config.yaml save on startup caused by mistakenly assuming that printer parameters were always migrated.
• Fixed issue causing remember_me cookie not to be deleted properly on logout
• Fixed broken filter toggling on ItemListHelper class used for various lists throughout the web interface
• Fixed an issue with the preliminary page never reporting that the server is now up if the page generated during preliminary caching had no cache headers set (e.g. because it contained the first run setup wizard)
• Fixed a bug causing the update of OctoPrint to not work under certain circumstances: If 1.2.16 was installed and the settings were never saved via the "Settings" dialog's "Save", the update of OctoPrint would fail due to a KeyError in the updater. Reason is a renamed property, properly switched to when saving the settings.
• Fixed the logging subsystem to properly clean up after itself.
• Fixed a wrong order in loading JS files on the client introduced in 1.2.17rc2 to make the UI more resilient against broken plugin JS.
• Properly handle empty JS file list from plugins. Solves a 500 on OctoPrint instances without any third party plugins installed generated during web asset bundling introduced in 1.2.17rc2.

More information

• Commits
• Release Candidates:
  • 1.2.17rc1
  • 1.2.17rc2
  • 1.2.17rc3
  • 1.2.17rc4

1.2.16 (2016-09-23)

Improvements

• #1434: Make sure to sanitize any file names in the upload folder that do not match OctoPrint's file name "sanitization standard" automatically when creating a file listing. This should solve issues with UI functionality like selecting a file for printing or deleting a file to not work with files that were uploaded manually to the uploads folder. As a side note: Please don't do this, use the watched folder if you want to SCP/FTP/copy files directly to OctoPrint.
• #1434: Allow [ and ] in uploaded file names.
• #1481: Bring back non-fuzzy layer time estimates in the GCODE viewer.
• Improved fuzzy print time displays in the frontend. Rounding now takes overall duration into account - durations over a day will be rounded up/down to half days, durations over an hour will be rounded up/down to half hours, durations over 30min will be rounded to 10min segments, durations below 30min will be rounded up or down to the next minute depending on the seconds and finally if we are talking about less than a minute, durations over 30s will return "less than a minute", durations under 30s will return "a couple of seconds".
• Improved intermediary loading page: Don't report server as ready and reload until preliminary caching has been done, IF preliminary caching will be done.
• Added release channels to OctoPrint's bundled Software Update plugin. You will now be able to subscribe to OctoPrint's maintenance or devel release candidates in addition to stable versions. Read more about Release Channels on the wiki.
• Return a "400 Bad Request" instead of a "500 Internal Server Error" if a multipart/form-data request (e.g. a file upload) is sent which lacks the boundary field.

Bug Fixes

• #1448: Don't "eat" first line of the pause script after a pause triggering M0 but send it to the printer instead
• #1477: Only report files enqueued for analysis which actually are (as in, don't claim to have queued STL files for GCODE analysis)
• #1478: Don't display inaccurate linear estimate ("6 days remaining") until 30 minutes have passed, even if nothing else is available. Potentially related to #1428.
• #1479: Make sure set cookies are post fixed with a port specific suffix and that the path they are set on takes the script root from the request into account.
• #1483: Filenames in file uploads may also now be encoded in ISO-8859-1, as defined in RFC 7230. Solves an issue when sending files with non-ASCII-characters in the file name from Slic3r.
• #1491: Fixed generate/delete API key in the user settings
• #1492: Fixed a bug in the software update plugin depending on the presence of the prerelease flag which is only present when added manually or using a non stable release channel.

More information

• Commits
• Release Candidates:
  • 1.2.16rc1
  • 1.2.16rc2

1.2.15 (2016-07-30)

Improvements

• #1425 - Added a compatibility work around for plugins implementing the octoprint.comm.transport.serial_factory hook but whose handler's write method did not return the number of written bytes (e.g. GPX plugin including v2.5.2, M33 Fio plugin including v1.2).

Bug Fixes

• #1423 - Fixed an issue with certain printers dropping or garbling communication when setting the read timeout of the serial line. Removed the dynamic timeout setting introduced by #1409 to solve this.
• #1425 - Fixed an error when trying to close a printer connection that had not yet been opened and was None
• Fixed "Last Modified" header calculation for views where only one source file was present

(Commits)

1.2.14 (2016-07-28)

Improvements

• #935 - Support alternative source file types and target extensions in SlicerPlugins.
• #1393 - Added dedicated sub commands on the job API to pause and resume a print job (instead of only offering a toggle option).
• Better "upload error" message with a list of supported extensions (instead of hardcoded ones)
• Use fuzzy times for print time estimation from GCODE analysis
• Allow M23 "File opened" response with no filename (RepRapPro)
• Allow intermediary startup page to forward query parameters and fragments from initial call to actual web frontend
• More error resilience when rendering templates (e.g. from plugins)
• Make sure that all bytes of a line to send to the printer have actually been sent
• "Tickle" printer when encountering a communication timeout while idle
• Report CLOSED/CLOSED_WITH_ERROR states as "Offline" in frontend for more consistency with startup NONE state which already was reported as "Offline"
• Another attempt at a saner print time estimation: Force linear (way less accurate) estimate if calculation of more accurate version takes too long, sanity check calculated estimate and use linear estimate if it looks wrong, improved threshold values for calculation. Read the second half of this post on the mailing list on why accurate print time estimation is so difficult to achieve.
• Display print job progress percentage on progress bar.
• Added an indicator for print time left prediction accuracy and explanation of its origin as tooltip.
• Improved visual distinction of "State" sidebar panel info clusters.

Bug Fixes

• #1385 - Send all non-protocol messages from printer to clients.
• #1388 - Track consecutive timeouts even when idle and disconnect from printer when it's not responding any longer.
• #1391 - Only use the first value from the X-Scheme header for the reverse proxy setup. Otherwise there could be problems when multiple reverse proxies were configured chained together, each adding their own header to the mix.
• #1407 - If a file is uploaded with the "print" flag set to true, make sure to clear that flag after the print job has been triggered so that now all following uploaded or selected files will start printing on their own.
• #1409 - Don't report a communication timeout after a heatup triggered by a print from SD.
• Fixed scrolling to freshly uploaded files, also now highlighting the file entry for better visibility.
• Fixed overeager preemptive caching of invalid protocols.
• Fix modal background of update confirmation not vanishing
• Ensure log entries and messages from printer are sent to frontend already converted to utf-8. Otherwise even one line in the log that can't be converted automatically without error can cause updates from the backend to not arrive.
• Report correct printer state including error strings even after disconnecting
• While printing, be sure to read the next line from file and send that if the current line was filtered
• Small fixes in the GCODE analysis
• Small fixes in the documentation

(Commits)

1.2.13 (2016-06-16)

Bug Fixes

• #1373: Don't parse B: as bed temperature when it shows up as part of a position report from M114.
• #1374: Don't try to perform a passive login when the components we'd need to inform about a change in login state aren't yet available. Solves a bug that lead - among other things - to the Plugin Manager and the Software Update Plugin not showing anything but misleading errors until the user logged out and back in.
• Fixed the temperature graph staying uninitialized until a connection to a printer was established.
• Fixed an error causing issues during frontend startup if the browser doesn't support tracking browser visibility.
• Fixed an error causing issues during frontend startup if the browser doesn't support the capabilities needed for the GCODE viewer.

(Commits)

1.2.12 (2016-06-09)

Improvements

• #1338: Threshold configuration fields now include information about how to specify the thresholds.
• Mark unrendered timelapses currently being processed (recording or rendering) in the list and remove action buttons so no accidental double-processing can take place.
• Removed file extension from "rendering" and "rendered" notifications, was misleading when using the mp4 wrapper script.
• Added some new events for manipulation of slicing profiles.
• Small fix of the german translation.

Bug Fixes

• #1314: Do not change the extension of .g files being uploaded to SD (e.g. auto0.g)
• #1320: Allow deletion of *.mp4 timelapse files (see this wrapper script).
• #1324: Make daemonized OctoPrint properly clean up its pid file again (see also #1330).
• #1326: Do not try to clean up an unrendered timelapse while it is already being deleted (and produce way too much logging output in the process).
• #1343: Events are now processed in the order they are fired in, making e.g. the "timelapse rendering" message always appear before "timelapse failed" and hence not stay on forever in case of a failed timelapse.
• #1344: ProgressPlugins now get also notified about a progress of 0%.
• #1357: Fixed wrongly named method call on editing access control options for a user, causing that to not work properly.
• #1361: Properly reload profile list for currently selected slicer in the slicing dialog on change of profiles.
• #1364: Fixed a race condition that could cause the UI to not initialize correctly due to 401 errors, leaving it in an unusable state until a reload.
• Fixed concurrent message pushing to the frontend being able to break push messages for the session by forcing synchronization of SockJS message sending.
• Do not require admin rights for connecting/disconnecting, like it was in 1.1.x (note that this is supposed to become configurable behaviour once #1110 gets implemented)

(Commits)

1.2.11 (2016-05-04)

Important Announcement

Due to a recent change in the financial situation of the project, the funding of OctoPrint is at stake. If you love OctoPrint and want to see its development continue at the pace of the past two years, please read on about its current funding situation and how you can help: "I need your support".

Improvements

• Added option to treat resend requests as ok for such firmwares that do not send an ok after requesting a resend. If you printer communication gets stalled after a resend request from the firmware, try checking this option.
• Added an "About" dialog to properly inform about OctoPrint's license, contributors and supporters.
• Added a announcement plugin that utilizes the RSS feeds of the OctoPrint Blog and the plugin repository to display news to the user. By default only the "important announcement" category is enabled. This category will only be used for very rare situations such as making you aware of critical updates or important news. You can enable further categories (with more announcements to be expected) in the plugin's settings dialog.

Bug Fixes

• #1300 - Removed possibility to accidentally disabling local file list by first limiting view to files from SD and then disabling SD support.
• #1315 - Fixed broken post roll on z-based timelapses.
• Fixed CSS data binding syntax on the download link in the files list
• Changed control distance from jQuery data into a knockout observerable and observerableArray
• Allow an unauthorized user to logout from a logedin interface state

(Commits)

1.2.10 (2016-03-16)

Improvements

• Improved performance of console output during plugin installation/deinstallation
• Slight performance improvements in the communication layer
• Log small log excerpt to octoprint.log upon encountering a communication error.
• Changed wording in "firmware error" notifications to better reflect that there was an error while communicating with the printer, since the error condition can also be triggered by serial errors while trying to establish a connection to the printer or when already connected.
• Support downloading ".mp4" timelapse files. You'll need a custom wrapper script for timelapse rendering for this to be relevant to you. See also #1255
• The communication layer will now wait up to 10s after clicking disconnect in order to send any left-over lines from its buffers.
• Moved less commonly used configuration options in Serial settings into "Advanced options" roll-out.

Bug Fixes

• #1224 - Fixed an issue introduced by the fix for #1196 that had the "Upload to SD" button stop working correctly.
• #1226 - Fixed an issue causing an error on disconnect after or cancelling of an SD print, caused by the unsuccessful attempt to record print recovery data for the file on the printer's SD card.
• #1268 - Only add bed temperature line to temperature management specific start gcode in CuraEngine invocation if a bed temperature is actually set in the slicing profile.
• #1271 - If a communication timeout occurs during an active resend request, OctoPrint will now not send an M105 with an increased line number anymore but repeat the last resent command instead.
• #1272 - Don't add an extra ok for M28 response.
• #1273 - Add an extra ok for M29 response, but only if configured such in "Settings" > "Serial" > "Advanced options" > "Generate additional ok for M29"
• #1274 - Trigger M20 only once after finishing uploading to SD
• #1275 - Prevent M105 "cascade" due to communication timeouts
• Fixed wrong tracking of extruder heating up for M109 Tn commands in multi-extruder setups.
• Fixed start of SD file uploads not sending an M110.
• Fixed job data not being reset when disconnecting while printing.

(Commits)

1.2.9 (2016-02-10)

Improvements

• #318 - Snapshots for timelapses are now named in a non-colliding, job-based way, allowing a new timelapse to start while the other is still being rendered (although printing with an active timelapse rendering job is not recommended and will be solved with a proper render job queue in a later version). Timelapses that were not successfully rendered are kept for 7 days (configurable, although not via the UI so far) and can be manually rendered or deleted through a new UI component within the timelapse tab that shows up if unrendered timelapses are detected.
• #485 - "Timelapse rendering" notification is now persistent, even across reloads/client switches. That should make it easier to see that a rendering job is currently in progress.
• #939 - Updated to Knockout 3.4.0
• #1204 - Display total print time as estimated by GCODE viewer on GCODE viewer tab. That will allow access to an estimate even if the server hadn't yet calculated that when a print started. Note that due to slightly different implementation server and client side the resulting estimate might differ.
• OctoPrint now serves an intermediary page upon start that informs the user about the server still starting up. Once the server is detected as running, the page automatically switches to the standard interface.
• OctoPrint now displays a link to the release notes of an updated component in the update notification, the update confirmation and the version overview in the settings dialog. Please always make sure to at least skim over the release notes for new OctoPrint releases, they might contain important information that you need to know before updating.
• Improved initial page loading speeds by introducing a preemptive cache. OctoPrint will now record how you access it and on server start pre-render the page so it's ideally available in the server-side cache when you try to access it.
• Initialize login user name and password with an empty string and clear both on successful login (see #1175).
• Added a "Refresh" button to the file list for people who modify the stored files externally (doing this is not encouraged however due to reasons of book keeping, e.g. metadata tracking etc).
• "Save" button on settings dialog is now disabled while background tasks (getting or receiving config data from the backend) are in progress.
• Improved performance of terminal tab on lower powered clients. Adaptive rate limiting now ensures the server backs off with log updates if the client can't process them fast enough. If the client is really slow, log updates get disabled automatically during printing. This behaviour can be disabled with override buttons in the terminal tab's advanced options if necessary.
• Added option to ignore any unhandled errors reported by the firmware and another option to only cancel ongoing prints on unhandled errors from the firmware (instead of instant disconnect that so far was the default).
• Made version compatibility check PEP440 compliant (important for plugin authors).
• Do not hiccup on manually sent M28 commands.
• Persist print recovery data on print failures (origin and name of printed file, position in file when print was aborted, time and date of print failure). Currently this data isn't used anywhere, but it can be accessed from plugins in order to add recovery functionality to OctoPrint.
• Small performance improvements in update checks.
• The file upload dialog will now only display files having an extension that's supported for upload (if the browser supports it, also see #1196).

Bug Fixes

• #1007 - Don't enable the "Print" button if no print job is selected.
• #1181 - Properly slugify UTF-8 only file names.
• #1196 - Do not show drag-n-drop overlay if server is offline.
• #1208 - Fixed retraction_combing profile setting being incorrectly used by bundled Cura plugin (see #1209)
• Fixed OctoPrint compatibility check in the plugin manager, could report False for development versions against certain versions of Python's setuptools (thanks to @ignaworm who stumbled over this).
• Fixed a missing parameter in PluginSettings.remove call (see #1177).
• Docs: Fixed the example for a custom M114 control to also match negative coordinates.
• Reset scroll position in settings dialog properly when re-opening it or switching tabs.
• Fixed an issue that prevented system menu entries that were added to a so far empty system menu make the menu show up.
• Fixed an issue that made requests to restricted resources fail even though the first run wizard had been completed successfully.
• Fixed an issue where an unknown command or the suppression of a command could cause the communication to stall until a communication timeout was triggered.
• Strip unwanted ANSI characters from output produced by pip versions 8.0.0, 8.0.1 and 8.0.3 that prevents our plugin installation detection from working correctly.

(Commits)

1.2.8 (2015-12-07)

Notes for Upgraders

A bug in 1.2.7 prevents directly updating to 1.2.8, here's what to do

A bug in OctoPrint 1.2.7 (fixed in 1.2.8) prevents updating OctoPrint to version 1.2.8. If you try to perform the update, you will simply be told that "the update was successful", but the update won't actually have taken place. To solve this hen-egg-problem, a plugin has been made available that fixes said bug (through monkey patching).

The plugin is called "Updatefix 1.2.7" and can be found in the plugin repository and on Github.

Before attempting to update your installation from version 1.2.7 to version 1.2.8, please install the plugin via your plugin manager and restart your server. Note that you will only see it in the Plugin Manager if you need it, since it's only compatible with OctoPrint version 1.2.7. After you installed the plugin and restarted your server you can update as usual. The plugin will self-uninstall once it detects that it's running under OctoPrint 1.2.8. After the self-uninstall another restart of your server will be triggered (if you have setup your server's restart command, defaults to sudo service octoprint restart on OctoPi) in order to really get rid of any left-overs, so don't be alarmed when that happens, it is intentional.

If you cannot or don't want to use the plugin, alternatively you can switch OctoPrint to "Commit" based tracking via the settings of the Software Update plugin, update, then switch back to "Release" based tracking (see this screenshot).

Bed temperatures are now only displayed if printer profile has a heated bed configured

This release fixes a bug that caused bed temperature display and controls to be available even if the selected printer profile didn't have a heated bed configured.

If your printer does have a heated bed but you are not seeing its temperature in the "Temperature" tab after updating to 1.2.8, please make sure to check the "Heated Bed" option in your printer profile (under Settings > Printer Profiles) as shown in this short GIF.

Improvements

• Version numbering now follows PEP440.
• Prepared some things for publishing OctoPrint on PyPi in the future.
• BlueprintPlugin mixin now has an errorhandler decorator that serves the same purpose as Flask's (#1059)
• Interpret M25 in a GCODE file that is being streamed from OctoPrint as indication to pause, like M0 and M1.
• Cache rendered page and translation files indefinitely. That should significantly improve performance on reloads of the web interface.
• Added the string "unknown command" to the list of ignored printer errors. This should help with general firmware compatibility in case a firmware lacks features.
• Added the strings "cannot open" and "cannot enter" to the list of ignored printer errors. Those are errors that Marlin may report if there is an issue with the printer's SD card.
• The "CuraEngine" plugin now makes it more obvious that it only targets CuraEngine versions up to and including 15.04 and also links to the plugin's homepage with more information right within the settings dialog.
• Browser tab visibility is now tracked by the web interface, disabling the webcam and the GCODE viewer if the tab containing OctoPrint is not active. That should reduce the amount of resource utilized by the web interface on the client when it is not actively monitored. Might also help to mitigate #1065, the final verdict on that one is still out though.
• The printer log in the terminal tab will now be cut off after 3000 lines even if autoscroll is disabled. If the limit is reached, no more log lines will be added to the client's buffer. That ensures that the log will not scroll and the current log excerpt will stay put while also not causing the browser to run into memory errors due to trying to buffer an endless amount of log lines.
• Increased timeout of "waiting for restart" after an update from 20 to 60sec (20sec turned out to be too little for OctoPi for whatever reason).
• Added a couple of unit tests

Bug Fixes

• #1120 - Made the watchdog that monitors and handles the watched folder more resilient towards errors.
• #1125 - Fixed OctoPrint displaying bed temperature and controls and allowing the sending of GCODE commands targeting the bed (M140, M190) if the printer profile doesn't have a heated bed configured.
• Fixed an issue that stopped the software updater working for OctoPrint. The updater reports success updating, but no update has actually taken place. A fix can be applied for this issue to OctoPrint version 1.2.7 via the Updatefix 1.2.7 plugin. For more information please refer to the Important information for people updating from version 1.2.7 above.
• Fix: Current filename in job data should never be prefixed with /
• Only persist plugin settings that differ from the defaults. This way the config.yaml won't be filled with lots of redundant data. It's the responsibility of the plugin authors to responsibly handle changes in default settings of their plugins and add data migration where necessary.
• Fixed a documentation bug (#1067)
• Fixed a conflict with bootstrap-responsive, e.g. when using the ScreenSquish Plugin (#1103)
• Fixed OctoPrint still sending SD card related commands to the printer even if SD card support is disabled (e.g. M21).
• Hidden files are no longer visible to the template engine, neither as (GCODE) scripts nor as interface templates.
• The hostname and URL prefix via which the OctoPrint web interface is accessed is now part of the cache key. Without that being the case the cache could be created referring to something like /octoprint/prefix/api/ for its API endpoint (if accessed via http://somehost:someport/octoprint/prefix/ first time), which would then cause the interface to not work if accessed later via another route (e.g. http://someotherhost/).
• Fixed a JavaScript error on finishing streaming of a file to SD.
• Fixed version reporting on detached HEADs (when the branch detection reported "HEAD" instead of "(detached"
• Fixed some path checks for systems with symlinked paths (#1051)
• Fixed a bug causing the "Server Offline" overlay to pop under the "Please reload" overlay, which could lead to "Connection refused" browser messages when clicking "Reload now" in the wrong moment.

(Commits)

1.2.7 (2015-10-20)

Improvements

• #1062 - Plugin Manager now has a configuration dialog that among other things allows defining the used pip command if auto detection proves to be insufficient here.
• Allow defining additional pip parameters in Plugin Manager. That might make sudo-less installation of plugins possible in situations where it's tricky otherwise.
• Improved timelapse processing (backported from devel branch):
  • Individually captured frames cannot "overtake" each other anymore through usage of a capture queue.
  • Notifications will now be shown when the capturing of the timelapse's post roll happens, including an approximation of how long that will take.
  • Usage of requests instead of urllib for fetching the snapshot, appears to also have positive effects on webcam compatibility.
• Some more defensive escaping for various settings in the UI (e.g. webcam URL)
• Switch to more error resilient saving of configuration files and other files modified during runtime (save to temporary file & move). Should reduce risk of file corruption.
• Downloading GCODE and STL files should now set more fitting Content-Type headers (text/plain and application/sla) for better client side support for "Open with" like usage scenarios.
• Selecting z-triggered timelapse mode will now inform about that not working when printing from SD card.
• Software Update Plugin: Removed "The web interface will now be reloaded" notification after successful update since that became obsolete with introduction of the "Reload Now" overlay.
• Updated required version of psutil and netifaces dependencies.

Bug Fixes

• #1057 - Better error resilience of the Software Update plugin against broken/incomplete update configurations.
• #1075 - Fixed support of sudo for installing plugins, but added big visible warning about it as it's not recommended.
• #1077 - Do not hiccup on UTF-8 BOMs (or other BOMs for that matter) at the beginning of GCODE files.
• Fixed an issue that caused user sessions to not be properly associated, leading to Sessions getting duplicated, wrongly saved etc.
• Fixed internal server error (HTTP 500) response on REST API calls with unset Content-Type header.
• Fixed an issue leading to drag-and-drop file uploads to trigger frontend processing in various other file upload widgets.
• Fixed a documentation error.
• Fixed caching behaviour on GCODE/STL downloads, was setting the ETag header improperly.
• Fixed GCODE viewer not properly detecting change of currently visualized file on Windows systems.

(Commits)

1.2.6 (2015-09-02)

Improvements

• Added support for version reporting on detached checkouts (see #1041)

Bug Fixes

• Pinned requirement for psutil dependency to version 3.1.1 of that library due to an issue when installing version 3.2.0 of that library released on 2015-09-02 through a python setup.py install on OctoPrint. Also pinned all other requirements to definitive versions that definitely work while at it to keep that from happening again.

(Commits)

1.2.5 (2015-08-31)

Improvements

• #986 - Added tooltip for "additional data" button in file list.
• #1028 - Hint about why timelapse configuration is disabled.
• 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.
• Settings dialog now visualizes when settings are saving and when they being retrieved. Also the Send/Cancel buttons are disabled while settings are saving to prevent duplicated requests and concurrent retrieval of the settings by multiple viewmodels is disabled as well.
• Better protection against rendering errors from templates provided by third party plugins.
• Better protection against corrupting the configuration by using a temporary file as intermediate buffer.
• Added warning to UI regarding Z timelapses and spiralized objects.
• Better compatibility with Repetier firmware:
  • Added "Format Error" to whitelisted recoverable communication errors (see also #1032).
  • Added option to ignore repeated resend requests for the same line (see also discussion in #1015).
• Software Update Plugin:
  • Adjusted to utilize new centralized restart commands (see above).
  • Allow configuration of checkout folder and version tracking type via Plugin Configuration.
  • Display message to user if OctoPrint's checkout folder is not configured or a non-release version is running and version tracking against releases is enabled.
  • Clear version cache when a change in the check configuration is detected.
  • Mark check configurations for which an update is not possible.
• Made disk space running low a bit more obvious through visual warning on configurable thresholds.

Bug Fixes

• #985 - Do not hiccup on unset Content-Type part headers for multipart file uploads.
• #1001 - Fixed connection tab not unfolding properly (see also #1002).
• #1012 - All API responses now set no-cache headers, making the Edge browser behave a bit better
• #1019 - Better error handling of problems when trying to write the webassets cache.
• #1021 - Properly handle serial close on Macs.
• #1031 - Special handling of M112 (emergency stop) command:
  • Jump send queue
  • In case the printer's firmware doesn't understand it yet, at least shutdown all of the heaters
  • Disconnect
• Properly reset job progress to 0% when restarting a previously completed printjob (see #998).
• Report an update as failed if the pip command returns a return code that indicates failure.
• Fixed sorting of templates: could only be sorted by name, individual configurations were ignored (see #1022).
• Fixed positioning of custom context menus: were offset due to changes in overall positioning settings (see #1023).
• Software Update: Don't use display version for comparison of git commit hashs.
• Fixed temperature parsing for multi extruder setups.
• Fixed nested vertical and horizontal custom control layouts.

(Commits)

1.2.4 (2015-07-23)

Improvements

• RepeatedTimer now defaults to daemon set to True. This makes sure plugins using it don't have to remember to set that flag themselves in order for the server to properly shut down when timers are still active.
• Fixed a typo in the docs about logging.yaml (top level element is loggers, not logger).
• Support for plugins with external dependencies (dependency_links in setuptools), interesting for plugin authors who need to depend on Python libraries that are (not yet) available on PyPI.
• Better resilience against errors within plugins.

Bug Fixes

• Do not cache web page when running for the first time, to avoid caching the first run dialog popup along side with it. This should solve issues people were having when configuring OctoPrint for the first time, then reloading the page without clearing the cache, being again prompted with the dialog with no chance to clear it.
• Fix/workaround for occasional white panes in settings dialog on Safari 8, which appears to have an issue with fixed positioning.
• Fixed form field truncation in upload requests that could lead to problems when trying to import Cura profiles with names longer than 28 characters.
• Fixed webcam rotation for timelapse rendering.
• Fixed user settings not reaching the editor in the frontend.
• Notifications that are in process of being closed don't open again on mouse over (that was actually more of an unwanted feature).

(Commits)

1.2.3 (2015-07-09)

Improvements

• New option to actively poll the watched folder. This should make it work also if it is mounted on a filesystem that doesn't allow getting notifications about added files through notification by the operating system (e.g. network shares).
• Better resilience against senseless temperature/SD-status-polling intervals (such as 0).
• Log exceptions during writing to the serial port to octoprint.log.

Bug Fixes

• #961 - Fixed a JavaScript error that caused an error to be logged when "enter" was pressed in file or plugin search.
• #962 - url(...)s in packed CSS and LESS files should now be rewritten properly too to refer to correct paths
• Update notifications were not vanishing properly after updating:
  • Only use version cache for update notifications if the OctoPrint version still is the same to make sure the cache gets invalidated after an external update of OctoPrint.
  • Do not persist version information when saving settings of the Software Update plugin
• Always delete files from the watched folder after importing then. Using file preprocessor plugins could lead to the files staying there.
• Fixed an encoding problem causing OctoPrint's Plugin Manager and Software Update plugins to choke on UTF-8 characters in the update output.
• Fixed sorting by file size in file list
• More resilience against missing plugin assets:
  • Asset existence will now be checked before they get included in the assets to bundle by webassets, logging a warning if a file isn't present.
  • Monkey-patched webassets filter chain to not die when a file doesn't exist, but to log an error instead and just return an empty file instead.

(Commits)

1.2.2 (2015-06-30)

Bug Fixes

• Fixed an admin-only security issue introduced in 1.2.0, updating is strongly advised.

(Commits)

1.2.1 (2015-06-30)

Improvements

• More flexibility when interpreting compatibility data from plugin repository. If compatibility information is provided only as a version number it's prefixed with >= for the check (so stating a compatibility of only 1.2.0 will now make the plugin compatible to OctoPrint 1.2.0+, not only 1.2.0). Alternatively the compatibility information may now contain stuff like >=1.2,<1.3 in which case the plugin will only be shown as compatible to OctoPrint versions 1.2.0 and up but not 1.3.0 or anything above that. See also the requirement specification format of the pkg_resources package.
• Only print the commands of configured event handlers to the log when a new debug flag is present in the config (see the docs). Reduces risk of disclosing sensitive data when sharing log files.

Bug Fixes

• #956 - Fixed server crash when trying to configure a default slicing profile for a still unconfigured slicer.
• #957 - Increased maximum allowed body size for plugin archive uploads.
• Bugs without tickets:
  • Clean exit on SIGTERM, calling the shutdown functions provided by plugins.
  • Don't disconnect on volume.init errors from the firmware.
  • touch uploaded files on local file storage to ensure proper "uploaded date" even for files that are just moved from other locations of the file system (e.g. when being added from the watched folder).

(Commits)

1.2.0 (2015-06-25)

Note for Upgraders

• The Cura integration has changed in such a way that OctoPrint now calls the CuraEngine directly instead of depending on the full Cura installation. See the wiki for instructions on how to change your setup to accommodate the new integration.

New Features

• OctoPrint now has a plugin system which allows extending its core functionality.
  • Plugins may be installed through the new and bundled Plugin Manager Plugin available in OctoPrint's settings. This Plugin Manager also allows browsing and easy installation of plugins registered on the official OctoPrint Plugin Repository.
  • For interested developers there is a tutorial available in the documentation and also a cookiecutter template to quickly bootstrap new plugins.
• Added internationalization of UI. Translations of OctoPrint are being crowd sourced via Transifex. Language Packs for both the core application as well as installed plugins can be uploaded through a new management dialog in Settings > Appearance > Language Packs. A translation into German is included, further language packs will soon be made available.
• Printer Profiles: Printer properties like print volume, extruder offsets etc are now managed via Printer Profiles. A connection to a printer will always have a printer profile associated.
• File management now supports STL files as first class citizens (including UI adjustments to allow management of uploaded STL files including removal and reslicing) and also allows folders (not yet supported by UI). STL files can be downloaded like GCODE files.
• Slicing has been greatly improved:
  • It now allows for a definition of slicing profiles to use for slicing plus overrides which can be defined per slicing job (defining overrides is not yet part of the UI but it's on the roadmap).
  • A new slicing dialog has been added which allows (re-)slicing uploaded STL files (which are now displayed in the file list as well). The slicing profile and printer profile to use can be specified here as well as the file name to which to slice to and the action to take after slicing has been completed (none, selecting the sliced GCODE for printing or starting to print it directly)
  • The slicing API allows positioning the model to slice on the print bed (Note: this is not yet available in the UI).
  • Slicers themselves are integrated into the system via SlicingPlugins.
  • Bundled Cura Plugin allows slicing through CuraEngine up to and including 15.04. Existing Cura slicing profiles can be imported through the web interface.
• New file list: Pagination is gone, no more (mobile incompatible) pop overs, instead scrollable and with instant search
• You can now define a folder (default: ~/.octoprint/watched) to be watched for newly added GCODE (or -- if slicing support is enabled -- STL) files to automatically add.
• New type of API key: App Session Keys for trusted applications
• OctoPrint now supports action:... commands received via debug messages (// action:...) from the printer. Currently supported are
  • action:pause: Pauses the current job in OctoPrint
  • action:resume: Resumes the current job in OctoPrint
  • action:disconnect: Disconnects OctoPrint from the printer Plugins can add supported commands by hooking into the octoprint.comm.protocol.action hook
• Mousing over the webcam image in the control tab enables key control mode, allowing you to quickly move the axis of your printer with your computer's keyboard (#610):
  • arrow keys: X and Y axes
  • W, S / PageUp, PageDown: Z axes
  • Home: Home X and Y axes
  • End: Home Z axes
  • 1, 2, 3, 4: change step size used (0.1, 1, 10, 100mm)
• Controls for adjusting feed and flow rate factor added to Controls (#362)
• Custom controls now also support slider controls
• Custom controls now support a row layout
• Users can now define custom GCODE scripts to run upon starting/pausing/resuming/success/failure of a print or for custom controls (#457, #347)
• Bundled Discovery Plugin allows discovery of OctoPrint instances via SSDP/UPNP and optionally also via ZeroConf/Bonjour/Avahi.
• Bundled Software Update Plugin takes care of notifying about new OctoPrint releases and also allows updating if configured as such. Plugins may register themselves with the update notification and application process through a new hook "octoprint.plugin.softwareupdate.check_config".

Improvements

• Logging is now configurable via config file
• Added last print time to additional GCODE file information
• Better error handling for capture issues during timelapse creation & more robust handling of missing images during timelapse creation
• Start counting the layers at 1 instead of 0 in the GCODE viewer
• Upgraded Font Awesome to version 3.2.1
• Better error reporting for timelapse rendering and system commands
• Custom control can now be defined so that they show a Confirm dialog with configurable text before executing (#532 and #590)
• Serial communication: Also interpret lines starting with "!!" as errors
• Added deletion of pyc files to the python setup.py clean command
• Settings now show a QRCode for the API Key (#637)
• Username in UI is no longer enclosed in scare quotes (#595)
• Username in login dialog is not automatically capitalized on mobile devices anymore (#639)
• "Slicing Done" and "Streaming Done" notifications now have a green background (#558)
• Files that are currently in use, be it for slicing, printing or whatever, are now tracked and can not be deleted as long as they are in use
• Settings in UI get refreshed when opening settings dialog
• New event "SettingsUpdated"
• "Print time left" is now not displayed until it becomes somewhat stable. Display in web interface now also happens in a fuzzy way instead of the format hh:mm:ss, to not suggest a high accuracy anymore where the can't be one. Additionally OctoPrint will use data from prior prints to enhance the initial print time estimation.
• Added handler for uncaught exceptions to make sure those get logged, should make the logs even more useful for analysing bug reports
• The server now tracks the modification date of the configuration file and reloads it prior to saving the config if it has been changed during runtime by external editing, hence no config settings added manually while the server was running should be overwritten anymore.
• Display a "Please Reload" overlay when a new server version or a change in installed plugins is detected after a reconnect to the server.
• Better handling of errors on the websocket - no more logging of the full stack trace to the log, only a warning message for now.
• Daemonized OctoPrint now cleans up its pidfile when receiving a TERM signal (#711)
• Added serial types for OpenBSD (#551)
• Improved behaviour of terminal:
  • Disabling autoscrolling now also stops cutting off the log while it's enabled, effectively preventing log lines from being modified at all (#735)
  • Applying filters displays [...] where lines where removed and doesn't cause scrolling on filtered lines anymore (#286)
  • Added a link to scroll to the end of the terminal log (useful for when autoscroll is disabled)
  • Added a link to select all current contents of the terminal log for easy copy-pasting
  • Added a display of how many lines are displayed, how many are filtered and how many are available in total
• Frame rate for timelapses can now be configured per timelapse (#782)
• Added an option to specify the amount of encoding threads for FFMPEG (#785)
• "Disconnected" screen now is not shown directly after a close of the socket, instead the client first tries to directly reconnect once, and only if that doesn't work displays the dialog. Should reduce short popups of the dialog due to shaky network connections and/or weird browser behaviour when downloading things from the UI.
• Development dependencies can now be installed with pip -e .[develop]
• White and transparent colors ;) are supported for the navigation bar (#789)
• Drag-n-drop overlay for file uploads now uses the full available screen space, improving usability on high resolution displays (#187)
• OctoPrint server should no longer hang when big changes in the system time happen, e.g. after first contact to an NTP server on a Raspberry Pi image. Achieved through monkey patching Tornado with this PR.
• Serial ports matching /dev/ttyAMA* are not anymore listed by default (this was the reason for a lot of people running into problems while attempting to connect to their printer on their Raspberry Pis, on which /dev/ttyAMA0 is the OS's serial console by default). Added configuration of additional ports to the Serial Connection section in the Settings to make it easier for those people who do indeed have their printer connected to /dev/ttyAMA0.
• Better behaviour of the settings dialog on low-width devices, navigation and content also now scroll independently from each other (see also #823)
• Renamed "Temperature Timeout" and "SD Status Timeout" in Settings to "Temperature Interval" and "SD Status Interval" to better reflect what those values are actually used for.
• Added support for rectangular printer beds with the origin in the center (#682 and #852). Printer profiles now contain a new settings volume.origin which can either be lowerleft or center. For circular beds only center is supported.
• Made baudrate detection a bit more solid, still can't perform wonders.
• Only show configuration options for additional extruders if more than one is available, and don't include offset configuration for first nozzle which acts as reference for the other offsets (#677).
• Cut off of the temperature graph is now not based on the number of data points any more but on the actual time of the data points. Anything older than n minutes will be cut off, with n defaulting to 30min. This value can be changed under "Temperatures" in the Settings (#343).
• High-DPI support for the GCode viewer (#837).
• Stop websocket connections from multiplying (#888).
• New setting to rotate webcam by 90° counter clockwise (#895 and #906)
• System commands now be set to a) run asynchronized by setting their async property to true and b) to ignore their result by setting their ignore property to true.
• Various improvements of newly introduced features over the course of development:
  • File management: The new implementation will migrate metadata from the old one upon first startup after upgrade from version 1.1.x to 1.2.x. That should speed up initial startup.
  • File management: GCODE Analysis backlog processing has been throttled to not take up too many resources on system startup. Freshly uploaded files should still be analyzed at full speed.
  • Plugins: SettingsPlugins may track versions of configuration format stored in config.yaml, including a custom migration method getting called when a mismatch between the currently stored configuration format version and the one reported by the plugin as current is detected.
  • Plugins: Plugins may now have a folder for plugin related data whose path can be retrieved from the plugin itself via its new method get_plugin_data_folder.
  • Plugin Manager: Don't allow plugin management actions (like installing/uninstalling or enabling/disabling) while the printer is printing (see also unreproduced issue #936).
  • Plugin Manager: More options to try to match up installed plugin packages with discovered plugins.
  • Plugin Manager: Display a more friendly message if after the installation of a plugin it could not be correctly identifier.
  • Software Update: Enforce refreshing of available updates after any changes in enabled plugins.

Bug Fixes

• #435 - Always interpret negative duration (e.g. for print time left) as 0
• #516 - Also require API key even if ACL is disabled.
• #556 - Allow login of the same user from multiple browsers without side effects
• #612 - Fixed GCODE viewer in zoomed out browsers
• #633 - Correctly interpret temperature lines from multi extruder setups under Smoothieware
• #680 - Don't accidentally include a newline from the MIME headers in the parsed multipart data from file uploads
• #709 - Properly initialize time estimation for SD card transfers too
• #715 - Fixed an error where Event Triggers of type command caused and exception to be raised due to a misnamed attribute in the code
• #717 - Use shutil.move instead of os.rename to avoid cross device renaming issues
• #752 - Fix error in event handlers sending multiple gcode commands.
• #780 - Always (re)set file position in SD files to 0 so that reprints work correctly
• #784 - Also include requirements.txt in files packed up for python setup.py sdist
• #330 - Ping pong sending to fix potential acknowledgement errors. Also affects #166, #470 and #490. A big thank you to all people involved in these tickets in getting to the ground of this.
• #825 - Fixed "please visualize" button of large GCODE files
• Various fixes of bugs in newly introduced features and improvements:
  • #625 - Newly added GCODE files were not being added to the analysis queue
  • #664 - Fixed jog controls again
  • #677 - Fixed extruder offsets not being properly editable in printer profiles
  • #678 - SockJS endpoints is now referenced by relative URL using url_for, should solve any issues with IE11.
  • #683 - Fixed heated bed option not being properly displayed in printer profiles
  • #685 - Quoted file name for Timelapse creation to not make command hiccup on ~ in file name
  • #709 - Fixed file sending to SD card
  • #714 - Fixed type validation of printer profiles
  • Heating up the heated bed (if present) was not properly configured in CuraEngine plugin
  • #720 - Fixed translation files not being properly copied over during install
  • #724 - Fixed timelapse deletion for timelapses with non-ascii characters in their name
  • #726 - Fixed babel_refresh command
  • #759 - Properly initialize counter for template plugins of type "generic"
  • #775 - Error messages in javascript console show the proper name of the objects
  • #795 - Allow adding slicing profiles for unconfigured slicers
  • #809 - Added proper form validation to printer profile editor
  • #824 - Settings getting lost when switching between panes in the settings dialog (fix provided by #879)
  • #892 - Preselected baudrate is now properly used for auto detected serial ports
  • #909 - Fixed Z-Timelapse for Z changes on G1 moves.
  • Fixed another instance of a missing branch field in version dicts generated by versioneer (compare #634). Caused an issue when installing from source archive downloaded from Github.
  • #931 - Adjusted octoprint_setuptools to be compatible to older versions of setuptools potentially site-wide installed on hosts.
  • #942 - Settings can now be saved again after installing a new plugin. Plugins must not use super anymore to call parent implementation of SettingsPlugin.on_settings_save but should instead switch to SettingsPlugin.on_settings_save(self, ...). Settings API will capture related TypeErrors and log a big warning to the log file indicating which plugin caused the problem and needs to be updated. Also updated all bundled plugins accordingly.
  • Software Update: Don't persist more check data than necessary in the configuration. Solves an issue where persisted information overrode updated check configuration reported by plugins, leading to a "an update is available" loop. An auto-migration function was added that should remove the redundant data.
• Various fixes without tickets:
  • GCODE viewer now doesn't stumble over completely extrusionless GCODE files
  • Do not deliver the API key on settings API unless user has admin rights
  • Don't hiccup on slic3r filament_diameter comments in GCODE generated for multi extruder setups
  • Color code successful or failed print results directly in file list, not just after a reload
  • Changing Timelapse post roll activates save button
  • Timelapse post roll is loaded properly from config
  • Handling of files on the printer's SD card contained in folders now works correctly
  • Don't display a "Disconnected" screen when trying to download a timelapse in Firefox
  • Fixed handling of SD card files in folders
  • Fixed refreshing of timelapse file list upon finished rendering of a new one
  • Fixed /api/printer which wasn't adapter yet to new internal offset data model
  • Made initial connection to printer a bit more responsive: Having to wait for the first serial timeout before sending the first M105 even when not waiting for seeing a "start" caused unnecessary wait times for reaching the "Operational" state.
  • Log cancelled prints only once (thanks to @imrahil for the headsup)

More information

• Commits
• Release Candidates:
  • RC1
  • RC2
  • RC3

1.1.2 (2015-03-23)

Improvements

• Added deletion of *.pyc files to python setup.py clean command, should help tremendously when switching branches (backported from 9e014eb)
• Increased default communication and connection timeouts
• #706 - Do not truncate error reported from printer

Bug Fixes

• #539 - Limit maximum number of tools, sanity check tool numbers in GCODE files against upper limit and refuse to create 10000 tools due to weird slicers. (backported from devel)
• #634 - Fixed missing branch fields in version dicts generated by versioneer
• #679 - Fix error where API state is requested and printer is offline (backport of 619fe9a).
• #719 - Properly center print bed in GCODE viewer
• #780 - Always (re)set file position in SD files to 0 so that reprints work correctly (backported from devel)
• #801 - Fixed setting of bed temperature offset
• [IRC] - Don't hiccup on slic3r filament_diameter comments generated for multi extruder setups
• [ML] - Fixed relative URL to SockJS endpoint, wasn't yet using the proper base url
• [unreported] & #698 - Generated URLs now take X-Forwarded-Host header sent by proxies into account for included host and port, also fixed #698 introduced by this
• [unreported] Fixed a bug causing gcodeInterpreter to hiccup on GCODES containing invalid coordinates such as Xnan or Yinf (backported from devel)
• Small fixes for timelapse creation:
  • #344 - Made timelapses capable of coping with missing captures in between by decrementing the image counter again if there was an error fetching the latest image from the snapshot URL (backport of 1a7a468 and bf9d5ef)
  • #693 - Try not to capture an image if image counter is still unset
  • [unreported] Synchronize image counter decrementing as well as incrementing to prevent rare race conditions when generating the image file names

(Commits)

1.1.1 (2014-10-27)

Improvements

• The API is now enabled by default and the API key -- if not yet set -- will be automatically generated on first server start and written back into config.yaml
• Event subscriptions are now enabled by default (it was an accident that they weren't)
• Generate the key used for session hashing individually for each server instance
• Generate the salt used for hashing user passwords individually for each server instance

Bug Fixes

• #580 - Properly unset job data when instructed so by callers
• #604 - Properly initialize settings basedir on server startup
• [IRC] Also allow downloading .g files via Tornado

(Commits)

1.1.0 (2014-09-03)

New Features

• New REST API, including User API Keys additionally to the global API key. Please note that this will break existing API clients as it replaces the old API (same endpoint). You can find the documentation of the new API at docs.octoprint.org.
• New Event structure allows more flexibility regarding payload data, configuration files will be migrated automatically. You can find the documentation of the new event format and its usage at docs.octoprint.org.
• Support for multi extruder setups. With this OctoPrint now in theory supports an unlimited amount of extruders, however for now it's artificially limited to 9.
• Log files can be accessed from within the browser via the Settings dialog (#361)
• Timelapses can now have a post-roll duration configured which will be rendered into the video too to not let it end so abruptly (#384)
• The terminal tab now has a command history (#388)

Improvements

• Stopping the application via Ctrl-C produces a less scary message (#277)
• Webcam stream is disabled when control tab is not in focus, reduces bandwidth (#316)
• M and G commands entered in Terminal tab are automatically converted to uppercase
• GCODE viewer now only loads automatically if GCODE file size is beneath certain threshold (different ones for desktop and mobile devices), only actually loads file if user acknowledges that this might be too much for his browser
• Added time needed for printing file to PrintDone event's payload (#333)
• Also provide the filename (basename without the path) in print events
• Support for circular beds in the GCODE viewer (#407)
• The dimensions of the print bed can now be configured via the Settings (#396)
• Target temperature reporting format of Repetier Firmware is now supported as well (360)
• Version tracking now based on git tagging and versioneer. Version number, git commit and branch get reported in the format <version tag>-<commits since then>-g<commit hash> (<branch> branch), e.g. 1.2.0-dev-172-ga48b5de (devel branch).
• Made "Center viewport on model" and "Zoom in on model" in the GCODE viewer automatically deselect and de-apply if viewport gets manipulated by the user (#398)
• GCODE viewer now interprets inverted axes for printer control and mirrors print bed accordingly (#431)
• Added clean command to setup.py, removes old build artifacts (mostly interesting for developers)
• Added version resource on API which reports application and API version
• Made the navbar static instead of fixed to improve usability on mobile devices (#257)
• Switch to password field upon enter in username field, submit login form upon enter in password field
• Changed default path to OctoPrint executable in included init-script to /usr/local/bin/octoprint (the default when installing via python setup.py install)

Bug Fixes

• Properly calculate time deltas (forgot to factor in days)
• #35 - GCODE viewer has been modularized, options are now functional
• #337 - Also recognize --iknowwhatimdoing when running as daemon
• #357 - Do not run GCODE analyzer when a print is ongoing
• #381 - Only list those SD files that have an ASCII filename
• Fixed a race condition that could occur when pressing "Print" (File not opened yet, but attempt to read from it)
• #398 - Fixed interfering options in GCODE viewer
• #399 & 360 - Leave bed temperature unset when not detected (instead of dying a horrible death)
• #492 - Fixed a race condition which could lead to an attempt to read from an already closed serial port, causing an error to be displayed to the user
• #257 - Logging in on mobile devices should now work
• #476 - Also update the metadata correctly when an analysis finishes
• Various fixes of bugs in newly introduced features and improvements:
  • #314 - Use G28 for homing (G1 was copy and paste error)
  • #317 - Fixed "load and print" function
  • #326 - Fixed refresh of SD file list
  • #338 - Refetch file list when deleting a file
  • #339 - More error resilience when handling temperature offset data from the backend
  • #345 - Also recognize such temperature reports that do not contain a T: but a T0:
  • #377 - URLs in API examples fixed
  • #378 - Fixed crash of API call when getStartTime() returns None
  • #379 - Corrected response code for connection success
  • #414 - Fix style attribute for Actual column header

(Commits)

1.0.0 (2014-06-22)

First release with new versioning scheme.