Home Assistant Home Assistant

OctoPrint

OctoPrint is a web interface for your 3D printer. This is the main integration to integrate OctoPrint sensors.

Configuration

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”, which you can select to set it up right away.

Manual configuration steps
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 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.

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

If the OctoPrint host is equipped with a web camera it is possible to add this as well using the MJPEG IP Camera integration. Use http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=stream for the MJPEG URL and http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=snapshot as the still image URL.

Buttons

The OctoPrint integration provides the following buttons.

  • Pause Job
  • Resume Job
  • Stop Job