OctoPrint is a web interface for your 3D printer. This is the main integration to integrate OctoPrint sensors.
Adding OctoPrint to your Home Assistant instance can be done via the user interface, by using 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 sidebar, select Settings.
From the configuration menu, select Devices & Services.
In the bottom right, select the Add Integration button.
From the list, search and select OctoPrint.
Follow the instructions on screen to complete the setup.
For the integration to work, please check that in Octoprint, the plugin Discovery is enabled and in the settings -> printer notifications menu pop-ups are enabled. 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 click allow on the prompt.
The OctoPrint integration provides the following binary sensors:
- Print Error
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
The OctoPrint integration provides a camera feed if one is configured in OctoPrint.
The OctoPrint integration provides the following buttons:
- Pause Job
- Resume Job
- Stop Job
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.yamlfor the instance (Typically
plugins/discovery, change the value of
upnpUuidto have a different uuid.
- Restart the OctoPrint service
- Attempt to add the instance once again.