OctoPrint
OctoPrint is a web interface for your 3D printer. This is the main integration to integrate OctoPrint sensors.
Configuration
To add the OctoPrint integration to your Home Assistant instance, use this My button:
OctoPrint can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.
If it wasn’t discovered automatically, don’t worry! You can set up a manual integration entry:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the Add Integration button.
-
From the list, select OctoPrint.
-
Follow the instructions on screen to complete the setup.
API key
For the integration to work, please check that in Octoprint, the Discovery Plugin is enabled and in the Settings -> Printer Notifications menu that Enable popups is checked. The Octoprint integration will attempt to register itself via the Application Keys Plugin. After submitting the configuration UI in Home Assistant, open the Octoprint UI and select Allow on the prompt. NOTE: You must be logged into Octoprint as the user which you are adding Home Assistant. Otherwise, the popup access prompt does not appear.
Binary sensor
The OctoPrint integration provides the following binary sensors:
- Printing
- Print Error
Sensor
The OctoPrint integration lets you monitor various states of your 3D printer and its print jobs.
Supported sensors:
- Current Printer State
- Job Completed Percentage
- Estimated Finish Time
- Estimated Start Time
Camera
The OctoPrint integration provides a camera feed if one is configured in OctoPrint.
Buttons
The OctoPrint integration provides the following buttons:
- Pause Job
- Resume Job
- Stop Job
- Shutdown System
- Reboot System
- Restart Octoprint
Troubleshooting
Device is already configured for a second instance
This is typically caused by copying/backup/restoring part of the config files between OctoPrint instances.
- SSH into the OctoPrint instance that is being added.
- Edit the
config.yaml
for the instance (Typically/home/pi/.octoprint
) - Under
plugins/discovery
, change the value ofupnpUuid
to have a different uuid. - Restart the OctoPrint service
- Attempt to add the instance once again.