diff --git a/source/_components/binary_sensor.octoprint.markdown b/source/_components/binary_sensor.octoprint.markdown index 7a05254c5e4..c8ef090c450 100644 --- a/source/_components/binary_sensor.octoprint.markdown +++ b/source/_components/binary_sensor.octoprint.markdown @@ -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. + +
+You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor. +
To set it up, add the following information to your `configuration.yaml` file: @@ -31,4 +35,3 @@ Configuration variables: - Printing - Printing Error -You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor.
diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index 9642fb40701..9103ad5e9c5 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -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. diff --git a/source/_components/sensor.octoprint.markdown b/source/_components/sensor.octoprint.markdown index 58aaacb01b8..20682101264 100644 --- a/source/_components/sensor.octoprint.markdown +++ b/source/_components/sensor.octoprint.markdown @@ -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. + ++You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor. +
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 -You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor.