jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-25 02:07:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Revert "Simplify the Hyperion documentation to reflect the new configuration flow" (#15569)

Browse Source 
This reverts commit 026cf024190cd08deb5dec60115949dad6b7d134.
This commit is contained in:
Franck Nijhof 2020-11-08 20:36:52 +01:00 committed by GitHub
parent a3fabeba94
commit eaf5f6505b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
source/_integrations/hyperion.markdown
View File

@ -14,40 +14,41 @@ 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
This integration can be configured using the integrations in the To use your Hyperion light in your installation, add the following to your `configuration.yaml` file:
Home Assistant frontend.
Menu: **Configuration** -> **Integrations**. ```yaml
# Example configuration.yaml entry
light:
- platform: hyperion
host: IP_ADDRESS
```
In most cases, Hyperion servers will be automatically discovered by {% configuration %}
Home Assistant. Those automatically discovered devices are listed host:
on the integrations page. description: The IP address of the device the Hyperion service is running on.
required: true
If for some reason Hyperion isn't discovered, it can be added manually. type: string
port:
Click on the `+` sign to add an integration and click on **Hyperion**. description: The port used to communicate with the Hyperion service.
After completing the configuration flow, the Hyperion integration will be required: false
available. type: integer
default: 19444
### Extra configuration of the integration name:
description: The name of the device used in the frontend.
All configuration options are offered from the frontend. Choose `Options` under the required: false
relevant entry on the `Integrations` page. type: string
priority:
Options supported: 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).
- **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). required: false
type: integer
## Hyperion Instances default: 128
{% 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