How To Configure Octoprint with Home Assistant

by Danny
0 comment

READING TIME: 5 MINUTES

In this guide, I’m going to show you how to integrate OctoPrint in Home Assistant. Octoprint is an open-source web interface for your 3D printer.

I’ve been using Octoprint with my Creality Ender 3 S1 for a while. It’s a great way to manage your 3d print jobs or remotely control your printer from your phone or computer. When you pair Octoprint with Home Assistant, it opens the doors to even more creative ideas.

There’s two different ways to integrate it. You can either use the official Octoprint integration, or use one from the Home Assistant Community (HACS) store. The HACS install method requires an MQTT broker, but does give you more entities to work with. I’ll create a separate guide for the HACS method in the near future.

This guide will show you how to integrate using the official Octoprint integration, and I’ll also show you how to create a nice 3D Printer Status card like you see above. Octoprint will already need to up and running before you can integrate it.

Let’s get started!


Other Useful Octoprint Guides

Official Creality Ender 3 S1 3D Printer with Direct Drive Extruder CR Touch Auto Leveling High Precision Double Z-axis Screw Silent Board Printing Size 8.6X8.6X10.6in, Upgrade Ender 3 V2 for Beginners
  • Dual-Gear Direct Drive Extruder: Compatible with more filaments, Ender 3 S1 3d printer can print PLA, TPU, PETG, ABS.etc. It is more lighter and features less inertia and more precise positioning. Upgraded dual-gear direct extruder features two chrome steel gears that are engaged at a 1:3.5 gear ratio. With a pushing force of up to 80N, the extruder realizes smooth feeding and discharging of flaments without slipping and works extremely well in printing flexible flaments such as TPU.
  • CR Touch Auto Bed Leveling: Upgraded CR Touch 16-point automatic bed leveling technology saves you the trouble of manual leveling. Easy to use, the intelligent leveling system can automatically compensate for the printing height of different points of the heatbed.

OctoPrint Home Assistant Automation Ideas

Before I show you how to integrate, here’s some automation ideas I use. Hopefully it inspires you to setup this integration, too.

  • Automatically turn off 3d printer (via smartplug) when status changes to idle
  • Turn print bed heat off if left on
  • Receive notifications when a print starts or completes
  • Start / Stop / Pause print
  • Pull webcam video feed into a dashboard

What automations do you have setup for your 3d printer?


Install Official Octoprint Integration

Installation is super easy. Just log into Home Assistant from a web browser.

Click Settings > Devices & Services > Integrations tab.

Your Octoprint server should automatically be detected.

If Home Assistant doesn’t detect it, click Add Integration and search for “Octoprint” to set it up manually.

Click Configure.

Enter your Octoprint username and uncheck SSL.

Click Submit. The onscreen message tells you to open OctoPrint to approve the Access Request.

To approve it, head over to your Octoprint web interface by going to http://octopi.local or entering the IP address of octopi in your browser.

Click Allow in the yellow box.

After that, navigate back to Home Assistant. If everything worked correctly, you’ll see a Success! message like this:


View Octoprint Entities

The next step is to take a look at all the newly created entities.

By default, this integration will create Pause Job, Resume Job, and Stop Job buttons.

Some of the sensors you have at your disposal are:

  • Current state
  • Estimated finish time
  • Job percentage
  • Start Time
  • various temperature sensors for the bed or nozzle

Here’s a screenshot of every entity provided to you with the default integration:


Octoprint / 3D Printer Card

If you’d like to create a simple, minimalistic 3D printer dashboard card, you can use this Threedy integration in Home Assistant. You will needs HACS installed for this.

To install:

  1. Open HACS from your sidebar & navigate to the Frontend Section
  2. Click the 3 dots in the top right corner. Then click on Custom repositories
  3. In the Repository box, paste https://github.com/dangreco/threedy
  4. In the category box, click Lovelace.
  5. Click Add.

Then click the Threedy integration.

Then Download.


Add Card to Dashboard

The next part is pretty self-explanatory. Just click Add Card on one of your Home Assistant dashboards.

Search for “threedy”.

Then just go through and select everything you want to see or monitor on the card.

Some of the options (Like ETA and Remaining) caused my card not to load so I couldn’t enable them, but it still looks cool. The printer logo animates too. It doesn’t appear that the card is actively developed, so use at your own risk.


Wrapping Up

Hopefully this guide helped you setup & configure Octoprint in Home Assistant quickly and easily. I’ll probably spend some time creating a nice view for my 3D printer stats at some point, but for the most part – I still manage my Octoprints from the OctoApp mobile app.

The primary reasons I integrated with Home Assistant is for safety features like automatically turning it on/off, sending notifications, and turning on my LED light strip when a print job starts so I can take better timelapses.


My Favorite Home Assistant Devices

Below are some of the Home Assistant-compatible devices I personally use in my home. I highly recommend each of them.

The full list of all Home Assistant compatible & recommended devices I use can be found on my Equipment List page.

0 comment

You may also like

Leave a Comment