mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-05 10:38:58 +00:00
1aca7b08cf
* e.g. to e.g., and proper case for Home Assistant * Instructions how to -> Instructions on how to
39 lines
1014 B
Markdown
39 lines
1014 B
Markdown
---
|
|
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 sensor.
|
|
</p>
|
|
|
|
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**: State of the printer.
|
|
- **Printing Error**: Error while printing.
|
|
- **name** (*Optional*): The name of the sensor. Default is 'OctoPrint'.
|