2024.10.4
Home ▸ Integrations ▸

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.

Manual configuration steps

If it wasn’t discovered automatically, don’t worry! You can set up a manual integration entry:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select OctoPrint.

  • Follow the instructions on screen to complete the setup.

username

Username for the server.

host

Address of the server, e.g., 192.168.1.32.

port

Port of the server.

path

URL path of the server

ssl

Whether to use SSL or not when communicating.

verify ssl

Should the SSL certificate be validated.

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, log in to Octoprint as the user whose credentials you just entered in Home Assistant, and select Allow on the prompt.

NOTE: You must be logged into Octoprint as the user which you are adding to Home Assistant. If you log in to Octoprint as any other user, you will not see the prompt to allow access.

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.

  1. SSH into the OctoPrint instance that is being added.
  2. Edit the config.yaml for the instance (Typically /home/pi/.octoprint)
  3. Under plugins/discovery, change the value of upnpUuid to have a different uuid.
  4. Restart the OctoPrint service
  5. Attempt to add the instance once again.