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-04-30 08:17:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_components/sensor.octoprint.markdown
William Scanlon c0fa3e6d1e Documentation for #8988 Fix octoprint errors when printer is off/disconnected (#3211) 
* Updates for #8988

* Fixed spelling errors

* Add HTML
2017-08-20 21:15:05 +02:00

1.5 KiB
Raw Blame History

layout title description date sidebar comments sharing footer logo ha_category ha_release ha_iot_class
page OctoPrint Sensor Instructions how to integrate OctoPrint sensors within Home Assistant. 2016-05-05 08:00 true false true true octoprint.png Sensor 0.19 Local Polling

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

You must have the [OctoPrint component](/components/octoprint/) 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

Configuration variables:

  • name (Optional): The name of the sensor. Default is 'OctoPrint'.
  • monitored_conditions array (Required): States to monitor.
    • Current State: Text of current state)
    • Temperatures: Temperatures of all available tools, eg. 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.

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.