From eaf5f6505b2ccc166f0c8ec9c0ea5f858ba9d4a6 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sun, 8 Nov 2020 20:36:52 +0100 Subject: [PATCH] Revert "Simplify the Hyperion documentation to reflect the new configuration flow" (#15569) This reverts commit 026cf024190cd08deb5dec60115949dad6b7d134. --- source/_integrations/hyperion.markdown | 55 +++++++++++++------------- 1 file changed, 28 insertions(+), 27 deletions(-) diff --git a/source/_integrations/hyperion.markdown b/source/_integrations/hyperion.markdown index 602686baca7..490a1a7fc5b 100644 --- a/source/_integrations/hyperion.markdown +++ b/source/_integrations/hyperion.markdown @@ -14,40 +14,41 @@ The `hyperion` platform allows you to integrate your [Hyperion](https://docs.hyperion-project.org/) into Home Assistant. Hyperion is 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 this integration. ## Configuration -This integration can be configured using the integrations in the -Home Assistant frontend. +To use your Hyperion light in your installation, add the following to your `configuration.yaml` file: -Menu: **Configuration** -> **Integrations**. +```yaml +# Example configuration.yaml entry +light: + - platform: hyperion + host: IP_ADDRESS +``` -In most cases, Hyperion servers will be automatically discovered by -Home Assistant. Those automatically discovered devices are listed -on the integrations page. - -If for some reason Hyperion isn't discovered, it can be added manually. - -Click on the `+` sign to add an integration and click on **Hyperion**. -After completing the configuration flow, the Hyperion integration will be -available. - -### Extra configuration of the integration - -All configuration options are offered from the frontend. Choose `Options` under the -relevant entry on the `Integrations` page. - -Options supported: -- **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). - -## Hyperion Instances - -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. +{% configuration %} + host: + description: The IP address of the device the Hyperion service is running on. + required: true + type: string + port: + description: The port used to communicate with the Hyperion service. + required: false + type: integer + default: 19444 + name: + description: The name of the device used in the frontend. + required: false + type: string + 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). + required: false + type: integer + default: 128 +{% endconfiguration %} ## Effects