Fixing Octoprint Integration in Home Assistant

So, Home Assistant has an integration for Octoprint. Seems like it would be really solid - a great thing!

Well, it is, unless you already have two printers set up in Home Assistant. I considered tearing it all out and rebuilding it. Delete it, and see what it comes back as. That probably would have been more sane. If you go this route, skip to Octoprint side fixes.

Identify what needs to get changed

The first step was that none of my sensors were correct. Fortunately, my input booleans (buttons for turning things on and off, retracting - those all go through MQTT topics in Node Red and were untouched.)

Octoprint side fixes

First, I went to two Octoprints and their Home Assistant Discovery plug-ins and changed the device name to be unique. (The names of the two printers showed up as "Octoprint", resulting in "Octoprint****_2" for some of the entities.)

Next, you do NOT need to change anything in MQTT. These are untouched.

Back in Home Assistant

In the configuration.yaml file, I was able to comment out all of the octoprint material, except for the temperature conversion templates. HA does not appreciate C or <degree-symbol>C to convert from Fahrenheit. (Once I'm sure I don't need it, I'll also kill their entries in the secrets.yaml file.) You'll also need to update the "what sensor am I converting from" for each of those templates.

Next, you'll need to fix the naming convention for each device and each entity sensor under that device. When I reloaded things, it seemed like there were 10 entities for each printer - low. Oh well - that's what all of the previous MQTT work was for, right?

Starting with Configuration > Integrations (Octoprint >  select one of the IP addresses > click on the entities. 6 of 10 came in just fine, but the tool/bed temperature-related ones needed to be renamed from the "_2".

Dashboard fixes

Any of those MQTT input boolean buttons should still be fine. My state-based Z-home vs. Cancel Job no longer worked, but the commands were still there. Mainly, it's just fixing the sensors that were renamed.

To fix the state-based buttons, I had to open up the 4th row in the code editor. The conditional sensors needed to be fixed, but the input booleans and text were fine.

Overall

It took about 30 minutes to fix it all. Destroying it and rebuilding might still be a better option - I only had 10 sensors show up.



Comments

Post a Comment

Popular posts from this blog

Home Assistant Controlling Octoprint through MQTT - Chapter 1

Image
I'm going to start listing software versions - sometimes I hit a wall, because of dated information. Home Assistant evolves continually...a year from now, this might have a different solution. Components and their versions: Home Assistant Core 2021.1.0 (HA) Operating System 5.9 (HA) Node Red 7.2.11 (HA) Mosquitto Broker 5.1 (HA) Octoprint 1.5.2 MQTT 0.8.7 (Octoprint plugin) MQTT-Subscribe 0.1.6 (Octoprint plugin) MQTT Explorer 0.3.5 (Linux, optional)  My goal is to create buttons in a Lovelace dashboard, to trigger actions for my two 3D printers. Actions like "connect/disconnect" to start a connection between Octoprint and the printer, "preheat nozzle" so I can have the nozzle go to 180 degrees Celsius to change filament, "Extrude" to extrude 10mm of filament, or "Retract" to retract 10mm of filament, and maybe a "heat bed" so I can heat up the bed to remove a print. I'll start with a "Connect" button for my Lulzbot ...
Read more

Setting up MQTT on HA and Octoprint

Image
  I'm going to start listing versions - sometimes I hit a wall, because of dated information. Home Assistant evolves continually...a year from now, this might have a different solution. Components and their versions: Home Assistant Core 2021.1.0 (HA) Operating System 5.9 (HA) Node Red 7.2.11 (HA) Mosquitto Broker 5.1 (HA - this is the MQTT Broker) Octoprint 1.5.2 MQTT 0.8.7 (Octoprint plugin) MQTT-Subscribe 0.1.6 (Octoprintg plugin) MQTT Explorer 0.3.5 (Linux, optional)  My goal is to create buttons in a Lovelace dashboard, to trigger actions for my two 3D printers. Actions like "connect/disconnect" to start a connection between Octoprint and the printer, "preheat nozzle" so I can have the nozzle go to 180 degrees Celsius to change filament, "Extrude" to extrude 10mm of filament, or "Retract" to retract 10mm of filament, and maybe a "heat bed" so I can heat up the bed to remove a print. I'm running Home Assistant on a...
Read more

Home Assistant Controlling Octoprint through MQTT - Chapter 2

Image
What I didn't mention in the previous post, was the struggle to get it working. I'm not a programmer or a savant that can pick up anything. The next part is wiring up other buttons for different commands, and that means using more of the Octoprint API, as of this writing, here: https://docs.octoprint.org/en/master/api/ Current issues Ongoing problem #1: I mentioned how I got connect to work. Using the same pseudo-code, it should be super easy to execute {"command":"disconnect"}. It even pops up the same area as the command: connect did...but it doesn't disconnect. Ongoing problem #2: Extrude/Retract - this happens frequently when changing out filament, or in some cases...the print fails to start after homing on the corners. Before the homing occurred, it retracted. If I were to just start again, it would retract again! (The nozzle needs to be preheated, extruded, and then turned off.) Ongoing problem #3: Preheat to 230/turn off - as I just mentioned in #...
Read more