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.

  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.