Installation

Installation

Currently Octolapse is not listed in the plugin repository, but it can be installed either manually or via the bundled Plugin Manager.

Steps prior to installation

1. Update OctoPrint to the latest version. Octolapse requires OctoPrint 1.3.7 or higher.
2. Make sure your webcam is correctly configured within Octoprint. Octolapse will try to discover your webcam settings when it is first installed, which will make setup easier.
3. Make sure FFMpeg is installed. It can be found here. If you can currently generate timelapses with Octoprint, it is likely already installed.
4. Make sure your FFMpeg path is correct in the Octoprint 'Timelapse Recordings' settings. Again, if the built-in timelapse plugin is working, FFMpeg is likely correctly configured.
5. It's a good idea to look at the known issues before installing Octolapse, especially the Prusa MK2/MK2S/MK3 firmware issue since it affects the only printers I've tested. It just might save you some trouble even if you aren't using Octolapse!

Install via the plugin manager

1. Open and sign into Octoprint.
2. Click the settings icon (wrench) at the top of the page.
3. Select the 'Plugin Manager' link on the left side of the settings popup.
4. Click on the 'Get More...' button towards the bottom of the Plugin Manager page.
5. Type 'octolapse' (without the 's) into the search box.
6. Click 'Install'
7. After installation is complete, follow the prompts to restart Octoprint.
8. After OctoPrint reloads clear your browser's cache (instructions vary by browser, but typically pressing ctrl+f5 will work).
9. If you were using a version of Octolapse prior to 2.1 you MUST restore the default settings, otherwise you may encounter strange issues. You can learn how to restore the default settings here.

If you want to install a specific branch, see 'Manually installing a specific branch' below

Steps after installation

1. Make sure to select or add the appropriate printer profile. Only the listed printers have been tested. Check your slicer settings and your printer's documentation for the appropriate values for your printer. Note that non-cartesian printers are NOT yet supported, and printers with center origins or inverted axes have NOT been tested. Use extreme caution when attempting to add an unsupported printer.
2. Make sure your webcam is working by editing the default camera profile and clicking the 'Test Camera Snapshot' button.
3. Unload any filament from your printer, and run a short print in 'Test Mode' to make sure things are working. See Test Mode in the wiki for instructions.

Manually Install a specific branch via the Plugin Manager

1. Open and sign into Octoprint.
2. Click the settings icon at the top of the page.
3. Select the 'Plugin Manager' link on the left side of the settings popup.
4. Click on the 'Get More...' button towards the bottom of the Plugin Manager page.
5. Copy and paste the following url into the '... from URL' box: https://github.com/FormerLurker/Octolapse/archive/BRANCHNAME.zip
6. Replace BRANCHNAME in the URL with the EXACT NAME of the desired branch name and click 'Install'.
7. After installation is complete, follow the prompts to restart Octoprint.
8. After OctoPrint reloads clear your browser's cache (instructions vary by browser, but typically pressing ctrl+f5 will work).