Skip to content

Commit c0fa3e6

Browse files
William Scanlonfabaff
William Scanlon
authored andcommitted
Documentation for home-assistant#8988 Fix octoprint errors when printer is off/disconnected (home-assistant#3211)
* Updates for home-assistant#8988 * Fixed spelling errors * Add HTML
1 parent 51f8791 commit c0fa3e6

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

source/_components/octoprint.markdown

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,14 @@ To get started with the OctoPrint API, please follow the directions on their [si
2323
octoprint:
2424
host: YOUR_OCTOPRINT_HOST
2525
api_key: YOUR_API_KEY
26+
bed: false
27+
number_of_tools: 1
2628
```
2729
2830
Configuration variables:
2931
3032
- **host** (*Required*): IP address or hostname of Octoprint host.
3133
- **api_key** (*Required*): The retrieved api key.
34+
- **bed** (*Optional*): If the printer has a heated bed.
35+
- **number_of_tools** (*Optional*): Number of temperature adjustable tools. i.e. nozzle.
3236
33-
34-
**NOTE** If your 3D printer isn't connected to the OctoPrint server during the startup of Home Assistant this component will fail to load.

source/_components/sensor.octoprint.markdown

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,9 @@ Configuration variables:
3939
- **monitored_conditions** array (*Required*): States to monitor.
4040
- **Current State**: Text of current state)
4141
- **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.
42-
- **Job Percentage**:
42+
- **Job Percentage**: Percentage of the job.
4343

44+
45+
<p class='note'>
46+
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.
47+
</p>

0 commit comments

Comments
 (0)