Report a Bug

UNDER CONSTRUCTION This page is still under construction. Things will change here a lot over the next days and weeks, so be sure to keep checking in!

Have you found a bug? Please note the following very important steps:

Complete the issue Template

It is ABSOLUTELY CRITICAL that you fill in the new issue template as much as possible. In order for me to fix your issue I need to understand what it is and be able to reproduce the bug you are seeing. Sometimes this is very difficult since it could be hardware related. Sometimes it's just hard to tell what could be causing your problem.

Not all items requested in the issue template will apply in every situation, but when in doubt, fill it out!

Include an Octolapse log file

Octolapse has a configurable logger, so not all logs are created equal. If you are reporting an issue, it's important that you include a diagnostic log. To create a diagnostic log, change your Debug Profile to either Live Print - Debug Issues or Test Mode - Debug Issues. Test mode will prevent your printer from warming up or extruding plastic, and is pretty convenient for quick tests.

Once your debug profile is set, run a small sample print that reproduces your current problem (say a small calibration cube). The trick here is that you want your test print to be as fast as possible while showing the error that is occurring. Longer prints = bigger logs = big headaches to debug. However, if you are unable to replicate your issue using a small sample print, go ahead and reproduce it any way you can.

Once you have reproduced your error, download the plugin_octolapse.log file from Octoprint Settings->Logs and keep it handy.

Include your settings.json file

This is almost always required to solve issues. Your Octolapse settings can be easily downloaded by clicking the Gear icon on the Octolapse tab (or by opening OctoPrint settings and clicking on the 'Octolapse' menu item), then clicking the 'Export Settings' button.

Include your gcode file

This is almost always required to resolve issues. Be sure to upload the same gocde file that you used to create the log file.

Upload your files to gist.github.com

Please please use gist.github.com to upload your documents. It's fast, convenient, and extremely useful for me. Pasting long log entries or gcode files (very short snippets are fine, but NOT long ones) directly in the github issue makes it very difficult for me to examine your issue. If I'm on mobile it makes it nearly impossible.

Be patient

I don't always have tons of free-time, and some issues take HOURS AND HOURS (sometimes days or weeks) to solve. I really do try to get to every issue that is reported, but sometimes issues fall through the cracks. If you've been waiting for a response for a long time (a week or two), feel free to give me a nudge.

Please respond promptly

I haven't received a response from your issue from you, I may flag the issue as 'Waiting for Response'. If I don't hear back from you I may close the issue. Don't take it personally, as I usually assume you've solved the issue yoruself. Also, I will usually re-open any closed issue if you ask me.

Close your issue after it is solved

Though I will eventually close long idle issues, I'd consider it a favor if you closed your issues out once they have been solved.

You're ready to create an issue!

Now, that you know the Octolapse issue basics, you are all ready to create a new issue!