Formatted according to documentation standards (#6441)

* Formatted according to documentation standards

* Wrap it in quotes

* ✏️ Corrected types
This commit is contained in:
pattyland 2018-10-03 20:19:08 +02:00 committed by Franck Nijhof
parent 7907badac8
commit eb9df96ed2

View File

@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
The `hyperion` platform allows you to integrate your [Hyperion](https://hyperion-project.org/wiki) into Home Assistant. Hyperion is an open source Ambilight implementation which runs on many platforms. The `hyperion` platform allows you to integrate your [Hyperion](https://hyperion-project.org/wiki) into Home Assistant. Hyperion is an open source Ambilight implementation which runs on many platforms.
## {% linkable_title Configuration %}
To use your Hyperion light in your installation, add the following to your `configuration.yaml` file: To use your Hyperion light in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
@ -24,12 +26,38 @@ light:
host: IP_ADDRESS host: IP_ADDRESS
``` ```
Configuration variables: {% configuration %}
host:
- **host** (*Required*): The IP address of the device the Hyperion service is running on. description: The IP address of the device the Hyperion service is running on.
- **port** (*Optional*): The port used to communicate with the Hyperion service. Defaults to `19444`. required: true
- **name** (*Optional*): The name of the device used in the frontend. type: string
- **priority** (*Optional*): The priority of the Hyperion instance. Defaults to `128`. port:
- **hdmi_priority** (*Optional*): The priority of the HDMI grabber of this Hyperion instance, note that this priority must be higher than all other priorities used for correct behavior. Defaults to `880`. description: The port used to communicate with the Hyperion service.
- **default_color** (*Optional*): The color of the light. Defaults to `[255, 255, 255]`. required: false
- **effect_list** (*Optional*): The list of effects that can be used. Defaults to `['HDMI', 'Cinema brighten lights', 'Cinema dim lights', 'Knight rider', 'Blue mood blobs', 'Cold mood blobs', 'Full color mood blobs', 'Green mood blobs', 'Red mood blobs', 'Warm mood blobs', 'Police Lights Single', 'Police Lights Solid', 'Rainbow mood', 'Rainbow swirl fast', 'Rainbow swirl', 'Random', 'Running dots', 'System Shutdown', 'Snake', 'Sparks Color', 'Sparks', 'Strobe blue', 'Strobe Raspbmc', 'Strobe white', 'Color traces', 'UDP multicast listener', 'UDP listener', 'X-Mas']`. type: int
default: 19444
name:
description: The name of the device used in the frontend.
required: false
type: string
priority:
description: The priority of the Hyperion instance.
required: false
type: int
default: 128
hdmi_priority:
description: The priority of the HDMI grabber of this Hyperion instance, note that this priority must be higher than all other priorities used for correct behavior.
required: false
type: int
default: 880
default_color:
description: The color of the light.
required: false
type: list
default: "[255, 255, 255]"
effect_list:
description: The list of effects that can be used.
required: false
type: list
default: "['HDMI', 'Cinema brighten lights', 'Cinema dim lights', 'Knight rider', 'Blue mood blobs', 'Cold mood blobs', 'Full color mood blobs', 'Green mood blobs', 'Red mood blobs', 'Warm mood blobs', 'Police Lights Single', 'Police Lights Solid', 'Rainbow mood', 'Rainbow swirl fast', 'Rainbow swirl', 'Random', 'Running dots', 'System Shutdown', 'Snake', 'Sparks Color', 'Sparks', 'Strobe blue', 'Strobe Raspbmc', 'Strobe white', 'Color traces', 'UDP multicast listener', 'UDP listener', 'X-Mas']"
{% endconfiguration %}