Octoprint -- Enclosure Plugin -- GPIO state in HA?

VolkerKa · August 27, 2019, 9:25am

Hello.
I have Octprint installed on a Raspberry Pi. The integration into HA worked wonderfully and the different states are also displayed. Now I have installed the “Enclosure Plugin” in Octprint and I can handle it super well.
Now my question: Can I display the status of a GPIO pin of the Octopi in HA as a sensor?
I have seen that you can set up a function for IFTTT in the “Enclosure Plugin”, in “Advanced Settings”. But I’m not such a big friend of IFTTT and wanted to know if there is another, more direct way.

Have not found a thread here in the forum to my question, so this one here.

Thank you in advance.

greetings

El_Duderino · October 5, 2019, 4:34pm

I would be very interested in this as well. Bonus points if you could control the pins directly from HA.

“There is also an API that can be used to interact with the plugin with other software”

El_Duderino · October 6, 2019, 3:49pm

To expand a little further on this, I can get the following command to turn on the lights in my Printer Enclosure using the Enclosure plug-in API documentation.

https://192.xxx.x.xxx/plugin/enclosure/setIO?status=true&index_id=4&apikey=XXXXXXXXXXXXXXXXX

However, I’m not sure how to best integrate these with input booleans, switches, etc in Hassio.

El_Duderino · October 7, 2019, 7:13pm

I worked on this a bit and the following Node-Red flow is allowing me to control my Octoprint Enclosure GPIO from within HA and has a 15 second sync to HA if things are changed via Octoprint.

I am more than open to suggestions on how to do cleaner job on this if anyone has any pointers. Otherwise, I thought someone else might benefit from my effort.

logicaljack · December 11, 2019, 2:19pm

Have you managed to get the temperature values from the Enclosure plugin imported into Home Assistant?

I have added a DHT22 sensor to the Pi and its working fine through the Octoprint web dashboard, however I want to pull the temperature/humidity readings into HomeAssistant and I am not sure if its possible? I did read the API info but it seems to relate to outputs only

donjoergo · December 31, 2019, 1:28am

Hi there,
i’ve been digging through the Repsoitory and found the following API.
In my case, I got a response from this URL:

http://<YOUR_OCTOPI_IP>/plugin/enclosure/inputs/1

This way, you can create a REST sensor:

# Octprint Enclosure Plugin
- platform: rest
  name: printer_enclosure_temp
  device_class: temperature
  unit_of_measurement: "°C"
  resource: http://<YOUR_OCTOPI_IP>/plugin/enclosure/inputs/1
  value_template: '{{ value_json.temp_sensor_temp }}'
- platform: rest
  name: printer_enclosure_hum
  device_class: humidity
  unit_of_measurement: "%"
  resource: http://<YOUR_OCTOPI_IP>/plugin/enclosure/inputs/1
  value_template: '{{ value_json.temp_sensor_humidity }}'

Hope this helps.

RAymax · January 25, 2020, 8:23pm

Does it work, does it show you the enclosure Temp and Humidity??

Verry interessted in that.

I copied your code in the config.yaml but it doesn’t work…

Would you be so kind and help me with that topic

Thanks

Serchio · October 23, 2020, 8:47am

Hello. share a switch for the enclosure plugin. can anyone come in handy

- platform: command_line
    scan_interval: 5
    switches:
      light_power:
        friendly_name: "Octoprint Light"
        command_on: "curl 'http://XXX.XXX.XXX.XXX/plugin/enclosure/setIO?status=true&index_id=5&apikey=XXXXXXXXXXXX'"
        command_off: "curl 'http://XXX.XXX.XXX.XXX/plugin/enclosure/setIO?status=false&index_id=5&apikey=XXXXXXXXXXXX'"
        command_state: "curl 'http://XXX.XXX.XXX.XXX/plugin/enclosure/getOutputStatus?apikey=XXXXXXXXXXXX'"
        value_template: "{{  (value_json[1].status==1) }}"

!secret dont work. comparison with 1 added because status is true and 1. sorry for my english.
for a long time I could not understand why it does not work. quotes!

paulhoek1 · November 10, 2020, 10:10pm

Hi @Serchio,

Just yesterday i connected my printer to HA and i wanted to control the enclosureplugin with HA.

Your code works great for controlling, but I can’t get the state to work.

Are you sure this line is correct?

    value_template: "{{  (value_json[1].status==1) }}"

I’ve checked the state command in a browser and it posts the following which seems right:

[{“status”: 1, “index_id”: 1}, {“status”: true, “index_id”: 2}]

Everything else works fine.

Can anyone take a look at this?

Thanks!

Serchio · November 12, 2020, 2:11pm

Not entirely correct))) . You must specify the correct item number in the json array. That is, the required element is the second - instead of 1 we write 2. If 3 - write 3

paulhoek1 · December 21, 2020, 11:30am

Got it working, thanks man!

Hicksta · February 16, 2021, 7:35am

I can’t get this to work. I used to be able to turn it off, but not back on. Have had to reinstall HomeAssistant and now can’t get it to work at all.
Getting this error.
Error parsing value: list object has no element 1 (value: [{“status”: true, “index_id”: 1}], template: {{ (value_json[1].status==1) }})

Hicksta · February 16, 2021, 10:42am

Not sure why, But recreated the enclosure plugin for led lights to id2 with exactly the same details as id1. Changed config to id2 and worked first time.
So Hours later it now works.

ChrisBarber · March 28, 2021, 5:34pm

Hello,

did you got it to work? When i go on the resource address, it shows me the json but in homeassistant i only get unknown.

Thanks

Gouranga · June 9, 2021, 10:04am

It took me some time to get it working, but this works for me.
I’ve got a single output defined in the enclosu

- platform: command_line
  scan_interval: 5
  switches:
     octoprint_gpio:
        friendly_name: "Prusa LEDs"
        command_on: 'curl -k "https://xxx.xxx.xxx.xxx/plugin/enclosure/setIO?status=true&index_id=1&apikey=xxxxxxxx"'
        command_off: 'curl -k "https://xxx.xxx.xxx.xxx/plugin/enclosure/setIO?status=false&index_id=1&apikey=xxxxxxxx"'
        command_state: 'curl -k "https://xxx.xxx.xxx.xxx/plugin/enclosure/getOutputStatus?&apikey=xxxxxxxxx"'
        value_template: "{{value_json.0.status }}"

Expecially the value template took me some time.
You can get a preview of the json info by entering the url (https://xxx.xxx.xxx.xxx/plugin/enclosure/getOutputStatus?&apikey=xxxxxxxxx) in your webbrowser.

In my case this returned:

0
index_id 1
status false
State " OFF "

In case of multiple gpio outputs the index will be 0, 1,…etc

jshank · November 12, 2021, 11:34pm

FYI that the old API methods are marked deprecating-soon in the Enclosure plugin code. Home Assistant debug homeassistant.components.rest: debug was utterly useless. I resorted to TCP dumps and lots of curl debugging to figure it out.

I was able to work out the correct restful switch as follows:

switch:
  - platform: rest
    name: Enclosure Lights
    resource: http:/<octoprint_ip>/plugin/enclosure/outputs/<enclosure_id>
    method: PATCH
    verify_ssl: false
    headers:
      X-Api-Key: "<Octoprint_API_key>"
      Content-Type: "application/json"
    body_on: '{"status":true}'
    body_off: '{"status":false}'
    is_on_template: "{{ value_json.current_value }}"

Note that <enclosure_id> is the index of the Output from the Enclosure plugin settings. Look for the field described as Id used for API control in OctoPrint Settings - Enclosure Plugin.

There are quite a few other undocumented API goodies buried in the code starting here. Just look for lines with @octoprint.plugin.BlueprintPlugin.route

infromatica · December 27, 2021, 10:13pm

Thank you this worked for me also. No let me see if i can make the temperature sensor work as well.

kobraevents · January 25, 2025, 3:13pm

ive tried so many times with the old api till i found this post!
Thanks man, great job. works like hell