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-05 10:38:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_components/octoprint.markdown
Fabian Affolter 227d5a3f4f Minimizing of the configuration sample (#1020)
2016-10-01 12:09:08 +02:00

1.1 KiB
Raw Blame History

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, featured, ha_release, ha_iot_class
layout title description date sidebar comments sharing footer logo ha_category featured ha_release ha_iot_class
page OctoPrint Instructions how to setup the OctoPrint in Home Assistant. 2015-01-20 22:36 true false true true octoprint.png Hub false 0.19 Local Polling

OctoPrint is a web interface for your 3D printer. This is the main component to integrate OctoPrint sensors, you will have to setup sensors and binary sensors separately.

To get started with the OctoPrint API, please follow the directions on their site. Once OctoPrint is configured you will need to add your API key and host to your configuration.yaml.

octoprint:
  host: YOUR_OCTOPRINT_HOST
  api_key: YOUR_API_KEY

Configuration variables:

  • host (Required): IP address or hostname of Octoprint host.
  • api_key (Required): The retrieved api key.

NOTE If your 3D printer isn't connected to the OctoPrint server during the startup of Home Assistant this component will fail to load.