Add configuration section to octoprint (#20323)

This commit is contained in:
Ryan Fleming 2022-01-10 07:15:44 -05:00 committed by GitHub
parent a2611da1eb
commit c15891f3cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 0 deletions

1
.vscode/cSpell.json vendored
View File

@ -57,6 +57,7 @@
"nginx", "nginx",
"Nijhof", "Nijhof",
"Nmap", "Nmap",
"OctoPrint",
"ohmconnect", "ohmconnect",
"Onkyo", "Onkyo",
"OpenZWave", "OpenZWave",

View File

@ -21,6 +21,37 @@ ha_platforms:
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
{% configuration_basic %}
username:
description: Username for the server.
required: true
type: string
host:
description: Address of the server, e.g., 192.168.1.32.
required: true
type: string
port:
description: Port of the server.
required: false
type: string
default: 80
path:
description: URL path of the server
required: false
type: string
default: /
ssl:
description: Whether to use SSL or not when communicating.
required: false
type: boolean
default: false
verify ssl:
description: Should the SSL certificate be validated.
required: false
type: boolean
default: false
{% endconfiguration_basic %}
### API Key ### API Key
For the integration to work, please check that the plugin Discovery is enabled. For the integration to work, please check that the plugin Discovery is enabled.
The Octoprint integration will attempt to register itself via the [application keys plugin](https://docs.octoprint.org/en/master/bundledplugins/appkeys.html). After submitting the configuration UI in Home Assistant, open the Octoprint UI and click allow on the prompt. The Octoprint integration will attempt to register itself via the [application keys plugin](https://docs.octoprint.org/en/master/bundledplugins/appkeys.html). After submitting the configuration UI in Home Assistant, open the Octoprint UI and click allow on the prompt.