OctoPrint


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
  bed: false
  number_of_tools: 1

Configuration Variables

host

(string)(Required)IP address or hostname of Octoprint host.

api_key

(string)(Required)The retrieved api key.

bed

(boolean)(Optional)If the printer has a heated bed.

Default value: false

number_of_tools

(integer)(Optional)Number of temperature adjustable tools, i.e. nozzle.

Default value: 0

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