From c0fa3e6d1ea6f30e19936d184f1c587d34b82dac Mon Sep 17 00:00:00 2001 From: William Scanlon Date: Sun, 20 Aug 2017 15:15:05 -0400 Subject: [PATCH] Documentation for #8988 Fix octoprint errors when printer is off/disconnected (#3211) * Updates for #8988 * Fixed spelling errors * Add HTML --- source/_components/octoprint.markdown | 6 ++++-- source/_components/sensor.octoprint.markdown | 6 +++++- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index 17b9f1a5935..192d5d9d9a3 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -23,12 +23,14 @@ To get started with the OctoPrint API, please follow the directions on their [si octoprint: host: YOUR_OCTOPRINT_HOST api_key: YOUR_API_KEY + bed: false + number_of_tools: 1 ``` Configuration variables: - **host** (*Required*): IP address or hostname of Octoprint host. - **api_key** (*Required*): The retrieved api key. +- **bed** (*Optional*): If the printer has a heated bed. +- **number_of_tools** (*Optional*): Number of temperature adjustable tools. i.e. nozzle. - -**NOTE** If your 3D printer isn't connected to the OctoPrint server during the startup of Home Assistant this component will fail to load. diff --git a/source/_components/sensor.octoprint.markdown b/source/_components/sensor.octoprint.markdown index 149c48a7b41..129660a2f84 100644 --- a/source/_components/sensor.octoprint.markdown +++ b/source/_components/sensor.octoprint.markdown @@ -39,5 +39,9 @@ Configuration variables: - **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**: + - **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. +