OctoPrint Sensor


The octoprint sensor platform let you monitor various states of your 3D printer and its print jobs.

You must have the OctoPrint component configured to use this sensor.

To set it up, add the following information to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: octoprint
    name: OctoPrint
    monitored_conditions:
      - Current State
      - Temperatures
      - Job Percentage
      - Time Elapsed
      - Time Remaining

Configuration Variables

name

(string)(Optional)The name of the sensor.

Default value: OctoPrint

monitored_conditions

(list)(Required)States to monitor.

current state

Text of current state.

temperatures

Temperatures of all available tools, e.g., print, head, print bed, etc. These will be displayed as tool0, tool1, or toolN please refer to your OctoPrint frontend to associate the tool number with an actual device.

job percentage

Percentage of the job.

time elapsed

Time elapsed on current print job, in seconds.

time remaining

Time remaining on current print job, in seconds.

If you are tracking temperature it is recommended to set bed and/or number_of_tools in your octoprint configuration. This will allow the octoprint sensors to load if the printer is offline during Home Assistant startup.