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-07-14 12:56:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation for #8988 Fix octoprint errors when printer is off/disconnected (#3211)

Browse Source 
* Updates for #8988

* Fixed spelling errors

* Add HTML
This commit is contained in:
William Scanlon 2017-08-20 15:15:05 -04:00 committed by Fabian Affolter
parent 51f8791b9e
commit c0fa3e6d1e
2 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
source/_components/octoprint.markdown
View File

@ -23,12 +23,14 @@ To get started with the OctoPrint API, please follow the directions on their [si
octoprint: octoprint:
host: YOUR_OCTOPRINT_HOST host: YOUR_OCTOPRINT_HOST
api_key: YOUR_API_KEY api_key: YOUR_API_KEY
bed: false
number_of_tools: 1
``` ```
Configuration variables: Configuration variables:
- **host** (*Required*): IP address or hostname of Octoprint host. - **host** (*Required*): IP address or hostname of Octoprint host.
- **api_key** (*Required*): The retrieved api key. - **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.

6
source/_components/sensor.octoprint.markdown
View File

@ -39,5 +39,9 @@ Configuration variables:
- **monitored_conditions** array (*Required*): States to monitor. - **monitored_conditions** array (*Required*): States to monitor.
- **Current State**: Text of current state) - **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. - **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.
<p class='note'>
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.
</p>