Installation

Octolapse is now listed in the plugin repository as long as you are running OctoPrint v1.3.7 rc1 or higher!

Update: As of 4/9/2018, OctoPrint v1.3.7 stable is out, so update today!

Steps prior to installation

1. Update OctoPrint to the latest version. Octolapse requires OctoPrint 1.3.7 or higher. You can check your version number by looking in the lower left hand corner of the OctoPrint home page. As of 3/28/2018, you must update to the latest maintenance release candidate.
2. Make sure FFMpeg is installed. It can be found here. If you can currently generate timelapses with Octoprint, it is likely already installed.
3. 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.
4. 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.
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 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 and click 'Intall' when the Octolapse plugin appears.
6. After installation is complete, follow the prompts to restart Octoprint.
7. After OctoPrint reloads clear your browser's cache (instructions vary by browser, but typically pressing ctrl+f5 will work).
8. If you were using a version of Octolapse prior to v0.3.0rc1 you MUST restore the default settings, otherwise you may encounter strange issues. You can learn how to restore the default settings here. You can find the Octolapse version number from within the Octolapse settings in the About tab.

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

Steps after installation - Configuration

Here is a video covering basic configuration of v0.3.4

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. Copy your slicer's settings into your printer profile. See this link for instructions relating to several common slicers.
3. Make sure your webcam is working by editing the default camera profile and clicking the 'Test Camera Snapshot' button.
4. 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).
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.

Keeping Octolapse Up-To-Date

By default OctoPrint will notify you when there are changes to the latest stable version of Octolapse. When a new version is detected, Octoprint will notify you with a popup message.

Track pre-release versions (version tracking)

If you are using Octolapse v0.3.3rc2 or above, you can be notified when there are new pre-release versions of Octolapse available. Follow these steps in order to receive the notifications:

1. Open OctoPrint settings (wrench icon).
2. Click on 'Software Update' from the left hand menu.
3. Click on the settings icon (wrench icon to the right of the 'Current Versions' title).
4. Set the 'OctoPrint version tracking' drop down to 'Release'.
5. Set the 'OctoPrint Release Channel' to either 'Maintenance RCs' or 'Devel RCs'
   1. Devel RCs - These Development Release Candidates are the first pre-release versions available. These will almost always have some code that has not been tested by users. If enhancements or bug-fixes are added to Octolapse, they will be applied here first.
   2. Maintenance RCs - If a Development Release Candidate appears to be stable, it will be promoted to a 'Maintenance Release Candidate' for further testing. These
6. Click 'Save'.

Manually Checking for Updates

Octoprint's software update plugin will only check for updates periodically (the current default is once per day). You can manually check for updates at any time by following these steps:

1. Open OctoPrint settings (wrench icon).
2. Click on 'Software Update' from the left hand menu.
3. Expand the 'Advanced Options'.
4. Click on 'Force check for update'.

If any updates are available you will receive a notification.

Notes about branches as of 2018-03-14:

master

https://github.com/FormerLurker/Octolapse/archive/master.zip - Currently contains the most recent version: Octolapse V0.3.0. This branch is compatible with OctoPrint 1.3.7 and above.

rc/maintenance

https://github.com/FormerLurker/Octolapse/archive/rc/maintenance.zip - This branch contains pre-release versions of Octolapse that are (usually) nearly ready for production. These are more thoroughly tested than the rc/devel branch but less tested than the master branch.

rc/devel

https://github.com/FormerLurker/Octolapse/archive/rc/devel.zip - This repository contains development work that usually involves preparing for a new rc/maintenance release. Additionally, any bugs found within an rc/maintenance will be first fixed and applied to the rc/devel build before carrying over to rc/maintenance

devel

https://github.com/FormerLurker/Octolapse/archive/devel.zip - This is the 'bleeding edge' branch. You can expect to find bugs or breaking changes at any time here. I don't recommend you install Octolapse from this branch unless you've been specifically told to do so within a support ticket.