mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
🚜 Merges/Redirect OctoPrint component pages (#8744)
This commit is contained in:
parent
ab2051268f
commit
73dcb3d655
@ -1,49 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "OctoPrint Binary Sensor"
|
|
||||||
description: "Instructions on 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
|
|
||||||
ha_release: 0.19
|
|
||||||
ha_iot_class: "Local Polling"
|
|
||||||
---
|
|
||||||
|
|
||||||
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 binary sensor. After configuring that component, binary sensors automatically appear.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
|
||||||
|
|
||||||
To set it up, add the following information to your `configuration.yaml` file:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
binary_sensor:
|
|
||||||
- platform: octoprint
|
|
||||||
monitored_conditions:
|
|
||||||
- Printing
|
|
||||||
- Printing Error
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
|
||||||
monitored_conditions:
|
|
||||||
description: States to monitor.
|
|
||||||
required: true
|
|
||||||
type: list
|
|
||||||
keys:
|
|
||||||
printing:
|
|
||||||
description: State of the printer.
|
|
||||||
printing error:
|
|
||||||
description: Error while printing.
|
|
||||||
name:
|
|
||||||
description: The name of the sensor.
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
default: OctoPrint
|
|
||||||
{% endconfiguration %}
|
|
@ -8,14 +8,29 @@ comments: false
|
|||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: octoprint.png
|
logo: octoprint.png
|
||||||
ha_category: Hub
|
ha_category:
|
||||||
|
- Hub
|
||||||
|
- Binary Sensor
|
||||||
|
- Sensor
|
||||||
featured: false
|
featured: false
|
||||||
ha_release: 0.19
|
ha_release: 0.19
|
||||||
ha_iot_class: "Local Polling"
|
ha_iot_class: "Local Polling"
|
||||||
|
redirect_from:
|
||||||
|
- /components/binary_sensor.octoprint/
|
||||||
|
- /components/sensor.octoprint/
|
||||||
---
|
---
|
||||||
|
|
||||||
[OctoPrint](http://octoprint.org/) is a web interface for your 3D printer. This is the main component to integrate OctoPrint sensors.
|
[OctoPrint](http://octoprint.org/) is a web interface for your 3D printer. This is the main component to integrate OctoPrint sensors.
|
||||||
|
|
||||||
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
|
- [Binary Sensor](#binary-sensor)
|
||||||
|
- [Sensor](#sensor)
|
||||||
|
|
||||||
|
<p class='note'>
|
||||||
|
You must have the <a href="#configuration">OctoPrint component</a> configured (below) to use the sensor and binary sensor. After configuring that component, the sensors and binary sensors automatically appear.
|
||||||
|
</p>
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
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`.
|
||||||
@ -136,3 +151,38 @@ camera:
|
|||||||
still_image_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=snapshot
|
still_image_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=snapshot
|
||||||
mjpeg_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=stream
|
mjpeg_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=stream
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## {% linkable_title 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 %}
|
||||||
|
monitored_conditions:
|
||||||
|
description: States to monitor.
|
||||||
|
required: true
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
printing:
|
||||||
|
description: State of the printer.
|
||||||
|
printing error:
|
||||||
|
description: Error while printing.
|
||||||
|
name:
|
||||||
|
description: The name of the sensor.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
default: OctoPrint
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
## {% linkable_title Sensor %}
|
||||||
|
|
||||||
|
The `octoprint` sensor platform let you monitor various states of your 3D printer and its print jobs.
|
||||||
|
@ -1,21 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "OctoPrint Sensor"
|
|
||||||
description: "Instructions on 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
|
|
||||||
ha_release: 0.19
|
|
||||||
ha_iot_class: "Local Polling"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
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. After configuring that component, sensors automatically appear.
|
|
||||||
</p>
|
|
Loading…
x
Reference in New Issue
Block a user