jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-17 00:18:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/octoprint.markdown
Ryan Fleming d16418622e
Octoprint Config Flow and sensors (#19854) 
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2021-10-26 12:10:21 +02:00

1.4 KiB
Raw Blame History

title, description, ha_category, ha_config_flow, ha_release, ha_codeowners, ha_iot_class, ha_domain, ha_zeroconf, ha_ssdp, ha_platforms
title description ha_category ha_config_flow ha_release ha_codeowners ha_iot_class ha_domain ha_zeroconf ha_ssdp ha_platforms
OctoPrint Integration between OctoPrint and Home Assistant.
Binary Sensor
Sensor
true 0.19
@rfleming71
Local Polling octoprint true true
binary_sensor
sensor

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

{% include integrations/config_flow.md %}

API Key

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.

camera:
  - platform: mjpeg
    name: OctoPrint
    still_image_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=snapshot
    mjpeg_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=stream