markwal / OctoPrint-PolarCloud

OctoPrint plugin that connects OctoPrint to the Polar3D cloud. You easily monitor your printer from outside your LAN without arcane setup of port forwarding, etc. Plus, take advantage of the rapidly evolving Polar Cloud capabilities and UI.
GNU Affero General Public License v3.0
15 stars 8 forks source link

OctoPrint-PolarCloud

Connects OctoPrint to the PolarCloud so that you can easily monitor and control your printer from anywhere via https://polar3d.com

Setup

Install via OctoPrint's Plugin Manager via OctoPrint->Settings->Plugin Manager->Get More... then search for Polar and click "Install".

This may take a long while, especially if your platform needs to install and compile the cryptography package. It should be a reasonable wait on a Raspberry Pi Zero, 2 or 3 though.

Install CuraEngine Legacy plugin

Octoprint newer than version 1.3.10 requires that the CuraEngine Legacy slicing plugin be installed. If running the Polar Cloud Plugin 1.9 or newer, CuraEngine Legacy slicer needs to be installed.

Enable Polar Cloud timelapses

To create timelapse movies in the format required by the Polar Cloud, the plugin uses GStreamer. To install GStreamer and the necessary plugins, use the following command line:

sudo apt-get update
sudo apt install gstreamer1.0-tools gstreamer1.0-libav libx264-dev gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly

Plugin Configuration

After installing the plugin and restarting OctoPrint, you need to register your printer with your PolarCloud user account.

Notes and Limitations

Note for Users running OctoPrint on Windows

If you've got an old version of pyopenssl installed into the OctoPrint environment and you don't have ssh-keygen on your path, this plugin won't be able to register your printer with Polar Cloud. You'll get something about 'ssh-keygen' not found in octoprint.log. You can fix this by updating pyOpenSSL and restarting OctoPrint.