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-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update octoprint docs

Browse Source
This commit is contained in:
Fabian Affolter 2016-09-01 19:03:52 +02:00
parent fed6dd8289
commit fa3bebf39a
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
3 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
source/_components/binary_sensor.octoprint.markdown
View File

@ -13,7 +13,11 @@ ha_release: 0.19
---
The `OctoPrint` binary sensor platform let you monitor if your 3D printer is printing or if there was a printing error.
The `octoprint` binary sensor platform let you monitor if your 3D printer is printing or if there was a printing error.
<p class='note'>
You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor.
</p>
To set it up, add the following information to your `configuration.yaml` file:
@ -31,4 +35,3 @@ Configuration variables:
- Printing
- Printing Error
<p class='note'>You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor.</p>

7
source/_components/octoprint.markdown
View File

@ -15,18 +15,19 @@ ha_release: 0.19
[OctoPrint](http://octoprint.org/) is a web interface for your 3D printer. This is the main component to integrate OctoPrint sensors, you will have to setup sensors and binary sensors separately.
To get started with the OctoPrint API, please follow the directions on their [site](http://docs.octoprint.org/en/master/api/general.html). Once OctoPrint is configured you will need to add your API key and host to your configuration.yaml.
To get started with the OctoPrint API, please follow the directions on their [site](http://docs.octoprint.org/en/master/api/general.html). Once OctoPrint is configured you will need to add your API key and host to your `configuration.yaml`.
```yaml
octoprint:
host: http://YOUR_OCTOPRINT_HOST
host: YOUR_OCTOPRINT_HOST
api_key: YOUR_API_KEY
```
Configuration variables:
- **api_key** (*Required*): The retrieved api key.
- **host** (*Required*): The octoprint host.
- **api_key** (*Required*): The retrieved api key.
**NOTE** If your 3D printer isn't connected to the OctoPrint server during the startup of Home Assistant this component will fail to load.

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

@ -13,7 +13,11 @@ ha_release: 0.19
---
The `OctoPrint` sensor platform let you monitor various states of your 3D printer and its print jobs.
The `octoprint` sensor platform let you monitor various states of your 3D printer and its print jobs.
<p class='note'>
You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor.
</p>
To set it up, add the following information to your `configuration.yaml` file:
@ -33,4 +37,3 @@ Configuration variables:
- Temperatures (Temperatures of all available tools)(print head, print bed, ...) These will be displayed as tool0, tool1, ... please refer to your OctoPrint frontend to associate tool number with actual device.
- Job Percentage
<p class='note'>You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor.</p>