Simplify the Hyperion documentation to reflect the new configuration flow (#15336)

This commit is contained in:
Dermot Duffy 2020-11-08 04:51:31 -08:00 committed by GitHub
parent 1576d40d70
commit 026cf02419
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -14,41 +14,40 @@ The `hyperion` platform allows you to integrate your
[Hyperion](https://docs.hyperion-project.org/) into Home Assistant. Hyperion is [Hyperion](https://docs.hyperion-project.org/) into Home Assistant. Hyperion is
an open source Ambilight implementation which runs on many platforms. an open source Ambilight implementation which runs on many platforms.
NOTE: [Hyperion-NG](https://github.com/hyperion-project/hyperion.ng) is **NOTE**: [Hyperion-NG](https://github.com/hyperion-project/hyperion.ng) is
supported, the original [discontinued Hyperion](https://github.com/hyperion-project/hyperion) is not supported by supported, the original [discontinued Hyperion](https://github.com/hyperion-project/hyperion) is not supported by
this integration. this integration.
## Configuration ## Configuration
To use your Hyperion light in your installation, add the following to your `configuration.yaml` file: This integration can be configured using the integrations in the
Home Assistant frontend.
```yaml Menu: **Configuration** -> **Integrations**.
# Example configuration.yaml entry
light:
- platform: hyperion
host: IP_ADDRESS
```
{% configuration %} In most cases, Hyperion servers will be automatically discovered by
host: Home Assistant. Those automatically discovered devices are listed
description: The IP address of the device the Hyperion service is running on. on the integrations page.
required: true
type: string If for some reason Hyperion isn't discovered, it can be added manually.
port:
description: The port used to communicate with the Hyperion service. Click on the `+` sign to add an integration and click on **Hyperion**.
required: false After completing the configuration flow, the Hyperion integration will be
type: integer available.
default: 19444
name: ### Extra configuration of the integration
description: The name of the device used in the frontend.
required: false All configuration options are offered from the frontend. Choose `Options` under the
type: string relevant entry on the `Integrations` page.
priority:
description: The priority for color and effects, make sure this is lower then the streaming sources priority in hyperion itself (typically lower than 200 is appropriate). Options supported:
required: false - **priority**: The priority for color and effects, make sure this is lower then the streaming sources priority in hyperion itself (typically lower than 200 is appropriate).
type: integer
default: 128 ## Hyperion Instances
{% endconfiguration %}
This integration supports multiple Hyperion instances running on a single Hyperion
server. As instances are added/removed on the Hyperion UI, they will automatically be
added/removed from Home Assistant.
## Effects ## Effects