From 73dcb3d6555a757cfd237da0d95b68e94f01d1d1 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 26 Feb 2019 09:32:39 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20OctoPrint=20co?= =?UTF-8?q?mponent=20pages=20(#8744)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../binary_sensor.octoprint.markdown | 49 ----------------- source/_components/octoprint.markdown | 52 ++++++++++++++++++- source/_components/sensor.octoprint.markdown | 21 -------- 3 files changed, 51 insertions(+), 71 deletions(-) delete mode 100644 source/_components/binary_sensor.octoprint.markdown delete mode 100644 source/_components/sensor.octoprint.markdown diff --git a/source/_components/binary_sensor.octoprint.markdown b/source/_components/binary_sensor.octoprint.markdown deleted file mode 100644 index c4181593468..00000000000 --- a/source/_components/binary_sensor.octoprint.markdown +++ /dev/null @@ -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. - -

-You must have the [OctoPrint component](/components/octoprint/) configured to use this binary sensor. After configuring that component, binary sensors automatically appear. -

- -## {% 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 %} diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index 646f766afd6..5a9de6605b9 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -8,14 +8,29 @@ comments: false sharing: true footer: true logo: octoprint.png -ha_category: Hub +ha_category: + - Hub + - Binary Sensor + - Sensor featured: false ha_release: 0.19 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. +There is currently support for the following device types within Home Assistant: + +- [Binary Sensor](#binary-sensor) +- [Sensor](#sensor) + +

+You must have the OctoPrint component configured (below) to use the sensor and binary sensor. After configuring that component, the sensors and binary sensors automatically appear. +

+ ## {% 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`. @@ -136,3 +151,38 @@ camera: still_image_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=snapshot 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. diff --git a/source/_components/sensor.octoprint.markdown b/source/_components/sensor.octoprint.markdown deleted file mode 100644 index c2998392855..00000000000 --- a/source/_components/sensor.octoprint.markdown +++ /dev/null @@ -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. - -

-You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor. After configuring that component, sensors automatically appear. -