Added octoprint documentation (#448)

This commit is contained in:
William Scanlon 2016-05-06 16:38:29 -04:00 committed by Fabian Affolter
parent de586c5433
commit 7d6b837ec0
4 changed files with 97 additions and 0 deletions

View File

@ -0,0 +1,33 @@
---
layout: page
title: "OctoPrint Binary Sensor"
description: "Instructions how to integrate OctoPrint binary sensors within Home Assistant."
date: 2016-05-05 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: octoprint.png
ha_category: Binary Sensor
---
The `OctoPrint` binary sensor platform let you monitor if your 3D printer is printing or if there was a printing error.
To set it up, add the following information to your `configuration.yaml` file:
```yaml
binary_sensor:
platform: octoprint
monitored_conditions:
- Printing
- Printing Error
```
Configuration variables:
- **monitored_conditions** array (*Required*): States to monitor.
- Printing
- Printing Error
<p class='note'>You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor.</p>

View File

@ -0,0 +1,29 @@
---
layout: page
title: "OctoPrint"
description: "Instructions how to setup the OctoPrint in Home Assistant."
date: 2015-01-20 22:36
sidebar: true
comments: false
sharing: true
footer: true
logo: octoprint.png
ha_category: Hub
featured: true
---
[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.
```yaml
octoprint:
host: http://YOUR_OCTOPRINT_HOST
api_key: YOUR_API_KEY
```
Configuration variables:
- **api_key** (*Required*): The retrieved api key.
- **host** (*Required*): The octoprint host.

View File

@ -0,0 +1,35 @@
---
layout: page
title: "OctoPrint Sensor"
description: "Instructions how to integrate OctoPrint sensors within Home Assistant."
date: 2016-05-05 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: octoprint.png
ha_category: Sensor
---
The `OctoPrint` sensor platform let you monitor various states of your 3D printer and its print jobs.
To set it up, add the following information to your `configuration.yaml` file:
```yaml
sensor:
platform: octoprint
monitored_conditions:
- Current State
- Temperatures
- Job Percentage
```
Configuration variables:
- **monitored_conditions** array (*Required*): States to monitor.
- Current State (Text of current state)
- 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>

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB