From eb9df96ed2f93c601f0fdeb0c4c54c0649930f7d Mon Sep 17 00:00:00 2001 From: pattyland Date: Wed, 3 Oct 2018 20:19:08 +0200 Subject: [PATCH] Formatted according to documentation standards (#6441) * Formatted according to documentation standards * Wrap it in quotes * :pencil2: Corrected types --- source/_components/light.hyperion.markdown | 46 +++++++++++++++++----- 1 file changed, 37 insertions(+), 9 deletions(-) diff --git a/source/_components/light.hyperion.markdown b/source/_components/light.hyperion.markdown index 7cba5e18f41..c7622a1a3fc 100644 --- a/source/_components/light.hyperion.markdown +++ b/source/_components/light.hyperion.markdown @@ -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. +## {% linkable_title Configuration %} + To use your Hyperion light in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -24,12 +26,38 @@ light: host: IP_ADDRESS ``` -Configuration variables: - -- **host** (*Required*): 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`. -- **name** (*Optional*): The name of the device used in the frontend. -- **priority** (*Optional*): The priority of the Hyperion instance. Defaults to `128`. -- **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`. -- **default_color** (*Optional*): The color of the light. Defaults to `[255, 255, 255]`. -- **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']`. +{% 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: 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 %}